view_component_reflex 1.0.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7e9a4ab35ecb85fef158f336121ffd080f26d344bbf804abfc1fd85849b6734
-  data.tar.gz: 202ab52b2ad27cca0b823cb13d71b0389d6dba68e35e1f92da2ef601a2690125
+  metadata.gz: 30533287ce1445add7dba2ebed5013ed80e792de560fa9c930f3e13dcbd612d7
+  data.tar.gz: bf84f573e602b373855848b2fbe61245967e4f16e7a420b03c1b6414aa1c8c73
 SHA512:
-  metadata.gz: aeccacfe56978cc599fabdba202e645950cbf09a52c1a42bcdd12620018a2299a6858c0cda5c13ad644d0e78c766cffef55d46227874ed54d4944c0cef70f042
-  data.tar.gz: e5e7798417649a6233513a741f7c891e05abe15c941e2ade30bb7a9200b8c9e93039ba54a656cff05bf5a1dab886dd1dfc7bfcc4b42539853ce2cac70857c606
+  metadata.gz: 47dc5ab24c0711778b07b8460207b1e532c944173d4df2cc8fe33447868b96a9043ad972b5a9672a0ea09ad323199b7cfa15327634199d3218e69e6c797f4196
+  data.tar.gz: d9dbc21f77baf9c73c20352a5163c8af52317a0138393d4128cc34bb60e903227e62e28e0f0e0ad92f4fa10d4206f79d295c74582774b93fefffd14801fe5c44

data/README.md

@@ -14,16 +14,16 @@ as any element that stimulates a reflex. ViewComponent is inherently state-less,
 
 ### Example
 ```ruby
-    # counter_component.rb
-    class CounterComponent < ViewComponentReflex::Component
-      def initialize
-        @count = 0
-      end
-    
-      def increment
-        @count += 1
-      end
-    end
+# counter_component.rb
+class CounterComponent < ViewComponentReflex::Component
+  def initialize
+    @count = 0
+  end
+
+  def increment
+    @count += 1
+  end
+end
 ```
 
 ```erb
@@ -34,6 +34,42 @@ as any element that stimulates a reflex. ViewComponent is inherently state-less,
 <% 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.
+
+### omitted_from_state
+Return an array of instance variables you want to omit from state. Useful if you have an object 
+that isn't serializable as an instance variable, like a form.
+
+```
+def omitted_from_state
+  [:@form]
+end
+```
+
+
 ## Custom State Adapters
 
 ViewComponentReflex uses session for its state by default. To change this, add
@@ -57,13 +93,13 @@ 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. 
+  # set_state is used to modify the state.
   #
-  # reflex - The reflex instance that's trying to set 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
 

data/app/components/view_component_reflex/component.rb

@@ -4,16 +4,16 @@ module ViewComponentReflex
       def init_stimulus_reflex
         klass = self
         @stimulus_reflex ||= Object.const_set(name + "Reflex", Class.new(StimulusReflex::Reflex) {
-          def refresh!(primary_selector = "[data-controller=\"#{stimulus_controller}\"][data-key=\"#{element.dataset[:key]}\"]", *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
 
@@ -62,7 +62,7 @@ module ViewComponentReflex
             return @component if @component
             @component = component_class.allocate
             reflex = self
-            exposed_methods = [:element, :refresh!, :refresh_all!, :stimulus_controller]
+            exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session]
             exposed_methods.each do |meth|
               @component.define_singleton_method(meth) do |*a|
                 reflex.send(meth, *a)
@@ -72,7 +72,7 @@ module ViewComponentReflex
           end
 
           def set_state(new_state = {})
-            ViewComponentReflex::Engine.state_adapter.set_state(self, element.dataset[:key], new_state)
+            ViewComponentReflex::Engine.state_adapter.set_state(request, controller, element.dataset[:key], new_state)
           end
 
           def state
@@ -98,24 +98,42 @@ module ViewComponentReflex
       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
+    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
-      self.class.init_stimulus_reflex
+    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
-      if @key.nil? || @key.empty?
-        @key = key
-      end
+      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 omitted_from_state
+      []
+    end
+
+    def key
       # initialize session state
       if !stimulus_reflex? || session[@key].nil?
         new_state = {}
@@ -124,15 +142,19 @@ module ViewComponentReflex
         blacklist = [
           :@view_context, :@lookup_context, :@view_renderer, :@view_flow,
           :@virtual_path, :@variant, :@current_template, :@output_buffer, :@key,
-          :@helpers, :@controller, :@request
+          :@helpers, :@controller, :@request, :@content
         ]
         instance_variables.reject { |k| blacklist.include?(k) }.each do |k|
-          new_state[k] = instance_variable_get(k)
+          new_state[k] = instance_variable_get(k) unless omitted_from_state.include?(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|
-          instance_variable_set(k, v)
+          unless permit_parameter?(initial_state[k], instance_variable_get(k))
+            instance_variable_set(k, v)
+          end
         end
       end
       @key

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 = '1.0.0'
+  VERSION = '1.3.0'
 end

metadata

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