view_component_reflex 2.3.10 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dad0cc0f7e6d5012a4ccc2d4bce92eb1d50f2d8c47bb803fabcbd7abb9fa28e
-  data.tar.gz: f448c90389a5c07addca133a0a046ca142b32db08e9e19b17d428dcf08d3b2db
+  metadata.gz: 48be01529611392c673d2ca154ba25657bde6564cfb9238c78debea251f3aa11
+  data.tar.gz: 41d40953951fbd6d26fa4044ad41e1ca6b5b2a969439404d78f755853ea1acca
 SHA512:
-  metadata.gz: 0ce1685cc918835c629aaca35d30e0b3492fa27776126bfe4a01d8e65d711c9fd6617d816ed62c7abd5d718e87c33e8da25aaed64b8511050bdd11c4d3bbfece
-  data.tar.gz: a4369503902bc85b1fd9105f678d0a27f6199aeec232d386126179fd064e0796605d3eab0b4932bbec81b002fb025fa065ad6863275aceadb66536ad964d9355
+  metadata.gz: a6b645acacb1f3716b05cf134225255096aa80ef47a131949d79f0cbfec69a9623c6f26d061d381f6637ff26501eeaeabdfe17c52e7cb2be027eda0e5eba91ec
+  data.tar.gz: 9d714a2889b6d4f100cd816f6068699e86966807bf529353b9ab2699738d649a5169116926e75fd5690a2cbb7a0583574cf164b52518b4cff29e86745a38d803

data/README.md

@@ -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

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/reflex.rb

@@ -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.10'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,35 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.3.10
+  version: 2.6.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-07 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.1
+        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: 6.0.3
     - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.3.1
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: stimulus_reflex
   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