view_component_reflex 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42797141d9ed8ecfb013f8f68c9e073b9ee6db4fe4eb04f1c7484babbd2c4e06
-  data.tar.gz: 9dfb73b083e7e1ac3417a676f37962c1861435310e0f04934d16cea5824f6eb3
+  metadata.gz: aed815b44b0d4708ba9bb85e9a08912f15f4d66442432df5d0933866f66e3aba
+  data.tar.gz: 96262b95434700007b142be8411d115dc50cdd0d5b94baf5200b582317ce858b
 SHA512:
-  metadata.gz: 4505fedd6b66cf2e5b31fe3cdeb8ec3b337a0c6b8de79082926d637c39dd74770b562280ae6f61bc79f434b2184e993c706dcd7fac088d436b185e56228f7d28
-  data.tar.gz: ed2b650393469281ecd997a7589f6e9999a1aeda25e624193c54c61c1d7e7b78b012718945c409c5db8db86588a7ea64e1be547a4d351e92b377329eef1d7e18
+  metadata.gz: 8cdd11ece267f4cc206af3e12d3e62b4881fdde56afb28a23b078437448842eb54e7aa1da43a68dd4f071544bb360e95c15db2b4ea4599da9ee7e57e7887a2d8
+  data.tar.gz: 64c8053422748319fd6460881170c3b5a9b84da0577180ebbf8a3dd3e62e5b1563c5d9e17c617de798141466f85894b42b281377aa553ff9a3840d9c522564d8

data/README.md

@@ -39,7 +39,7 @@ end
 In order to reconcile state to components in collections, you can specify a `collection_key` method that returns some
 value unique to that component.
 
-```
+```ruby
 class TodoComponent < ViewComponentReflex::Component
   def initialize(todo:)
     @todo = todo
@@ -53,6 +53,134 @@ 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.
+
+```ruby
+def permit_parameter?(initial_param, new_param)
+  if new_param.instance_of? MyModel 
+    new_param.id == @my_model.id
+  else
+    super
+  end
+end
+```
+
+### 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.
+
+```ruby
+def omitted_from_state
+  [:@form]
+end
+```
+
+### reflex_tag(reflex, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+This shares the same definition as `content_tag`, except it accepts a reflex as the first parameter.
+
+```erb
+<%= reflex_tag :increment, :button, "Click me!" %>
+```
+
+Would add a click handler to the `increment` method on your component.
+
+To use a non-click event, specific that with `->` notiation
+
+```erb
+<%= reflex_tag "mouseenter->increment", :button, "Click me!" %>
+```
+
+### 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.
+
+```ruby
+def initialize
+  @my_model = MyModel.new
+end
+
+def collection_key
+ @my_model.id
+end
+```
+
+### prevent_refresh!
+By default, VCR will re-render your component after it executes your method. `revent_refresh!` prevents this from happening.
+
+```ruby
+def my_method
+  prevent_refresh!
+  @foo = Lbar
+end # the rendered page will not reflect this change
+```
+
+### refresh_all!
+Refresh the entire body of the page
+
+```ruby
+def do_some_global_action
+  prevent_refresh!
+  session[:model] = MyModel.new
+  refresh_all!
+end
+```
+
+### key
+This is a key unique to a particular component. It's used to reconcile state between renders, and should be passed as a data attribute whenever a reflex is called
+
+```erb
+<button type="button" data-reflex="click->MyComponent#do_something" data-key="<%= key %>">Click me!</button>
+```
+
+### component_controller(options = {}, &blk)
+This is a view helper to properly connect VCR to the component. It outputs `<div data-controller="my-controller" key=<%= key %></div>`
+You *must* wrap your component in this for everything to work properly.
+
+```erb
+<%= component_controller do %>
+  <p><%= @count %></p
+<% end %>
+```
+
+## Common patterns
+A lot of the time, you only need to update specific components when changing instance variables. For example, changing `@loading` might only need
+to display a spinner somewhere on the page. You can define setters to implicitly render the appropriate pieces of dom whenever that variable is set
+
+```ruby
+def initialize
+  @loading = false
+end
+
+def loading=(new_value)
+  @loading = new_value
+  refresh! '#loader'
+end
+
+def do_expensive_action
+  prevent_refresh! 
+
+  self.loading = true
+  execute_it
+  self.loading = false
+end
+```
+
+```erb
+<%= component_controller do %>
+  <div id="loader"> 
+    <% if @loading %>
+      <p>Loading...</p>
+    <% end %>
+  </div>
+
+  <button type="button" data-reflex="click->MyComponent#do_expensive_action" data-key="<%= key %>">Click me!</button>
+<% end
+```
+
 ## Custom State Adapters
 
 ViewComponentReflex uses session for its state by default. To change this, add
@@ -76,13 +204,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

@@ -43,7 +43,11 @@ module ViewComponentReflex
               component.instance_variable_set(k, v)
             end
             name.to_proc.call(component, *args)
-            refresh!
+            refresh! unless @prevent_refresh
+          end
+
+          def prevent_refresh!
+            @prevent_refresh = true
           end
 
           define_method :component_class do
@@ -62,7 +66,7 @@ module ViewComponentReflex
             return @component if @component
             @component = component_class.allocate
             reflex = self
-            exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller]
+            exposed_methods = [:params, :request, :element, :refresh!, :refresh_all!, :stimulus_controller, :session, :prevent_refresh!]
             exposed_methods.each do |meth|
               @component.define_singleton_method(meth) do |*a|
                 reflex.send(meth, *a)
@@ -72,7 +76,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
@@ -100,6 +104,7 @@ module ViewComponentReflex
 
     def component_controller(opts = {}, &blk)
       self.class.init_stimulus_reflex
+      init_key
       opts[:data] = {
         controller: self.class.stimulus_controller,
         key: key,
@@ -108,23 +113,49 @@ module ViewComponentReflex
       content_tag :div, capture(&blk), opts
     end
 
-    def collection_key
-      nil
-    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
+    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
-      if @key.nil? || @key.empty?
-        @key = key
+      @key = key
+    end
+
+    def reflex_tag(reflex, name, content_or_options_with_block = nil, options = nil, escape = true, &block)
+      action, method = reflex.split("->")
+      if method.nil?
+        method = action
+        action = "click"
       end
+      data_attributes = {
+        reflex: "#{action}->#{self.class.name}##{method}",
+        key: key
+      }
+      if content_or_options_with_block.is_a?(Hash)
+        merge_data_attributes(content_or_options_with_block, data_attributes)
+      else
+        merge_data_attributes(options, data_attributes)
+      end
+      content_tag(name, content_or_options_with_block, options, escape, &block)
+    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 = {}
@@ -133,18 +164,33 @@ 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
     end
+
+    private
+
+    def merge_data_attributes(options, attributes)
+      data = options[:data]
+      if data.nil?
+        options[:data] = attributes
+      else
+        options[:data].merge! attributes
+      end
+    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 = '1.1.0'
+  VERSION = '1.5.0'
 end

metadata

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