Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add new
Rails/RootPathnameMethods
cop
`Rails.root` is an instance of `Pathname`. So instead of ```ruby File.open(Rails.root.join('db', 'schema.rb')) File.open(Rails.root.join('db', 'schema.rb'), 'w') File.read(Rails.root.join('db', 'schema.rb')) File.binread(Rails.root.join('db', 'schema.rb')) File.write(Rails.root.join('db', 'schema.rb'), content) File.binwrite(Rails.root.join('db', 'schema.rb'), content) ``` we can simply write ```ruby Rails.root.join('db', 'schema.rb').open Rails.root.join('db', 'schema.rb').open('w') Rails.root.join('db', 'schema.rb').read Rails.root.join('db', 'schema.rb').binread Rails.root.join('db', 'schema.rb').write(content) Rails.root.join('db', 'schema.rb').binwrite(content) ``` This cop works best when used together with [`Style/FileRead`](rubocop/rubocop#10261), [`Style/FileWrite`](rubocop/rubocop#10260), and [`Rails/RootJoinChain`](#586).
- Loading branch information
Showing
10 changed files
with
330 additions
and
5 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* [#587](https://github.com/rubocop/rubocop-rails/pull/587): Add new `Rails/RootPathnameMethods` cop. ([@leoarnold][]) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
developpment | ||
filetest |
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# @abstract parent class to Rails cops | ||
class Base < ::RuboCop::Cop::Base | ||
include RuboCop::Rails::Language | ||
|
||
exclude_from_registry | ||
|
||
# Invoke the original inherited hook so our cops are recognized | ||
def self.inherited(subclass) # rubocop:disable Lint/MissingSuper | ||
RuboCop::Cop::Base.inherited(subclass) | ||
end | ||
end | ||
end | ||
end | ||
end |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,189 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Cop | ||
module Rails | ||
# Use `Rails.root` IO methods instead of passing it to `File`. | ||
# | ||
# `Rails.root` is an instance of `Pathname` | ||
# so we can apply many IO methods directly. | ||
# | ||
# This cop works best when used together with | ||
# `Style/FileRead`, `Style/FileWrite` and `Rails/RootJoinChain`. | ||
# | ||
# @example | ||
# # bad | ||
# File.open(Rails.root.join('db', 'schema.rb')) | ||
# File.open(Rails.root.join('db', 'schema.rb'), 'w') | ||
# File.read(Rails.root.join('db', 'schema.rb')) | ||
# File.binread(Rails.root.join('db', 'schema.rb')) | ||
# File.write(Rails.root.join('db', 'schema.rb'), content) | ||
# File.binwrite(Rails.root.join('db', 'schema.rb'), content) | ||
# | ||
# # good | ||
# Rails.root.join('db', 'schema.rb').open | ||
# Rails.root.join('db', 'schema.rb').open('w') | ||
# Rails.root.join('db', 'schema.rb').read | ||
# Rails.root.join('db', 'schema.rb').binread | ||
# Rails.root.join('db', 'schema.rb').write(content) | ||
# Rails.root.join('db', 'schema.rb').binwrite(content) | ||
# | ||
class RootPathnameMethods < Base | ||
extend AutoCorrector | ||
|
||
MSG = '`%<rails_root>s` is a `Pathname` so you can just append `#%<method>s`.' | ||
|
||
DIR_METHODS = %i[ | ||
children | ||
delete | ||
each_child | ||
empty? | ||
entries | ||
exist? | ||
glob | ||
mkdir | ||
open | ||
rmdir | ||
unlink | ||
].to_set.freeze | ||
|
||
FILE_METHODS = %i[ | ||
atime | ||
basename | ||
binread | ||
binwrite | ||
birthtime | ||
blockdev? | ||
chardev? | ||
chmod | ||
chown | ||
ctime | ||
delete | ||
directory? | ||
dirname | ||
empty? | ||
executable? | ||
executable_real? | ||
exist? | ||
expand_path | ||
extname | ||
file? | ||
fnmatch | ||
fnmatch? | ||
ftype | ||
grpowned? | ||
join | ||
lchmod | ||
lchown | ||
lstat | ||
mtime | ||
open | ||
owned? | ||
pipe? | ||
read | ||
readable? | ||
readable_real? | ||
readlines | ||
readlink | ||
realdirpath | ||
realpath | ||
rename | ||
setgid? | ||
setuid? | ||
size | ||
size? | ||
socket? | ||
split | ||
stat | ||
sticky? | ||
symlink? | ||
sysopen | ||
truncate | ||
unlink | ||
utime | ||
world_readable? | ||
world_writable? | ||
writable? | ||
writable_real? | ||
write | ||
zero? | ||
].to_set.freeze | ||
|
||
FILE_TEST_METHODS = %i[ | ||
blockdev? | ||
chardev? | ||
directory? | ||
empty? | ||
executable? | ||
executable_real? | ||
exist? | ||
file? | ||
grpowned? | ||
owned? | ||
pipe? | ||
readable? | ||
readable_real? | ||
setgid? | ||
setuid? | ||
size | ||
size? | ||
socket? | ||
sticky? | ||
symlink? | ||
world_readable? | ||
world_writable? | ||
writable? | ||
writable_real? | ||
zero? | ||
].to_set.freeze | ||
|
||
FILE_UTILS_METHODS = %i[ | ||
chmod | ||
chown | ||
mkdir | ||
mkpath | ||
rmdir | ||
rmtree | ||
].to_set.freeze | ||
|
||
RESTRICT_ON_SEND = (DIR_METHODS + FILE_METHODS + FILE_TEST_METHODS + FILE_UTILS_METHODS).to_set.freeze | ||
|
||
def_node_matcher :pathname_method, <<~PATTERN | ||
{ | ||
(send (const {nil? cbase} :Dir) $DIR_METHODS $_ $...) | ||
(send (const {nil? cbase} {:IO :File}) $FILE_METHODS $_ $...) | ||
(send (const {nil? cbase} :FileTest) $FILE_TEST_METHODS $_ $...) | ||
(send (const {nil? cbase} :FileUtils) $FILE_UTILS_METHODS $_ $...) | ||
} | ||
PATTERN | ||
|
||
def_node_matcher :rails_root_pathname?, <<~PATTERN | ||
{ | ||
$#rails_root? | ||
(send $#rails_root? :join ...) | ||
} | ||
PATTERN | ||
|
||
def on_send(node) | ||
evidence(node) do |method, path, args, rails_root| | ||
add_offense(node, message: format(MSG, method: method, rails_root: rails_root.source)) do |corrector| | ||
replacement = "#{path.source}.#{method}" | ||
replacement += "(#{args.map(&:source).join(', ')})" unless args.empty? | ||
|
||
corrector.replace(node, replacement) | ||
end | ||
end | ||
end | ||
|
||
private | ||
|
||
def evidence(node) | ||
return if node.method?(:open) && node.parent&.send_type? | ||
return unless (method, path, args = pathname_method(node)) && (rails_root = rails_root_pathname?(path)) | ||
|
||
yield(method, path, args, rails_root) | ||
end | ||
end | ||
end | ||
end | ||
end |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# frozen_string_literal: true | ||
|
||
module RuboCop | ||
module Rails | ||
# Contains node matchers for common Rails DSL. | ||
module Language | ||
extend RuboCop::NodePattern::Macros | ||
|
||
# @!method rails?(node) | ||
def_node_matcher :rails?, <<~PATTERN | ||
(const {nil? cbase} :Rails) | ||
PATTERN | ||
|
||
# @!method rails_root?(node) | ||
def_node_matcher :rails_root?, <<~PATTERN | ||
(send #rails? {:root :public_path}) | ||
PATTERN | ||
end | ||
end | ||
end |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# frozen_string_literal: true | ||
|
||
RSpec.describe RuboCop::Cop::Rails::RootPathnameMethods, :config do | ||
{ | ||
Dir: described_class::DIR_METHODS, | ||
File: described_class::FILE_METHODS, | ||
FileTest: described_class::FILE_TEST_METHODS, | ||
FileUtils: described_class::FILE_UTILS_METHODS, | ||
IO: described_class::FILE_METHODS | ||
}.each do |receiver, methods| | ||
methods.each do |method| | ||
it "registers an offense when using `#{receiver}.#{method}(Rails.public_path)` (if arity exists)" do | ||
expect_offense(<<~RUBY) | ||
#{receiver}.#{method}(Rails.public_path) | ||
#{'^' * receiver.size}^#{'^' * method.size}^^^^^^^^^^^^^^^^^^^ `Rails.public_path` is a `Pathname` so you can just append `##{method}`. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
Rails.public_path.#{method} | ||
RUBY | ||
end | ||
|
||
it "registers an offense when using `::#{receiver}.#{method}(::Rails.root.join(...))` (if arity exists)" do | ||
expect_offense(<<~RUBY) | ||
::#{receiver}.#{method}(::Rails.root.join('db', 'schema.rb')) | ||
^^#{'^' * receiver.size}^#{'^' * method.size}^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `::Rails.root` is a `Pathname` so you can just append `##{method}`. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
::Rails.root.join('db', 'schema.rb').#{method} | ||
RUBY | ||
end | ||
|
||
it "registers an offense when using `::#{receiver}.#{method}(::Rails.root.join(...), ...)` (if arity exists)" do | ||
expect_offense(<<~RUBY) | ||
::#{receiver}.#{method}(::Rails.root.join('db', 'schema.rb'), 20, 5) | ||
^^#{'^' * receiver.size}^#{'^' * method.size}^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `::Rails.root` is a `Pathname` so you can just append `##{method}`. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
::Rails.root.join('db', 'schema.rb').#{method}(20, 5) | ||
RUBY | ||
end | ||
end | ||
end | ||
|
||
# This is handled by `Rails/RootJoinChain` | ||
it 'does not register an offense when using `File.read(Rails.root.join(...).join(...))`' do | ||
expect_no_offenses(<<~RUBY) | ||
File.read(Rails.root.join('db').join('schema.rb')) | ||
RUBY | ||
end | ||
|
||
# This is handled by `Style/FileRead` | ||
it 'does not register an offense when using `File.open(Rails.root.join(...)).read`' do | ||
expect_no_offenses(<<~RUBY) | ||
File.open(Rails.root.join('db', 'schema.rb')).read | ||
RUBY | ||
end | ||
|
||
# This is handled by `Style/FileRead` | ||
it 'does not register an offense when using `File.open(Rails.root.join(...)).binread`' do | ||
expect_no_offenses(<<~RUBY) | ||
File.open(Rails.root.join('db', 'schema.rb')).binread | ||
RUBY | ||
end | ||
|
||
# This is handled by `Style/FileWrite` | ||
it 'does not register an offense when using `File.open(Rails.root.join(...)).write(content)`' do | ||
expect_no_offenses(<<~RUBY) | ||
File.open(Rails.root.join('db', 'schema.rb')).write(content) | ||
RUBY | ||
end | ||
|
||
# This is handled by `Style/FileWrite` | ||
it 'does not register an offense when using `File.open(Rails.root.join(...)).binwrite(content)`' do | ||
expect_no_offenses(<<~RUBY) | ||
File.open(Rails.root.join('db', 'schema.rb')).binwrite(content) | ||
RUBY | ||
end | ||
|
||
it 'registers an offense when using `File.open(Rails.root.join(...), ...)` inside an iterator' do | ||
expect_offense(<<~RUBY) | ||
files.map { |file| File.open(Rails.root.join('db', file), 'wb') } | ||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ `Rails.root` is a `Pathname` so you can just append `#open`. | ||
RUBY | ||
|
||
expect_correction(<<~RUBY) | ||
files.map { |file| Rails.root.join('db', file).open('wb') } | ||
RUBY | ||
end | ||
end |