rubocop-hq/rubocop

# frozen_string_literal: true

module RuboCop
  module Cop
    module InternalAffairs
      # Checks for redundant `location` argument to `#add_offense`. `location`
      # argument has a default value of `:expression` and this method will
      # automatically use it.
      #
      # @example
      #
      #   # bad
      #   add_offense(node, location: :expression)
      #
      #   # good
      #   add_offense(node)
      #   add_offense(node, location: :selector)
      #
      class RedundantLocationArgument < Base
        include RangeHelp
        extend AutoCorrector

        MSG = 'Redundant location argument to `#add_offense`.'
        RESTRICT_ON_SEND = %i[add_offense].freeze

        # @!method redundant_location_argument(node)
        def_node_matcher :redundant_location_argument, <<~PATTERN
          (send nil? :add_offense _
            (hash <$(pair (sym :location) (sym :expression)) ...>)
          )
        PATTERN

        def on_send(node)
          redundant_location_argument(node) do |argument|
            add_offense(argument) do |corrector|
              range = offending_range(argument)

              corrector.remove(range)
            end
          end
        end

        private

        def offending_range(node)
          with_space = range_with_surrounding_space(node.source_range)

          range_with_surrounding_comma(with_space, :left)
        end
      end
    end
  end
end