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

Inherits:
Base
  • Object
show all
Extended by:
AutoCorrector
Includes:
RangeHelp
Defined in:
lib/rubocop/cop/lint/duplicate_require.rb

Overview

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 = 
Set.new(%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 included from AutoCorrector

support_autocorrect?

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, #initialize, #inspect, joining_forces, lint?, match?, #message, #offenses, #on_investigation_end, #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

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

Instance Method Details

#on_new_investigation ⇒ Object 



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

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 



45
46
47
48
49
50
51
52
 
# File 'lib/rubocop/cop/lint/duplicate_require.rb', line 45

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)) do |corrector|
    corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
  end
end

#require_call?(node) ⇒ Object 



35
36
37
 
# File 'lib/rubocop/cop/lint/duplicate_require.rb', line 35

def_node_matcher :require_call?, <<~PATTERN
  (send {nil? (const _ :Kernel)} %REQUIRE_METHODS _)
PATTERN