Merge pull request #554 from github/549-collection-private-method-format

Fix bug rendering component collections from controllers

Author: joelhawksley

.github/workflows/ci.yml

@@ -34,13 +34,15 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        rails_version: [5.0.0, 5.2.3, 6.0.0, master]
+        rails_version: [5.0.0, 5.2.3, 6.0.0, 6.1.0, master]
         ruby_version: [2.4.x, 2.5.x, 2.6.x, 2.7.x]
         exclude:
-          - rails_version: master
-            ruby_version: 2.4.x
           - rails_version: 6.0.0
             ruby_version: 2.4.x
+          - rails_version: 6.1.0
+            ruby_version: 2.4.x
+          - rails_version: master
+            ruby_version: 2.4.x
     steps:
     - uses: actions/checkout@master
     - name: Setup Ruby

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+* Fix bug where rendering a component `with_collection` from a controller raised an error.
+
+    *Joel Hawksley*
+
 ## 2.23.1
 
 * Fixed out-of-order rendering bug in `ActionView::SlotableV2`

lib/view_component/collection.rb

@@ -4,14 +4,17 @@
 
 module ViewComponent
   class Collection
+    attr_reader :component
+    delegate :format, to: :component
+
     def render_in(view_context, &block)
       iterator = ActionView::PartialIteration.new(@collection.size)
 
-      @component.compile(raise_errors: true)
-      @component.validate_collection_parameter!(validate_default: true)
+      component.compile(raise_errors: true)
+      component.validate_collection_parameter!(validate_default: true)
 
       @collection.map do |item|
-        content = @component.new(**component_options(item, iterator)).render_in(view_context, &block)
+        content = component.new(**component_options(item, iterator)).render_in(view_context, &block)
         iterator.iterate!
         content
       end.join.html_safe
@@ -34,8 +37,8 @@ def collection_variable(object)
     end
 
     def component_options(item, iterator)
-      item_options = { @component.collection_parameter => item }
-      item_options[@component.collection_counter_parameter] = iterator.index + 1 if @component.counter_argument_present?
+      item_options = { component.collection_parameter => item }
+      item_options[component.collection_counter_parameter] = iterator.index + 1 if component.counter_argument_present?
 
       @options.merge(item_options)
     end

test/app/controllers/integration_examples_controller.rb

@@ -34,4 +34,10 @@ def controller_to_string_render_component
   def products
     @products = [OpenStruct.new(name: "Radio clock"), OpenStruct.new(name: "Mints")]
   end
+
+  def inline_products
+    products = [OpenStruct.new(name: "Radio clock"), OpenStruct.new(name: "Mints")]
+
+    render(ProductComponent.with_collection(products, notice: "Today only"))
+  end
 end

test/config/routes.rb

@@ -9,6 +9,7 @@
   get :content, to: "integration_examples#content"
   get :variants, to: "integration_examples#variants"
   get :products, to: "integration_examples#products"
+  get :inline_products, to: "integration_examples#inline_products"
   get :cached, to: "integration_examples#cached"
   get :render_check, to: "integration_examples#render_check"
   get :controller_inline, to: "integration_examples#controller_inline"

test/view_component/integration_test.rb

@@ -330,6 +330,17 @@ def test_renders_collections
     assert_select("p", text: "Mints counter: 2")
   end
 
+  def test_renders_inline_collections
+    get "/inline_products"
+
+    assert_select("h1", text: "Product", count: 2)
+    assert_select("h2", text: "Radio clock")
+    assert_select("h2", text: "Mints")
+    assert_select("p", text: "Today only", count: 2)
+    assert_select("p", text: "Radio clock counter: 1")
+    assert_select("p", text: "Mints counter: 2")
+  end
+
   def test_renders_the_previews_in_the_configured_route
     with_preview_route("/previews") do
       get "/previews"