view_component_reflex 2.3.14 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ad19988c11a33e1cc66d09f768f2d74218db3c04e16c8625c4624ce5a223c9f
-  data.tar.gz: b994c4d403c7d24be9152f543f9b5e257f11405e8fd6d671921e28f3aaa61d2f
+  metadata.gz: 047aa78feb4675abeb3bb5a5ed86ea4071c6a22fef3e06fb2806b04d651898cd
+  data.tar.gz: 5c0cc3c3c6fca877e8b2d8a595c601ddea90b892a62367af6abed6099a6b1b81
 SHA512:
-  metadata.gz: b4bd5cf4fd21a5dad48247bc6bdc4cd3d149ae67851298a4ed43d747f80ebeb3447589711e16648b8d00fa823e43d18a378caea4d658d35673ac84bebb6a6050
-  data.tar.gz: 1d5c9965e17767d5c44f6f6b8034569232179008780a0a3f870bf848c81572c70ec747f6acc50579da86a9c16f80eba2d22cfb01037462626cc93d8f04fc5770
+  metadata.gz: 0f3f2e6f15c43e47aa3cdcd39632f4e2d7d76dd7065dcfd38b718db0e34ac100fed7268371660994c402a9c0aacd07635a935f088cec49cebbbcbccae6533aea
+  data.tar.gz: 56fa191797a8d3f757457a7a8c94f4394304ca0dd201639c0d47225a7f7be7ceb9b349641805783538325e884431e483a5b51714c4f75f26826912c953474d7c

data/README.md

