add `render_preview` test helper #1347

joelhawksley · 2022-05-04T22:59:04Z

Summary

I've documented this change thoroughly, see the diff ❤️

docs/guide/previews.md

docs/CHANGELOG.md

BlakeWilliams · 2022-05-10T14:33:33Z

lib/view_component/test_helpers.rb

@@ -41,14 +41,49 @@ def refute_component_rendered
    # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
    # @return [Nokogiri::HTML]
    def render_inline(component, **args, &block)
-      @rendered_component =
+      @rendered_content =


Super minor, but I wonder if this is being used directly by any libraries/apps and if renaming it would break anything.

I do wonder that too. I'll add a note to the changelog.

This indeed is used by lots of people! #1372 and #1373 offer two fixes.

I wonder if we should update the documentation to more explicitly direct people towards writing expectations that use page if they are using RSpec and Capybara?

expect(page).to have_link("Home page", href: root_path)

Related issue: #1375

BlakeWilliams · 2022-05-10T14:34:36Z

app/controllers/concerns/view_component/preview_actions.rb

@@ -23,6 +23,8 @@ def index
    end

    def previews
+      find_preview


Just curious, why was this change necessary?

Good question. Since we're calling previews directly from render_preview, before_action isn't called. In fact, I think we could inline find_preview here!

BlakeWilliams

I like this a lot!

Similar to how we adopted i18n, slots v2 , and other features, what are your thoughts on extracting the test functionality into it's own namespace and not include it by default? That way we can make breaking changes as/if needed without needing a major release.

Co-authored-by: Blake Williams <blakewilliams@github.com>

@camertron

In working on #1347, @camertron and I realized that it's a little strange to have our test suite in two places. In the interest of having our suite serve as an example for consumers of the framework, we decided to move everything into the sandbox application.

@camertron

* Move tests into sandbox directory In working on #1347, @camertron and I realized that it's a little strange to have our test suite in two places. In the interest of having our suite serve as an example for consumers of the framework, we decided to move everything into the sandbox application. * use more specific name for test

In ViewComponent#1347, rendered component has been renamed to rendered content. But its method name seems to be the same as before.

…1372) * Rename accessor method name: rendered_component => rendered_content In #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>

@camertron

* Move tests into sandbox directory In working on ViewComponent#1347, @camertron and I realized that it's a little strange to have our test suite in two places. In the interest of having our suite serve as an example for consumers of the framework, we decided to move everything into the sandbox application. * use more specific name for test

* clean up previews docs * RSpec not rspec * always find preview for action * rename @rendered_component to @rendered_page * Introduce `render_preview` test helper * rename rendered_page to rendered_content * rename benchmark * copy edits * re-add lookbook note * Update docs/CHANGELOG.md Co-authored-by: Blake Williams <blakewilliams@github.com> * Update docs/CHANGELOG.md Co-authored-by: Blake Williams <blakewilliams@github.com> * update depa * add note to changelog * render_preview is opt-in * fix broken reference in benchmark build * always load descendants * add Preview.load_all/load_all! * how about this? * remove duplicate before_action * Ruby 3 changed error formatting! * don't assert with period * mdlint * rename ivar * always load all previews * try this * explicitly load previews * one more try * this one? * load in engine? * uncomment load_previews call * remove call in engine Co-authored-by: Blake Williams <blakewilliams@github.com>

…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>

@camertron

* Move tests into sandbox directory In working on ViewComponent#1347, @camertron and I realized that it's a little strange to have our test suite in two places. In the interest of having our suite serve as an example for consumers of the framework, we decided to move everything into the sandbox application. * use more specific name for test

* clean up previews docs * RSpec not rspec * always find preview for action * rename @rendered_component to @rendered_page * Introduce `render_preview` test helper * rename rendered_page to rendered_content * rename benchmark * copy edits * re-add lookbook note * Update docs/CHANGELOG.md Co-authored-by: Blake Williams <blakewilliams@github.com> * Update docs/CHANGELOG.md Co-authored-by: Blake Williams <blakewilliams@github.com> * update depa * add note to changelog * render_preview is opt-in * fix broken reference in benchmark build * always load descendants * add Preview.load_all/load_all! * how about this? * remove duplicate before_action * Ruby 3 changed error formatting! * don't assert with period * mdlint * rename ivar * always load all previews * try this * explicitly load previews * one more try * this one? * load in engine? * uncomment load_previews call * remove call in engine Co-authored-by: Blake Williams <blakewilliams@github.com>

…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>

joelhawksley added 8 commits May 3, 2022 12:48

clean up previews docs

36f5acd

RSpec not rspec

c6a8578

always find preview for action

2ae1f61

rename @rendered_component to @rendered_page

598f54c

Introduce render_preview test helper

11aa0cf

rename rendered_page to rendered_content

b425fa6

rename benchmark

d425ba2

copy edits

929016b

joelhawksley requested review from juanmanuelramallo and a team as code owners May 4, 2022 22:59

Spone reviewed May 5, 2022

View reviewed changes

docs/guide/previews.md Show resolved Hide resolved

joelhawksley added 2 commits May 9, 2022 15:45

Merge branch 'main' into render_preview

dbce872

re-add lookbook note

ab62dbf

BlakeWilliams reviewed May 10, 2022

View reviewed changes

docs/CHANGELOG.md Outdated Show resolved Hide resolved

BlakeWilliams reviewed May 10, 2022

View reviewed changes

docs/CHANGELOG.md Outdated Show resolved Hide resolved

BlakeWilliams reviewed May 10, 2022

View reviewed changes

BlakeWilliams approved these changes May 10, 2022

View reviewed changes

joelhawksley and others added 12 commits May 10, 2022 09:19

Update docs/CHANGELOG.md

464d921

Co-authored-by: Blake Williams <blakewilliams@github.com>

Update docs/CHANGELOG.md

1dddf60

Co-authored-by: Blake Williams <blakewilliams@github.com>

Merge branch 'main' into render_preview

a639265

update depa

f913810

add note to changelog

bfa77c0

render_preview is opt-in

8d93e6f

Merge branch 'main' into render_preview

06e7bac

fix broken reference in benchmark build

9bdadfe

always load descendants

7b8a3fe

add Preview.load_all/load_all!

5de1d4d

Merge branch 'main' into render_preview

db91b42

how about this?

1a3eb4c

try this

45daf39

joelhawksley force-pushed the render_preview branch from 31423cb to 45daf39 Compare May 25, 2022 22:05

joelhawksley added 2 commits May 26, 2022 15:22

explicitly load previews

8fa0fc0

Merge branch 'main' into render_preview

338c3b7

joelhawksley mentioned this pull request May 26, 2022

Move tests into sandbox directory #1368

Merged

Merge branch 'main' into render_preview

f89176c

joelhawksley force-pushed the render_preview branch from 53ea6d1 to f89176c Compare May 26, 2022 22:40

joelhawksley added 6 commits May 26, 2022 16:54

one more try

95b115f

this one?

ffc855f

load in engine?

d34254c

uncomment load_previews call

5ed25ff

Merge branch 'main' into render_preview

359ea37

remove call in engine

780b0ad

joelhawksley merged commit 4bceecf into main May 31, 2022

joelhawksley deleted the render_preview branch May 31, 2022 21:02

yhirano55 mentioned this pull request Jun 1, 2022

Rename accessor method name: rendered_component => rendered_content #1372

Merged

spdawson mentioned this pull request Jun 1, 2022

Return @rendered_content from rendered_component test helper #1373

Closed

rmacklin mentioned this pull request Jun 1, 2022

Restore test coverage of rendered_content method in TestHelpers #1376

Closed

joelhawksley mentioned this pull request Jun 17, 2022

[904] Enable testing component JS interactions using new with_rendered_component_path method #1061

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add `render_preview` test helper #1347

add `render_preview` test helper #1347

joelhawksley commented May 4, 2022

BlakeWilliams May 10, 2022

joelhawksley May 11, 2022

cpjmcquillan Jun 1, 2022

rmacklin Jun 2, 2022

BlakeWilliams May 10, 2022

joelhawksley May 11, 2022

BlakeWilliams left a comment

add render_preview test helper #1347

add render_preview test helper #1347

Conversation

joelhawksley commented May 4, 2022

Summary

BlakeWilliams May 10, 2022

Choose a reason for hiding this comment

joelhawksley May 11, 2022

Choose a reason for hiding this comment

cpjmcquillan Jun 1, 2022

Choose a reason for hiding this comment

rmacklin Jun 2, 2022

Choose a reason for hiding this comment

BlakeWilliams May 10, 2022

Choose a reason for hiding this comment

joelhawksley May 11, 2022

Choose a reason for hiding this comment

BlakeWilliams left a comment

Choose a reason for hiding this comment

add `render_preview` test helper #1347

add `render_preview` test helper #1347