123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RuboCop::Cop::AutoCorrector, ::RuboCop::Cop::Base, ::RuboCop::ExcludeLimit, NodePattern::Macros, RuboCop::AST::Sexp
Instance Chain:
Inherits: RuboCop::Cop::Base
Defined in: lib/rubocop/cop/style/expand_path_arguments.rb

Overview

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

::RuboCop::Cop::Base - Inherited

EMPTY_OFFENSES, RESTRICT_ON_SEND

::RuboCop::Cop::RangeHelp - Included

BYTE_ORDER_MARK, NOT_GIVEN

Class Attribute Summary

::RuboCop::Cop::AutoCorrector - Extended

::RuboCop::Cop::Base - Inherited

.gem_requirements, .lint?,
.support_autocorrect?

Returns if class supports autocorrect.

.support_multiple_source?

Override if your cop should be called repeatedly for multiple investigations Between calls to on_new_investigation and on_investigation_end, the result of processed_source will remain constant.

Class Method Summary

::RuboCop::Cop::Base - Inherited

.autocorrect_incompatible_with

List of cops that should not try to autocorrect at the same time as this cop.

.badge

Naming.

.callbacks_needed, .cop_name, .department,
.documentation_url

Returns an url to view this cops documentation online.

.exclude_from_registry

Call for abstract Cop classes.

.inherited,
.joining_forces

Override and return the Force class(es) you need to join.

.match?

Returns true if the cop name or the cop namespace matches any of the given names.

.new,
.requires_gem

Register a version requirement for the given gem name.

.restrict_on_send

::RuboCop::ExcludeLimit - Extended

exclude_limit

Sets up a configuration option to have an exclude limit tracked.

transform

Instance Attribute Summary

Instance Method Summary

::RuboCop::Cop::RangeHelp - Included

#add_range, #column_offset_between,
#contents_range

A range containing only the contents of a literal with delimiters (e.g.

#directions,
#effective_column

Returns the column attribute of the range, except if the range is on the first line and there’s a byte order mark at the beginning of that line, in which case 1 is subtracted from the column value.

#final_pos, #move_pos, #move_pos_str, #range_between, #range_by_whole_lines, #range_with_comments, #range_with_comments_and_lines, #range_with_surrounding_comma, #range_with_surrounding_space, #source_range

::RuboCop::Cop::Base - Inherited

#add_global_offense

Adds an offense that has no particular location.

#add_offense

Adds an offense on the specified range (or node with an expression) Unless that offense is disabled for this range, a corrector will be yielded to provide the cop the opportunity to autocorrect the offense.

#begin_investigation

Called before any investigation.

#callbacks_needed,
#cop_config

Configuration Helpers.

#cop_name, #excluded_file?,
#external_dependency_checksum

This method should be overridden when a cop’s behavior depends on state that lives outside of these locations:

#inspect
#message

Gets called if no message is specified when calling add_offense or add_global_offense Cops are discouraged to override this; instead pass your message directly.

#name

Alias for Base#cop_name.

#offenses,
#on_investigation_end

Called after all on_…​

#on_new_investigation

Called before all on_…​

#on_other_file

Called instead of all on_…​

#parse

There should be very limited reasons for a Cop to do it’s own parsing.

#parser_engine,
#ready

Called between investigations.

#relevant_file?, #target_rails_version, #target_ruby_version, #annotate, #apply_correction, #attempt_correction,
#callback_argument

Reserved for Cop::Cop.

#complete_investigation

Called to complete an investigation.

#correct, #current_corrector,
#current_offense_locations

Reserved for Commissioner:

#current_offenses, #currently_disabled_lines, #custom_severity, #default_severity, #disable_uncorrectable, #enabled_line?, #file_name_matches_any?, #find_message, #find_severity, #range_for_original, #range_from_node_or_range,
#reset_investigation

Actually private methods.

#use_corrector

::RuboCop::Cop::AutocorrectLogic - Included

::RuboCop::Cop::IgnoredNode - Included

Constructor Details

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

Instance Method Details

#arguments_range(node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 189

def arguments_range(node)
  range_between(node.parent.first_argument.source_range.begin_pos,
                node.parent.last_argument.source_range.end_pos)
end

#autocorrect(corrector, node) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 100

def autocorrect(corrector, node)
  if (current_path, default_dir = file_expand_path(node))
    autocorrect_expand_path(corrector, current_path, default_dir)
  elsif (dir = pathname_parent_expand_path(node) || pathname_new_parent_expand_path(node))
    corrector.replace(dir, '__dir__')
    remove_parent_method(corrector, dir)
  end
end

#autocorrect_expand_path(corrector, current_path, default_dir) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 135

def autocorrect_expand_path(corrector, current_path, default_dir)
  stripped_current_path = strip_surrounded_quotes!(current_path.source)

  case depth(stripped_current_path)
  when 0
    range = arguments_range(current_path)

    corrector.replace(range, '__FILE__')
  when 1
    range = arguments_range(current_path)

    corrector.replace(range, '__dir__')
  else
    new_path = "'#{parent_path(stripped_current_path)}'"

    corrector.replace(current_path, new_path)
    corrector.replace(default_dir, '__dir__')
  end
end

#depth(current_path) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 162

def depth(current_path)
  paths = current_path.split(File::SEPARATOR)

  paths.count { |path| path != '.' }
end

#file_expand_path(node)

[ GitHub ]

  
# 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

#inspect_offense_for_expand_path(node, current_path, default_dir) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 113

def inspect_offense_for_expand_path(node, current_path, default_dir)
  return unless unrecommended_argument?(default_dir) && current_path.str_type?

  current_path = strip_surrounded_quotes!(current_path.source)

  parent_path = parent_path(current_path)
  new_path = parent_path == '' ? '' : "'#{parent_path}', "

  new_default_dir = depth(current_path).zero? ? '__FILE__' : '__dir__'

  message = format(
    MSG,
    new_path: new_path,
    new_default_dir: new_default_dir,
    current_path: "'#{current_path}'"
  )

  add_offense(node.loc.selector, message: message) do |corrector|
    autocorrect(corrector, node)
  end
end

#on_send(node)

[ GitHub ]

  
# 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

#parent_path(current_path) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 168

def parent_path(current_path)
  paths = current_path.split(File::SEPARATOR)

  paths.delete('.')
  paths.each_with_index do |path, index|
    if path == '..'
      paths.delete_at(index)
      break
    end
  end

  paths.join(File::SEPARATOR)
end

#pathname_new_parent_expand_path(node)

[ GitHub ]

  
# 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)

[ GitHub ]

  
# 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

#remove_parent_method(corrector, default_dir) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 182

def remove_parent_method(corrector, default_dir)
  node = default_dir.parent.parent.parent.children.first

  corrector.remove(node.loc.dot)
  corrector.remove(node.loc.selector)
end

#strip_surrounded_quotes!(path_string) (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 155

def strip_surrounded_quotes!(path_string)
  path_string.slice!(path_string.length - 1)
  path_string.slice!(0)

  path_string
end

#unrecommended_argument?(default_dir) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/rubocop/cop/style/expand_path_arguments.rb', line 109

def unrecommended_argument?(default_dir)
  default_dir.source == '__FILE__'
end