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 duplicated
  1
end

def duplicated
  2
end

Constant Summary collapse

MSG = 
'Method `%s` is defined at both %s and %s.'.freeze

Constants included from Util

Util::ASGN_NODES, Util::BYTE_ORDER_MARK, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES, Util::STRING_ESCAPES, Util::STRING_ESCAPE_REGEX

Instance Attribute Summary

Attributes inherited from Cop

#config, #corrections, #offenses, #processed_source

Instance Method Summary collapse

Methods inherited from Cop

#add_offense, all, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, cop_name, #cop_name, cop_type, #correct, #debug?, #details, #display_cop_names?, #display_style_guide?, #excluded_file?, #extra_details?, inherited, #join_force?, lint?, match?, #message, non_rails, #parse, qualified_cop_name, #reference_url, #relevant_file?, #style_guide_url, #target_ruby_version

Methods included from Sexp

#s

Methods included from NodePattern::Macros

#def_node_matcher, #def_node_search, #node_search_body

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #support_autocorrect?

Methods included from IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

begins_its_line?, block_length, comment_line?, directions, double_quotes_acceptable?, double_quotes_required?, effective_column, ends_its_line?, first_part_of_call_chain, interpret_string_escapes, line_range, move_pos, numeric_range_size, on_node, operator?, parentheses?, range_with_surrounding_comma, range_with_surrounding_space, source_range, strip_quotes, to_string_literal, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, hidden?, issue_deprecation_warning, match_path?, relative_path

Constructor Details

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

Returns a new instance of DuplicateMethods.



22
23
24
25
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 22

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

Instance Method Details

#on_def(node) ⇒ Object 



27
28
29
30
31
32
33
34
35
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 27

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)

  return unless (scope = node.parent_module_name)
  found_instance_method(node, scope)
end

#on_defs(node) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 37

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

  receiver, name, = *node
  if receiver.const_type?
    _, const_name = *receiver
    if (qualified = lookup_constant(node, const_name))
      found_method(node, "#{qualified}.#{name}")
    end
  elsif receiver.self_type?
    if (enclosing = node.parent_module_name)
      found_method(node, "#{enclosing}.#{name}")
    end
  end
end