view_component 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca0004a178e80b26bc7c47af5ef2dab32cdb4f3c61d09a1b27e593cf8ec4f5ea
-  data.tar.gz: 16427ce66ee5872627dafd670799fe19c42bfec499163dcbbe4e643a0e3b34fc
+  metadata.gz: 026e6dbe1f96cf8fb5d6127b756a5f78733e5918df2f9785972208866e755fd7
+  data.tar.gz: cbab7c479e82b0d5445e6bdcfa7c2526e409b302283c601cc21c2df8e32f6ed9
 SHA512:
-  metadata.gz: 7ea71f48ee58741b49df4818f0717328b715a1c11ebb0ecf0771c15aabb53fc3cdb51428c0b5f85781c04f113afca98fbe152083090f9f0b518f988cd60de3e9
-  data.tar.gz: 401537d259e436c9cb0ea7e3c4dc40af6c02f69013460583b4827795f9d615d79aa510aa9472840af05edea39d689d6cd785279a82c6e1b48ebb980654c03087
+  metadata.gz: cd6a8e929dc0c9ac04c1b8ac28ccf600a22b74394af75783a901c1054372ef00c1713ac1f82ea7602633f2f9ad92d499c7ea90310a3351f6e1c7e6da3cc52924
+  data.tar.gz: dc16afe7a53dff39a9c1713d8ecb8878692dc49b5184da1fc5d733d41b46a91e8caeb9c1c0eae7aa4d396dac0269d563556d3a5932f8f31605ef4ee5b98569fa

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # master
 
+# v2.5.0
+
+* Add counter variables when rendering collections.
+
+    *Frank S*
+
+* Add the ability to access params from preview examples.
+
+    *Fabio Cantoni*
+
 # v2.4.0
 
 * Add `#render_to_string` support.

data/README.md

@@ -322,6 +322,25 @@ end
 </li>
 ```
 
+`ViewComponent` defines a counter variable matching the parameter name above, followed by `_counter`. To access this variable, add it to `initialize` as an argument:
+
+`app/components/product_component.rb`
+``` ruby
+class ProductComponent < ViewComponent::Base
+  def initialize(product:, product_counter:)
+    @product = product
+    @counter = product_counter
+  end
+end
+```
+
+`app/components/product_component.html.erb`
+``` erb
+<li>
+  <%= @counter %> <%= @product.name %>
+</li>
+```
+
 ### Sidecar assets (experimental)
 
 We're experimenting with including Javascript and CSS alongside components, sometimes called "sidecar" assets or files.
@@ -508,7 +527,7 @@ class TestComponentPreview < ViewComponent::Preview
   end
 
   def with_content_block
-    render(TestComponent.new(title: "This component accepts a block of content") do
+    render(TestComponent.new(title: "This component accepts a block of content")) do
       tag.div do
         content_tag(:span, "Hello")
       end
@@ -521,6 +540,19 @@ Which generates <http://localhost:3000/rails/view_components/test_component/with
 <http://localhost:3000/rails/view_components/test_component/with_long_title>,
 and <http://localhost:3000/rails/view_components/test_component/with_content_block>.
 
+It's also possible to set dynamic values from the params by setting them as arguments:
+
+`test/components/previews/test_component_preview.rb`
+```ruby
+class TestComponentPreview < ViewComponent::Preview
+  def with_dynamic_title(title: "Test component default")
+    render(TestComponent.new(title: title))
+  end
+end
+```
+
+You'll then be able to pass down a value with <http://localhost:3000/rails/components/test_component/with_dynamic_title?title=Custom+title>.
+
 The `ViewComponent::Preview` base class includes
 [`ActionView::Helpers::TagHelper`][tag-helper], which provides the [`tag`][tag]
 and [`content_tag`][content_tag] view helper methods.
@@ -648,10 +680,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/github
 |@blakewilliams|@seanpdoyle|@tclem|@nashby|@jaredcwhite|
 |Boston, MA|New York, NY|San Francisco, CA|Minsk|Portland, OR|
 
-|<img src="https://avatars.githubusercontent.com/simonrand?s=256" alt="simonrand" width="128" />|<img src="https://avatars.githubusercontent.com/fugufish?s=256" alt="fugufish" width="128" />|
-|:---:|:---:|
-|@simonrand|@fugufish|
-|Dublin, Ireland|Salt Lake City, Utah|
+|<img src="https://avatars.githubusercontent.com/simonrand?s=256" alt="simonrand" width="128" />|<img src="https://avatars.githubusercontent.com/fugufish?s=256" alt="fugufish" width="128" />|<img src="https://avatars.githubusercontent.com/cover?s=256" alt="cover" width="128" />|<img src="https://avatars.githubusercontent.com/franks921?s=256" alt="franks921" width="128" />|
+|:---:|:---:|:---:|:---:|
+|@simonrand|@fugufish|@cover|@franks921|
+|Dublin, Ireland|Salt Lake City, Utah|Barcelona|South Africa|
 
 ## License
 

data/app/controllers/rails/view_components_controller.rb

@@ -30,7 +30,7 @@ class Rails::ViewComponentsController < Rails::ApplicationController # :nodoc:
     else
       prepend_application_view_paths
       @example_name = File.basename(params[:path])
-      @render_args = @preview.render_args(@example_name)
+      @render_args = @preview.render_args(@example_name, params: params.permit!)
       layout = @render_args[:layout]
       opts = layout.nil? ? {} : { layout: layout }
       # rubocop:disable GitHub/RailsControllerRenderPathsExist

data/lib/view_component/base.rb

@@ -187,6 +187,14 @@ module ViewComponent
           templates.map { |template| template[:variant] } + variants_from_inline_calls(inline_calls)
         end
 
+        define_singleton_method(:collection_counter_parameter_name) do
+          "#{collection_parameter_name}_counter".to_sym
+        end
+
+        define_singleton_method(:counter_argument_present?) do
+          instance_method(:initialize).parameters.map(&:second).include?(collection_counter_parameter_name)
+        end
+
         # If template name annotations are turned on, a line is dynamically
         # added with a comment. In this case, we want to return a different
         # starting line number so errors that are raised will point to the

data/lib/view_component/collection.rb

@@ -1,13 +1,14 @@
-
 # frozen_string_literal: true
 
 module ViewComponent
   class Collection
     def render_in(view_context, &block)
-      as = @component.collection_parameter_name
+      iterator = ActionView::PartialIteration.new(@collection.size)
 
       @collection.map do |item|
-        @component.new(@options.merge(as => item)).render_in(view_context, &block)
+        content = @component.new(component_options(item, iterator)).render_in(view_context, &block)
+        iterator.iterate!
+        content
       end.join.html_safe
     end
 
@@ -26,5 +27,12 @@ module ViewComponent
         raise ArgumentError.new("The value of the argument isn't a valid collection. Make sure it responds to to_ary: #{object.inspect}")
       end
     end
+
+    def component_options(item, iterator)
+      item_options = { @component.collection_parameter_name => item }
+      item_options[@component.collection_counter_parameter_name] = iterator.index + 1 if @component.counter_argument_present?
+
+      @options.merge(item_options)
+    end
   end
 end

data/lib/view_component/preview.rb

@@ -19,8 +19,11 @@ module ViewComponent # :nodoc:
       end
 
       # Returns the arguments for rendering of the component in its layout
-      def render_args(example)
-        new.public_send(example).merge(layout: @layout)
+      def render_args(example, params: {})
+        example_params_names = instance_method(example).parameters.map(&:last)
+        provided_params = params.slice(*example_params_names).to_h.symbolize_keys
+        result = provided_params.empty? ? new.public_send(example) : new.public_send(example, **provided_params)
+        result.merge(layout: @layout)
       end
 
       # Returns the component object class associated to the preview.

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-16 00:00:00.000000000 Z
+date: 2020-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport