Add "Testing View Partials" section to the Testing Guides #49193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
seanpdoyle
force-pushed
the
action-view-test-case-documentation
branch
2 times, most recently
from
c93fdff
to
51348d4
Compare
|
@skipkayhil if you're available, I would appreciate some review on these changes. |
|
@zzak since they're largely documentation based, would you be interested in reviewing these changes? |
Motivation / Background --- While the `ActionView::TestCase` class isn't marked with a `:nodoc:` comment to indicate that it's internal to Rails, there isn't much content in the guides that explains how to test view partials. Libraries like [view_component](https://github.com/ViewComponent/view_component/) have [built-in support for testing](https://viewcomponent.org/guide/testing.html), including Capybara integration. While `ActionView::TestCase` already integrates with `rails-dom-testing`, that integration could be better documented. Additionally, it wouldn't take much for consuming applications to mimic the ViewComponent testing experience for their Action View Partials. Details --- First, link to the "Testing Rails Applications" page from the `ActionView::TestCase` class documentation. Next, add a "Testing View Partials" section to the guides that expands upon the variety of tooling available to tests that inherit from `ActionView::TestCase`. In that section, cover topics like: * the `render` helper method * the `rendered` helper attribute reader * calls to `assert_select` with attribute placeholders * the `document_root_element` helper method * integration with Ruby's Pattern Matching * opportunities to integrate with Capybara Additional Information --- Additionally, add test coverage that exercise the examples shared in the new section, including: * Calls to `assert_select` that utilize attribute placeholders * Ruby 3.0's Pattern Matching * Integration with Capybara
seanpdoyle
force-pushed
the
action-view-test-case-documentation
branch
from
51348d4
to
a9148b4
Compare
adrianna-chang-shopify
approved these changes
Sep 13, 2023
Co-authored-by: Adrianna Chang <adrianna.chang@shopify.com>
|
@adrianna-chang-shopify thank you for the review! If you're interested, #49194 is related and in need of review. |
|
@seanpdoyle I'm not always able to read every notification from GitHub, in the future you can ping me on discord/slack/email 🙏 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation / Background
While the
ActionView::TestCaseclass isn't marked with a:nodoc:comment to indicate that it's internal to Rails, there isn't much content in the guides that explains how to test view partials.Libraries like view_component have built-in support for testing, including Capybara integration.
While
ActionView::TestCasealready integrates withrails-dom-testing, that integration could be better documented. Additionally, it wouldn't take much for consuming applications to mimic the ViewComponent testing experience for their Action View Partials.Detail
First, link to the "Testing Rails Applications" page from the
ActionView::TestCaseclass documentation.Next, add a "Testing View Partials" section to the guides that expands upon the variety of tooling available to tests that inherit from
ActionView::TestCase. In that section, cover topics like:renderhelper methodrenderedhelper attribute readerassert_selectwith attribute placeholdersdocument_root_elementhelper methodAdditional information
Additionally, add test coverage that exercise the examples shared in the new section, including:
assert_selectthat utilize attribute placeholdersChecklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]