Update documentation around fixture paths #48512
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
This was referenced Jun 19, 2023
adrianna-chang-shopify
approved these changes
Jun 19, 2023
There was a problem hiding this comment.
Doc changes all look good to me! ❤️
I noticed while reviewing that the deprecation messages around the existing fixture_path methods could use adjusting (e.g. we should use TestFixtures.fixture_path is deprecated instead of TestFixtures#fixture_path is deprecated for the class method, the setter message refers to the getter method, etc...), so I'll open a small PR to tweak those.
2 tasks
gmcgibbon
approved these changes
Jun 20, 2023
Since this method has been documented in the guides for ages, it's probably safe. https://guides.rubyonrails.org/testing.html#revenge-of-the-fixtures TODO: I don't like how these methods are documented on ActionMailer::TestCase::Behavior, even though the API is meant to be exposed through ActionMailer::TestCase
This removes the deprecated .fixture_path and .fixture_path= methods from public documentation, and creates a class method for the getter and setters. Interestingly because these methods were always `class_attribute` based, which RDoc doesn't parse, they weren't technically "public" documentation.
These methods are only available when requiring the railties "rails/test_help" file, which is included by default in the test_helper.rb for newly generated Rails applications. Since requiring that file is the only way, and some applications may have removed it or not used test-unit when generating their application, I think it's worth calling out explicitly here.
* Improve the spacing of various paragraphs * Link to AS::TestCase.fixture_paths= API * Add a note about needing to require "rails/test_help" to get fixture_paths * Expanded briefly on YAML default map unordering property * Improve heading weight consistency * Unlink several RDoc autolinked things
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.
This PR makes a couple of changes, so I've broken them down atomically.
Based on what I've found from #47675, there were a couple of improvements to be made.
Please feel free to review them on a per-commit basis, starting:
fixture_paths=setter now that it's documented, and other small cleanupsPlanning to not merge this one without feedback, since it's changing the public visibility of a method and adding other possibly controversial docs.