view_component_reflex 0.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 730dc20cb5c31f500fb8c6fd63c5e21286a4a3ea28f63a64aaa06c1640ef4844
-  data.tar.gz: 911b8665fd95a69b28de2bf366ffa9edb4240070c8e29c145090d27ba8eaf271
+  metadata.gz: f7e9a4ab35ecb85fef158f336121ffd080f26d344bbf804abfc1fd85849b6734
+  data.tar.gz: 202ab52b2ad27cca0b823cb13d71b0389d6dba68e35e1f92da2ef601a2690125
 SHA512:
-  metadata.gz: 679abeb33702936136cfc32244be5bd7ed85cbe8526594eb3f3ed8138b0aec7e004507eab5c4624fa0accd19958999a62641122dbfd67693ab9c3bf11424fd9f
-  data.tar.gz: 97f3b2645a43893d09a253c3d8c780ce1c141aab599c67db3fb6bd47ed443780960d831da6b10ff2930a1bdb0eb063ff667c5292b1c23f1e6eb9f1292f890c40
+  metadata.gz: aeccacfe56978cc599fabdba202e645950cbf09a52c1a42bcdd12620018a2299a6858c0cda5c13ad644d0e78c766cffef55d46227874ed54d4944c0cef70f042
+  data.tar.gz: e5e7798417649a6233513a741f7c891e05abe15c941e2ade30bb7a9200b8c9e93039ba54a656cff05bf5a1dab886dd1dfc7bfcc4b42539853ce2cac70857c606

data/README.md

@@ -6,51 +6,32 @@ ViewComponentReflex allows you to write reflexes right in your view component co
 
 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
-      refresh!
-    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.
 
-#####note: A reflex will not automatically re-render the component upon its completion. A component will re-render whenever the `set_state` or `refresh!` method is called.
-
-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. Calling `set_state` will set the state, 
-and also re-render your component.
-
-If you're using state add `data-key="<%= key %>"` to any html element using a reflex. This 
-lets ViewComponentReflex keep track of which state belongs to which component.
-
+ViewComponentReflex will maintain your component's instance variables between renders. You need to include `data-key=<%= key %>` on your root element, as well 
+as any element that stimulates a reflex. ViewComponent is inherently state-less, so the key is used to reconcile state to its respective component.
 
+### Example
 ```ruby
     # counter_component.rb
     class CounterComponent < ViewComponentReflex::Component
-   
       def initialize
-        initialize_state({
-          count: 0
-        })
+        @count = 0
       end
     
-      reflex :increment do
-        set_state(count: state[:count] + 1)
+      def increment
+        @count += 1
       end
     end
 ```
 
 ```erb
 # counter_component.html.erb
-<div data-controller="counter">
-    <p><%= state[:count] %></p>
+<%= component_controller do %>
+    <p><%= @count %></p>
     <button type="button" data-reflex="click->CounterComponentReflex#increment" data-key="<%= key %>">Click</button>
-</div>
+<% end %>
 ```
 
 ## Custom State Adapters
@@ -76,36 +57,27 @@ class YourAdapter
   end
 
   ##
+  # set_state is used to modify the state. It accepts a reflex, which gives you
+  # access to the request, as well as the controller and other useful objects. 
+  #
   # reflex - The reflex instance that's trying to set the state
   # key - a unique string that identifies the component
   # new_state - the new state to set
   def self.set_state(reflex, key, new_state)
+    # update the state
   end
 
 
   ##
+  # store_state is used to replace the state entirely. It only accepts
+  # a request object, rather than a reflex because it's called from the component's 
+  # side with the component's instance variables.
+  #
   # request - a rails request object
   # key - a unique string that identifies the component instance
   # new_state - a hash containing the component state
   def self.store_state(request, key, new_state = {})
