lib/rubocop/cop/lint/duplicate_require.rb


# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # This cop checks for duplicate `require`s and `require_relative`s.
      #
      # @example
      #   # bad
      #   require 'foo'
      #   require 'bar'
      #   require 'foo'
      #
      #   # good
      #   require 'foo'
      #   require 'bar'
      #
      #   # good
      #   require 'foo'
      #   require_relative 'foo'
      #
      class DuplicateRequire < Base
        MSG = 'Duplicate `%<method>s` detected.'
        REQUIRE_METHODS = %i[require require_relative].freeze
        RESTRICT_ON_SEND = REQUIRE_METHODS

        def_node_matcher :require_call?, <<~PATTERN
          (send {nil? (const _ :Kernel)} {:#{REQUIRE_METHODS.join(' :')}} _)
        PATTERN

        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

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