view_component_reflex 0.2.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496ca8914c7e26b3cf8d6e8023e3919f554354e81c6b67900290c1872fee518a
-  data.tar.gz: 322663d7019f05aa3065b6cc619c37c0f26e94a1e39bb6a42731fa46e48bc61d
+  metadata.gz: 6604db3319eb30b4cf0ac65502e46c3c1107094290b7ba2c9efda8c16735b250
+  data.tar.gz: d644b0e76cc36cd6f969406569c4f28d32719e574a848bc360db0979398a0dbc
 SHA512:
-  metadata.gz: f4aff8020d47d29c6e1c4a44ff6819178ac5fd6767785009a8d91e87d856b170a452796e636da127a4c91ab7e07de64805826175d28b966d5002f8da0d275d45
-  data.tar.gz: 88f1b3feb877862866846f2d599f846308c5281d7e8feff60de4acbea3300613e4baebf84191cad43cf9ead7a7005efda74af874eea8e34dc15a7aa4887a5811
+  metadata.gz: 3af567ec00951af7ba672cee153b30971f0c9ec679c148447c4e2379687e1af7592d3c23960135a9efd8d1d752bb9f482bcafd83731a88d60f6740175acce586
+  data.tar.gz: a4a16cf03448c3251dd94714a98f269e06c983a7f1351aab7622a65a80a9ef3794c277fbd0cbb4b2ba7de91c16e4de4f4c4eff49dee4afa2f3a605d56980b14c

data/README.md

@@ -19,7 +19,8 @@ using stimulus reflex.
 
 In addition to calling reflexes, there is a rudimentary state system. You can initialize component-local state with `initialize_state(obj)`, where `obj` is a hash.
 
-You can access state with the `state` helper. See the code below for an example.
+You can access state with the `state` helper. See the code below for an example. Calling `set_state` will set the state, 
+and also re-render your component.
 
 If you're using state add `data-key="<%= key %>"` to any html element using a reflex. This 
 lets ViewComponentReflex keep track of which state belongs to which component.
@@ -36,7 +37,7 @@ lets ViewComponentReflex keep track of which state belongs to which component.
       end
     
       reflex :increment do
-        state[:count] = state[:count] + 1
+        set_state(count: state[:count] + 1)
       end
     end
 ```
@@ -49,6 +50,64 @@ 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
+
+  ##
+  # reflex - The reflex instance that's trying to set the state
+  # key - a unique string that identifies the component
+  # new_state - the new state to set
+  def self.set_state(reflex, key, new_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.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,29 @@ 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
+
+          def set_state(new_state)
+            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
+            @channel.render_page_and_broadcast_morph(self, nil, {
+              dataset: element.dataset.to_h,
+              args: [],
+              attrs: element.attributes.to_h,
+              selectors: ['body'],
+              target: "#{self.class.name}##{method_name}",
+              url: request.url,
+              permanentAttributeName: "data-reflex-permanent"
+            })
+          end
+
+          before_reflex do |reflex, *args|
+            instance_exec(*args, &self.class.callbacks[self.method_name.to_sym]) if self.class.callbacks.include?(self.method_name.to_sym)
+            throw :abort
+          end
+
+          def self.callbacks
+            @callbacks ||= {}
           end
 
           define_method :stimulus_controller do
@@ -17,8 +39,8 @@ module ViewComponentReflex
           end
 
           define_singleton_method(:reflex) do |name, &blk|
+            callbacks[name] = blk
             define_method(name) do |*args|
-              instance_exec(*args, &blk)
             end
           end
         })
@@ -30,7 +52,7 @@ module ViewComponentReflex
     end
 
     # key is required if you're using state
-    # We can't initialize the session state in the initiale method
+    # We can't initialize the session state in the initial method
     # because it doesn't have a view_context yet
     # This is the next best place to do it
     def key
@@ -38,16 +60,16 @@ module ViewComponentReflex
 
       # initialize session state
       if session[@key].nil?
-        session[@key] = {}
-        (@state ||= {}).each do |key, v|
-          session[@key][key] = v
-        end
+        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, @state)
+        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", @state)
+      else
+        ViewComponentReflex::Engine.state_adapter.reconcile_state(request, @key, @state)
       end
       @key
     end
 
     def state
-      session[key]
+      ViewComponentReflex::Engine.state_adapter.state(request, key)
     end
   end
 end

data/lib/view_component_reflex.rb

@@ -1,18 +1,7 @@
+require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/engine"
 require 'stimulus_reflex'
 
 module ViewComponentReflex
   # Your code goes here...
 end
-
-module StimulusReflexChannelExtension
-  def render_page_and_broadcast_morph(reflex, selectors, data = {})
-    html = render_page(reflex)
-    if reflex.respond_to? :stimulus_controller
-      selectors = ["[data-controller=\"#{reflex.stimulus_controller}\"]"]
-    end
-    broadcast_morphs selectors, data, html if html.present?
-  end
-end
-
-StimulusReflex::Channel.include StimulusReflexChannelExtension

data/lib/view_component_reflex/engine.rb

@@ -1,4 +1,26 @@
 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 = {})
+          html = render_page(reflex)
+          if reflex.respond_to? :stimulus_controller
+            selectors = ["[data-controller=\"#{reflex.stimulus_controller}\"]"]
+          end
+          broadcast_morphs selectors, data, html if html.present?
+        end
+      end
+
+    end
   end
 end

data/lib/view_component_reflex/state_adapter/session.rb

@@ -0,0 +1,38 @@
+module ViewComponentReflex
+  module StateAdapter
+    class Session
+      def self.state(request, key)
+        request.session[key] ||= {}
+      end
+
+      def self.set_state(reflex, key, new_state)
+        new_state.each do |k, v|
+          state(reflex.request, key)[k] = v
+        end
+        store = reflex.request.session.instance_variable_get("@by")
+        store.commit_session reflex.request, reflex.controller.response
+      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.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-04 00:00:00.000000000 Z
+date: 2020-06-10 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/session.rb
 - lib/view_component_reflex/version.rb
 homepage: https://github.com/joshleblanc/view_component_reflex
 licenses: