view_component_reducible 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a699ce3503948db085a77d5d187e725157966bf53a132e9d9124a772db648f1c
-  data.tar.gz: ba68826392cd3ea83ca6ceea8f8f753d893f013467d61eff20f3085fd40c9e0c
+  metadata.gz: 6b8576a2267bf71dae86a6339162039c3b2effa03bbd25f0eefb1fa378481244
+  data.tar.gz: eb2629af05937f40b4c87731f062f32d2640bb7a78cc0ceff20a4d6d4188c4f3
 SHA512:
-  metadata.gz: 9eca692a8a5b7185869237597cb79d199d4e1e036501f2c9c2574e40ea643e99535202f31fb44198a51e293e2fd5078adefd2e65756bd95fc8732917a688b892
-  data.tar.gz: bfe0b991478a5a8788f2b2f9c69f7705d5ad9bf1de828d76d50c5b652a8d57bb23c18dfe883289bf231c54b77885e311c35485e9d4a7fc37f200b87d113033a8
+  metadata.gz: 554e95d73a13b21d4bf47185b669d63cfec7a5846668de2889b9766efb30d80e872f2739ac33e0c70af99f4673aaf74bc17cf06725c9ea68ea9dfee53d637312
+  data.tar.gz: a507b13dae0abeefa7961ac0dddf5679d22bc90e64eb6a6324481b615aa6ee68e1e81e2b6c1c3ea5383c50175940898e91b7f57fb91d2c8736d23cd20908f4f1

data/lib/view_component_reducible/adapter/base.rb

@@ -4,8 +4,14 @@ module ViewComponentReducible
   module Adapter
     # Base adapter interface for envelope serialization.
     class Base
+      # @return [String]
+      def self.state_param_name
+        'vcr_state'
+      end
+
       # @param secret [String]
-      def initialize(secret:)
+      # @param _kwargs [Hash]
+      def initialize(secret:, **_kwargs)
         @secret = secret
       end
 

data/lib/view_component_reducible/adapter/hidden_field.rb

@@ -23,7 +23,7 @@ module ViewComponentReducible
       # @param request [ActionDispatch::Request]
       # @return [Hash]
       def load(request:)
-        signed = request.params.fetch('vcr_state')
+        signed = request.params.fetch(self.class.state_param_name)
         verifier.verify(signed)
       end
     end

data/lib/view_component_reducible/adapter/redis.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/message_verifier'
+require 'securerandom'
+require 'json'
+
+module ViewComponentReducible
+  module Adapter
+    # Redis adapter storing envelope outside of the session.
+    class Redis < Base
+      DEFAULT_TTL = 900
+      DEFAULT_NAMESPACE = 'vcr'
+
+      def self.state_param_name
+        'vcr_state_key'
+      end
+
+      # @param secret [String]
+      # @param redis [Object, nil]
+      # @param redis_url [String, nil]
+      # @param redis_ttl [Integer, nil]
+      # @param redis_namespace [String, nil]
+      def initialize(secret:, redis: nil, redis_url: nil, redis_ttl: DEFAULT_TTL, redis_namespace: DEFAULT_NAMESPACE)
+        super(secret:)
+        @redis = redis || build_client(redis_url)
+        @redis_ttl = redis_ttl
+        @redis_namespace = redis_namespace
+      end
+
+      # @return [ActiveSupport::MessageVerifier]
+      def verifier
+        @verifier ||= ActiveSupport::MessageVerifier.new(@secret, digest: 'SHA256', serializer: JSON)
+      end
+
+      # @param envelope [Hash]
+      # @param request [ActionDispatch::Request]
+      # @return [String]
+      def dump(envelope, request:)
+        _ = request
+        key = SecureRandom.hex(16)
+        write(key, JSON.generate(envelope))
+        verifier.generate({ 'k' => key })
+      end
+
+      # @param request [ActionDispatch::Request]
+      # @return [Hash]
+      def load(request:)
+        signed = request.params.fetch(self.class.state_param_name)
+        payload = verifier.verify(signed)
+        key = payload.fetch('k')
+        raw = @redis.get(redis_key(key))
+        raise KeyError, "Missing envelope for #{key}" if raw.nil?
+
+        JSON.parse(raw)
+      end
+
+      private
+
+      def build_client(redis_url)
+        require 'redis'
+        return ::Redis.new if redis_url.nil? || redis_url == ''
+
+        ::Redis.new(url: redis_url)
+      rescue LoadError
+        raise LoadError, 'Redis adapter requires the redis gem. Add `gem "redis"` to your bundle.'
+      end
+
+      def write(key, payload)
+        if @redis_ttl
+          @redis.setex(redis_key(key), @redis_ttl, payload)
+        else
+          @redis.set(redis_key(key), payload)
+        end
+      end
+
+      def redis_key(key)
+        "#{@redis_namespace}:#{key}"
+      end
+    end
+  end
+end

data/lib/view_component_reducible/adapter/session.rb

@@ -8,6 +8,10 @@ module ViewComponentReducible
   module Adapter
     # Session adapter storing envelope in server session.
     class Session < Base
