Add new RSpec/FileFixture cop
#1214
Conversation
`RSpec` provides the convenience method
```ruby
file_fixture('path/some_file.csv')
```
which (by default) is equivalent to
```ruby
Rails.root.join('spec/fixtures/files/path/some_file.csv')
```
We add a cop which detects and autocorrects verbose `Rails.root`
constructions and works best in combination with
[`Rails/RootPathnameMethods`](rubocop/rubocop-rails#587).
| @@ -0,0 +1 @@ | |||
| * [#1214](https://github.com/rubocop/rubocop-rails/pull/1214): Add new `RSpec/FileFixture` cop. ([@leoarnold][]) | |||
There was a problem hiding this comment.
We're still using the old approach with just one CHANGELOG.md in this repo - it's not a major pain to merge it.
| # Rails.root.join('spec', 'fixtures', 'files', 'some_file.csv') | ||
| # | ||
| # # good | ||
| # file_fixture('../path/some_file.csv').path |
There was a problem hiding this comment.
Is path a Pathname method? I couldn't find it.
| def_node_matcher :rails_root_join, <<~PATTERN | ||
| (send | ||
| (send | ||
| (const {nil? cbase} :Rails) :root) :join (str $_)+) |
There was a problem hiding this comment.
What if it's not a literal string passed to join? E.g. a string variable or an interpolated string.
| it 'registers an offense when using ' \ | ||
| '`"\#{Rails.root}/spec/fixtures/files/some_file.csv"`' do | ||
| expect_offense(<<~RUBY) | ||
| "\#{Rails.root}/spec/fixtures/files/some_file.csv" |
There was a problem hiding this comment.
I think it's possible to write heredoc as <<~'RUBY' to avoid escaping the hash.
|
|
||
| RSpec.describe RuboCop::Cop::RSpec::FileFixture, :config do | ||
| it 'registers an offense when using ' \ | ||
| '`"\#{Rails.root}/spec/fixtures/files/some_file.csv"`' do |
There was a problem hiding this comment.
This docstring just duplicates what the example itself tells. Does it make sense to write a free-form text explaining this case?
| @@ -353,6 +353,12 @@ RSpec/ExpectOutput: | |||
| VersionAdded: '1.10' | |||
| StyleGuide: https://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/ExpectOutput | |||
|
|
|||
| RSpec/FileFixture: | |||
|
@pirj You're right. I thought RSpec had it's own I'll close here and reopen on |
RSpecprovides the convenience methodwhich (by default) is equivalent to
We add a cop which detects and autocorrects verbose
Rails.rootconstructions and works best in combination with
Rails/RootPathnameMethods.Before submitting the PR make sure the following are checked:
master(if not - rebase it).CHANGELOG.mdif the new code introduces user-observable changes.bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).If you have created a new cop:
config/default.yml.Enabled: pendinginconfig/default.yml.VersionAddedindefault/config.ymlto the next minor version.If you have modified an existing cop's configuration options:
VersionChangedinconfig/default.ymlto the next major version.