Document Testing configuration for RSpec users #539
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
Jbuilder documentation does not guide users to any extra configuration to test the response body of a template. Searching for "Rspec" in the project, we see that there are lots of closed issues related to this issue. Although this extra configuration is not related to JBuilder, I believe this is an important thing to have in the documentation. Including a note about it in the documentation would save users hours of trying to debug JBuilder, and maintainer's hours that could be used on another features.
|
It looks like there are some flakey specs: The CI is failing even when no code changes were made. I opened an issue #540 |
K4sku
reviewed
Mar 29, 2023
Co-authored-by: Cezary Kłos <cezary.klos@gmail.com>
that-jill
referenced
this pull request
in powerhome/power-web-development-interview
May 1, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [jbuilder](https://togithub.com/rails/jbuilder) ([changelog](https://togithub.com/rails/jbuilder/releases/tag/v2.12.0)) | `2.11.5` -> `2.12.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>rails/jbuilder (jbuilder)</summary> ### [`v2.12.0`](https://togithub.com/rails/jbuilder/releases/tag/v2.12.0) [Compare Source](https://togithub.com/rails/jbuilder/compare/v2.11.5...v2.12.0) #### What's Changed - Use OpenStruct only if available by [@​yahonda](https://togithub.com/yahonda) in [https://github.com/rails/jbuilder/pull/562](https://togithub.com/rails/jbuilder/pull/562) - Replace deprecated `ProxyObject` with `BasicObject` by [@​Earlopain](https://togithub.com/Earlopain) in [https://github.com/rails/jbuilder/pull/563](https://togithub.com/rails/jbuilder/pull/563) - Avoid loading `ActionController::API` constant by [@​nvasilevski](https://togithub.com/nvasilevski) in [https://github.com/rails/jbuilder/pull/529](https://togithub.com/rails/jbuilder/pull/529) - Fixed a bug where [#​501](https://togithub.com/rails/jbuilder/issues/501) broke compatibility with Enumerable by [@​yuki24](https://togithub.com/yuki24) in [https://github.com/rails/jbuilder/pull/531](https://togithub.com/rails/jbuilder/pull/531) - Fix namespace issue when generating jbuilder views by [@​hahmed](https://togithub.com/hahmed) in [https://github.com/rails/jbuilder/pull/536](https://togithub.com/rails/jbuilder/pull/536) - Remove reliance on ERBTracker from rails by [@​HParker](https://togithub.com/HParker) in [https://github.com/rails/jbuilder/pull/504](https://togithub.com/rails/jbuilder/pull/504) - Fix require path of dependency_tracker in railtie.rb by [@​jalyna](https://togithub.com/jalyna) in [https://github.com/rails/jbuilder/pull/552](https://togithub.com/rails/jbuilder/pull/552) #### New Contributors - [@​nvasilevski](https://togithub.com/nvasilevski) made their first contribution in [https://github.com/rails/jbuilder/pull/529](https://togithub.com/rails/jbuilder/pull/529) - [@​okuramasafumi](https://togithub.com/okuramasafumi) made their first contribution in [https://github.com/rails/jbuilder/pull/526](https://togithub.com/rails/jbuilder/pull/526) - [@​berkos](https://togithub.com/berkos) made their first contribution in [https://github.com/rails/jbuilder/pull/528](https://togithub.com/rails/jbuilder/pull/528) - [@​hahmed](https://togithub.com/hahmed) made their first contribution in [https://github.com/rails/jbuilder/pull/536](https://togithub.com/rails/jbuilder/pull/536) - [@​casperisfine](https://togithub.com/casperisfine) made their first contribution in [https://github.com/rails/jbuilder/pull/550](https://togithub.com/rails/jbuilder/pull/550) - [@​jalyna](https://togithub.com/jalyna) made their first contribution in [https://github.com/rails/jbuilder/pull/552](https://togithub.com/rails/jbuilder/pull/552) - [@​yahonda](https://togithub.com/yahonda) made their first contribution in [https://github.com/rails/jbuilder/pull/562](https://togithub.com/rails/jbuilder/pull/562) - [@​Earlopain](https://togithub.com/Earlopain) made their first contribution in [https://github.com/rails/jbuilder/pull/563](https://togithub.com/rails/jbuilder/pull/563) - [@​stefannibrasil](https://togithub.com/stefannibrasil) made their first contribution in [https://github.com/rails/jbuilder/pull/539](https://togithub.com/rails/jbuilder/pull/539) **Full Changelog**: rails/jbuilder@v2.11.5...v2.12.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/powerhome/power-web-development-interview). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMjEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjMyMS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
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.
JBuilder documentation does not guide users to any extra configuration to test the response body of a template.
Searching for "Rspec" in the project, we see that there are lots of closed issues related to this issue.
Although this extra configuration is not related to JBuilder, I believe this is an important thing to have in the documentation. Users clearly need that extra guidance.
Including a note about it in the documentation would save users hours of trying to debug JBuilder, and maintainers hours that could be used on another features.
Opening this PR for a discussion. I am not sure this is the best place to put this note. Any suggestions?