view_component_reflex 1.5.0 → 1.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aed815b44b0d4708ba9bb85e9a08912f15f4d66442432df5d0933866f66e3aba
-  data.tar.gz: 96262b95434700007b142be8411d115dc50cdd0d5b94baf5200b582317ce858b
+  metadata.gz: 7e5577d7e345a14f59567739802588506a300b2caa96bba74bd4f12a93752a04
+  data.tar.gz: be4d877d89d50555bde7f1ba929ef4fd5b1e60c72f2e7e921e33e2623574bfa7
 SHA512:
-  metadata.gz: 8cdd11ece267f4cc206af3e12d3e62b4881fdde56afb28a23b078437448842eb54e7aa1da43a68dd4f071544bb360e95c15db2b4ea4599da9ee7e57e7887a2d8
-  data.tar.gz: 64c8053422748319fd6460881170c3b5a9b84da0577180ebbf8a3dd3e62e5b1563c5d9e17c617de798141466f85894b42b281377aa553ff9a3840d9c522564d8
+  metadata.gz: 60530d55c39126bd6be3d5be688f08cbe4e84e0b16e444334e438d99ec1a6b05a1f08c102407bea04b9c73ca5ace4bbb4ec013529810bc5363c6bd09e4224d70
+  data.tar.gz: ceebff13ff2407be15ad1d3e851f78130a7bec2d00cdd260bd3ed78d32ebfce596f1763d6608b822d628f0ce91b164a53c47ee2296755733ddac01888ae1bf8c

data/README.md

@@ -30,7 +30,7 @@ end
 # counter_component.html.erb
 <%= component_controller do %>
     <p><%= @count %></p>
-    <button type="button" data-reflex="click->CounterComponentReflex#increment" data-key="<%= key %>">Click</button>
+    <%= reflex_tag :increment, :button, "Click" %>
 <% end %>
 ```
 
@@ -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

@@ -85,7 +85,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,15 +102,23 @@ module ViewComponentReflex
       helpers.controller.instance_variable_get(:@stimulus_reflex)
     end
 
-    def component_controller(opts = {}, &blk)
+    def component_controller(opts_or_tag = :div, opts = {}, &blk)
       self.class.init_stimulus_reflex
       init_key
-      opts[:data] = {
+
+      tag = :div
+      if opts_or_tag.is_a? Hash
+        options = opts_or_tag
+      else
+        tag = opts_or_tag
+        options = opts
+      end
+      options[:data] = {
         controller: self.class.stimulus_controller,
         key: key,
-        **(opts[:data] || {})
+        **(options[:data] || {})
       }
-      content_tag :div, capture(&blk), opts
+      content_tag tag, capture(&blk), options
     end
 
     # key is required if you're using state
@@ -125,8 +133,8 @@ module ViewComponentReflex
       @key = key
     end
 
-    def reflex_tag(reflex, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
-      action, method = reflex.split("->")
+    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
         action = "click"
@@ -157,18 +165,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
@@ -182,8 +182,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.5.0'
-end
+module ViewComponentReflex
+  VERSION = '1.7.2'
+end

metadata

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