Class: StimulusController

Inherits:
Object
  • Object
show all
Defined in:
lib/opal_stimulus/stimulus_controller.rb

Constant Summary collapse

DEFAULT_METHODS =
%i[initialize connect disconnect dispatch]
DEFAULT_GETTERS =
%i[element]

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.classes=(class_names = []) ⇒ Object



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
# File 'lib/opal_stimulus/stimulus_controller.rb', line 194

def self.classes=(class_names = [])
  `#{self.stimulus_controller}.classes = class_names`

  class_names.each do |class_name|
    js_name = class_name.to_s
    ruby_name = self.to_ruby_name(class_name)

    define_method("#{ruby_name}_class") do
      `return this[#{js_name + "Class"}]`
    end

    define_method("#{ruby_name}_classes") do
      `return this[#{js_name + "Classes"}]`
    end

    define_method("has_#{ruby_name}_class") do
      `return this[#{"has" + js_name.capitalize + "Class"}]`
    end
  end
end

.inherited(subclass) ⇒ Object



11
12
13
# File 'lib/opal_stimulus/stimulus_controller.rb', line 11

def self.inherited(subclass)
  ::Opal.bridge(subclass.stimulus_controller, subclass)
end

.method_added(name) ⇒ Object



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
# File 'lib/opal_stimulus/stimulus_controller.rb', line 25

def self.method_added(name)
  return if DEFAULT_GETTERS.include?(name)

  %x{
    #{self.stimulus_controller}.prototype[name] = function (...args) {
      try {
        var wrappedArgs = args.map(function(arg) {
          if (arg && typeof arg === "object" && !arg.$$class) {
            return Opal.JS.Proxy.$new(arg);
          }
          return arg;
        });
        return this['$' + name].apply(this, wrappedArgs);
      } catch (e) {
        console.error("Uncaught", e);
      }
    }
  }
end

.outlets=(outlets = []) ⇒ Object



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/opal_stimulus/stimulus_controller.rb', line 104

def self.outlets=(outlets = [])
  `#{self.stimulus_controller}.outlets = outlets`

  outlets.each do |outlet|
    js_name = outlet.to_s
    ruby_name = self.to_ruby_name(outlet)

    define_method(ruby_name + "_outlet") do
      `return this[#{js_name + "Outlet"}]`
    end

    define_method(ruby_name + "_outlets") do
      `this[#{js_name + "Outlets"}]`
    end

    define_method("has_" + ruby_name + "_outlet") do
      `return this[#{"has" + js_name.capitalize + "Outlet"}]`
    end

    snake_case_connected = ruby_name + "_outlet_connected"
    camel_case_connected = js_name + "OutletConnected"
    %x{
      #{self.stimulus_controller}.prototype[#{camel_case_connected}] = function() {
        if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_connected})) {
          return this['$' + #{snake_case_connected}]();
        }
      }
    }

    snake_case_disconnected = ruby_name + "_outlet_disconnected"
    camel_case_disconnected = js_name + "OutletDisconnected"
    %x{
      #{self.stimulus_controller}.prototype[#{camel_case_disconnected}] = function() {
        if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_disconnected})) {
          return this['$' + #{snake_case_disconnected}]();
        }
      }
    }
  end
end

.register_all!Object



52
53
54
55
56
57
58
59
# File 'lib/opal_stimulus/stimulus_controller.rb', line 52

def self.register_all!
  subclasses.each do |controller|
    controller.define_method(:dummy) {}

    return if `application.controllers`.include?(`#{controller.stimulus_name}`)
    `application.register(#{controller.stimulus_name}, #{controller.stimulus_controller})`
  end
end

.stimulus_controllerObject



15
16
17
18
19
# File 'lib/opal_stimulus/stimulus_controller.rb', line 15

def self.stimulus_controller
  return @stimulus_controller if @stimulus_controller
  @stimulus_controller = `class extends Controller {}`
  @stimulus_controller
end

.stimulus_nameObject



