Sha256: 860c1888277723516f68a2a70807bbe5136e2ab949ae38530d6bef543372cd31

Contents?: true

Size: 1.57 KB

Versions: 18

Compression:

Stored size: 1.57 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Lint
      # Checks for duplicate `require`s and `require_relative`s.
      #
      # @safety
      #   This cop's autocorrection is unsafe because it may break the dependency order
      #   of `require`.
      #
      # @example
      #   # bad
      #   require 'foo'
      #   require 'bar'
      #   require 'foo'
      #
      #   # good
      #   require 'foo'
      #   require 'bar'
      #
      #   # good
      #   require 'foo'
      #   require_relative 'foo'
      #
      class DuplicateRequire < Base
        include RangeHelp
        extend AutoCorrector

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

        # @!method require_call?(node)
        def_node_matcher :require_call?, <<~PATTERN
          (send {nil? (const _ :Kernel)} %REQUIRE_METHODS _)
        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)) do |corrector|
            corrector.remove(range_by_whole_lines(node.source_range, include_final_newline: true))
          end
        end
      end
    end
  end
end

Version data entries

18 entries across 16 versions & 3 rubygems

Version Path
cm-admin-1.5.22 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/duplicate_require.rb
cm-admin-1.5.21 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/duplicate_require.rb
cm-admin-1.5.20 vendor/bundle/ruby/3.3.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/duplicate_require.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/lint/duplicate_require.rb
scrapbook-0.3.2 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/duplicate_require.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.31.2/lib/rubocop/cop/lint/duplicate_require.rb
scrapbook-0.3.1 vendor/ruby/2.7.0/gems/rubocop-1.35.1/lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.35.1 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.35.0 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.34.1 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.34.0 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.33.0 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.32.0 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.31.2 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.31.1 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.31.0 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.30.1 lib/rubocop/cop/lint/duplicate_require.rb
rubocop-1.30.0 lib/rubocop/cop/lint/duplicate_require.rb