Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    # Ensure a require statement is present for a standard library determined
    # by variable library_name
    module RequireLibrary
      extend NodePattern::Macros

      RESTRICT_ON_SEND = [:require].freeze

      def ensure_required(corrector, node, library_name)
        node = node.parent while node.parent&.parent?

        if node.parent&.begin_type?
          return if @required_libs.include?(library_name)

          remove_subsequent_requires(corrector, node, library_name)
        end

        RequireLibraryCorrector.correct(corrector, node, library_name)
      end

      def remove_subsequent_requires(corrector, node, library_name)
        node.right_siblings.each do |sibling|
          next unless require_library_name?(sibling, library_name)

          range = range_by_whole_lines(sibling.source_range, include_final_newline: true)
          corrector.remove(range)
        end
      end

      def on_send(node)
        return if node.parent&.parent?

        name = require_any_library?(node)
        return if name.nil?

        @required_libs.add(name)
      end

      private

      def on_new_investigation
        # Holds the required files at top-level
        @required_libs = Set.new
        super
      end

      # @!method require_any_library?(node)
      def_node_matcher :require_any_library?, <<~PATTERN
        (send {(const {nil? cbase} :Kernel) nil?} :require (str $_))
      PATTERN

      # @!method require_library_name?(node, library_name)
      def_node_matcher :require_library_name?, <<~PATTERN
        (send {(const {nil? cbase} :Kernel) nil?} :require (str %1))
      PATTERN
    end
  end
end

Version data entries

177 entries across 176 versions & 19 rubygems

Version	Path
rubocop-1.74.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.73.2	lib/rubocop/cop/mixin/require_library.rb
siteimprove_api_client-1.0.1	vendor/bundle/ruby/3.2.0/gems/rubocop-1.73.1/lib/rubocop/cop/mixin/require_library.rb
rubocop-1.73.1	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.73.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.72.2	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.72.1	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.72.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.71.2	lib/rubocop/cop/mixin/require_library.rb
tailscale_middleware-0.0.3	vendor/cache/ruby/3.4.0/gems/rubocop-1.71.1/lib/rubocop/cop/mixin/require_library.rb
rubocop-1.71.1	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.71.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.70.0	lib/rubocop/cop/mixin/require_library.rb
minato_ruby_api_client-0.2.2	vendor/bundle/ruby/3.2.0/gems/rubocop-1.64.1/lib/rubocop/cop/mixin/require_library.rb
rubocop-1.69.2	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.69.1	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.69.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.68.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.67.0	lib/rubocop/cop/mixin/require_library.rb
rubocop-1.66.1	lib/rubocop/cop/mixin/require_library.rb