view_component_reflex 2.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3e7ed47e432ef756d8359ace66447aedd995d240eb423007ec868c9dfa0402
-  data.tar.gz: bb836fc180d285454b516ced91b92cc309320d9257c5da71a17c2789631fcd0f
+  metadata.gz: 0ab31dd62e6ea3047e6092dc2fed4fb4ec56c0c6b348217109a91a63a7f5f741
+  data.tar.gz: 51d03bf7e07b25c12fd5f2babd8c0346815c4e9cd7d4e0bfff6ff7df9d0acfcd
 SHA512:
-  metadata.gz: 594bf37cfa1ef0798df664220190d694d3c164ee25516b0220ba6f884b4bf3667a52cfb0668d7d0ae2d684d17c18296862f5ae2473ace3b23ac8496f29825ba6
-  data.tar.gz: d82970ac5abd4aea2ffb675f261ba7c6b840e1f866f9b93b51c368cead4fff06d9ac1e7c8211f679f0f58a4d6b78557fe2c553b66bec982ddaf7d1cf0c5e8433
+  metadata.gz: 305353ea23702dec039ddfb05304adbc894f40355649ab137ddce4a03e6fab42f2fc6f5f775236e29c12e2a2b24e0e28d2d6e2904b2135435e51b3aa2c7c3fbb
+  data.tar.gz: 8e1dc76c9d0efe24a7609ce25ab307daef5d861495c23be8a66d5bb6f96c88a1bba3b8c28735d4e55595b5b4e572db89ab65a6bae50c2430edb497387eff7f6d

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
@@ -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))
+        if name.include? "::"
+          @stimulus_reflex ||= module_parent.const_set(name.split("::").last + "Reflex", Class.new(Reflex))
+        else
+          @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(Reflex))
+        end
         @stimulus_reflex.component_class = self
       end
     end
@@ -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
@@ -109,7 +117,7 @@ module ViewComponentReflex
       [
         :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
         :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-        :@helpers, :@controller, :@request, :@content, :@tag_builder
+        :@helpers, :@controller, :@request, :@tag_builder
       ]
     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

@@ -20,16 +20,18 @@ module ViewComponentReflex
         [primary_selector, *rest].each do |s|
           html = document.css(s)
           if html.present?
-            cable_ready[channel.stream_name].inner_html(
+            cable_ready[channel.stream_name].morph(
               selector: s,
               html: html.inner_html,
-              children_only: true
+              children_only: true,
+              permanent_attribute_name: "data-reflex-permanent"
             )
           end
         end
       else
         refresh_component!
       end
+      cable_ready.broadcast
     end
 
     def refresh_component!
@@ -38,9 +40,12 @@ module ViewComponentReflex
           element.dataset[:key]
         end
       end
-      cable_ready[channel.stream_name].outer_html(
+      document = Nokogiri::HTML(controller.render_component_to_string(component))
+      cable_ready[channel.stream_name].morph(
         selector: selector,
-        html: controller.render_component_to_string(component)
+        children_only: true,
+        html: document.css(selector).inner_html,
+        permanent_attribute_name: "data-reflex-permanent"
       )
     end
 
@@ -91,11 +96,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/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.0.0'
+  VERSION = '2.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-08-03 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