view_component_reflex 2.6.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48be01529611392c673d2ca154ba25657bde6564cfb9238c78debea251f3aa11
-  data.tar.gz: 41d40953951fbd6d26fa4044ad41e1ca6b5b2a969439404d78f755853ea1acca
+  metadata.gz: 9df2379bc1c256d8d3b703c542693300fd82af260540d819174e1ac77b98a42e
+  data.tar.gz: 3918c1cbe4ef273c94583d65373a8a574971607e825769040a410282aed3558f
 SHA512:
-  metadata.gz: a6b645acacb1f3716b05cf134225255096aa80ef47a131949d79f0cbfec69a9623c6f26d061d381f6637ff26501eeaeabdfe17c52e7cb2be027eda0e5eba91ec
-  data.tar.gz: 9d714a2889b6d4f100cd816f6068699e86966807bf529353b9ab2699738d649a5169116926e75fd5690a2cbb7a0583574cf164b52518b4cff29e86745a38d803
+  metadata.gz: c1c741bf5d6005a7cc8b9c48bf428b2920234872a7c5b2b186052c579f33448a5366f95d596e93e82e314d39dfe44086ae654d1aacb000ad764aabb5fc870a20
+  data.tar.gz: 189253b1a19210ab6dfc550408300169bdd43b6ce42b69165286af86ee1bf1bff278c9bc65c97ee5d8513af946f68bcae10bd1ba67ea5f4bf0785e8d5db456c3

data/MIT-LICENSE

@@ -1,20 +1,20 @@
-Copyright 2020 Joshua LeBlanc
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2020 Joshua LeBlanc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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
 ```
 
@@ -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
 ```
 
@@ -348,6 +348,46 @@ $ 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.
+
+## 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/Rakefile

@@ -1,32 +1,32 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'ViewComponentReflex'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
-load 'rails/tasks/engine.rake'
-
-load 'rails/tasks/statistics.rake'
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ViewComponentReflex'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

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

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

@@ -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.0'
+  VERSION = '3.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Joshua LeBlanc
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-17 00:00:00.000000000 Z
+date: 2020-12-18 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.pre9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.3.0
+        version: 3.4.0.pre9
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -58,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
@@ -82,7 +96,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +111,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Allow stimulus reflexes in a view component
 test_files: []