view_component_reflex 0.2.3 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f33f828c6eb7e41485294b552248fc561925c2390144fa990b4c63cf9016633
-  data.tar.gz: 64b879ffa7759e40b2d60c805cda0f578a4210a061bdc3d9ca6ad17e0bf92629
+  metadata.gz: af9ea0fbad8a65f59a333d8367315adb6a13bb52f7d6dcf35fccd8ad71b8de9c
+  data.tar.gz: 29846c963ffb334ac158b2658566cbb3a2cb1248e8e67febd0d0a034af134b54
 SHA512:
-  metadata.gz: d90f9f7e38d3b767b5b0370fd5cea40c3295ee01e8261e6669cfa691d003ec15066da6186ccce2e794ea0d97d8eeec1c6f0405cf5a891d5636edb7ab50ef2732
-  data.tar.gz: c60512a9eaaf8dbb4912f35c38d4d2ca46cf2dbe3a4597be04c5200bb7a22179802d5313e366a37a6b1c56c636310f0f8c890d00f321f453f3bcdd581571c97e
+  metadata.gz: 99478df0b1a5ffa4784aea880b7f757299a706e0ff35a2b6a692bfecbfe64b0cd483b730c115f0574f75f5566fb50770ce2e0d079e646e5ce01113b57adfe780
+  data.tar.gz: d6802a9810a10dbdef2e4f82ddfeb63e766973f1151b6f87799ebfac3513e446aaaf56649c6f31f2bf24a617ece938b539e3b317354189cee1ff99488db70650

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,33 @@ 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!
+            @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
+
+          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 +43,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 +56,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 +64,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.3'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.5.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
@@ -34,16 +34,16 @@ dependencies:
   name: stimulus_reflex
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.pre1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.2.pre1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -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: