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

Inherits:
Cop
  • Object
show all
Includes:
RangeHelp
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)

Constant Summary collapse

MSG = 
'Use `method?(%<method_name>s)` instead of ' \
'`method_name == %<method_name>s`.'

Constants included from Util

Util::LITERAL_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, autocorrect_incompatible_with, badge, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, #correct, department, #disable_uncorrectable, #duplicate_location?, #excluded_file?, #external_dependency_checksum, #find_location, #highlights, inherited, #initialize, #join_force?, lint?, match?, #message, #messages, #parse, qualified_cop_name, #reason_to_not_correct, #relevant_file?, #target_rails_version, #target_ruby_version

Methods included from AST::Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search, #node_search_all, #node_search_body, #node_search_first

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #correctable?, #disable_offense, #disable_uncorrectable?, #safe_autocorrect?, #support_autocorrect?

Methods included from RuboCop::Cop::IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, comment_line?, double_quotes_required?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_range, needs_escaping?, on_node, parentheses?, same_line?, to_string_literal, to_supported_styles, tokens, trim_string_interporation_escape_character

Methods included from PathUtil

absolute?, chdir, hidden_dir?, hidden_file_in_not_hidden_dir?, match_path?, pwd, relative_path, reset_pwd, smart_path

Constructor Details

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

Instance Method Details

#autocorrect(node) ⇒ Object 



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

def autocorrect(node)
  lambda do |corrector|
    method_name?(node) do |method_name_node, method_name_arg|
      corrector.replace(
        range(method_name_node, node),
        "method?(#{method_name_arg.first.source})"
      )
    end
  end
end

#on_send(node) ⇒ Object 



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

def on_send(node)
  method_name?(node) do |method_name_node, method_name_arg|
    message = format(MSG, method_name: method_name_arg.first.source)

    range = range(method_name_node, node)

    add_offense(node, location: range, message: message)
  end
end