-    # store the state 
-    # this will be called twice, once with key, once with key_initial
-    # key_initial contains the initial, unmodified state.
-    # it should be used in reconcile_state to decide whether or not
-    # to re-initialize the state
-  end
-  
-  ##
-  # request - a rails request object
-  # key - a unique string that identifies the component instance
-  # new_state - a hash containing the component state
-  def self.reconcile_state(request, key, new_state)
-  # The passed state should always match the initial state of the component
-  # if it doesn't, we need to reset the state to the passed value.
-  #
-  # This handles cases where your initialize_state param computes some value that changes
-  # initialize_state({ transaction: @customer.transactions.first })
-  # if you delete the first transaction, that ^ is no longer valid. We need to update the state.
+    # replace the state
   end
 end
 ```

data/app/components/view_component_reflex/component.rb

@@ -1,83 +1,141 @@
 module ViewComponentReflex
   class Component < ViewComponent::Base
     class << self
-      def reflex(name, &blk)
-        stimulus_reflex.reflex(name, &blk)
-      end
-
-      def stimulus_reflex
+      def init_stimulus_reflex
         klass = self
         @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(StimulusReflex::Reflex) {
-          def state
-            ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
-          end
-
-          def refresh!
-            @channel.send :render_page_and_broadcast_morph, self, ["[data-controller=\"#{stimulus_controller}\"]"], {
+          def refresh!(primary_selector = "[data-controller=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]", *selectors)
+            save_state
+            @channel.send :render_page_and_broadcast_morph, self, [primary_selector, *selectors], {
               dataset: element.dataset.to_h,
               args: [],
               attrs: element.attributes.to_h,
-              selectors: ['body'],
+              selectors: ["body"],
               target: "#{self.class.name}##{method_name}",
               url: request.url,
               permanentAttributeName: "data-reflex-permanent"
             }
           end
 
-          def set_state(new_state = {})
-            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
-            refresh!
+          def refresh_all!
+            refresh!("body")
           end
 
-          before_reflex do |reflex, *args|
-            instance_exec(*args, &self.class.callbacks[self.method_name.to_sym]) if self.class.callbacks.include?(self.method_name.to_sym)
+          # SR's delegate_call_to_reflex in channel.rb
+          # 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
+          end
+
+          def respond_to_missing?(name, _ = false)
+            !!name.to_proc
+          end
+
+          before_reflex do |a|
+            a.send a.method_name
             throw :abort
           end
 
-          def self.callbacks
-            @callbacks ||= {}
+          def method_missing(name, *args)
+            super unless respond_to_missing?(name)
+            state.each do |k, v|
+              component.instance_variable_set(k, v)
+            end
+            name.to_proc.call(component, *args)
+            refresh!
+          end
+
+          define_method :component_class do
+            @component_class ||= klass
+          end
+
+          private :component_class
+
+          private
+
+          def stimulus_controller
+            component_class.stimulus_controller
+          end
+
+          def component
+            return @component if @component
+            @component = component_class.allocate
+            reflex = self
+            exposed_methods = [:element, :refresh!, :refresh_all!, :stimulus_controller]
+            exposed_methods.each do |meth|
+              @component.define_singleton_method(meth) do |*a|
+                reflex.send(meth, *a)
+              end
+            end
+            @component
+          end
+
+          def set_state(new_state = {})
+            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
           end
 
-          define_method :stimulus_controller do
-            klass.name.chomp("Component").underscore.dasherize
+          def state
+            ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
           end
 
-          define_singleton_method(:reflex) do |name, &blk|
-            callbacks[name] = blk
-            define_method(name) do |*args|
+          def save_state
+            new_state = {}
+            component.instance_variables.each do |k|
+              new_state[k] = component.instance_variable_get(k)
             end
+            set_state(new_state)
           end
         })
       end
     end
 
-    def initialize_state(obj)
-      @state = obj
+    def self.stimulus_controller
+      name.chomp("Component").underscore.dasherize
     end
 
     def stimulus_reflex?
       helpers.controller.instance_variable_get(:@stimulus_reflex)
     end
 
+    def component_controller(&blk)
+      opts = {data: {controller: self.class.stimulus_controller, key: key}}
+      view_context.content_tag :div, capture(&blk), opts
+    end
+
     # key is required if you're using state
     # We can't initialize the session state in the initial 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
+      self.class.init_stimulus_reflex
+      # 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
+      if @key.nil? || @key.empty?
+        @key = key
+      end
 
       # initialize session state
       if !stimulus_reflex? || session[@key].nil?
-        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, @state)
-        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", @state)
+        new_state = {}
+
+        # this will almost certainly break
+        blacklist = [
+          :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
+          :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
+          :@helpers, :@controller, :@request
+        ]
+        instance_variables.reject { |k| blacklist.include?(k) }.each do |k|
+          new_state[k] = instance_variable_get(k)
+        end
+        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, new_state)
       else
-        # ViewComponentReflex::Engine.state_adapter.reconcile_state(request, @key, @state)
+        ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
+          instance_variable_set(k, v)
+        end
       end
       @key
     end
-
-    def state
-      ViewComponentReflex::Engine.state_adapter.state(request, key)
-    end
   end
 end

data/lib/view_component_reflex/state_adapter/session.rb

@@ -19,20 +19,6 @@ module ViewComponentReflex
           request.session[key][k] = v
         end
       end
-
-      # The passed state should always match the initial state of the component
-      # if it doesn't, we need to reset the state to the passed value.
-      #
-      # This handles cases where your initialize_state param computes some value that changes
-      # initialize_state({ transaction: @customer.transactions.first })
-      # if you delete the first transaction, that ^ is no longer valid. We need to update the state.
-      def self.reconcile_state(request, key, new_state)
-        request.session["#{key}_initial"].each do |k, v|
-          if new_state[k] != v
-            request.session[key][k] = new_state[k]
-          end
-        end
-      end
     end
   end
 end

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '0.5.1'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component_reflex
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Joshua LeBlanc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails