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

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

Overview

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.'
RESTRICT_ON_SEND = 
%i[alias_method attr_reader attr_writer attr_accessor attr].freeze
DEF_TYPES = 
%i[def defs].freeze

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

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, #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 IgnoredNode

#ignore_node, #ignored_node?, #part_of_ignored_node?

Methods included from Util

silence_warnings

Constructor Details

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

Returns a new instance of DuplicateMethods.



47
48
49
50
51
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 47

def initialize(config = nil, options = nil)
  super
  @definitions = {}
  @scopes = Hash.new { |hash, key| hash[key] = [] }
end

Instance Method Details

#alias_method?(node) ⇒ Object 



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

def_node_matcher :alias_method?, <<~PATTERN
  (send nil? :alias_method (sym $_name) _)
PATTERN

#method_alias?(node) ⇒ Object 



75
76
77
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 75

def_node_matcher :method_alias?, <<~PATTERN
  (alias (sym $_name) sym)
PATTERN

#on_alias(node) ⇒ Object 



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

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 



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

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.each_ancestor.any?(&:if_type?)
  return if possible_dsl?(node)

  found_instance_method(node, node.method_name)
end

#on_defs(node) ⇒ Object 



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

def on_defs(node)
  return if node.each_ancestor.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 



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

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

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

#sym_name(node) ⇒ Object 



93
 
# File 'lib/rubocop/cop/lint/duplicate_methods.rb', line 93

def_node_matcher :sym_name, '(sym $_name)'