view_component_reflex 2.0.2 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6da4b2d9e532fefeb33b06d18081a1be6a281545a7716dc0650f2e5facd44d3
-  data.tar.gz: f267ea6850f2fd12250d19af6183ca4b48266b38c37d0486375efa11871ab391
+  metadata.gz: 2fdf34d064e1a90d42f689dbeac337bfcefdecb34da14005a3333985de710d32
+  data.tar.gz: 8de6a22148047c13913d7363fb87c61cee167c7cb7d6b3ddc841f4d5af259233
 SHA512:
-  metadata.gz: 9bfecb324ea02fc969beba3a393752d73881a6fd917e16bcbbc49a0082113c46c4a2a0c27e1c2f9a8eb501f6429b992a0eff4ce078cc32ebc87cec1f589f0612
-  data.tar.gz: 45b0510fea9923a7edc82eef3ade6d01459134627c9e505c0c92aadd2c16be05c11ab08aa9220e363d3ee79b8f73a9885138777f963b9e38bf4252178312a3f4
+  metadata.gz: 0f4f49aca8e48a7addfdc6590cff4d2e8bf21c2aca5c9588af7ed673b90614f12d043cdfdd760a6653efaa6a064c536c693e1373be1d89130e78c4d21fc3845b
+  data.tar.gz: b0e40d72439efa641a044eef1c36842a6d3532a27ff6c029b7d0fa0798a61c72e468879289c5f85f4f2cb95db561c35f39af0d59653ad110e54f1ee2f620f35c

data/README.md

@@ -108,6 +108,20 @@ def collection_key
 end
 ```
 
+### stimulate(target, data)
+Stimulate another reflex from within your component. This typically requires the key of the component you're stimulating
+which can be passed in via parameters.
+
+```ruby
+def initialize(parent_key)
+  @parent_key = parent_key
+end
+
+def stimulate_other
+  stimulate("OtherComponent#method", { key: @parent_key })
+end
+```
+
 ### refresh!(selectors)
 Refresh a specific element on the page. Using this will implicitly run `prevent_render!`.
 If you want to render a specific element, as well as the component, a common pattern would be to pass `selector` as one of the parameters
@@ -205,7 +219,7 @@ ViewComponentReflex uses session for its state by default. To change this, add
 an initializer to `config/initializers/view_component_reflex.rb`.
 
 ```ruby
-ViewComponentReflex.configure do |config|
+ViewComponentReflex::Engine.configure do |config|
   config.state_adapter = YourAdapter
 end
 ```
@@ -265,9 +279,19 @@ Or install it yourself as:
 $ gem install view_component_reflex
 ```
 
+## Common problems
+
+# Uninitialized constants \<component\>Reflex
+A component needs to be wrapped in `<%= component_controller do %>` in order to properly initialize, otherwise the Reflex class won't get created.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Caveats
 
 State uses session to maintain state as of right now. It also assumes your component view is written with the file extension `.html.erb`
+
+## Support me
+
+<a href="https://www.buymeacoffee.com/jleblanc" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="40" ></a>
+

data/app/components/view_component_reflex/component.rb

@@ -2,7 +2,11 @@ module ViewComponentReflex
   class Component < ViewComponent::Base
     class << self
       def init_stimulus_reflex
-        @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(Reflex))
+        @stimulus_reflex ||= if name.include? "::"
+          module_parent.const_set(name.split("::").last + "Reflex", Class.new(Reflex))
+        else
+          Object.const_set(name + "Reflex", Class.new(Reflex))
+        end
         @stimulus_reflex.component_class = self
       end
     end
@@ -20,11 +24,11 @@ module ViewComponentReflex
       init_key
 
       tag = :div
-      if opts_or_tag.is_a? Hash
-        options = opts_or_tag
+      options = if opts_or_tag.is_a? Hash
+        opts_or_tag
       else
         tag = opts_or_tag
-        options = opts
+        opts
       end
       options[:data] = {
         controller: self.class.stimulus_controller,
@@ -91,7 +95,11 @@ module ViewComponentReflex
       else
         initial_state = ViewComponentReflex::Engine.state_adapter.state(request, "#{@key}_initial")
         ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
-          unless permit_parameter?(initial_state[k], instance_variable_get(k))
+          instance_value = instance_variable_get(k)
+          if permit_parameter?(initial_state[k], instance_value)
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", { k => instance_value })
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, { k => instance_value })
+          else
             instance_variable_set(k, v)
           end
         end

data/lib/view_component_reflex.rb

@@ -2,6 +2,7 @@ require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/state_adapter/memory"
 require "view_component_reflex/engine"
 require "stimulus_reflex"
+require "view_component_reflex/reflex"
 
 module ViewComponentReflex
   # Your code goes here...

data/{app/reflexes → lib}/view_component_reflex/reflex.rb

@@ -61,19 +61,26 @@ module ViewComponentReflex
     # uses method to gather the method parameters, but since we're abusing
     # method_missing here, that'll always fail
     def method(name)
-      name.to_sym.to_proc
+      component.method(name.to_sym)
     end
 
     def respond_to_missing?(name, _ = false)
       !!name.to_proc
     end
 
-    before_reflex do |a|
-      a.send a.method_name
-      throw :abort
+    # this is copied out of stimulus_reflex/reflex.rb and modified
+    def morph(selectors, html = "")
+      case selectors
+      when :nothing
+        @broadcaster = StimulusReflex::NothingBroadcaster.new(self)
+      else
+        @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
+        broadcaster.morphs << [selectors, html]
+      end
     end
 
     def method_missing(name, *args)
+      morph :nothing
       super unless respond_to_missing?(name)
       state.each do |k, v|
         component.instance_variable_set(k, v)
@@ -96,11 +103,23 @@ module ViewComponentReflex
       component_class.stimulus_controller
     end
 
+    def stimulate(target, data)
+      dataset = {}
+      data.each do |k, v|
+        dataset["data-#{k}"] = v.to_s
+      end
+      channel.receive({
+        "target" => target,
+        "attrs" => element.attributes.to_h.symbolize_keys,
+        "dataset" => dataset
+      })
+    end
+
     def component
       return @component if @component
       @component = component_class.allocate
       reflex = self
-      exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector]
+      exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector, :stimulate]
       exposed_methods.each do |meth|
         @component.define_singleton_method(meth) do |*a|
           reflex.send(meth, *a)

data/lib/view_component_reflex/state_adapter/memory.rb

@@ -15,7 +15,7 @@ module ViewComponentReflex
 
       def self.store_state(request, key, new_state = {})
         VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s] ||= {}
-        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] ||= {}
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] = {}
         new_state.each do |k, v|
           VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key][k] = v
         end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.0.2'
+  VERSION = '2.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.4
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,9 +69,9 @@ files:
 - README.md
 - Rakefile
 - app/components/view_component_reflex/component.rb
-- app/reflexes/view_component_reflex/reflex.rb
 - lib/view_component_reflex.rb
 - lib/view_component_reflex/engine.rb
+- lib/view_component_reflex/reflex.rb
 - lib/view_component_reflex/state_adapter/memory.rb
 - lib/view_component_reflex/state_adapter/session.rb
 - lib/view_component_reflex/version.rb