view_component_reflex 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b4bb28b771603fa4e792b0047b4553bd3fabc4f6bc57684b2ea78fc580ae645
-  data.tar.gz: ace4315c83201693a8217aa3eab37d8e56aebb9e26a188e87c17879eccc98a5f
+  metadata.gz: f83ad05fefd096a38658392650961db6eddc0bcd23597eb3b99dac0172461f8d
+  data.tar.gz: dfa368d0bd5ff81f66c42b03f81ea084302c1d150e82fccef5e74006ecaf967c
 SHA512:
-  metadata.gz: efa9e440ddafb686295047c3a613a22d9e50f2b4d493105ba9856e72bca2fea2a711bcea1ccf0d66c32e95b19f0f8a526f029f72470b1791730dc05eb0ed7beb
-  data.tar.gz: 2c50c353ace6c579fe5c9a807605bcb85de103342547b407917592df41c819385567f5e533582f4ccaaeb9c7056ed30cc42d2a26df489e7c132ec5c846c58cc6
+  metadata.gz: 1530f410f27aefa0ecf788dbac750f3772f86132e92a7cae5ca21846e0ded0e8e3cbf52b1c8aad3d3fbb8aee751da77998e6b67696be4dcc88cb96bd7dbbab48
+  data.tar.gz: ef01d4cfd26a466f0b009aca9f16ca91866c9d82a0076015b239fcf32b5132054ea6a557484cba9677d17adf43137ceed42b95cad7f60f728a45badbb632c5d3

data/README.md

@@ -309,8 +309,11 @@ end
 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`.
 
-Optionally, you can also store state right in the dom with `ViewComponentReflex::StateAdapter::Dom`. Not that the DOM
-adapter requires the `data-reflex-dataset="*"` property to be set on anything firing the reflex. 
+Optionally, you can also store state right in the dom with `ViewComponentReflex::StateAdapter::Dom`.
+Note that the DOM adapter requires the `data-reflex-dataset="children"` property to be set on anything firing the reflex. You can mix it with other options like `data-reflex-dataset="ancestors children"`.
+Optionally you can include all datasets in the reflex `data-reflex-dataset="*"` but in large applications you may want to limit the amount of data being transferred only to what is necessary.
+
+When using the `ViewComponentReflex::StateAdapter::Dom` make sure your key does not contain underscores and is limited to max. 80 characters. That's important when you'd be using customized [collection_key](#collections) which increases the length of the key.
 
 ## Custom State Adapters
 

data/lib/view_component_reflex/reflex.rb

@@ -11,6 +11,10 @@ module ViewComponentReflex
       Nokogiri::HTML(controller.response.body)
     end
 
+    def cable_ready
+      CableReady::Channels.instance[stream]
+    end
+
     def refresh!(primary_selector = nil, *rest)
       save_state
 
@@ -24,7 +28,7 @@ module ViewComponentReflex
         [primary_selector, *rest].each do |s|
           html = document.css(s)
           if html.present?
-            CableReady::Channels.instance[stream].morph(
+            cable_ready.morph(
               selector: s,
               html: html.inner_html,
               children_only: true,
@@ -36,7 +40,7 @@ module ViewComponentReflex
       else
         refresh_component!
       end
-      CableReady::Channels.instance[stream].broadcast
+      cable_ready.broadcast
     end
 
     def stream
@@ -60,7 +64,7 @@ module ViewComponentReflex
     end
 
     def refresh_component!
-      CableReady::Channels.instance[stream].morph(
+      cable_ready.morph(
         selector: selector,
         children_only: true,
         html: component_document.css(selector).to_html,
@@ -187,7 +191,8 @@ module ViewComponentReflex
         :prevent_refresh!,
         :selector,
         :stimulate,
-        :stream_to
+        :stream_to,
+        :cable_ready
       ]
       exposed_methods.each do |meth|
         @component.define_singleton_method(meth) do |*a|

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '3.2.0'
+  VERSION = '3.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-12-21 00:00:00.000000000 Z
+date: 2023-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -116,7 +116,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Allow stimulus reflexes in a view component