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

# bad

def duplicated
  1
end

alias duplicated other_duplicated

# good

def duplicated
  1
end

def other_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::CONDITIONAL_NODES, Util::EQUALS_ASGN_NODES, Util::LITERAL_REGEX, Util::LOGICAL_OPERATOR_NODES, Util::MODIFIER_NODES, Util::OPERATOR_METHODS, Util::SHORTHAND_ASGN_NODES

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, #duplicate_location?, #excluded_file?, #find_location, #highlights, inherited, #join_force?, lint?, match?, #message, #messages, non_rails, #parse, qualified_cop_name, #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?, #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?, compatible_external_encoding_for?, directions, double_quotes_required?, effective_column, ends_its_line?, escape_string, first_part_of_call_chain, interpret_string_escapes, line_distance, line_range, move_pos, needs_escaping?, on_node, operator?, parentheses?, parenthesized_call?, preceed?, range_between, range_by_whole_lines, range_with_surrounding_comma, range_with_surrounding_space, same_line?, scrub_string, source_range, strip_quotes, stripped_source_upto, symbol_without_quote?, to_string_literal, to_supported_styles, to_symbol_literal, within_node?

Methods included from PathUtil

absolute?, match_path?, relative_path, smart_path

Constructor Details

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

Returns a new instance of DuplicateMethods.



45
46
47
48
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 45

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

Instance Method Details

#on_alias(node) ⇒ Object 



77
78
79
80
81
82
83
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 77

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 



50
51
52
53
54
55
56
57
58
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 50

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)

  name, = *node
  found_instance_method(node, name)
end

#on_defs(node) ⇒ Object 



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

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
    check_const_receiver(node, name, const_name)
  elsif receiver.self_type?
    check_self_receiver(node, name)
  end
end

#on_send(node) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 95

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