Class: FoxTail::StimulusController

Inherits:

Object

• Object
• FoxTail::StimulusController

Defined in:

lib/fox_tail/stimulus_controller.rb

Direct Known Subclasses

AccordionComponent::StimulusController, AutocompleteComponent::StimulusController, CarouselComponent::StimulusController, CheckboxComponent::StimulusController, ClickableComponent::StimulusController, CollapsibleComponent::StimulusController, CollapsibleTriggerComponent::StimulusController, ColorThemeTriggerComponent::StimulusController, DismissibleComponent::StimulusController, DismissibleTriggerComponent::StimulusController, DrawerComponent::StimulusController, DrawerTriggerComponent::StimulusController, DropdownComponent::StimulusController, DropdownTriggerComponent::StimulusController, DropzoneComponent::StimulusController, FABComponent::StimulusController, InputBaseComponent::StimulusController, ModalComponent::StimulusController, ModalTriggerComponent::StimulusController, PasswordInputComponent::StimulusController, PasswordInputTriggerComponent::StimulusController, PopoverComponent::StimulusController, PopoverTriggerComponent::StimulusController, ProgressBarComponent::StimulusController, RadioButtonComponent::StimulusController, Tabs::TabComponent::StimulusController, TextareaComponent::AutoResizeStimulusController, TooltipComponent::StimulusController, TooltipTriggerComponent::StimulusController

Instance Attribute Summary

• #identifier ⇒ Object readonly

  Returns the value of attribute identifier.

Instance Method Summary

• #action(method_name, event: nil) ⇒ Object
• #action_param_key(name, raw: false) ⇒ Object
• #attributes(_options = {}) ⇒ Object
• #build_actions(actions) ⇒ Object
• #classes_key(name, raw: false) ⇒ Object
• #config ⇒ Object
• #event(event_name) ⇒ Object
• #initialize(identifier, config: nil) ⇒ StimulusController constructor

  A new instance of StimulusController.

• #merge(attributes, options = {}) ⇒ Object
• #merge!(attributes, options = {}) ⇒ Object
• #outlet_key(name, raw: false) ⇒ Object
• #target_key(raw: false) ⇒ Object
• #to_s ⇒ Object
• #to_sym ⇒ Object
• #value_key(name, raw: false) ⇒ Object

Constructor Details

#initialize(identifier, config: nil) ⇒ StimulusController

Returns a new instance of StimulusController.

# File 'lib/fox_tail/stimulus_controller.rb', line 9

def initialize(identifier, config: nil)
  @identifier = format_identifier identifier
  @config = config
end

Instance Attribute Details

#identifier ⇒ Object (readonly)

Returns the value of attribute identifier.

# File 'lib/fox_tail/stimulus_controller.rb', line 7

def identifier
  @identifier
end

Instance Method Details

#action(method_name, event: nil) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 48

def action(method_name, event: nil)
  action = "#{identifier}##{method_name}"
  (event && event.to_sym != :click) ? "#{event}->#{action}" : action
end

#action_param_key(name, raw: false) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 53

def action_param_key(name, raw: false)
  key name, :param, raw: raw
end

#attributes(_options = {}) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 18

def attributes(_options = {})
  {
    data: {controller: identifier}
  }
end

#build_actions(actions) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 61

def build_actions(actions)
  return nil if actions.blank?

  formatted_actions = actions.each_with_object([]) do |(method_name, events), results|
    Array(events).each { |event| results.push(action(method_name, event: event)) }
  end

  stimulus_merger.merge_actions(*formatted_actions)
end

#classes_key(name, raw: false) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 36

def classes_key(name, raw: false)
  key name, :class, raw: raw
end

#config ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 14

def config
  @config ||= FoxTail::Config.current
end

#event(event_name) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 57

def event(event_name)
  "#{identifier}:#{event_name}"
end

#merge(attributes, options = {}) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 40

def merge(attributes, options = {})
  merge! attributes.deep_dup, options
end

#merge!(attributes, options = {}) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 44

def merge!(attributes, options = {})
  stimulus_merger.merge_attributes! attributes, self.attributes(options)
end

#outlet_key(name, raw: false) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 28

def outlet_key(name, raw: false)
  key name, :outlet, raw: raw
end

#target_key(raw: false) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 24

def target_key(raw: false)
  key :target, raw: raw
end

#to_s ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 75

def to_s
  identifier
end

#to_sym ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 71

def to_sym
  identifier.gsub("-", "_").to_sym
end

#value_key(name, raw: false) ⇒ Object

# File 'lib/fox_tail/stimulus_controller.rb', line 32

def value_key(name, raw: false)
  key name, :value, raw: raw
end