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

Inherits:
Cop
  • Object
show all
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`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, #correct, department, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 92

def autocorrect(node)
  lambda do |corrector|
    if (captured_values = file_expand_path(node))
      current_path, default_dir = captured_values

      autocorrect_expand_path(corrector, current_path, default_dir)
    elsif (default_dir = pathname_parent_expand_path(node)) ||
          (default_dir = pathname_new_parent_expand_path(node))
      corrector.replace(default_dir.loc.expression, '__dir__')
      remove_parent_method(corrector, default_dir)
    end
  end
end

#on_send(node) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 76

def on_send(node)
  if (captured_values = file_expand_path(node))
    current_path, default_dir = captured_values

    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)
  elsif (default_dir = pathname_new_parent_expand_path(node))
    return unless unrecommended_argument?(default_dir)

    add_offense(node, message: PATHNAME_NEW_MSG)
  end
end