21
22
23
# File 'lib/opal_stimulus/stimulus_controller.rb', line 21

def self.stimulus_name
  self.name.gsub(/Controller$/, "").gsub(/([a-z])([A-Z])/, '\1-\2').gsub("::", "--").downcase
end

.targets=(targets = []) ⇒ Object



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/opal_stimulus/stimulus_controller.rb', line 61

def self.targets=(targets = [])
  `#{self.stimulus_controller}.targets = targets`

  targets.each do |target|
    js_name = target.to_s
    ruby_name = self.to_ruby_name(target)

    define_method(ruby_name + "_target") do
      JS::Proxy.new(`this[#{js_name + "Target"}]`)
    end

    define_method(ruby_name + "_targets") do
      `this[#{js_name + "Targets"}]`.map do |el|
        JS::Proxy.new(el)
      end
    end

    define_method("has_" + ruby_name + "_target") do
      `this[#{"has" + js_name.capitalize + "Target"}]`
    end

    snake_case_connected = ruby_name + "_target_connected"
    camel_case_connected = js_name + "TargetConnected"
    %x{
      #{self.stimulus_controller}.prototype[#{camel_case_connected}] = function() {
        if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_connected})) {
          return this['$' + #{snake_case_connected}]();
        }
      }
    }

    snake_case_disconnected = ruby_name + "_target_disconnected"
    camel_case_disconnected = js_name + "TargetDisconnected"
    %x{
      #{self.stimulus_controller}.prototype[#{camel_case_disconnected}] = function() {
        if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_disconnected})) {
          return this['$' + #{snake_case_disconnected}]();
        }
      }
    }
  end
end

.to_ruby_name(name) ⇒ Object



45
46
47
48
49
50
# File 'lib/opal_stimulus/stimulus_controller.rb', line 45

def self.to_ruby_name(name)
  name
    .to_s
    .gsub(/([A-Z]+)/) { "_#{$1.downcase}" }
    .sub(/^_/, '')
end

.values=(values_hash = {}) ⇒ Object



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/opal_stimulus/stimulus_controller.rb', line 145

def self.values=(values_hash = {})
  js_values = {}

  values_hash.each do |name, type|
    name = self.to_ruby_name(name)

    js_type = case type
    when :string then `String`
    when :number then `Number`
    when :boolean then `Boolean`
    when :array then `Array`
    when :object then `Object`
    else
      raise ArgumentError,
        "Unsupported value type: #{type}, please use :string, :number, :boolean, :array, or :object"
    end

    js_values[name] = js_type

    `#{self.stimulus_controller}.values = #{js_values.to_n}`

    define_method(name + "_value") do
      Native(`this[#{name + "Value"}]`)
    end

    define_method(name + "_value=") do |value|
      Native(`this[#{name + "Value"}]= #{value}`)
    end

    define_method("has_#{name}") do
      `return this[#{"has" + name.to_s.capitalize + "Value"}]`
    end

    snake_case_changed = "#{name}_value_changed"
    camel_case_changed = "#{name}ValueChanged"
    %x{
      #{self.stimulus_controller}.prototype[#{camel_case_changed}] = function(value, previousValue) {
        if (#{type == :object}) {
          value = JSON.stringify(value)
          previousValue = JSON.stringify(previousValue)
        }
        if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_changed})) {
          return this['$' + #{snake_case_changed}](value, previousValue);
        }
      }
    }
  end
end

Instance Method Details

#documentObject



223
224
225
# File 'lib/opal_stimulus/stimulus_controller.rb', line 223

def document
  @document ||= JS::Proxy.new($$.document)
end

#elementObject



215
216
217
# File 'lib/opal_stimulus/stimulus_controller.rb', line 215

def element
  JS::Proxy.new(`this.element`)
end

#windowObject



219
220
221
# File 'lib/opal_stimulus/stimulus_controller.rb', line 219

def window
  @window ||= JS::Proxy.new($$.window)
end