Add new Rails/RootPublicPath cop
#588
Closed
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
leoarnold
force-pushed
the
leoarnold/rails-root-public-path
branch
from
6f726fc
to
d3b0bc9
Compare
Instead of
```ruby
Rails.root.join('public')
Rails.root.join('public/file.pdf')
Rails.root.join('public', 'file.pdf')
```
we can use
```ruby
Rails.public_path
Rails.public_path.join('file.pdf')
Rails.public_path.join('file.pdf')
```
leoarnold
force-pushed
the
leoarnold/rails-root-public-path
branch
from
d3b0bc9
to
ce65d64
Compare
pirj
reviewed
Nov 21, 2021
|
|
||
| it "registers an offense when using `Rails.root.join('public/file.pdf')`" do | ||
| expect_offense(<<~RUBY) | ||
| Rails.root.join('public/file.pdf') |
There was a problem hiding this comment.
Will it detect "public/#{file}.pdf"?
There was a problem hiding this comment.
Not yet. Will work on that.
koic
reviewed
Nov 29, 2021
| Rails/RootPublicPath: | ||
| Description: "Favor `Rails.public_path` over `Rails.root` with `'public'`." | ||
| Enabled: pending | ||
| VersionAdded: '2.13' |
There was a problem hiding this comment.
Suggested change
| VersionAdded: '2.13' | |
| VersionAdded: '<<next>>' |
koic
reviewed
Nov 29, 2021
|
|
||
| RESTRICT_ON_SEND = %i[join].to_set.freeze | ||
|
|
||
| PATTERN = %r{^public(/|$)}.freeze |
There was a problem hiding this comment.
\A and \z would be preferable if it is unexpecting a match to a multiline.
Suggested change
| PATTERN = %r{^public(/|$)}.freeze | |
| PATTERN = %r{\Apublic(/|\z)}.freeze |
koic
reviewed
Nov 29, 2021
| @@ -484,3 +484,4 @@ | |||
| [@theunraveler]: https://github.com/theunraveler | |||
| [@pirj]: https://github.com/pirj | |||
| [@vitormd]: https://github.com/vitormd | |||
| [@leoarnold]: https://github.com/leoarnold | |||
There was a problem hiding this comment.
Account name will be auto-inserted, so it's better to remove it.
|
@leoarnold Can you rebase with the latest mater branch? |
|
@leoarnold Ping |
|
I've cherry-picked this PR into the master branch. The following can be extended later. Thank you. |
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.
Instead of
we can use
Before submitting the PR make sure the following are checked:
[Fix #issue-number](if the related issue exists).master(if not - rebase it).{change_type}_{change_description}.mdif the new code introduces user-observable changes. See changelog entry format for details.and description in grammatically correct, complete sentences.
bundle exec rake default. It executes all tests and RuboCop for itself, and generates the documentation.