lib/rubocop/cop/lint/missing_cop_enable_directive.rb


# frozen_string_literal: true

# rubocop:disable Lint/UnneededCopDisableDirective
module RuboCop
  module Cop
    module Lint
      # This cop checks that there is an `# rubocop:enable ...` statement
      # after a `# rubocop:disable ...` statement. This will prevent leaving
      # cop disables on wide ranges of code, that latter contributors to
      # a file wouldn't be aware of.
      #
      # @example
      #   # Lint/MissingCopEnableDirective:
      #   #   MaximumRangeSize: .inf
      #
      #   # good
      #   # rubocop:disable Layout/SpaceAroundOperators
      #   x= 0
      #   # rubocop:enable Layout/SpaceAroundOperators
      #   # y = 1
      #   # EOF
      #
      #   # bad
      #   # rubocop:disable Layout/SpaceAroundOperators
      #   x= 0
      #   # EOF
      #
      # @example
      #   # Lint/MissingCopEnableDirective:
      #   #   MaximumRangeSize: 2
      #
      #   # good
      #   # rubocop:disable Layout/SpaceAroundOperators
      #   x= 0
      #   # With the previous, there are 2 lines on which cop is disabled.
      #   # rubocop:enable Layout/SpaceAroundOperators
      #
      #   # bad
      #   # rubocop:disable Layout/SpaceAroundOperators
      #   x= 0
      #   x += 1
      #   # Including this, that's 3 lines on which the cop is disabled.
      #   # rubocop:enable Layout/SpaceAroundOperators
      #
      class MissingCopEnableDirective < Cop
        include RangeHelp

        MSG = 'Re-enable %<cop>s cop with `# rubocop:enable` after ' \
              'disabling it.'.freeze
        MSG_BOUND = 'Re-enable %<cop>s cop within %<max_range>s lines after ' \
                    'disabling it.'.freeze

        def investigate(processed_source)
          max_range = cop_config['MaximumRangeSize']
          processed_source.disabled_line_ranges.each do |cop, line_ranges|
            line_ranges.each do |line_range|
              # This has to remain a strict inequality to handle
              # the case when max_range is Float::INFINITY
              next if line_range.max - line_range.min < max_range + 2

              range = source_range(processed_source.buffer,
                                   line_range.min,
                                   (0..0))
              add_offense(range,
                          location: range,
                          message: message(max_range: max_range, cop: cop))
            end
          end
        end

        private

        def message(max_range:, cop:)
          if max_range == Float::INFINITY
            format(MSG, cop: cop)
          else
            format(MSG_BOUND, cop: cop, max_range: max_range)
          end
        end
      end
    end
  end
end
# rubocop:enable Lint/UnneededCopDisableDirective, Layout/SpaceAroundOperators