Class: RuboCop::Cop::Lint::DuplicateMethods

Inherits:
Cop
  • Object
show all
Defined in:
lib/rubocop/cop/lint/duplicate_methods.rb

Overview

This cop checks for duplicated instance (or singleton) method definitions.

Examples:


# bad

def foo
  1
end

def foo
  2
end

# bad

def foo
  1
end

alias foo bar

# good

def foo
  1
end

def bar
  2
end

# good

def foo
  1
end

alias bar foo

Constant Summary collapse

MSG = 
'Method `%<method>s` is defined at both %<defined>s and ' \
'%<current>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?, #find_location, #highlights, inherited, #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 NodePattern::Macros

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

Methods included from AST::Sexp

#s

Methods included from AutocorrectLogic

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

Methods included from 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

#initialize(config = nil, options = nil) ⇒ DuplicateMethods

Returns a new instance of DuplicateMethods


56
57
58
59
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 56

def initialize(config = nil, options = nil)
  super
  @definitions = {}
end

Instance Method Details

#on_alias(node) ⇒ Object 


86
87
88
89
90
91
92
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 86

def on_alias(node)
  return unless (name = method_alias?(node))
  return if node.ancestors.any?(&:if_type?)
  return if possible_dsl?(node)

  found_instance_method(node, name)
end

#on_def(node) ⇒ Object 


61
62
63
64
65
66
67
68
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 61

def on_def(node)
  # if a method definition is inside an if, it is very likely
  # that a different definition is used depending on platform, etc.
  return if node.ancestors.any?(&:if_type?)
  return if possible_dsl?(node)

  found_instance_method(node, node.method_name)
end

#on_defs(node) ⇒ Object 


70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 70

def on_defs(node)
  return if node.ancestors.any?(&:if_type?)
  return if possible_dsl?(node)

  if node.receiver.const_type?
    _, const_name = *node.receiver
    check_const_receiver(node, node.method_name, const_name)
  elsif node.receiver.self_type?
    check_self_receiver(node, node.method_name)
  end
end

#on_send(node) ⇒ Object 


104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 104

def on_send(node)
  if (name = alias_method?(node))
    return unless name
    return if node.ancestors.any?(&:if_type?)
    return if possible_dsl?(node)

    found_instance_method(node, name)
  elsif (attr = attr?(node))
    on_attr(node, *attr)
  end
end