view_component_reflex 2.6.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 707610d40c14c49d025779455b65bc00e5a62f6ac5efb45b67465ddaf877e037
-  data.tar.gz: d968005df1c10fc89d6a596acccaa114a1c7fda23d159f1e49f7a065591c55ce
+  metadata.gz: ec3bf329ad0e7bbc776b52761cadec00a33ab1c78fba847d26271b27e8a30532
+  data.tar.gz: 5b6d10305c220bbd86486d513b97091e88afa87d6b0b91669c95d04cb1539fb2
 SHA512:
-  metadata.gz: 6a852616da1e12e5cc0d54017b738ea97040092a1c9801a8355aca89681846dcc08b6e5e62ab6209d2c48b7328f46e4c42896a20f54cb465af896c05442dc94e
-  data.tar.gz: fd389d8e0706b8f7133d01953b31c06e8d08c88dfa3015bb5f443c57b6e34604bb81de16bea00e2861eb39aadd90d0c36a3a733e247af74b0fa9c7f33b9ee8b4
+  metadata.gz: 44151d570ece600f3151acffd7eb7ff7a382bc26ac36d088683c7de6439d8335643742aeb5a9de337f19646967f913678402d39a2b11baef7506d1af3beb2eef
+  data.tar.gz: 8de0f26c998b8a1061829128d4f5a8175ae11d3a115b2e676af6d6af3a5896150cb32b72df295a53c75d83009dbaaba136bf638dd125e1d69c56dd1a38200702

data/README.md

@@ -207,7 +207,7 @@ 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
@@ -217,7 +217,7 @@ end
 
 
 class MyComponent < ViewComponentReflex::Component
-  reflex_base_class ApplicationReflex
+  MyComponent.reflex_base_class = ApplicationReflex
 end
 ```
 
@@ -359,6 +359,35 @@ end
 
 StimulusReflex 3.4 introduced a fix that merges the current `request.env` and provides the CSRF token to fetch the session.
 
+## Help, my instance variables do not persist into the session
+
+These instance variable names are not working and unsafe:
+
+```rb
+def unsafe_instance_variables
+  [
+    :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
+    :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
+    :@helpers, :@controller, :@request, :@tag_builder, :@initialized_state
+  ]
+end
+```
+Please use a different name to be able to save them to 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,
@@ -151,7 +141,7 @@ module ViewComponentReflex
       adapter = ViewComponentReflex::Engine.state_adapter
 
       # initialize session state
-      if !stimulus_reflex? || adapter.state(request, @key).empty?
+      if (!stimulus_reflex? || adapter.state(request, @key).empty?) && !@initialized_state
 
         new_state = create_safe_state
 
@@ -179,13 +169,14 @@ module ViewComponentReflex
           end
         end
         after_state_initialized(parameters_changed)
-        @initialized_state = true
       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
@@ -203,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/engine.rb

@@ -13,13 +13,16 @@ module ViewComponentReflex
             reflex_name, _ = target.split("#")
             reflex_name = reflex_name.camelize
             component_name = reflex_name.end_with?("Reflex") ? reflex_name[0...-6] : reflex_name
-            if component_name.end_with?("Component")
-              begin
-                component_name.constantize.init_stimulus_reflex
-              rescue
-                p "Tried to initialize view_component_reflex on #{component_name}, but it's not a view_component_reflex"
-              end
+            component = begin
+              component_name.constantize
+            rescue
+              # Since every reflex runs through this monkey patch, we're just going to ignore the ones that aren't for components
+            end
 
+            if component&.respond_to?(:init_stimulus_reflex)
+              component.init_stimulus_reflex
+            else
+              p "Tried to initialize view_component_reflex on #{component_name}, but it's not a view_component_reflex"
             end
             receive_original(data)
           end

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
@@ -41,14 +50,28 @@ module ViewComponentReflex
         end
       end
       document = Nokogiri::HTML(component.render_in(controller.view_context))
-      cable_ready[channel.stream_name].morph(
+      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

@@ -3,8 +3,10 @@ module ViewComponentReflex
   module StateAdapter
     class Memory
       def self.state(request, key)
-        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s] ||= {}
-        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] ||= {}
+        id = extract_id(request)
+
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[id] ||= {}
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[id][key] ||= {}
       end
 
       def self.set_state(request, _, key, new_state)
@@ -14,16 +16,29 @@ module ViewComponentReflex
       end
 
       def self.store_state(request, key, new_state = {})
-        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s] ||= {}
-        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] = {}
+        id = extract_id(request)
+
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[id] ||= {}
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[id][key] = {}
         new_state.each do |k, v|
-          VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key][k] = v
+          VIEW_COMPONENT_REFLEX_MEMORY_STATE[id][key][k] = v
         end
       end
 
       def self.wrap_write_async
         yield
       end
+
+      private
+
+      def self.extract_id(request)
+        session = request&.session
+        if session.respond_to? :id
+          session.id.to_s
+        else
+          nil
+        end
+      end
     end
   end
 end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.6.1'
+  VERSION = '3.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 3.0.3
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-06 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -36,20 +36,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.3.0
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.4'
+        version: 3.4.0
   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'
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -64,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Allow stimulus reflexes in a view component
 email:
 - joshleblanc94@gmail.com