view_component_reflex 0.2.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbeda9f2f7f4f327afd6da54bcd82ac6871eab33efa07ae1901ccd8d002801d2
-  data.tar.gz: bb5afb39f319dadfcf68272cbee6762286d475c1ce93382e611f722dd6d46baa
+  metadata.gz: f8bf2b7cc30e75bc01877f62705927b40e5f16fb7f763e065f33c857f8a6e9f2
+  data.tar.gz: 5af71af978af81acc1eef07609937e763ead6d9bbfd89dc613017342b1ffa17d
 SHA512:
-  metadata.gz: 27d42f4f6a349223d3a0d354b31a0d37dacd51fef18450c254c8353cadb8018bc62dbccefcb99e2a5cff3bf6d61240b6836eebfb8af0974448baf57f2c4a9bc3
-  data.tar.gz: fac906b5ad974f51b0023f04a58ba9164d38348b181a6f22e6193664d77c93ef5dd53da31abe4a94cf9f39d6ecffdd5fbf2654831f07de810c712751237c3204
+  metadata.gz: 7362f2ea46bf50b44f14b186ec95375a42e2a3a582e97876ab4f468eb6a13ebf755d20472a684ff8023b6cee8063ba48409d497596b95c4c435fc584c57216d9
+  data.tar.gz: 99be6f450fefb1bd19c5421f883b689b677d8ea6317fc140e7b01ecef9d6fcd177675509c956434506abb81c65845dc66427f1d65a577b7f0bb56a80fa67095d

data/README.md

@@ -11,15 +11,19 @@ To add a reflex to your component, use the `reflex` method.
 ```ruby
     reflex :my_cool_reflex do
       # do stuff
+      refresh!
     end
 ```
 
 This will act as if you created a reflex with the method `my_cool_stuff`. To call this reflex, add `data-reflex="click->MyComponentReflex#my_cool_reflex"`, just like you're
 using stimulus reflex.
 
+#####note: A reflex will not automatically re-render the component upon its completion. A component will re-render whenever the `set_state` or `refresh!` method is called.
+
 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 +40,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 +53,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,37 @@ 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 refresh!(selectors = ["[data-controller=\"#{stimulus_controller}\"]"])
+            @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,
+              permanentAttributeName: "data-reflex-permanent"
+            }
+          end
+
+          def refresh_all!
+            refresh!(['body'])
+          end
+
+          def set_state(new_state = {})
+            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
+            refresh!
+          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 +47,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
         })
@@ -29,6 +59,10 @@ module ViewComponentReflex
       @state = obj
     end
 
+    def stimulus_reflex?
+      helpers.controller.instance_variable_get(:@stimulus_reflex)
+    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
@@ -37,40 +71,17 @@ module ViewComponentReflex
       @key ||= caller.find { |p| p.include? ".html.erb" }&.hash.to_s
 
       # initialize session state
-      if session[@key].nil?
-        store_state(@key)
-        store_state("#{@key}_initial")
+      if !stimulus_reflex? || session[@key].nil?
+        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,16 +1,13 @@
 module ViewComponentReflex
   class Engine < ::Rails::Engine
-    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
+    class << self
+      mattr_accessor :state_adapter
 
+      self.state_adapter = StateAdapter::Session
+    end
+
+    def self.configure
+      yield self if block_given?
     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.5'
+  VERSION = '0.6.0'
 end

metadata

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