Class: RuboCop::Cop::Style::ExpandPathArguments

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/style/expand_path_arguments.rb

Overview

This cop checks for use of the `File.expand_path` arguments. Likewise, it also checks for the `Pathname.new` argument.

Contrastive bad case and good case are alternately shown in the following examples.

Examples:

# bad
File.expand_path('..', __FILE__)

# good
File.expand_path(__dir__)

# bad
File.expand_path('../..', __FILE__)

# good
File.expand_path('..', __dir__)

# bad
File.expand_path('.', __FILE__)

# good
File.expand_path(__FILE__)

# bad
Pathname(__FILE__).parent.expand_path

# good
Pathname(__dir__).expand_path

# bad
Pathname.new(__FILE__).parent.expand_path

# good
Pathname.new(__dir__).expand_path

Constant Summary collapse

MSG =
'Use `expand_path(%<new_path>s%<new_default_dir>s)` instead of ' \
'`expand_path(%<current_path>s, __FILE__)`.'
PATHNAME_MSG =
'Use `Pathname(__dir__).expand_path` instead of ' \
'`Pathname(__FILE__).parent.expand_path`.'
PATHNAME_NEW_MSG =
'Use `Pathname.new(__dir__).expand_path` ' \
'instead of ' \
'`Pathname.new(__FILE__).parent.expand_path`.'
RESTRICT_ON_SEND =
%i[expand_path].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

#exclude_limit

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_uncorrectable?, #safe_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

This class inherits a constructor from RuboCop::Cop::Base

Instance Method Details

#file_expand_path(node) ⇒ Object


58
59
60
61
62
63
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 58

def_node_matcher :file_expand_path, <<~PATTERN
  (send
    (const {nil? cbase} :File) :expand_path
    $_
    $_)
PATTERN

#on_send(node) ⇒ Object


82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 82

def on_send(node)
  if (current_path, default_dir = file_expand_path(node))
    inspect_offense_for_expand_path(node, current_path, default_dir)
  elsif (default_dir = pathname_parent_expand_path(node))
    return unless unrecommended_argument?(default_dir)

    add_offense(node, message: PATHNAME_MSG) { |corrector| autocorrect(corrector, node) }
  elsif (default_dir = pathname_new_parent_expand_path(node))
    return unless unrecommended_argument?(default_dir)

    add_offense(node, message: PATHNAME_NEW_MSG) do |corrector|
      autocorrect(corrector, node)
    end
  end
end

#pathname_new_parent_expand_path(node) ⇒ Object


74
75
76
77
78
79
80
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 74

def_node_matcher :pathname_new_parent_expand_path, <<~PATTERN
  (send
    (send
      (send
        (const {nil? cbase} :Pathname) :new
        $_) :parent) :expand_path)
PATTERN

#pathname_parent_expand_path(node) ⇒ Object


66
67
68
69
70
71
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 66

def_node_matcher :pathname_parent_expand_path, <<~PATTERN
  (send
    (send
      (send nil? :Pathname
        $_) :parent) :expand_path)
PATTERN