+      def self.state_param_name
+        'vcr_state_key'
+      end
+
       # @return [ActiveSupport::MessageVerifier]
       def verifier
         @verifier ||= ActiveSupport::MessageVerifier.new(@secret, digest: 'SHA256', serializer: JSON)
@@ -18,14 +22,17 @@ module ViewComponentReducible
       # @return [String]
       def dump(envelope, request:)
         key = SecureRandom.hex(16)
-        request.session["vcr:#{key}"] = envelope
+        session = request.session
+        session_keys = session.respond_to?(:keys) ? session.keys : session.to_hash.keys
+        session_keys.grep(/\Avcr:/).each { |session_key| session.delete(session_key) }
+        session["vcr:#{key}"] = envelope
         verifier.generate({ 'k' => key })
       end
 
       # @param request [ActionDispatch::Request]
       # @return [Hash]
       def load(request:)
-        signed = request.params.fetch('vcr_state')
+        signed = request.params.fetch(self.class.state_param_name)
         payload = verifier.verify(signed)
         key = payload.fetch('k')
         request.session.fetch("vcr:#{key}")

data/lib/view_component_reducible/configuration.rb

@@ -4,11 +4,15 @@ module ViewComponentReducible
   # Global configuration for adapter and secrets.
   class Configuration
     # @return [Class]
-    attr_accessor :adapter, :secret
+    attr_accessor :adapter, :secret, :redis, :redis_url, :redis_ttl, :redis_namespace
 
     def initialize
       @adapter = Adapter::Session
       @secret = nil
+      @redis = nil
+      @redis_url = nil
+      @redis_ttl = nil
+      @redis_namespace = nil
     end
 
     # Build adapter instance for a controller request.
@@ -19,7 +23,13 @@ module ViewComponentReducible
       resolved_secret = secret || default_secret
       raise 'ViewComponentReducible secret is missing' if resolved_secret.nil?
 
-      (adapter_class || adapter).new(secret: resolved_secret)
+      kwargs = { secret: resolved_secret }
+      kwargs[:redis] = redis if redis
+      kwargs[:redis_url] = redis_url if redis_url
+      kwargs[:redis_ttl] = redis_ttl unless redis_ttl.nil?
+      kwargs[:redis_namespace] = redis_namespace if redis_namespace
+
+      (adapter_class || adapter).new(**kwargs)
     end
 
     private

data/lib/view_component_reducible/helpers.rb

@@ -24,10 +24,11 @@ module ViewComponentReducible
     def vcr_dispatch_form(state:, msg_type:, msg_payload: {}, target_path: nil, url: '/vcr/dispatch', &block)
       payload = msg_payload.is_a?(String) ? msg_payload : JSON.generate(msg_payload)
       resolved_target = target_path || vcr_envelope_path || instance_variable_get(:@vcr_current_path) || 'root'
+      state_param = ViewComponentReducible.config.adapter.state_param_name
 
