view_component_reflex 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec3bf329ad0e7bbc776b52761cadec00a33ab1c78fba847d26271b27e8a30532
-  data.tar.gz: 5b6d10305c220bbd86486d513b97091e88afa87d6b0b91669c95d04cb1539fb2
+  metadata.gz: c044811ae2dc2de577c5d2c358bc47717c6db79e833537ffe30912b1324ed67e
+  data.tar.gz: 776a2f724d7b32dbf742bbaf3a7ffb14755767f01c13702313b5cf6f40950e4e
 SHA512:
-  metadata.gz: 44151d570ece600f3151acffd7eb7ff7a382bc26ac36d088683c7de6439d8335643742aeb5a9de337f19646967f913678402d39a2b11baef7506d1af3beb2eef
-  data.tar.gz: 8de0f26c998b8a1061829128d4f5a8175ae11d3a115b2e676af6d6af3a5896150cb32b72df295a53c75d83009dbaaba136bf638dd125e1d69c56dd1a38200702
+  metadata.gz: b941db2658a7764e881383582d5244855dd09f8ec336d20165c07a9d9104d2ece87e0a4309f91b293f4329e70f0b22019f8fe8e31469dd3edb26519ff6d575b2
+  data.tar.gz: 3180e0b52a0709ecba31fc9200d5265646b8149d8e10ec45a674cf87d229a7bb706663edda3ad06a1a0cc22c707b570daea15c4ae58779c9e430e12d189a894f

data/README.md

@@ -176,6 +176,17 @@ def do_some_global_action
 end
 ```
 
+### stream_to(channel)
+Stream to a custom channel, rather than the default stimulus reflex one
+
+```ruby
+def do_something
+  stream_to MyChannel
+  
+  @foo = :bar
+end
+```
+
 ### key
 This is a key unique to a particular component. It's used to reconcile state between renders, and should be passed as a data attribute whenever a reflex is called
 

data/app/components/view_component_reflex/component.rb

@@ -47,7 +47,7 @@ module ViewComponentReflex
     end
 
     def self.stimulus_controller
-      name.chomp("Component").underscore.dasherize
+      name.chomp("Component").underscore.dasherize.gsub("/", "--")
     end
 
     def stimulus_reflex?
@@ -57,7 +57,7 @@ module ViewComponentReflex
     def component_controller(opts_or_tag = :div, opts = {}, &blk)
       init_key
 
-      tag = :div
+      tag = :di
       options = if opts_or_tag.is_a? Hash
         opts_or_tag
       else

data/lib/view_component_reflex.rb

@@ -1,5 +1,6 @@
 require "stimulus_reflex"
 require 'view_component_reflex/reflex_factory'
+require "view_component_reflex/state_adapter/base"
 require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/state_adapter/memory"
 require "view_component_reflex/state_adapter/redis"

data/lib/view_component_reflex/reflex.rb

@@ -19,21 +19,12 @@ module ViewComponentReflex
         [primary_selector, *rest].each do |s|
           html = document.css(s)
           if html.present?
-            CableReady::Channels.instance[stream_name].morph(
+            CableReady::Channels.instance[stream].morph(
               selector: s,
               html: html.inner_html,
               children_only: true,
               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]}
-              }
+              stimulus_reflex: stimulus_reflex_data
             )
           end
         end
@@ -43,6 +34,14 @@ module ViewComponentReflex
       cable_ready.broadcast
     end
 
+    def stream
+      @stream ||= stream_name
+    end
+
+    def stream_to(channel)
+      @stream = channel
+    end
+
     def refresh_component!
       component.tap do |k|
         k.define_singleton_method(:key) do
@@ -50,24 +49,30 @@ module ViewComponentReflex
         end
       end
       document = Nokogiri::HTML(component.render_in(controller.view_context))
-      CableReady::Channels.instance[stream_name].morph(
+      CableReady::Channels.instance[stream].morph(
         selector: selector,
         children_only: true,
         html: document.css(selector).inner_html,
         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]}
-        }
+        stimulus_reflex: stimulus_reflex_data
       )
     end
 
+    def stimulus_reflex_data
+      {
+        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
@@ -127,27 +132,49 @@ module ViewComponentReflex
     end
 
     def stimulate(target, data)
-      dataset = {}
-      data.each do |k, v|
-        dataset["data-#{k}"] = v.to_s
+      data_to_receive = {}
+
+      stimulus_reflex_data.each do |k, v|
+        data_to_receive[k.to_s.camelize(:lower)] = v
+      end
+
+      data_to_receive["dataset"] = data.each_with_object({}) do |(k, v), o|
+        o["data-#{k}"] = v
       end
-      channel.receive({
-        "target" => target,
-        "attrs" => element.attributes.to_h.symbolize_keys,
-        "dataset" => dataset
-      })
+
+      data_to_receive["attrs"] = element.attributes.to_h.symbolize_keys
+      data_to_receive["target"] = target
+
+      channel.receive data_to_receive
     end
 
     def component
       return @component if @component
       @component = component_class.allocate
       reflex = self
-      exposed_methods = [:params, :request, :connection, :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)
         end
       end
+
+      @component.define_singleton_method(:reflex) do
+        reflex
+      end
+
       @component
     end
 

data/lib/view_component_reflex/state_adapter/base.rb

@@ -0,0 +1,18 @@
+module ViewComponentReflex
+  module StateAdapter
+    class Base
+
+      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/state_adapter/memory.rb

@@ -1,7 +1,7 @@
 VIEW_COMPONENT_REFLEX_MEMORY_STATE = {}
 module ViewComponentReflex
   module StateAdapter
-    class Memory
+    class Memory < Base
       def self.state(request, key)
         id = extract_id(request)
 
@@ -28,17 +28,6 @@ module ViewComponentReflex
       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/state_adapter/redis.rb

@@ -10,7 +10,7 @@
 
 module ViewComponentReflex
   module StateAdapter
-    class Redis
+    class Redis < Base
       attr_reader :client, :ttl
 
       def initialize(redis_opts:, ttl: 3600)
@@ -67,8 +67,9 @@ module ViewComponentReflex
       end
 
       def get_key(request, key)
-        "#{request.session.id.to_s}_#{key}_session_reflex_redis"
+        id = Redis.extract_id(request)
+        "#{id}_#{key}_session_reflex_redis"
       end
     end
   end
-end
+end

data/lib/view_component_reflex/state_adapter/session.rb

@@ -1,6 +1,6 @@
 module ViewComponentReflex
   module StateAdapter
-    class Session
+    class Session < Base
       def self.state(request, key)
         request.session[key] ||= {}
       end

data/lib/view_component_reflex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-19 00:00:00.000000000 Z
+date: 2021-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -87,6 +87,7 @@ files:
 - lib/view_component_reflex/engine.rb
 - lib/view_component_reflex/reflex.rb
 - lib/view_component_reflex/reflex_factory.rb
+- lib/view_component_reflex/state_adapter/base.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