view_component_reflex 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46d3bc691137a986b26a9487624f004cf9625079040130a035129d12f3f52829
-  data.tar.gz: 9793628bd7618163d9c0014f887d8ef791ac25c2f168dd8c7cbb45e6c55f0839
+  metadata.gz: 4ac0e4b7fc45ba1963f6d260f66463a00a37fccfb6db10855f608beb8f54126e
+  data.tar.gz: eaa30fcda3a41ffc51f651398d490a51b89d1eb06fdf81619e2a9ee0535b62f7
 SHA512:
-  metadata.gz: 014e4d807f719ccb361d9bd800ed599164c498c8e0a947820495982d63a1c07c7409041394d24e247701ec2510b27fe2bbfaee9829733946fe8e51ce630f8e80
-  data.tar.gz: 11cb4beef6ec931032d5b228fa43aee432ce8973fffa10c4391a8577d4788607937d3eb19b41650f778bbdd3cdad94f05e6eb69c0f97a7fdddc8056973f0152c
+  metadata.gz: aa7fed3d3bd4aa4718c5c5358c798b6e0a9edb028d26bb26228989cf6c17f9348036a5ab4d3932c376cb632b7eb145d1e7e1f37a44405e6188609cf1b3942bd8
+  data.tar.gz: f761bbdc0c3a11edbcc01e49fe704fa4a8dac9fdf167a5068c2187d28bb35b400afe542edd2d2b7fe2964a0d5a224a299d00de660a47c26525162e12b8d5efea

data/README.md

@@ -2,6 +2,8 @@
 
 ViewComponentReflex allows you to write reflexes right in your view component code.
 