-      form_tag(url, method: :post, data: { vcr_form: true }) do
+      form_tag(url, method: :post, data: { vcr_form: true, vcr_state_param: state_param }) do
         body = [
-          hidden_field_tag('vcr_state', state),
+          hidden_field_tag(state_param, state),
           hidden_field_tag('vcr_msg_type', msg_type),
           hidden_field_tag('vcr_msg_payload', payload),
           hidden_field_tag('vcr_target_path', resolved_target),
@@ -74,7 +75,8 @@ module ViewComponentReducible
                 if (payload.state) {
                   var boundary = document.querySelector('[data-vcr-path="' + targetPath + '"]');
                   if (boundary) {
-                    boundary.querySelectorAll('input[name="vcr_state"]').forEach(function(input) {
+                    var stateParam = form.dataset.vcrStateParam || "vcr_state";
+                    boundary.querySelectorAll('input[name="' + stateParam + '"]').forEach(function(input) {
                       input.value = payload.state;
                     });
                   }

data/lib/view_component_reducible/msg.rb

@@ -20,17 +20,59 @@ module ViewComponentReducible
       type = params.fetch('vcr_msg_type')
       payload_json = params['vcr_msg_payload']
       payload = payload_json && payload_json != '' ? JSON.parse(payload_json) : {}
-      new(type:, payload:)
+      build(type:, payload:)
     end
 
-    private
+    # Build a Msg with a normalized payload object.
+    # @param type [String, Symbol]
+    # @param payload [Object, nil]
+    # @return [ViewComponentReducible::Msg]
+    def self.build(type:, payload: nil)
+      return new(type:, payload:) if payload.is_a?(Data)
 
-    def normalized_type
+      normalized = normalize_type(type)
+      new(type:, payload: self::Payload.from_hash(normalized, payload))
+    end
+
+    # @param type [String, Symbol]
+    # @return [Symbol]
+    def self.normalize_type(type)
       type.to_s
           .gsub(/([a-z\d])([A-Z])/, '\1_\2')
           .tr('-', '_')
           .downcase
           .to_sym
     end
+
+    private
+
+    def normalized_type
+      self.class.normalize_type(type)
+    end
+  end
+
+  class Msg
+    module Payload
+      Empty = Data.define
+      Value = Data.define(:value)
+
+      def self.from_hash(_type, payload)
+        payload_hash = payload.is_a?(Hash) ? payload.transform_keys(&:to_s) : nil
+
+        return Empty.new if payload.nil? || (payload.respond_to?(:empty?) && payload.empty?)
+        return Value.new(value: payload) unless payload_hash
+
+        build_generic(payload_hash)
+      end
+
+      def self.build_generic(payload_hash)
+        return Empty.new if payload_hash.empty?
+
+        keys = payload_hash.keys.map(&:to_sym)
+        klass = Data.define(*keys)
+        values = keys.to_h { |key| [key, payload_hash[key.to_s]] }
+        klass.new(**values)
+      end
+    end
   end
 end

data/lib/view_component_reducible/runtime.rb

@@ -48,34 +48,53 @@ module ViewComponentReducible
       schema = component_klass.vcr_state_schema
       state = schema.build_data(env['data'])
 
-      new_state = component.reduce(state, msg)
-      env['data'] = normalize_state(new_state, schema)
-      effects = build_effects(component, schema, env['data'], msg)
+      reducer_result = component.reduce(state, msg)
+      reduced_state, reducer_effects = case reducer_result
+                                       in state_only unless reducer_result.is_a?(Array)
+                                         [state_only, []]
+                                       in [state_only]
+                                         [state_only, []]
+                                       in [state_only, *effects]
+                                         [state_only, effects]
+                                       end
+      env['data'] = normalize_state(reduced_state, schema)
+      effects = normalize_effects(reducer_effects) + normalize_effects(build_effects(component, schema, env['data'],
+                                                                                     msg))
 
       run_effects(component_klass, env, effects, controller)
     end
 
     def run_effects(component_klass, env, effects, controller)
-      return env if effects.nil? || effects.empty?
+      effects_queue = normalize_effects(effects).dup
+      return env if effects_queue.empty?
 
-      effects_queue = effects.dup
       steps = 0
 
       while (eff = effects_queue.shift)
         steps += 1
         raise 'Too many effect steps' if steps > MAX_EFFECT_STEPS
 
-        follow_msg = eff.call(controller: controller, envelope: env)
+        follow_msg = resolve_effect_msg(eff, controller, env)
         next unless follow_msg
+        raise ArgumentError, 'Effect must return a Msg' unless follow_msg.is_a?(Msg)
 
         component = component_klass.new(vcr_envelope: env)
         schema = component_klass.vcr_state_schema
         state = schema.build_data(env['data'])
 
-        new_state = component.reduce(state, follow_msg)
-        env['data'] = normalize_state(new_state, schema)
-        new_effects = build_effects(component, schema, env['data'], follow_msg)
-        effects_queue.concat(Array(new_effects))
+        reducer_result = component.reduce(state, follow_msg)
+        reduced_state, reducer_effects = case reducer_result
+                                         in state_only unless reducer_result.is_a?(Array)
+                                           [state_only, []]
+                                         in [state_only]
+                                           [state_only, []]
+                                         in [state_only, *effects]
+                                           [state_only, effects]
+                                         end
+        env['data'] = normalize_state(reduced_state, schema)
+        new_effects = normalize_effects(reducer_effects) + normalize_effects(build_effects(component, schema,
+                                                                                           env['data'], follow_msg))
+        effects_queue.concat(new_effects)
       end
 
       env
@@ -110,6 +129,17 @@ module ViewComponentReducible
       Array(component.effects(state, msg))
     end
 
+    def normalize_effects(effects)
+      Array(effects).compact
+    end
+
+    def resolve_effect_msg(effect, controller, env)
+      return effect if effect.is_a?(Msg)
+      return effect.call(controller: controller, envelope: env) if effect.respond_to?(:call)
+
+      raise ArgumentError, 'Effect must respond to #call or be a Msg'
+    end
+
     def deep_dup(obj)
       Marshal.load(Marshal.dump(obj))
     end

data/lib/view_component_reducible/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ViewComponentReducible
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
 end

data/lib/view_component_reducible.rb

@@ -6,6 +6,7 @@ require_relative 'view_component_reducible/msg'
 require_relative 'view_component_reducible/adapter/base'
 require_relative 'view_component_reducible/adapter/hidden_field'
 require_relative 'view_component_reducible/adapter/session'
+require_relative 'view_component_reducible/adapter/redis'
 require_relative 'view_component_reducible/helpers'
 require_relative 'view_component_reducible/state/schema'
 require_relative 'view_component_reducible/state/dsl'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reducible
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
 - manabeai
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,7 @@ files:
 - lib/view_component_reducible.rb
 - lib/view_component_reducible/adapter/base.rb
 - lib/view_component_reducible/adapter/hidden_field.rb
+- lib/view_component_reducible/adapter/redis.rb
 - lib/view_component_reducible/adapter/session.rb
 - lib/view_component_reducible/component.rb
 - lib/view_component_reducible/configuration.rb