Class: RuboCop::Cop::Style::NestedFileDirname

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

Overview

Checks for nested `File.dirname`. It replaces nested `File.dirname` with the level argument introduced in Ruby 3.1.

Examples:


# bad
File.dirname(File.dirname(path))

# good
File.dirname(path, 2)

Constant Summary collapse

MSG =
'Use `dirname(%<path>s, %<level>s)` instead.'
RESTRICT_ON_SEND =
%i[dirname].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods included from AutoCorrector

support_autocorrect?

Methods included from TargetRubyVersion

minimum_target_ruby_version, required_minimum_ruby_version, support_target_ruby_version?

Methods inherited from Base

#active_support_extensions_enabled?, #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?, #autocorrect_with_disable_uncorrectable?, #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_dirname?(node) ⇒ Object


28
29
30
31
# File 'lib/rubocop/cop/style/nested_file_dirname.rb', line 28

def_node_matcher :file_dirname?, <<~PATTERN
  (send
    (const {cbase nil?} :File) :dirname ...)
PATTERN

#on_send(node) ⇒ Object


33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/rubocop/cop/style/nested_file_dirname.rb', line 33

def on_send(node)
  return if file_dirname?(node.parent) || !file_dirname?(node.first_argument)

  path, level = path_with_dir_level(node, 1)
  return if level < 2

  message = format(MSG, path: path, level: level)
  range = offense_range(node)

  add_offense(range, message: message) do |corrector|
    corrector.replace(range, "dirname(#{path}, #{level})")
  end
end