view_component_reflex 0.6.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25f3eb9ce0b0a130b3448c9aa350636e86f4497c9274a1a4ba7edfb564d11a16
-  data.tar.gz: 809b06a816a92e8ba1e3ce0198c55c6f3d812a0ad3c4b447300c56e4733102b4
+  metadata.gz: 4ed2f845769bba6d5142bef6d6fc601b44841080c49ee47abc0036801f62b145
+  data.tar.gz: 73e625d1948e5b477def8e098a4a4d55b9a02763c575e1d4bdd4c734e0f208b0
 SHA512:
-  metadata.gz: e3c0cf57dda891149ccd671d02fbc967aaa83277f789a1cd0c7c75192fa4a83e3e593177ef49f904cbc9cc8bb241b9506527bfafee0b90b049252b1822a4cb68
-  data.tar.gz: 94c5b424ae03b1f35f797ddebf0d6f24bf78b05960140c415cce86d4c2bf645ce4eef7445d7049ef57ab0d2f26925bac251b0a202199840f23f4f0adee22fc17
+  metadata.gz: 76c5b53b3acb0fa68084b762ad14fddbaa0aee1d0b9bbe67f33910f088e7b60062bf5dcf61c7703932b2cfa228f4bccfc768e6b9ab64253397e3483efd50cfb5
+  data.tar.gz: 077a34955920288651b183d77971d30eb4fbfeabe45aaa799d78f2ea242cb46f328d23223508d053e53210c00e9aeb570e9d234b571aba3005e57b6448afd5fc

data/README.md

@@ -6,53 +6,60 @@ 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
-        })
-      end
-    
-      reflex :increment do
-        set_state(count: state[:count] + 1)
-      end
-    end
+# counter_component.rb
+class CounterComponent < ViewComponentReflex::Component
+  def initialize
+    @count = 0
+  end
+
+  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 %>
 ```
 
+## Collections
+
+In order to reconcile state to components in collections, you can specify a `collection_key` method that returns some
+value unique to that component.
+
+```
+class TodoComponent < ViewComponentReflex::Component
+  def initialize(todo:)
+    @todo = todo
+  end
+
+  def collection_key
+    @todo.id
+  end
+end
+#
+<%= render(TodoComponent.with_collection(Todo.all)) %>
+```
+
+## API
+
+### permit_parameter?(initial_param, new_params)
+If a new parameter is passed to the component during rendering, it is used instead of what's in state.
+If you're storing instances in state, you can use this to properly compare them.
+
+
 ## Custom State Adapters
 
 ViewComponentReflex uses session for its state by default. To change this, add
@@ -76,19 +83,27 @@ class YourAdapter
   end
 
   ##
-  # reflex - The reflex instance that's trying to set the state
+  # set_state is used to modify the state.
+  #
+  # request - a rails request object
+  # controller - the current controller
   # key - a unique string that identifies the component
   # new_state - the new state to set
-  def self.set_state(reflex, key, new_state)
+  def self.set_state(request, controller, 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 
+    # replace the state
   end
 end
 ```

data/app/components/view_component_reflex/component.rb

@@ -1,84 +1,159 @@
 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!(primary_selector = "[data-controller=\"#{stimulus_controller}\"]", *selectors)
+          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'],
-              target: "#{self.class.name}##{method_name}",
-              url: request.url,
-              permanentAttributeName: "data-reflex-permanent"
+              "dataset" => element.dataset.to_h,
+              "args" => [],
+              "attrs" => element.attributes.to_h,
+              "selectors" => ["body"],
+              "target" => "#{self.class.name}##{method_name}",
+              "url" => request.url,
+              "permanent_attribute_name" => "data-reflex-permanent"
             }
           end
 
           def refresh_all!
-            refresh!('body')
+            refresh!("body")
+          end
+
+          # 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 set_state(new_state = {}, primary_selector = nil, *selectors)
-            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
-            refresh!(primary_selector, *selectors)
+          def respond_to_missing?(name, _ = false)
+            !!name.to_proc
           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)
+          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
 
-          define_method :stimulus_controller do
-            klass.name.chomp("Component").underscore.dasherize
+          private :component_class
+
+          private
+
+          def stimulus_controller
+            component_class.stimulus_controller
           end
 
-          define_singleton_method(:reflex) do |name, &blk|
-            callbacks[name] = blk
-            define_method(name) do |*args|
+          def component
+            return @component if @component
+            @component = component_class.allocate
+            reflex = self
+            exposed_methods = [:params, :request, :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(request, controller, element.dataset[:key], new_state)
+          end
+
+          def state
+            ViewComponentReflex::Engine.state_adapter.state(request, element.dataset[:key])
+          end
+
+          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(opts = {}, &blk)
+      self.class.init_stimulus_reflex
+      init_key
+      opts[:data] = {
+        controller: self.class.stimulus_controller,
+        key: key,
+        **(opts[:data] || {})
+      }
+      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
+    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 += collection_key.to_s if collection_key
+      @key = key
+    end
 
+    def collection_key
+      nil
+    end
+
+    def permit_parameter?(initial_param, new_param)
+      initial_param != new_param
+    end
+
+    def key
       # initialize session state
       if !stimulus_reflex? || session[@key].nil?
-        ViewComponentReflex::Engine.state_adapter.store_state(request, @key, @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, :@content
+        ]
+        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)
+        ViewComponentReflex::Engine.state_adapter.store_state(request, "#{@key}_initial", new_state)
+      else
+        initial_state = ViewComponentReflex::Engine.state_adapter.state(request, "#{@key}_initial")
+        ViewComponentReflex::Engine.state_adapter.state(request, @key).each do |k, v|
+          unless permit_parameter?(initial_state[k], instance_variable_get(k))
+            instance_variable_set(k, v)
+          end
+        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

@@ -5,12 +5,12 @@ module ViewComponentReflex
         request.session[key] ||= {}
       end
 
-      def self.set_state(reflex, key, new_state)
+      def self.set_state(request, controller, key, new_state)
         new_state.each do |k, v|
-          state(reflex.request, key)[k] = v
+          state(request, key)[k] = v
         end
-        store = reflex.request.session.instance_variable_get("@by")
-        store.commit_session reflex.request, reflex.controller.response
+        store = request.session.instance_variable_get("@by")
+        store.commit_session request, controller.response
       end
 
       def self.store_state(request, key, new_state = {})

data/lib/view_component_reflex/version.rb

@@ -1,3 +1,3 @@
 module ViewComponentReflex
-  VERSION = '0.6.3'
+  VERSION = '1.2.0'
 end

metadata

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