Rename accessor method name: rendered_component => rendered_content (V…

…iewComponent#1372) * Rename accessor method name: rendered_component => rendered_content In ViewComponent#1347, rendered component has been renamed to rendered content. But its method name seems to be the same as before. * s/rendered_component/rendered_content/ in guide * Update docs/CHANGELOG.md * Update docs/CHANGELOG.md * Update docs/CHANGELOG.md Co-authored-by: Joel Hawksley <joelhawksley@github.com>
claudiob · Jan 3, 2024 · f7afcd1 · f7afcd1
1 parent a2338e0
commit f7afcd1
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 5 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -9,6 +9,10 @@ title: Changelog
 
 ## main
 
+* Rename private accessor `rendered_component` to `rendered_content`.
+
+    *Yoshiyuki Hirano*, *Simon Dawson*
+
 ## 2.56.0
 
 * Introduce experimental `render_preview` test helper. Note: `@rendered_component` in `TestHelpers` has been renamed to `@rendered_content`.

diff --git a/docs/guide/testing.md b/docs/guide/testing.md
@@ -66,13 +66,13 @@ def test_render_component
 end
 ```
 
-Alternatively, assert against the raw output of the component, which is exposed as `rendered_component`:
+Alternatively, assert against the raw output of the component, which is exposed as `rendered_content`:
 
 ```ruby
 def test_render_component
   render_inline(ExampleComponent.new(title: "my title")) { "Hello, World!" }
 
-  assert_includes rendered_component, "Hello, World!"
+  assert_includes rendered_content, "Hello, World!"
 end
 ```
 
@@ -202,9 +202,9 @@ RSpec.describe ExampleComponent, type: :component do
   it "renders component" do
     render_inline(described_class.new(title: "my title")) { "Hello, World!" }
 
-    expect(rendered_component).to have_css "span[title='my title']", text: "Hello, World!"
+    expect(rendered_content).to have_css "span[title='my title']", text: "Hello, World!"
     # or, to just assert against the text
-    expect(rendered_component).to have_text "Hello, World!"
+    expect(rendered_content).to have_text "Hello, World!"
   end
 end
 ```

diff --git a/lib/view_component/test_helpers.rb b/lib/view_component/test_helpers.rb
@@ -30,7 +30,7 @@ def refute_component_rendered
     end
 
     # @private
-    attr_reader :rendered_component
+    attr_reader :rendered_content
 
     # Render a component inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used: