view_component_reflex 1.7.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c34425ccfef14458d218da7f297859dee0d17e5b922c9cefc82059e13fa5af99
-  data.tar.gz: 6f201ab4b1a8a84e08a840a3de07e117d4c4dc1095dbe8decaf2c6b70bed971f
+  metadata.gz: 415195dd61211d392433d4e85963a6807871143f255b3264e2f7b4871bb42c42
+  data.tar.gz: 69f6030f02557d4d9886e3cfc00c738c66d748eb7a1a4b8149136ddaef8f8e9d
 SHA512:
-  metadata.gz: d4ee24cfffed38e1e6f72c33c6aaffb3d8573328759da2be6175d85bb1d2fa1973c5314aa79ec5ed94be73655f4c42929674cff964bcc7ee0bb600db331d08bf
-  data.tar.gz: f89ab463f3aaf436da93442ac9c212b3552367ef6a10815180142a83022944a0188c2993cfe678bd3d579b8a5d334d3bb302a44bf29e480399daa6393b0159c3
+  metadata.gz: e12ff695c21dc3f6c140c9d7aa7ccc854eeaeacf2a8071dc519f87c4ca1447464c01f8dfc9c200c0ac720dd864a71788fcc80f74072577c4c833743ccea29c79
+  data.tar.gz: ed7a85c244de733490571e7c4b529ce7b8dd295c0f6c1a5d57b15f40460b4a3737f2669bf8f28845d80a06b2ed721de49bc810c7ac9477629ead664635b2f2ee

data/README.md

@@ -108,6 +108,33 @@ 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
+
+```
+def my_method
+  refresh! '#my-special-element', selector
+end
+```
+
+### selector
+Returns the unique selector for this component. Useful to pass to `refresh!` when refreshing custom elements.
+
 ### prevent_refresh!
 By default, VCR will re-render your component after it executes your method. `revent_refresh!` prevents this from happening.
 

data/app/components/view_component_reflex/component.rb

@@ -2,122 +2,8 @@ module ViewComponentReflex
   class Component < ViewComponent::Base
     class << self
       def init_stimulus_reflex
-        klass = self
-        @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(StimulusReflex::Reflex) {
-          def refresh!(*selectors)
-            save_state
-
-            # If the component has instance variables omitted from state,
-            # we can't render it to string from here because those instance
-            # variables will be missing. In that case, set the selectors to the
-            # default selector and manually morph the page
-            if selectors.empty? && !component.can_render_to_string?
-              selectors.push selector
-            end
-
-            # If we're just updating the component itself, we can
-            # directly render it instead of rendering the entire page again
-            if selectors.empty?
-              refresh_component!
-            else
-              @channel.send :render_page_and_broadcast_morph, self, selectors, {
-                "dataset" => element.dataset.to_h,
-                "args" => [],
-                "attrs" => element.attributes.to_h,
-                "selectors" => ["body"],
-                "target" => "#{self.class.name}##{method_name}",
-                "url" => request.url,
-                "permanent_attribute_name" => permanent_attribute_name
-              }
-            end
-          end
-
-          def refresh_component!
-            # The component can't figure out the key when we render from here
-            # Luckily we already know the key, so we can manually override it
-            component.tap do |k|
-              k.define_singleton_method(:key) do
-                element.dataset[:key]
-              end
-            end
-            html = controller.render_component_to_string(component)
-            document = Nokogiri::HTML(html)
-            morph selector, document.css("#{selector} > *").to_s
-          end
-
-          def selector
-            "[data-controller~=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]"
-          end
-
-          def refresh_all!
-            morph :body, render_page(self)
-          end
-
-          # SR's delegate_call_to_reflex in channel.rb
-          # 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
-          end
-
-          def respond_to_missing?(name, _ = false)
-            !!name.to_proc
-          end
-
-          def method_missing(name, *args)
-            super unless respond_to_missing?(name)
-            state.each do |k, v|
-              component.instance_variable_set(k, v)
-            end
-            name.to_proc.call(component, *args)
-            refresh! unless @prevent_refresh
-          end
-
-          def prevent_refresh!
-            @prevent_refresh = true
-          end
-
-          define_method :component_class do
-            @component_class ||= klass
-          end
-
-          private :component_class
-
-          private
-
-          def stimulus_controller
-            component_class.stimulus_controller
-          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!]
-            exposed_methods.each do |meth|
-              @component.define_singleton_method(meth) do |*a|
-                reflex.send(meth, *a)
-              end
-            end
-            @component
-          end
-
-          def set_state(new_state = {})
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
-          end
-
-          def state
-            ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
-          end
-
-          def save_state
-            new_state = {}
-            component.safe_instance_variables.each do |k|
-              new_state[k] = component.instance_variable_get(k)
-            end
-            set_state(new_state)
-          end
-        })
+        @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(Reflex))
+        @stimulus_reflex.component_class = self
       end
     end
 
@@ -129,10 +15,6 @@ module ViewComponentReflex
       helpers.controller.instance_variable_get(:@stimulus_reflex)
     end
 
-    def can_render_to_string?
-      omitted_from_state.empty?
-    end
-
     def component_controller(opts_or_tag = :div, opts = {}, &blk)
       self.class.init_stimulus_reflex
       init_key
@@ -152,6 +34,10 @@ module ViewComponentReflex
       content_tag tag, capture(&blk), options
     end
 
+    def can_render_to_string?
+      omitted_from_state.empty?
+    end
+
     # key is required if you're using state
     # We can't initialize the session state in the initial method
     # because it doesn't have a view_context yet
@@ -205,7 +91,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
@@ -223,7 +113,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/app/reflexes/view_component_reflex/reflex.rb

@@ -0,0 +1,140 @@
+module ViewComponentReflex
+  class Reflex < StimulusReflex::Reflex
+    include CableReady::Broadcaster
+
+    class << self
+      attr_accessor :component_class
+    end
+
+    def refresh!(primary_selector = nil, *rest)
+      save_state
+
+      if primary_selector.nil? && !component.can_render_to_string?
+        primary_selector = selector
+      end
+      if primary_selector
+        prevent_refresh!
+
+        controller.process(url_params[:action])
+        document = Nokogiri::HTML(controller.response.body)
+        [primary_selector, *rest].each do |s|
+          html = document.css(s)
+          if html.present?
+            cable_ready[channel.stream_name].morph(
+              selector: s,
+              html: html.inner_html,
+              children_only: true,
+              permanent_attribute_name: "data-reflex-permanent"
+            )
+          end
+        end
+      else
+        refresh_component!
+      end
+      cable_ready.broadcast
+    end
+
+    def refresh_component!
+      component.tap do |k|
+        k.define_singleton_method(:key) do
+          element.dataset[:key]
+        end
+      end
+      document = Nokogiri::HTML(controller.render_component_to_string(component))
+      cable_ready[channel.stream_name].morph(
+        selector: selector,
+        children_only: true,
+        html: document.css(selector).inner_html,
+        permanent_attribute_name: "data-reflex-permanent"
+      )
+    end
+
+    def refresh_all!
+      refresh!("body")
+    end
+
+    def selector
+      "[data-controller~=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]"
+    end
+
+    # SR's delegate_call_to_reflex in channel.rb
+    # 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
+    end
+
+    def respond_to_missing?(name, _ = false)
+      !!name.to_proc
+    end
+
+    before_reflex do |a|
+      a.send a.method_name
+      throw :abort
+    end
+
+    def method_missing(name, *args)
+      super unless respond_to_missing?(name)
+      state.each do |k, v|
+        component.instance_variable_set(k, v)
+      end
+      name.to_proc.call(component, *args)
+      refresh! unless @prevent_refresh
+    end
+
+    def prevent_refresh!
+      @prevent_refresh = true
+    end
+
+    private
+
+    def component_class
+      self.class.component_class
+    end
+
+    def stimulus_controller
+      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, :stimulate]
+      exposed_methods.each do |meth|
+        @component.define_singleton_method(meth) do |*a|
+          reflex.send(meth, *a)
+        end
+      end
+      @component
+    end
+
+    def set_state(new_state = {})
+      ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
+    end
+
+    def state
+      ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
+    end
+
+    def save_state
+      new_state = {}
+      component.safe_instance_variables.each do |k|
+        new_state[k] = component.instance_variable_get(k)
+      end
+      set_state(new_state)
+    end
+  end
+end

data/lib/view_component_reflex.rb

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

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '1.7.1'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2020-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,28 +36,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0.pre0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0.pre0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: '0'
 description: Allow stimulus reflexes in a view component
 email:
 - joshleblanc94@gmail.com
@@ -69,6 +69,7 @@ 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/state_adapter/memory.rb