Fix "annotate models" functionality for models in subdirectories #38762
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
breville
approved these changes
Jan 27, 2021
davidsbailey
approved these changes
Jan 27, 2021
| # We have a PR opened with a fix at https://github.com/ctran/annotate_models/pull/848; | ||
| # once a version of the gem is released which includes that change, we can get rid of | ||
| # this line. | ||
| config.autoload_paths.map!(&:to_s) |
|
@Hamms I think we lost an annotation that was recently added to dashboard/app/models/featured_project.rb in this PR? |
|
oh, it's very possible that I was missing I migration when I did this. I do see that rerunning annotate now does produce an annotation on that model file |
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.
Follow-up to #37175
Since upgrading the annotate gem as part of the Rails upgrade work, we've been getting warnings indicating that the gem is unable to annotate any of our models contained in subdirectories of the
modelsdir:I discovered that this is an open bug in annotate (ctran/annotate_models#758) and in fact some other users had already done the investigation to figure out exactly what change needed to be made. I opened a PR to implement their fix (ctran/annotate_models#848), but while we wait for it to get accepted and released I figured we might as well implement a workaround.
The simple workaround is to make sure that the configuration variable containing the paths to look in for files consists of just strings and no Pathnames.
Testing story
Ran
bundle exec annotate --models; confirmed that not only does it run without generating warnings but it also successfully updates the annotations for the models it was previously warning about. I've included those updates in this PR.Reviewer Checklist: