view_component_reflex 2.3.12 → 2.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd84d332d4e687111e200c5ce5ee21714aff7b96e3911527b2a6b0fe1957fa4c
-  data.tar.gz: 3402b8dd84bf2b1dd4e3d11053916aaa62c0e583f3605a0c2a89c321668673ef
+  metadata.gz: 707610d40c14c49d025779455b65bc00e5a62f6ac5efb45b67465ddaf877e037
+  data.tar.gz: d968005df1c10fc89d6a596acccaa114a1c7fda23d159f1e49f7a065591c55ce
 SHA512:
-  metadata.gz: 515a31e4d242bdd381e537d5b4dac20322a8318895cba609ef39cba068940a3b3e931b5862cf6404364794bea1bfbf0ed6ad6ce71cef9f9032bc7ddf7fc2499a
-  data.tar.gz: cd1040ec6bac0ee57ef3050c2cd1d0cfaa79daa21cbe141efec01ca97f5bdcba6553cb384a752294ba7149e299eb3e2a5631a4ccf2204557d7c3a2eecca41b28
+  metadata.gz: 6a852616da1e12e5cc0d54017b738ea97040092a1c9801a8355aca89681846dcc08b6e5e62ab6209d2c48b7328f46e4c42896a20f54cb465af896c05442dc94e
+  data.tar.gz: fd389d8e0706b8f7133d01953b31c06e8d08c88dfa3015bb5f443c57b6e34604bb81de16bea00e2861eb39aadd90d0c36a3a733e247af74b0fa9c7f33b9ee8b4

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,6 +193,19 @@ 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.
 The parent class must inherit ViewComponentReflex::Reflex, and will throw an error if it does not.
@@ -245,8 +258,8 @@ end
 
 ## State
 
-By default, view_component_reflex stores component state in memory. You can optionally set the state adapter
-to use the session by changing `config.state_adapter` to `ViewComponentReflex::StateAdapter::Session`
+By default (since version `2.3.2`), view_component_reflex stores component state in session. You can optionally set the state adapter
+to use the memory by changing `config.state_adapter` to `ViewComponentReflex::StateAdapter::Memory`.
 
 ## Custom State Adapters
 
@@ -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,17 @@ $ 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.
+
 ## 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

@@ -139,33 +139,46 @@ 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?
 
         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
+        after_state_initialized(parameters_changed)
         @initialized_state = true
       end
       @key

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

@@ -40,7 +40,7 @@ module ViewComponentReflex
           element.dataset[:key]
         end
       end
-      document = Nokogiri::HTML(controller.render_component_to_string(component))
+      document = Nokogiri::HTML(component.render_in(controller.view_context))
       cable_ready[channel.stream_name].morph(
         selector: selector,
         children_only: true,
@@ -119,7 +119,7 @@ module ViewComponentReflex
       return @component if @component
       @component = component_class.allocate
       reflex = self
-      exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector, :stimulate]
+      exposed_methods = [:params, :request, :connection, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!, :selector, :stimulate]
       exposed_methods.each do |meth|
         @component.define_singleton_method(meth) do |*a|
           reflex.send(meth, *a)

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.12'
+  VERSION = '2.6.1'
 end

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.3.12
+  version: 2.6.1
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: stimulus_reflex
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +80,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