Document the assert_turbo_stream helpers
#462
Merged
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
First, mention the `assert_turbo_stream` test helpers in the [README.md](./README.md) under a new "Testing" heading. Next, add method-level documentation to describe each helper's interface. Finally, separate the `ActionDispatch::IntegrationTest` portion of the test into a new `Turbo::TestAssertions::IntegrationTestAssertions` module that's automatically included in `ActionDispatch::IntegrationTest` when it's loaded. By separating the two, the `assert_turbo_stream` helpers can be invoked outside of an HTTP request test, while still providing a baseline implementation for when an HTTP response is available.
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.
First, mention the
assert_turbo_streamtest helpers in the README.md under a new "Testing" heading.Next, add method-level documentation to describe each helper's interface.
Finally, separate the
ActionDispatch::IntegrationTestportion of the test into a newTurbo::TestAssertions::IntegrationTestAssertionsmodule that's automatically included inActionDispatch::IntegrationTestwhen it's loaded.By separating the two, the
assert_turbo_streamhelpers can be invoked outside of an HTTP request test, while still providing a baseline implementation for when an HTTP response is available.