Class: RuboCop::Cop::InternalAffairs::MethodNameEndWith

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

Overview

Checks potentially usage of method identifier predicates defined in rubocop-ast instead of ‘method_name.end_with?`.

Examples:

# bad
node.method_name.to_s.end_with?('=')

# good
node.assignment_method?

# bad
node.method_name.to_s.end_with?('?')

# good
node.predicate_method?

# bad
node.method_name.to_s.end_with?('!')

# good
node.bang_method?

Constant Summary collapse

MSG = 
'Use `%<method_name>s` instead of `%<method_suffix>s`.'
RESTRICT_ON_SEND = 
%i[end_with?].freeze
SUGGEST_METHOD_FOR_SUFFIX = 
{
  '=' => 'assignment_method?',
  '!' => 'bang_method?',
  '?' => 'predicate_method?'
}.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_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 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

#method_name_end_with?(node) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/rubocop/cop/internal_affairs/method_name_end_with.rb', line 41

def_node_matcher :method_name_end_with?, <<~PATTERN
  {
    (call
      (call
        $(... :method_name) :to_s) :end_with?
      $(str {"=" "?" "!"}))
    (call
      $(... :method_name) :end_with?
    $(str {"=" "?" "!"}))
  }
PATTERN

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



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

def on_send(node)
  method_name_end_with?(node) do |method_name_node, end_with_arg|
    next unless method_name_node.receiver

    preferred_method = SUGGEST_METHOD_FOR_SUFFIX[end_with_arg.value]
    range = range(method_name_node, node)
    message = format(MSG, method_name: preferred_method, method_suffix: range.source)

    add_offense(range, message: message) do |corrector|
      corrector.replace(range, preferred_method)
    end
  end
end