view_component_reflex 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2269d8639ced76028ffe2a5970960d7381c862a75ce36481a84d8cf8886acd6c
-  data.tar.gz: c368a487c3a2d97b4207ecb47558877596f9f9dccc7aa63f363598bc72a4eb82
+  metadata.gz: eb949fc8de60d18d54d72195cd04947ba24ef73db4091b2ddd0c2992287df7d0
+  data.tar.gz: c474384a6b9c073ba4efbf924067113971e67c4e8bdc0fbfa6462471ecf95b6e
 SHA512:
-  metadata.gz: 4822e9370947d8881b8f33ca8a00df19a9458ca31f9da4bc84bcfb438e768f37226a2790f489efe94ec36418f77ed4d32a122a003653ec3120ddc49df5af2a1d
-  data.tar.gz: 0f38085c800aa78f43e6df67cec9664115fed2cbce0cefc7fb89dbe2a0b3f624d7adfff1a71e542039af40a6b247744677e96a0115afe6f5f5ad65fb4c2a78df
+  metadata.gz: e0f4a365d380e55ba8deb5f567f35fa81b2aa8ab108cd2aca4f6e97041139e8e53f446f30db3ddcea0ee0fcb08e62b2f98feef14b83f5810c54ce705a6564716
+  data.tar.gz: df46044a3c7bddc9ab204ddb052fce04f0cecf190428043a3aa4ff2fb5a1b86d7d4e9524fa509ecbea51991641f8b4da9b8eaed2b1f4ede565c6cdb922a07724

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
@@ -181,6 +181,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

@@ -4,21 +4,53 @@ module ViewComponentReflex
       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)
+          def refresh!(*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"
-            }
+
+            # 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!
-            refresh!("body")
+            morph :body, render_page(self)
           end
 
           # SR's delegate_call_to_reflex in channel.rb
@@ -32,11 +64,6 @@ module ViewComponentReflex
             !!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|
@@ -85,7 +112,7 @@ module ViewComponentReflex
 
           def save_state
             new_state = {}
-            component.instance_variables.each do |k|
+            component.safe_instance_variables.each do |k|
               new_state[k] = component.instance_variable_get(k)
             end
             set_state(new_state)
@@ -102,6 +129,10 @@ 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
@@ -165,18 +196,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 +213,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/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.1'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -71,6 +71,7 @@ files:
 - app/components/view_component_reflex/component.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