Class: RuboCop::Cop::InternalAffairs::LocationExists

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Defined in:
lib/rubocop/cop/internal_affairs/location_exists.rb

Overview

When a node location may not exist, ‘Node#loc?` or `Node#loc_is?` can be used instead of calling `Node#respond_to?` before using the value.

Examples:

# bad
node.loc.respond_to?(:begin)

# good
node.loc?(:begin)

# bad
node.loc.respond_to?(:begin) && node.loc.begin

# good
node.loc?(:begin)

# bad
node.loc.respond_to?(:begin) && node.loc.begin.is?('(')

# good
node.loc_is?(:begin, '(')

# bad
node.loc.respond_to?(:begin) && node.loc.begin.source == '('

# good
node.loc_is?(:begin, '(')

Constant Summary collapse

MSG = 
'Use `node.loc?` instead of `loc.respond_to?`.'
MSG_CORRECTABLE = 
'Use `%<replacement>s` instead of `%<source>s`.'
RESTRICT_ON_SEND = 
%i[respond_to?].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

#active_support_extensions_enabled?, #add_global_offense, #add_offense, #always_autocorrect?, autocorrect_incompatible_with, badge, #begin_investigation, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #contextual_autocorrect?, #cop_config, cop_name, #cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_new_investigation, #on_other_file, #parse, #parser_engine, #ready, #relevant_file?, requires_gem, #string_literals_frozen_by_default?, support_autocorrect?, support_multiple_source?, #target_gem_version, #target_rails_version, #target_ruby_version

Methods included from ExcludeLimit

cop_dir_for, #exclude_limit, read_limits

Methods included from AutocorrectLogic

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

Methods included from RuboCop::Cop::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

#loc_respond_to?(node) ⇒ Object 



43
44
45
46
47
 
# File 'lib/rubocop/cop/internal_affairs/location_exists.rb', line 43

def_node_matcher :loc_respond_to?, <<~PATTERN
  (call
    (call $_receiver :loc) :respond_to?
    $(sym _location))
PATTERN

#on_and(node) ⇒ Object 



78
79
80
 
# File 'lib/rubocop/cop/internal_affairs/location_exists.rb', line 78

def on_and(node)
  replace_with_loc(node) || replace_with_loc_is(node)
end

#on_send(node) ⇒ Object Also known as: on_csend 



82
83
84
85
86
87
88
 
# File 'lib/rubocop/cop/internal_affairs/location_exists.rb', line 82

def on_send(node)
  return if ignored_node?(node.parent)

  loc_respond_to?(node) do |receiver, location|
    register_offense(node, replacement(receiver, "loc?(#{location.source})"))
  end
end

#replaceable_with_loc(node) ⇒ Object 



69
70
71
72
73
74
75
76
 
# File 'lib/rubocop/cop/internal_affairs/location_exists.rb', line 69

def_node_matcher :replaceable_with_loc, <<~PATTERN
  (and
    (call
      (call $_receiver :loc) :respond_to?
      $(sym _location))
    (call
      (call _receiver :loc) _location))
PATTERN

#replaceable_with_loc_is(node) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rubocop/cop/internal_affairs/location_exists.rb', line 50

def_node_matcher :replaceable_with_loc_is, <<~PATTERN
  (and
    (call
      (call $_receiver :loc) :respond_to?
      $(sym _location))
    {
      (call
        (call
          (call _receiver :loc) _location) :is?
        $(str _))
      (call
        (call
          (call
            (call _receiver :loc) _location) :source) :==
            $(str _))
    })
PATTERN