Add rationale for Rails/FilePath rule #128
Conversation
This was previously included in the documentation before rubocop-rails was split off from Rubocop: https://web.archive.org/web/20180307163045/https://rubocop.readthedocs.io/en/latest/cops_rails/#railsfilepath
|
It has been updated by the PR rubocop/rubocop#5835.
Rails.root.class #=> PathnameIt seems that Therefore, I'm considering changing the |
ghost
deleted the
|
Thanks for your response :) |
This PR changes default of `EnforcedStyle` from `arguments` to `slashes` for `Rails/FilePath`. The following is why `slashes` by default. -`Rails.root` is an instance of `Pathname`, so the separator (`/`) works for example on the Windows platform. - Since it can be expressed by a single string, the number of string instances can be reduced. - Clarified because the argument is fixed to one. `EnforcedStyle`'s default was `arguments` because it was mainly due to Windows platform considerations, but it seems to have been a mistake. rubocop#128 (comment)
This PR changes default of `EnforcedStyle` from `arguments` to `slashes` for `Rails/FilePath`. The following is why `slashes` by default. - `Rails.root` is an instance of `Pathname`, so the separator (`/`) works for example on the Windows platform. - Since it can be expressed by a single string, the number of string instances can be reduced. - Clarified because the argument is fixed to one. `EnforcedStyle`'s default was `arguments` because it was mainly due to Windows platform considerations, but it seems to have been a mistake. rubocop#128 (comment)
This PR changes default of `EnforcedStyle` from `arguments` to `slashes` for `Rails/FilePath`. The following is why `slashes` by default. - `Rails.root` is an instance of `Pathname`, so the separator (`/`) works for example on the Windows platform. - Since it can be expressed by a single string, the number of string instances can be reduced. - Clarified because the argument is fixed to one. `EnforcedStyle`'s default was `arguments` because it was mainly due to Windows platform considerations, but it seems to have been a mistake. rubocop#128 (comment)
|
regardless of if it works for you this is a significant departure, likely depending on ruby internals, or OS quirks. As a multi-OS user, I can remember windows not working with a This is resulting in a number of pointless changes, which at best reads like a litany of errors, from what is often considered to be best practice across multiple other languages. File.join while superficially similar to just adding a '/', presents clarity for the reader as they can see each level in a hierarchy of folders. It fixes a case of accidentally entering consider given when then vs when then vs when then It's basing decisions on quirks (which may well work), but are not the the standard expected by a potential OS. |
In the gem bump for rubocop-rails to 2.4.1 the default EnforcementStyle
changed from arguments to slashes. That means that
`Rails.root.join('config', 'controlled_vocabularies', '*.yml')` becomes
`Rails.root.join('config/controlled_vocabularies/*.yml')`. It was
[previously thought](rubocop/rubocop-rails#128 (comment))
that the first way was OS agnostic but it turns out that Rails.root is a
Pathname instance which accounts for this. Now the slash is prefered for
fewer strings/arguments.
In the gem bump for rubocop-rails to 2.4.1 the default EnforcementStyle
changed from arguments to slashes. That means that
`Rails.root.join('config', 'controlled_vocabularies', '*.yml')` becomes
`Rails.root.join('config/controlled_vocabularies/*.yml')`. It was
[previously thought](rubocop/rubocop-rails#128 (comment))
that the first way was OS agnostic but it turns out that Rails.root is a
Pathname instance which accounts for this. Now the slash is prefered for
fewer strings/arguments.
* Bump rubocop-rails from 2.3.2 to 2.4.1 Bumps [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails) from 2.3.2 to 2.4.1. - [Release notes](https://github.com/rubocop-hq/rubocop-rails/releases) - [Changelog](https://github.com/rubocop-hq/rubocop-rails/blob/master/CHANGELOG.md) - [Commits](rubocop/rubocop-rails@v2.3.2...v2.4.1) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> * Rails/FilePath default changed to slashes In the gem bump for rubocop-rails to 2.4.1 the default EnforcementStyle changed from arguments to slashes. That means that `Rails.root.join('config', 'controlled_vocabularies', '*.yml')` becomes `Rails.root.join('config/controlled_vocabularies/*.yml')`. It was [previously thought](rubocop/rubocop-rails#128 (comment)) that the first way was OS agnostic but it turns out that Rails.root is a Pathname instance which accounts for this. Now the slash is prefered for fewer strings/arguments. Co-authored-by: pgwillia <tricia.g.jenkins@gmail.com>
I thought so too and so did many people in the Ruby community, but it turns out that it is not the case.
You are right, However, when your paths are not variables but strings like so: File.join('/', '/var/', somevar)
File.join('/usr', 'var', 'logs', 'myapp', 'daily', somevar)It doesn’t make much practical sense here to split this in multiple Strings. It can be simply written: File.join('/var', somevar)
File.join('/usr/var/logs/myapp/daily', somevar) |
This was previously included in the documentation before rubocop-rails was split off from Rubocop: https://web.archive.org/web/20180307163045/https://rubocop.readthedocs.io/en/latest/cops_rails/#railsfilepath