@@ -6,7 +6,7 @@ It builds upon [stimulus_reflex](https://github.com/hopsoft/stimulus_reflex) and
 
 ## Usage
 
-You can add reflexes to your component by adding inheriting from `ViewComponentReflex::Component`.
+You can add reflexes to your component by inheriting from `ViewComponentReflex::Component`.
 
 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.
@@ -124,7 +124,7 @@ def initialize
 end
 
 def collection_key
- @my_model.id
+  @my_model.id
 end
 ```
 
@@ -161,7 +161,7 @@ By default, VCR will re-render your component after it executes your method. `pr
 ```ruby
 def my_method
   prevent_refresh!
-  @foo = Lbar
+  @foo = :bar
 end # the rendered page will not reflect this change
 ```
 
@@ -193,8 +193,21 @@ You *must* wrap your component in this for everything to work properly.
 <% end %>
 ```
 
+### after_state_initialized(parameters_changed)
+
+This is called after the state has been inserted in the component. You can use this to run conditional functions after 
+some parameter has superseeded whatever's in state
+
+```
+def after_state_initialized(parameters_changed)
+  if parameters_changed.include?(:@filter)
+    calculate_visible_rows
+  end
+end
+```
+
 ## Custom reflex base class
-Reflexes typically inherit from a base ApplicationReflex. You can define the base class for a view_component_reflex by using the `reflex_base_class` method.
+Reflexes typically inherit from a base ApplicationReflex. You can define the base class for a view_component_reflex by using the `reflex_base_class` accessor.
 The parent class must inherit ViewComponentReflex::Reflex, and will throw an error if it does not.
 
 ```ruby
@@ -204,7 +217,7 @@ end
 
 
 class MyComponent < ViewComponentReflex::Component
-  reflex_base_class ApplicationReflex
+  MyComponent.reflex_base_class = ApplicationReflex
 end
 ```
 
@@ -259,6 +272,22 @@ ViewComponentReflex::Engine.configure do |config|
 end
 ```
 
+
+## Existing Fast Redis based State Adapter
+
+This adapter uses hmset and hgetall to reduce the number of operations. 
+This is the recommended adapter if you are using AnyCable.
+
+```ruby
+ViewComponentReflex::Engine.configure do |config|
+  config.state_adapter = ViewComponentReflex::StateAdapter::Redis.new(
+      redis_opts: {
+          url: "redis://localhost:6379/1", driver: :hiredis
+      },
+      ttl: 3600)
+end
+```
+
 `YourAdapter` should implement 
 
 ```ruby
@@ -319,6 +348,31 @@ $ gem install view_component_reflex
 ## Uninitialized constants \<component\>Reflex
 A component needs to be wrapped in `<%= component_controller do %>` in order to properly initialize, otherwise the Reflex class won't get created.
 
+## Session is an empty hash
+StimulusReflex 3.3 introduced _selector morphs_, allowing you to render arbitrary strings via `ApplicationController.render`, for example:
+
+```rb
+def test_selector
+  morph '#some-container', ApplicationController.render(MyComponent.new(some: :param))
+end
+```
+
+StimulusReflex 3.4 introduced a fix that merges the current `request.env` and provides the CSRF token to fetch the session.
+
+## Anycable
+
+@sebyx07 provided a solution to use anycable (https://github.com/joshleblanc/view_component_reflex/issues/23#issue-721786338)
+
+Leaving this, might help others:
+
+I tried this with any cable and I had to add this to development.rb
+Otherwise @instance_variables were nil after a reflex
+
+```ruby
+  config.cache_store = :redis_cache_store, { url: "redis://localhost:6379/1", driver: :hiredis }
+  config.session_store :cache_store
+```
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 

data/app/components/view_component_reflex/component.rb

@@ -1,5 +1,7 @@
 module ViewComponentReflex
   class Component < ViewComponent::Base
+    class_attribute :reflex_base_class, default: ViewComponentReflex::Reflex
+
     class << self
       def init_stimulus_reflex
         factory = ViewComponentReflex::ReflexFactory.new(self)
@@ -7,18 +9,6 @@ module ViewComponentReflex
         wire_up_callbacks if factory.new?
       end
 
-      def reflex_base_class(new_base_class = nil)
-        if new_base_class.nil?
-          @reflex_base_class ||= ViewComponentReflex::Reflex
-        else
-          if new_base_class <= ViewComponentReflex::Reflex
-            @reflex_base_class = new_base_class
-          else
-            raise StandardError.new("The reflex base class must inherit from ViewComponentReflex::Reflex")
-          end
-        end
-      end
-
       def queue_callback(key, args, blk)
         callbacks(key).push({
           args: args,
@@ -139,40 +129,54 @@ module ViewComponentReflex
       []
     end
 
+    def after_state_initialized(parameters_changed)
+      # called after state component has been hydrated
+    end
+
     # def receive_params(old_state, params)
     #   # no op
     # end
 
     def key
+      adapter = ViewComponentReflex::Engine.state_adapter
+
       # initialize session state
-      if !stimulus_reflex? || ViewComponentReflex::Engine.state_adapter.state(request, @key).empty?
+      if (!stimulus_reflex? || adapter.state(request, @key).empty?) && !@initialized_state
 
         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)
+        adapter.wrap_write_async do
+          adapter.store_state(request, @key, new_state)
+          adapter.store_state(request, "#{@key}_initial", new_state)
+        end
       elsif !@initialized_state
-        initial_state = ViewComponentReflex::Engine.state_adapter.state(request, "#{@key}_initial")
+        initial_state = adapter.state(request, "#{@key}_initial")
 
         # incoming_params = safe_instance_variables.each_with_object({}) { |var, obj| obj[var] = instance_variable_get(var) }
         # receive_params(ViewComponentReflex::Engine.state_adapter.state(request, @key), incoming_params)
 
-        ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
+        parameters_changed = []
+        adapter.state(request, @key).each do |k, v|
           instance_value = instance_variable_get(k)
           if permit_parameter?(initial_state[k], instance_value)
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, {k => instance_value})
+            parameters_changed << k
+            adapter.wrap_write_async do
+              adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
+              adapter.set_state(request, controller, @key, {k => instance_value})
+            end
           else
             instance_variable_set(k, v)
           end
         end
-        @initialized_state = true
+        after_state_initialized(parameters_changed)
       end
+
+      @initialized_state = true
       @key
     end
 
     def safe_instance_variables
-      instance_variables - unsafe_instance_variables
+      instance_variables - unsafe_instance_variables - omitted_from_state
     end
 
     private
@@ -190,7 +194,7 @@ module ViewComponentReflex
 
       # this will almost certainly break
       safe_instance_variables.each do |k|
-        new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(k)
+        new_state[k] = instance_variable_get(k)
       end
       new_state
     end

data/lib/view_component_reflex.rb

@@ -2,6 +2,7 @@ require "stimulus_reflex"
 require 'view_component_reflex/reflex_factory'
 require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/state_adapter/memory"
+require "view_component_reflex/state_adapter/redis"
 require "view_component_reflex/reflex"
 require "view_component_reflex/engine"
 

data/lib/view_component_reflex/engine.rb

@@ -1,10 +1,8 @@
 module ViewComponentReflex
   class Engine < ::Rails::Engine
-    class << self
-      mattr_accessor :state_adapter
 
-      self.state_adapter = StateAdapter::Session
-    end
+    mattr_accessor :state_adapter
+    Engine.state_adapter = StateAdapter::Session
 
     config.to_prepare do
       StimulusReflex::Channel.class_eval do

data/lib/view_component_reflex/reflex.rb

@@ -1,6 +1,5 @@
 module ViewComponentReflex
   class Reflex < StimulusReflex::Reflex
-    include CableReady::Broadcaster
 
     class << self
       attr_accessor :component_class
@@ -15,16 +14,26 @@ module ViewComponentReflex
       if primary_selector
         prevent_refresh!
 
-        controller.process(url_params[:action])
+        controller.process(params[:action])
         document = Nokogiri::HTML(controller.response.body)
         [primary_selector, *rest].each do |s|
           html = document.css(s)
           if html.present?
-            cable_ready[channel.stream_name].morph(
+            CableReady::Channels.instance[stream_name].morph(
               selector: s,
               html: html.inner_html,
               children_only: true,
-              permanent_attribute_name: "data-reflex-permanent"
+              permanent_attribute_name: "data-reflex-permanent",
+              stimulus_reflex: {
+                  reflex_id: reflex_id,
+                  xpath: xpath,
+                  c_xpath: c_xpath,
+                  target: target,
+                  reflex_controller: reflex_controller,
+                  url: url,
+                  morph: :page,
+                  attrs: {key: element.dataset[:key]}
+              }
             )
           end
         end
@@ -40,15 +49,29 @@ module ViewComponentReflex
           element.dataset[:key]
         end
       end
-      document = Nokogiri::HTML(controller.render_component_to_string(component))
-      cable_ready[channel.stream_name].morph(
+      document = Nokogiri::HTML(component.render_in(controller.view_context))
+      CableReady::Channels.instance[stream_name].morph(
         selector: selector,
         children_only: true,
         html: document.css(selector).inner_html,
-        permanent_attribute_name: "data-reflex-permanent"
+        permanent_attribute_name: "data-reflex-permanent",
+        stimulus_reflex: {
+            reflex_id: reflex_id,
+            xpath: xpath,
+            target: target,
+            c_xpath: c_xpath,
+            reflex_controller: reflex_controller,
+            url: url,
+            morph: :page,
+            attrs: {key: element.dataset[:key]}
+        }
       )
     end
 
+    def target
+      "#{component_class}##{method_name}"
+    end
+
     def refresh_all!
       refresh!("body")
     end

data/lib/view_component_reflex/reflex_factory.rb

@@ -35,11 +35,17 @@ module ViewComponentReflex
     end
 
     def reflex_from_nested_component
-      if @component.module_parent.const_defined?(reflex_name)
-        @component.module_parent.const_get(reflex_name)
+      parent = if @component.respond_to? :module_parent
+        @component.module_parent
+      else
+        @component.parent
+      end
+
+      if parent.const_defined?(reflex_name)
+        parent.const_get(reflex_name)
       else
         @new = true
-        @component.module_parent.const_set(reflex_name, reflex_instance)
+        parent.const_set(reflex_name, reflex_instance)
       end
     end
 

data/lib/view_component_reflex/state_adapter/memory.rb

@@ -20,6 +20,10 @@ module ViewComponentReflex
           VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key][k] = v
         end
       end
+
+      def self.wrap_write_async
+        yield
+      end
     end
   end
 end

data/lib/view_component_reflex/state_adapter/redis.rb

@@ -0,0 +1,74 @@
+# A redis based adapter for component_reflex
+#
+# ViewComponentReflex::Engine.configure do |config|
+#   config.state_adapter = ViewComponentReflex::StateAdapter::Redis.new(
+#       redis_opts: {
+#           url: "redis://localhost:6379/1", driver: :hiredis
+#       },
+#       ttl: 3600)
+# end
+
+module ViewComponentReflex
+  module StateAdapter
+    class Redis
+      attr_reader :client, :ttl
+
+      def initialize(redis_opts:, ttl: 3600)
+        @client = ::Redis.new(redis_opts)
+        @ttl = ttl
+      end
+
+      def state(request, key)
+        cache_key = get_key(request, key)
+        value = client.hgetall(cache_key)
+
+        return {} if value.nil?
+
+        value.map do |k, v|
+          [k, Marshal.load(v)]
+        end.to_h
+      end
+
+      def set_state(request, _, key, new_state)
+        cache_key = get_key(request, key)
+        save_to_redis(cache_key, new_state)
+      end
+
+      def store_state(request, key, new_state = {})
+        cache_key = get_key(request, key)
+        optimized_store_to_redis(cache_key, new_state, request)
+      end
+
+      def wrap_write_async
+        client.pipelined do
+          yield
+        end
+      end
+
+      private
+
+      # Reduce number of calls coming from #store_state to save Redis
+      # when it's first rendered
+      def optimized_store_to_redis(cache_key, new_state, request)
+        request.env["CACHE_REDIS_REFLEX"] ||= []
+        return if request.env["CACHE_REDIS_REFLEX"].include?(cache_key)
+        request.env["CACHE_REDIS_REFLEX"].push(cache_key)
+
+        save_to_redis(cache_key, new_state)
+      end
+
+      def save_to_redis(cache_key, new_state)
+        new_state_json = new_state.map do |k, v|
+          [k, Marshal.dump(v)]
+        end
+
+        client.hmset(cache_key, new_state_json.flatten)
+        client.expire(cache_key, ttl)
+      end
+
+      def get_key(request, key)
+        "#{request.session.id.to_s}_#{key}_session_reflex_redis"
+      end
+    end
+  end
+end

data/lib/view_component_reflex/state_adapter/session.rb

@@ -19,6 +19,10 @@ module ViewComponentReflex
           request.session[key][k] = v
         end
       end
+
+      def self.wrap_write_async
+        yield
+      end
     end
   end
 end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.3.14'
+  VERSION = '3.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.3.14
+  version: 3.0.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2020-12-06 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.3.0
+        version: 3.4.0.pre8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0.pre8
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ files:
 - lib/view_component_reflex/reflex.rb
 - lib/view_component_reflex/reflex_factory.rb
 - lib/view_component_reflex/state_adapter/memory.rb
+- lib/view_component_reflex/state_adapter/redis.rb
 - lib/view_component_reflex/state_adapter/session.rb
 - lib/view_component_reflex/version.rb
 homepage: https://github.com/joshleblanc/view_component_reflex