Class: RuboCop::Cop::Lint::DuplicateRequire

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

Overview

This cop checks for duplicate `require`s and `require_relative`s.

Examples:

# bad
require 'foo'
require 'bar'
require 'foo'

# good
require 'foo'
require 'bar'

# good
require 'foo'
require_relative 'foo'

Constant Summary collapse

MSG =
'Duplicate `%<method>s` detected.'
REQUIRE_METHODS =
%i[require require_relative].freeze
RESTRICT_ON_SEND =
REQUIRE_METHODS

Instance Attribute Summary

Attributes inherited from Base

#config, #processed_source

Instance Method Summary collapse

Methods inherited from Base

#add_global_offense, #add_offense, autocorrect_incompatible_with, badge, #callbacks_needed, callbacks_needed, #config_to_allow_offenses, #config_to_allow_offenses=, #cop_config, #cop_name, cop_name, department, documentation_url, exclude_from_registry, #excluded_file?, #external_dependency_checksum, inherited, #initialize, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #on_other_file, #ready, #relevant_file?, support_autocorrect?, support_multiple_source?, #target_rails_version, #target_ruby_version

Methods included from AutocorrectLogic

#autocorrect?, #autocorrect_enabled?, #autocorrect_requested?, #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

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

Instance Method Details

#on_new_investigationObject


31
32
33
34
35
# File 'lib/rubocop/cop/lint/duplicate_require.rb', line 31

def on_new_investigation
  # Holds the known required files for a given parent node (used as key)
  @required = Hash.new { |h, k| h[k] = Set.new }.compare_by_identity
  super
end

#on_send(node) ⇒ Object


37
38
39
40
41
42
# File 'lib/rubocop/cop/lint/duplicate_require.rb', line 37

def on_send(node)
  return unless require_call?(node)
  return if @required[node.parent].add?("#{node.method_name}#{node.first_argument}")

  add_offense(node, message: format(MSG, method: node.method_name))
end