view_component_reflex 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d42e80a31d1a4a27c828f02fc584e9c5eb6660a6d5697e0db3a9631be358dec
-  data.tar.gz: 96450604f1d0965c104171a8b1d667f6d4dc38019e0c6434fd974ff80a3d9f26
+  metadata.gz: 2a3e7ed47e432ef756d8359ace66447aedd995d240eb423007ec868c9dfa0402
+  data.tar.gz: bb836fc180d285454b516ced91b92cc309320d9257c5da71a17c2789631fcd0f
 SHA512:
-  metadata.gz: deaf8859ae5816796b965ba5c7e1022032253f44fc1e6c94bcdda8dd481d20afb1319a63c99acc98e184908c5c0b299384e1b77cecef4cd5099263bc4f0d4606
-  data.tar.gz: 6da8e3668c5cf6f2dd64c770eada3b381669dd2dac2cf11dc65b2f9e7a94d4e7d450a563506459057642d0f97629d582d1935a9eef7bbf61acfc084402b2e1cd
+  metadata.gz: 594bf37cfa1ef0798df664220190d694d3c164ee25516b0220ba6f884b4bf3667a52cfb0668d7d0ae2d684d17c18296862f5ae2473ace3b23ac8496f29825ba6
+  data.tar.gz: d82970ac5abd4aea2ffb675f261ba7c6b840e1f866f9b93b51c368cead4fff06d9ac1e7c8211f679f0f58a4d6b78557fe2c553b66bec982ddaf7d1cf0c5e8433

data/README.md

@@ -70,8 +70,8 @@ end
 ```
 
 ### omitted_from_state
-Return an array of instance variables you want to omit from state. Useful if you have an object 
-that isn't serializable as an instance variable, like a form.
+Return an array of instance variables you want to omit from state. Only really useful if you're using the session state
+adapter, and you have an instance variable that can't be serialized.
 
 ```ruby
 def omitted_from_state
@@ -108,6 +108,19 @@ def collection_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.
 
@@ -181,6 +194,11 @@ end
 <% end
 ```
 
+## State
+
+By default, view_component_reflex stores component state in memory. You can optionally set the state adapter
+to use the session by changing `config.state_adapter` to `ViewComponentReflex::StateAdapter::Session`
+
 ## Custom State Adapters
 
 ViewComponentReflex uses session for its state by default. To change this, add

data/app/components/view_component_reflex/component.rb

@@ -2,95 +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!(primary_selector = "[data-controller~=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]", *selectors)
-            save_state
-            @channel.send :render_page_and_broadcast_morph, self, [primary_selector, *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" => "data-reflex-permanent"
-            }
-          end
-
-          def refresh_all!
-            refresh!("body")
-          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
-
-          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.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
 
@@ -121,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
@@ -133,7 +50,7 @@ module ViewComponentReflex
       @key = key
     end
 
-    def reflex_tag(reflex, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
       action, method = reflex.to_s.split("->")
       if method.nil?
         method = action
@@ -165,18 +82,10 @@ module ViewComponentReflex
 
     def key
       # initialize session state
-      if !stimulus_reflex? || session[@key].nil?
-        new_state = {}
-
-        # this will almost certainly break
-        blacklist = [
-          :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
-          :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-          :@helpers, :@controller, :@request, :@content
-        ]
-        instance_variables.reject { |k| blacklist.include?(k) }.each do |k|
-          new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(k)
-        end
+      if !stimulus_reflex? || ViewComponentReflex::Engine.state_adapter.state(request, @key).empty?
+
+        new_state = create_safe_state
+
         ViewComponentReflex::Engine.state_adapter.store_state(request, @key, new_state)
         ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", new_state)
       else
@@ -190,8 +99,30 @@ module ViewComponentReflex
       @key
     end
 
+    def safe_instance_variables
+      instance_variables - unsafe_instance_variables
+    end
+
     private
 
+    def unsafe_instance_variables
+      [
+        :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
+        :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
+        :@helpers, :@controller, :@request, :@content, :@tag_builder
+      ]
+    end
+
+    def create_safe_state
+      new_state = {}
+
+      # this will almost certainly break
+      safe_instance_variables.each do |k|
+        new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(k)
+      end
+      new_state
+    end
+
     def merge_data_attributes(options, attributes)
       data = options[:data]
       if data.nil?

data/app/reflexes/view_component_reflex/reflex.rb

@@ -0,0 +1,123 @@
+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].inner_html(
+              selector: s,
+              html: html.inner_html,
+              children_only: true
+            )
+          end
+        end
+      else
+        refresh_component!
+      end
+    end
+
+    def refresh_component!
+      component.tap do |k|
+        k.define_singleton_method(:key) do
+          element.dataset[:key]
+        end
+      end
+      cable_ready[channel.stream_name].outer_html(
+        selector: selector,
+        html: controller.render_component_to_string(component)
+      )
+    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 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.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,8 @@
-require "view_component_reflex/state_adapter/session"
-require "view_component_reflex/engine"
-require 'stimulus_reflex'
-
-module ViewComponentReflex
-  # Your code goes here...
-end
+require "view_component_reflex/state_adapter/session"
+require "view_component_reflex/state_adapter/memory"
+require "view_component_reflex/engine"
+require "stimulus_reflex"
+
+module ViewComponentReflex
+  # Your code goes here...
+end

data/lib/view_component_reflex/engine.rb

@@ -1,13 +1,13 @@
-module ViewComponentReflex
-  class Engine < ::Rails::Engine
-    class << self
-      mattr_accessor :state_adapter
-
-      self.state_adapter = StateAdapter::Session
-    end
-
-    def self.configure
-      yield self if block_given?
-    end
-  end
-end
+module ViewComponentReflex
+  class Engine < ::Rails::Engine
+    class << self
+      mattr_accessor :state_adapter
+
+      self.state_adapter = StateAdapter::Memory
+    end
+
+    def self.configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/view_component_reflex/state_adapter/memory.rb

@@ -0,0 +1,25 @@
+VIEW_COMPONENT_REFLEX_MEMORY_STATE = {}
+module ViewComponentReflex
+  module StateAdapter
+    class Memory
+      def self.state(request, key)
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s] ||= {}
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] ||= {}
+      end
+
+      def self.set_state(request, _, key, new_state)
+        new_state.each do |k, v|
+          state(request, key)[k] = v
+        end
+      end
+
+      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] ||= {}
+        new_state.each do |k, v|
+          VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key][k] = v
+        end
+      end
+    end
+  end
+end

data/lib/view_component_reflex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,8 +69,10 @@ 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
 - lib/view_component_reflex/state_adapter/session.rb
 - lib/view_component_reflex/version.rb
 homepage: https://github.com/joshleblanc/view_component_reflex