view_component_reflex 2.1.3 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5ffbf1eef5f6b3a5d7d65f4d541dffb0d396125b23c4db8f768928a2e5d7477
-  data.tar.gz: 67e7902d699879181cf2bfba948a93967eda19d355b85e785b61f41a3f89e0dc
+  metadata.gz: 884879671f11072c36d18205c1bb452c8b0ff9e2e50c6e57b70e1bfb602f1b87
+  data.tar.gz: dd3ac067aaa30fa45785b6abd1b609b7a09fadf9c11ca272d829271675750fb9
 SHA512:
-  metadata.gz: 6912fa047d572bf7d666e5cb1f151164103709d93b473ab1a40642d2828b64807928fb064621ce1804a6144899483a98b5440f1d615eb7bf451e924d8e8f21ed
-  data.tar.gz: 5f4c565c378d6caad49fd2f18064dc474535fbff28f64c8480354398cb23e9d164a45138424cf2dc70c983bb1cbd6b842a8fed57c83356e4be2a9e3c268ae7c3
+  metadata.gz: 6740d002a2fae276c4ff60433485461cb43a90ac4a6fdb2431fa757b326fc2f882f86b662d7b23ba735f65ca89d87a047ebdb5f7874f3db08826fe3cb880d39c
+  data.tar.gz: fc558e67327441ea6c1f813f7d005e57ce6b127221e4ab34835c78e1a7d6a0b2fd25e406de405ae615a6d204d691e8a94d669eb28df7bb64192e770bd88f06df

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.
@@ -136,7 +156,7 @@ end
 Returns the unique selector for this component. Useful to pass to `refresh!` when refreshing custom elements.
 
 ### prevent_refresh!
-By default, VCR will re-render your component after it executes your method. `revent_refresh!` prevents this from happening.
+By default, VCR will re-render your component after it executes your method. `prevent_refresh!` prevents this from happening.
 
 ```ruby
 def my_method
@@ -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,9 @@ Or install it yourself as:
 $ gem install view_component_reflex
 ```
 
-## Common problems
+# Common problems
 
-# Uninitialized constants \<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.
 
 ## License

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(ViewComponentReflex::Reflex))
         else
-          @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(Reflex))
+          Object.const_set(name + "Reflex", Class.new(ViewComponentReflex::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,
@@ -49,25 +49,30 @@ module ViewComponentReflex
     def init_key
       # we want the erb file that renders the component. `caller` gives the file name,
       # and line number, which should be unique. We hash it to make it a nice number
-      key = caller.select { |p| p.include? ".html.erb" }[1]&.hash.to_s
+      key = caller.select { |p| p.match? /.\.html\.(haml|erb|slim)/ }[1]&.hash.to_s
       key += collection_key.to_s if collection_key
       @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

@@ -1,8 +1,8 @@
+require "stimulus_reflex"
 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"
+require "view_component_reflex/engine"
 
 module ViewComponentReflex
   # Your code goes here...

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '2.1.3'
+  VERSION = '2.2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.2
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-09-16 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