Rake notes compatibility in Rails 5.1.0 #1661
Merged
Conversation
This file contains hidden or 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
Rails SourceAnnotationExtractor which means when we run `rake notes` it will now also for the first time list out any todos in the `/spec` folder. This was added in this PR: rails/rails#25692 Resulting in: ```bash $ rake notes app/spec/models/article_spec.rb: * [2] [TODO] add more specs * [3] [FIXME] Spec A is broken * [4] [OPTIMIZE] improve this test ```
* just fixed the railtie As of Rails 5.1.0 gems can register a directories to work with `rake notes` In this case we can tell Rails it to now look in the `/spec` folder when searching for annotations like `# TODO:` `# FIXME` etc. This was added in this PR: rails/rails#25692 Resulting in: ```bash $ rake notes app/spec/models/article_spec.rb: * [2] [TODO] add more specs * [3] [FIXME] Spec A is broken * [4] [OPTIMIZE] improve this test ``` Thats one less daily annoyance. John
| @@ -8,6 +8,12 @@ module RSpec | |||
| module Rails | |||
| # Railtie to hook into Rails. | |||
| class Railtie < ::Rails::Railtie | |||
|
|
|||
| # As of Rails 5.1.0 you can register directories to work with `rake notes` | |||
| if Gem::Requirement.new(">= 5.1.0").satisfied_by?(Gem::Version.new(::Rails.version)) | |||
There was a problem hiding this comment.
Could you switch this away from using rubygems please? It's generally a good idea to not assume it's present, a check on the rails version string is sufficient normally (e.g. ::Rails.version >= "5.1.0").
There was a problem hiding this comment.
You can see our preferred form a few lines down in fact, so making this ::Rails::VERSION::STRING >= '5.1' would be preferred :)
* Changed the method of detecting the Rails version. * Removed extra spaces.
It works with 5.1 and greater. Not just over 5.1 :) Rails::VERSION::STRING >= '5.1'
|
Thanks ❤️ |
sebjacobs
pushed a commit
to futurelearn/rspec-rails
that referenced
this pull request
Mar 15, 2019
* As of Rails 5.1.0 gems can register a directories with the Rails `SourceAnnotationExtractor` which means when we run `rake notes` it will now also list out any todos in the `/spec` folder. This was added in this PR: rails/rails#25692 Resulting in: ```bash $ rake notes app/spec/models/article_spec.rb: * [2] [TODO] add more specs * [3] [FIXME] Spec A is broken * [4] [OPTIMIZE] improve this test ``` * In this commit: * just fixed the railtie As of Rails 5.1.0 gems can register a directories to work with `rake notes` In this case we can tell Rails it to now look in the `/spec` folder when searching for annotations like `# TODO:` `# FIXME` etc. This was added in this PR: rails/rails#25692 Resulting in: ```bash $ rake notes app/spec/models/article_spec.rb: * [2] [TODO] add more specs * [3] [FIXME] Spec A is broken * [4] [OPTIMIZE] improve this test ```
sebjacobs
pushed a commit
to futurelearn/rspec-rails
that referenced
this pull request
Mar 15, 2019
[skip ci]
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.
As of Rails 5.1.0 gems can register a directories to work with
rake notesin this case we can tell Rails it to now look in the
/specfolder when searching for annotations like# TODO:# FIXMEetc.This was added in this PR:
rails/rails#25692
Resulting in:
Thats one less daily annoyance.
John