+It builds upon [stimulus_reflex](https://github.com/hopsoft/stimulus_reflex) and [view_component](https://github.com/github/view_component)
+
 ## Usage
 
 You can add reflexes to your component by adding inheriting from `ViewComponentReflex::Component`.
@@ -88,12 +90,30 @@ This shares the same definition as `content_tag`, except it accepts a reflex as
 
 Would add a click handler to the `increment` method on your component.
 
-To use a non-click event, specific that with `->` notiation
+To use a non-click event, specific that with `->` notation
 
 ```erb
 <%= reflex_tag "mouseenter->increment", :button, "Click me!" %>
 ```
 
+### reflex_data_attributes(reflex)
+
+This helper will give you the data attributes used in the reflex_tag above if you want to build your own elements.
+
+Build your own tag:
+
+```erb
+<%= link_to (image_tag photo.image.url(:medium)), data: reflex_data_attributes(:increment) %>
+```
+
+Render a ViewComponent
+
+```erb
+<%= render ButtonComponent.new(data: reflex_data_attributes("mouseenter->increment")) %>
+```
+
+Make sure that you assign the reflex_data_attributes to the correct element in your component.
+
 ### collection_key
 If you're rendering a component as a collection with `MyComponent.with_collection(SomeCollection)`, you must define this method to return some unique value for the component.
 This is used to reconcile state in the background.
@@ -219,7 +239,7 @@ ViewComponentReflex uses session for its state by default. To change this, add
 an initializer to `config/initializers/view_component_reflex.rb`.
 
 ```ruby
-ViewComponentReflex.configure do |config|
+ViewComponentReflex::Engine.configure do |config|
   config.state_adapter = YourAdapter
 end
 ```
@@ -279,9 +299,19 @@ Or install it yourself as:
 $ gem install view_component_reflex
 ```
 
+# Common problems
+
+## 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.
+
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 ## Caveats
 
 State uses session to maintain state as of right now. It also assumes your component view is written with the file extension `.html.erb`
+
+## Support me
+
+<a href="https://www.buymeacoffee.com/jleblanc" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="40" ></a>
+

data/app/components/view_component_reflex/component.rb

@@ -2,10 +2,10 @@ module ViewComponentReflex
   class Component < ViewComponent::Base
     class << self
       def init_stimulus_reflex
-        if name.include? "::"
-          @stimulus_reflex ||= module_parent.const_set(name.split("::").last + "Reflex", Class.new(Reflex))
+        @stimulus_reflex ||= if name.include? "::"
+          module_parent.const_set(name.split("::").last + "Reflex", Class.new(Reflex))
         else
-          @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(Reflex))
+          Object.const_set(name + "Reflex", Class.new(Reflex))
         end
         @stimulus_reflex.component_class = self
       end
@@ -24,11 +24,11 @@ module ViewComponentReflex
       init_key
 
       tag = :div
-      if opts_or_tag.is_a? Hash
-        options = opts_or_tag
+      options = if opts_or_tag.is_a? Hash
+        opts_or_tag
       else
         tag = opts_or_tag
-        options = opts
+        opts
       end
       options[:data] = {
         controller: self.class.stimulus_controller,
@@ -54,20 +54,25 @@ module ViewComponentReflex
       @key = key
     end
 
-    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
+    # Helper to use to create the proper reflex data attributes for an element
+    def reflex_data_attributes(reflex)
       action, method = reflex.to_s.split("->")
       if method.nil?
         method = action
         action = "click"
       end
-      data_attributes = {
+
+      {
         reflex: "#{action}->#{self.class.name}##{method}",
         key: key
       }
+    end
+
+    def reflex_tag(reflex, name, content_or_options_with_block = {}, options = {}, escape = true, &block)
       if content_or_options_with_block.is_a?(Hash)
-        merge_data_attributes(content_or_options_with_block, data_attributes)
+        merge_data_attributes(content_or_options_with_block, reflex_data_attributes(reflex))
       else
-        merge_data_attributes(options, data_attributes)
+        merge_data_attributes(options, reflex_data_attributes(reflex))
       end
       content_tag(name, content_or_options_with_block, options, escape, &block)
     end
@@ -97,8 +102,8 @@ module ViewComponentReflex
         ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
           instance_value = instance_variable_get(k)
           if permit_parameter?(initial_state[k], instance_value)
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", { k => instance_value })
-            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, { k => instance_value })
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, "#{@key}_initial", {k => instance_value})
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, @key, {k => instance_value})
           else
             instance_variable_set(k, v)
           end

data/lib/view_component_reflex.rb

@@ -2,6 +2,7 @@ require "view_component_reflex/state_adapter/session"
 require "view_component_reflex/state_adapter/memory"
 require "view_component_reflex/engine"
 require "stimulus_reflex"
+require "view_component_reflex/reflex"
 
 module ViewComponentReflex
   # Your code goes here...

data/{app/reflexes → lib}/view_component_reflex/reflex.rb

@@ -61,19 +61,26 @@ module ViewComponentReflex
     # uses method to gather the method parameters, but since we're abusing
     # method_missing here, that'll always fail
     def method(name)
-      name.to_sym.to_proc
+      component.method(name.to_sym)
     end
 
     def respond_to_missing?(name, _ = false)
       !!name.to_proc
     end
 
-    before_reflex do |a|
-      a.send a.method_name
-      throw :abort
+    # this is copied out of stimulus_reflex/reflex.rb and modified
+    def morph(selectors, html = "")
+      case selectors
+      when :nothing
+        @broadcaster = StimulusReflex::NothingBroadcaster.new(self)
+      else
+        @broadcaster = StimulusReflex::SelectorBroadcaster.new(self) unless broadcaster.selector?
+        broadcaster.morphs << [selectors, html]
+      end
     end
 
     def method_missing(name, *args)
+      morph :nothing
       super unless respond_to_missing?(name)
       state.each do |k, v|
         component.instance_variable_set(k, v)

data/lib/view_component_reflex/state_adapter/memory.rb

@@ -15,7 +15,7 @@ module ViewComponentReflex
 
       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] ||= {}
+        VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key] = {}
         new_state.each do |k, v|
           VIEW_COMPONENT_REFLEX_MEMORY_STATE[request.session.id.to_s][key][k] = v
         end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-15 00:00:00.000000000 Z
+date: 2020-08-24 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: '0'
+        version: 3.3.0.pre2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0.pre2
 - !ruby/object:Gem::Dependency
   name: view_component
   requirement: !ruby/object:Gem::Requirement
@@ -69,9 +69,9 @@ files:
 - README.md
 - Rakefile
 - app/components/view_component_reflex/component.rb
-- app/reflexes/view_component_reflex/reflex.rb
 - lib/view_component_reflex.rb
 - lib/view_component_reflex/engine.rb
+- lib/view_component_reflex/reflex.rb
 - lib/view_component_reflex/state_adapter/memory.rb
 - lib/view_component_reflex/state_adapter/session.rb
 - lib/view_component_reflex/version.rb