Class: RuboCop::Cop::InternalAffairs::MethodNameEqual

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

Overview

Checks that method names are checked using ‘method?` method.

Examples:

# bad
node.method_name == :do_something

# good
node.method?(:do_something)

# bad
node.method_name != :do_something

# good
!node.method?(:do_something)

Constant Summary collapse

MSG = 
'Use `%<prefer>s` instead.'
RESTRICT_ON_SEND = 
%i[== !=].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(node) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/rubocop/cop/internal_affairs/method_name_equal.rb', line 28

def_node_matcher :method_name, <<~PATTERN
  (send
    (send
      (...) :method_name) {:== :!=}
    $_)
PATTERN

#on_send(node) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/rubocop/cop/internal_affairs/method_name_equal.rb', line 35

def on_send(node)
  method_name(node) do |method_name_arg|
    bang = node.method?(:!=) ? '!' : ''
    prefer = "#{bang}#{node.receiver.receiver.source}.method?(#{method_name_arg.source})"
    message = format(MSG, prefer: prefer)

    add_offense(node, message: message) do |corrector|
      corrector.replace(node, prefer)
    end
  end
end