view_component_reflex 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbeda9f2f7f4f327afd6da54bcd82ac6871eab33efa07ae1901ccd8d002801d2
-  data.tar.gz: bb5afb39f319dadfcf68272cbee6762286d475c1ce93382e611f722dd6d46baa
+  metadata.gz: e02789888b71896b7005d2e854834926ebc5cb4839c4d3d8eb57a2a7ca9f1c16
+  data.tar.gz: e51ad3e1aabaa02a81751533688bbc29cc3a227aaf26ed77f6ee61465ff2ff5b
 SHA512:
-  metadata.gz: 27d42f4f6a349223d3a0d354b31a0d37dacd51fef18450c254c8353cadb8018bc62dbccefcb99e2a5cff3bf6d61240b6836eebfb8af0974448baf57f2c4a9bc3
-  data.tar.gz: fac906b5ad974f51b0023f04a58ba9164d38348b181a6f22e6193664d77c93ef5dd53da31abe4a94cf9f39d6ecffdd5fbf2654831f07de810c712751237c3204
+  metadata.gz: ccd9589f0c94f331d0e361c255803cf4d37ad2372e77e7752db1ba509ee528d87c08a1e2a43c45e80212674857e7176a0a7bde103bce1b0c5ce9c5cbba4c3ff0
+  data.tar.gz: 5407c04db562748c569aac3ab7901a978e2fbfff1b7beab69c5cf6eb9b4baa7927092c3d6fddbced17b25b32263effd5bdd1b4ce6fdf3389f44c275a3081b3a2

data/README.md

@@ -49,6 +49,56 @@ lets ViewComponentReflex keep track of which state belongs to which component.
 </div>
 ```
 
+## Custom State Adapters
+
+ViewComponentReflex uses session for its state by default. To change this, add
+an initializer to `config/initializers/view_component_reflex.rb`.
+
+```ruby
+ViewComponentReflex.configure do |config|
+  config.state_adapter = YourAdapter
+end
+```
+
+`YourAdapter` should implement 
+
+```ruby
+class YourAdapter
+  ##
+  # request - a rails request object
+  # key - a unique string that identifies the component instance
+  def self.state(request, key)
+    # Return state for a given key
+  end
+
+  ##
+  # request - a rails request object
+  # key - a unique string that identifies the component instance
+  # new_state - a hash containing the component state
+  def self.store_state(request, key, new_state = {})
+    # store the state 
+    # this will be called twice, once with key, once with key_initial
+    # key_initial contains the initial, unmodified state.
+    # it should be used in reconcile_state to decide whether or not
+    # to re-initialize the state
+  end
+  
+  ##
+  # request - a rails request object
+  # key - a unique string that identifies the component instance
+  # new_state - a hash containing the component state
+  def self.reconcile_state(request, key, new_state)
+  # The passed state should always match the initial state of the component
+  # if it doesn't, we need to reset the state to the passed value.
+  #
+  # This handles cases where your initialize_state param computes some value that changes
+  # initialize_state({ transaction: @customer.transactions.first })
+  # if you delete the first transaction, that ^ is no longer valid. We need to update the state.
+  end
+end
+```
+
+
 ## Installation
 Add this line to your application's Gemfile:
 

data/app/components/view_component_reflex/component.rb

@@ -9,7 +9,7 @@ module ViewComponentReflex
         klass = self
         @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(StimulusReflex::Reflex) {
           def state
-            session[element.dataset[:key]] ||= {}
+            ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
           end
 
           define_method :stimulus_controller do
@@ -38,39 +38,16 @@ module ViewComponentReflex
 
       # initialize session state
       if session[@key].nil?
-        store_state(@key)
-        store_state("#{@key}_initial")
+        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, @state)
+        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", @state)
       else
-        reconcile_state
+        ViewComponentReflex::Engine.state_adapter.reconcile_state(request, @key, @state)
       end
       @key
     end
 
     def state
-      session[key]
-    end
-
-    private
-
-    # The passed state should always match the initial state of the component
-    # if it doesn't, we need to reset the state to the passed value.
-    #
-    # This handles cases where your initialize_state param computes some value that changes
-    # initialize_state({ transaction: @customer.transactions.first })
-    # if you delete the first transaction, that ^ is no longer valid. We need to update the state.
-    def reconcile_state
-      session["#{@key}_initial"].each do |k, v|
-        if @state[k] != v
-          session[@key][k] = @state[k]
-        end
-      end
-    end
-
-    def store_state(a_key)
-      session[a_key] = {}
-      (@state ||= {}).each do |key, v|
-        session[a_key][key] = v
-      end
+      ViewComponentReflex::Engine.state_adapter.state(request, key)
     end
   end
 end

data/lib/view_component_reflex.rb

@@ -1,3 +1,4 @@
+require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/engine"
 require 'stimulus_reflex'
 

data/lib/view_component_reflex/engine.rb

@@ -1,5 +1,15 @@
 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
+
     config.to_prepare do
       class StimulusReflex::Channel < ActionCable::Channel::Base
         def render_page_and_broadcast_morph(reflex, selectors, data = {})

data/lib/view_component_reflex/state_adapter/session.rb

@@ -0,0 +1,30 @@
+module ViewComponentReflex
+  module StateAdapter
+    class Session
+      def self.state(request, key)
+        request.session[key] ||= {}
+      end
+
+      def self.store_state(request, key, new_state = {})
+        request.session[key] = {}
+        new_state.each do |k, v|
+          request.session[key][k] = v
+        end
+      end
+
+      # The passed state should always match the initial state of the component
+      # if it doesn't, we need to reset the state to the passed value.
+      #
+      # This handles cases where your initialize_state param computes some value that changes
+      # initialize_state({ transaction: @customer.transactions.first })
+      # if you delete the first transaction, that ^ is no longer valid. We need to update the state.
+      def self.reconcile_state(request, key, new_state)
+        request.session["#{key}_initial"].each do |k, v|
+          if new_state[k] != v
+            request.session[key][k] = new_state[k]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '0.2.5'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua LeBlanc
@@ -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/session.rb
 - lib/view_component_reflex/version.rb
 homepage: https://github.com/joshleblanc/view_component_reflex
 licenses: