Class: Plutonium::Action::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/plutonium/action/base.rb

Overview

Base class for all actions in the Plutonium framework.

Direct Known Subclasses

Interactive, Simple

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, **options) ⇒ Base

Returns a new instance of Base.



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/plutonium/action/base.rb', line 11

def initialize(name, **options)
  @name = name.to_sym
  @label = options[:label] || @name.to_s.titleize
  @description = options[:description]
  @icon = options[:icon] || Phlex::TablerIcons::ChevronRight
  @color = options[:color]
  @confirmation = options[:confirmation]
  @route_options = build_route_options(options[:route_options])
  @turbo = options[:turbo]
  @turbo_frame = options[:turbo_frame]
  @return_to = options[:return_to]
  @bulk_action = options[:bulk_action] || false
  @collection_record_action = options[:collection_record_action] || false
  @record_action = options[:record_action] || false
  @resource_action = options[:resource_action] || false
  @hidden = options[:hidden] || false
  @category = ActiveSupport::StringInquirer.new((options[:category] || :secondary).to_s)
  @position = options[:position] || 50
  @modal_mode = options[:modal]
  @modal_size = options[:size]
  @condition = options[:condition]
  # Author-supplied HTML attributes, keyed by the element they target:
  # `link:` merges onto every anchor rendering (the GET link and dropdown
  # items — which are anchors even for non-GET actions), `button:` onto
  # the button_to <form> (the non-GET toolbar rendering). Both deep-merge
  # over the framework's attributes at render time, with the author
  # winning.
  @link = normalize_html_attribute_bag(options[:link], :link)
  @button = normalize_html_attribute_bag(options[:button], :button)
  validate_modal_mode!
  validate_modal_size!

  freeze
end

Instance Attribute Details

#button ⇒ Object (readonly)

Returns the value of attribute button.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def button
  @button
end

#category ⇒ Object (readonly)

Returns the value of attribute category.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def category
  @category
end

#color ⇒ Object (readonly)

Returns the value of attribute color.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def color
  @color
end

#condition ⇒ Object (readonly)

Returns the value of attribute condition.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def condition
  @condition
end

#confirmation ⇒ Object (readonly)

Returns the value of attribute confirmation.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def confirmation
  @confirmation
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def description
  @description
end

#icon ⇒ Object (readonly)

Returns the value of attribute icon.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def icon
  @icon
end

#label ⇒ Object (readonly)

Returns the value of attribute label.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def label
  @label
end

#link ⇒ Object (readonly)

Returns the value of attribute link.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def link
  @link
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def name
  @name
end

#position ⇒ Object (readonly)

Returns the value of attribute position.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def position
  @position
end

#return_to ⇒ Object (readonly)

Returns the value of attribute return_to.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def return_to
  @return_to
end

#route_options ⇒ Object (readonly)

Returns the value of attribute route_options.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def route_options
  @route_options
end

#turbo ⇒ Object (readonly)

Returns the value of attribute turbo.



9
10
11
 
# File 'lib/plutonium/action/base.rb', line 9

def turbo
  @turbo
end

Instance Method Details

#bulk_action? ⇒ Boolean

Returns:

  • (Boolean) 


75
 
# File 'lib/plutonium/action/base.rb', line 75

def bulk_action? = @bulk_action

#button_attributes(attributes) ⇒ Object 



119
120
121
 
# File 'lib/plutonium/action/base.rb', line 119

def button_attributes(attributes)
  merge_author_bag(@button, attributes)
end

#collection_record_action? ⇒ Boolean

Returns:

  • (Boolean) 


76
 
# File 'lib/plutonium/action/base.rb', line 76

def collection_record_action? = @collection_record_action

#condition_met?(view_context, record: nil) ⇒ Boolean

Display-only visibility gate, mirroring the condition: proc on inputs/displays/columns. Returns true when no condition is set.

The proc is evaluated against a ConditionContext: object/record is the contextual record (nil for resource/bulk actions), and every other call delegates to the view context (current_user, params, request, allowed_to?, resource_record!, …).

NOT an authorization boundary — a hidden action still has a live route; keep authorization in the policy.

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'lib/plutonium/action/base.rb', line 103

def condition_met?(view_context, record: nil)
  return true if @condition.nil?
  ConditionContext.new(view_context, record).instance_exec(&@condition)
end

#hidden? ⇒ Boolean

True when this action must never render. It still has a live route, policy predicate, and (if interactive) form + params machinery — it is simply reachable only by something other than a button: a kanban drop, a drag-reorder, a custom Stimulus controller.

Display-only, like #condition_met? — NOT an authorization boundary. Keep authorization in the policy.

Returns:

  • (Boolean) 


87
 
# File 'lib/plutonium/action/base.rb', line 87

def hidden? = @hidden

#link_attributes(attributes) ⇒ Object

Merge points for rendering surfaces: deep-merge the author's bag over the framework-built attributes for the element being rendered, with the author winning on every key. link_attributes is for anchors (the GET toolbar link, dropdown items — anchors even for non-GET actions — bulk-action links, kanban column actions, card show links); button_attributes is for the button_to

wrapper. Surfaces call these instead of merging #link/#button themselves.



115
116
117
 
# File 'lib/plutonium/action/base.rb', line 115

def link_attributes(attributes)
  merge_author_bag(@link, attributes)
end

#modal_mode(definition = nil) ⇒ Object

Resolves to the definition's modal_mode when unset on the action.



47
48
49
50
 
# File 'lib/plutonium/action/base.rb', line 47

def modal_mode(definition = nil)
  return @modal_mode if @modal_mode || definition.nil?
  definition.modal_mode
end

#modal_size(definition = nil) ⇒ Object

Resolves to the definition's modal_size when unset on the action.



53
54
55
56
 
# File 'lib/plutonium/action/base.rb', line 53

def modal_size(definition = nil)
  return @modal_size if @modal_size || definition.nil?
  definition.modal_size
end

#permitted_by?(policy) ⇒ Boolean

Returns:

  • (Boolean) 


89
90
91
 
# File 'lib/plutonium/action/base.rb', line 89

def permitted_by?(policy)
  policy.allowed_to?(:"#{name}?")
end

#record_action? ⇒ Boolean

Returns:

  • (Boolean) 


77
 
# File 'lib/plutonium/action/base.rb', line 77

def record_action? = @record_action

#resource_action? ⇒ Boolean

Returns:

  • (Boolean) 


78
 
# File 'lib/plutonium/action/base.rb', line 78

def resource_action? = @resource_action

#turbo_frame(definition = nil) ⇒ Object

Downgrades the remote-modal frame to nil when the definition has modal false, so the link navigates as a full page instead of targeting a frame that won't exist. Other frames pass through.

The canonical :show action carries no explicit frame; instead it reads the definition's show_in so a resource can open its show page in a modal (show_in :modal) or full-page (:page, default) without the caller threading a frame. This is deliberately independent of modal_mode (which styles :new/:edit) — show is always centered.



67
68
69
70
71
72
73
 
# File 'lib/plutonium/action/base.rb', line 67

def turbo_frame(definition = nil)
  return nil if definition && targets_remote_modal? && definition.modal_mode == false
  if definition && name == :show && @turbo_frame.nil?
    return (definition.show_in == :modal) ? Plutonium::REMOTE_MODAL_FRAME : nil
  end
  @turbo_frame
end

#with(**overrides) ⇒ Object

Returns a new Action with the given options merged over this one.



124
125
126
 
# File 'lib/plutonium/action/base.rb', line 124

def with(**overrides)
  self.class.new(name, **to_options.merge(overrides))
end