view_component_reflex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42a18772bfb90827ea98389fcf0372d4e040263d9574daf7f6b5bd46d37abcff
-  data.tar.gz: cc1adae2d0e275d0356d0431369bc3a4c99c4f9e46c943fff99d7e177f383857
+  metadata.gz: 9c0c42d6658ac5c2c6af6bc78a4de1c04cfaaa38bdf4a206106975cbf7c5c049
+  data.tar.gz: 5bc792233916b8d16dd364eadb02eb9183ede8da619ed67908b47b410a9c80d5
 SHA512:
-  metadata.gz: cb5b99238e5106761cb071296cb55c0717499d30afd6d4f11948c800faae31260bae5cb133c24c0f04400ba605b79adebdcd66c95118696f34f5e357dbef2c89
-  data.tar.gz: a7eda1ce0386f187efd4d354ec0dbb23dee3103377db7088f94e0f74694b971d06b975b06fbf855bea52219aef06cd0c6cf5ab7ea68ee420526328041ce3daba
+  metadata.gz: 2747491eede7da7ccfab22ec260426755a44ee46a28218da5297ef3b1108cf6fe8c9cb38559f03cc20b68e6f0c00e79d5480fddd5a6595f1e0c979e2f2865e4a
+  data.tar.gz: c979f87cc33842ced72066d2dc262e876ff77cd5b3764052c0e388d5139a060c7b22fdcc9963fef5f8a3a0f2e82c8a6b35ede0feaaca4bdc70f32ffe59a1abee

data/README.md

@@ -1,28 +1,75 @@
-# ViewComponentReflex
-Short description and motivation.
-
-## Usage
-How to use my plugin.
-
-## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'view_component_reflex'
-```
-
-And then execute:
-```bash
-$ bundle
-```
-
-Or install it yourself as:
-```bash
-$ gem install view_component_reflex
-```
-
-## Contributing
-Contribution directions go here.
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# ViewComponentReflex
+
+ViewComponentReflex allows you to write reflexes right in your view component code.
+
+## Usage
+
+You can add reflexes to your component by adding inheriting from `ViewComponentReflex::Component`.
+
+To add a reflex to your component, use the `reflex` method.
+
+```ruby
+    reflex :my_cool_reflex do
+      # do stuff
+    end
+```
+
+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.
+
+In addition to calling reflexes, there is a rudimentary state system. You can initialize component-local state with `initialize_state(obj)`, where `obj` is a hash.
+
+You can access state with the `state` helper. See the code below for an example.
+
+If you're using state, include `super()` at the beginning of your initialize method, and add `data-key="<%= key %>"` to any html element using a reflex. This 
+lets ViewComponentReflex keep track of which state belongs to which component.
+
+
+```ruby
+    # counter_component.rb
+    class CounterComponent < ViewComponentReflex::Component
+   
+      def initialize
+        super()
+        initialize_state({
+          count: 0
+        })
+      end
+    
+      reflex :increment do
+        state[:count] = state[:count] + 1
+      end
+    end
+```
+
+```erb
+# counter_component.html.erb
+<div data-controller="counter">
+    <p><%= state[:count] %></p>
+    <button type="button" data-reflex="click->CounterComponentReflex#increment" data-key="<%= key %>">Click</button>
+</div>
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component_reflex'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install view_component_reflex
+```
+
+## 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`

data/app/components/view_component_reflex/component.rb

@@ -2,17 +2,20 @@ module ViewComponentReflex
   class Component < ViewComponent::Base
     class << self
       def reflex(name, &blk)
-        @stimulus_reflex.reflex(name, &blk)
+        stimulus_reflex.reflex(name, &blk)
       end
 
-      def connect_stimulus_reflex
+      def stimulus_reflex
+        klass = self
         @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(StimulusReflex::Reflex) {
-          include CableReady::Broadcaster
-
           def state
             session[element.dataset[:key]] ||= {}
           end
 
+          define_method :stimulus_controller do
+            klass.name.chomp("Component").underscore.dasherize
+          end
+
           define_singleton_method(:reflex) do |name, &blk|
             define_method(name) do |*args|
               instance_exec(*args, &blk)
@@ -22,21 +25,21 @@ module ViewComponentReflex
       end
     end
 
-    def initialize
-      @key = caller.find { |p| p.include? ".html.erb" }&.hash.to_s
-    end
-
     def initialize_state(obj)
       @state = obj
-      @state.each do |k, v|
-        instance_variable_set("@#{k}", v)
-      end
     end
 
+    # key is required if you're using state
+    # We can't initialize the session state in the initiale method
+    # because it doesn't have a view_context yet
+    # This is the next best place to do it
     def key
+      @key ||= caller.find { |p| p.include? ".html.erb" }&.hash.to_s
+
+      # initialize session state
       if session[@key].nil?
         session[@key] = {}
-        @state.each do |key, v|
+        (@state ||= {}).each do |key, v|
           session[@key][key] = v
         end
       end

data/lib/stimulus_reflex/channel.rb

@@ -0,0 +1,9 @@
+class StimulusReflex::Channel < ActionCable::Channel::Base
+  def render_page_and_broadcast_morph(reflex, selectors, data = {})
+    html = render_page(reflex)
+    if reflex.respond_to? :stimulus_controller
+      selectors = ["[data-controller=\"#{reflex.stimulus_controller}\"]"]
+    end
+    broadcast_morphs selectors, data, html if html.present?
+  end
+end

data/lib/view_component_reflex.rb

@@ -1,4 +1,6 @@
 require "view_component_reflex/engine"
+require 'stimulus_reflex'
+require_relative 'stimulus_reflex/channel'
 
 module ViewComponentReflex
   # Your code goes here...

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2020-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -69,6 +69,7 @@ files:
 - README.md
 - Rakefile
 - app/components/view_component_reflex/component.rb
+- lib/stimulus_reflex/channel.rb
 - lib/view_component_reflex.rb
 - lib/view_component_reflex/engine.rb
 - lib/view_component_reflex/version.rb