Sha256: da0b88b17717d8545fa3306d52b42c4d7f31bb4ffcf9f6fbe930d4002a049239

Contents?: true

Size: 1.61 KB

Versions: 30

Compression:

Stored size: 1.61 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module InternalAffairs
      # Checks for potential uses of the location keywords which can be used as
      # shortcut arguments to `#add_offense`.
      #
      # @example
      #
      #   # bad
      #   add_offense(node, location: node.loc.selector)
      #
      #   # good
      #   add_offense(node, location: :selector)
      class OffenseLocationKeyword < Base
        extend AutoCorrector

        MSG = 'Use `:%<keyword>s` as the location argument to ' \
              '`#add_offense`.'
        RESTRICT_ON_SEND = %i[add_offense].freeze

        def on_send(node)
          node_type_check(node) do |node_arg, kwargs|
            find_offending_argument(node_arg, kwargs) do |location, keyword|
              add_offense(location, message: format(MSG, keyword: keyword)) do |corrector|
                (*, keyword) = offending_location_argument(location.parent)

                corrector.replace(location, ":#{keyword}")
              end
            end
          end
        end

        private

        def_node_matcher :node_type_check, <<~PATTERN
          (send nil? :add_offense $_node $hash)
        PATTERN

        def_node_matcher :offending_location_argument, <<~PATTERN
          (pair (sym :location) $(send (send $_node :loc) $_keyword))
        PATTERN

        def find_offending_argument(searched_node, kwargs)
          kwargs.pairs.each do |pair|
            offending_location_argument(pair) do |location, node, keyword|
              yield(location, keyword) if searched_node == node
            end
          end
        end
      end
    end
  end
end

Version data entries

30 entries across 30 versions & 2 rubygems

Version Path
plaid-14.13.0 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
plaid-14.12.1 vendor/bundle/ruby/3.0.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
plaid-14.12.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
plaid-14.11.1 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
plaid-14.10.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
plaid-14.7.0 vendor/bundle/ruby/2.6.0/gems/rubocop-0.91.1/lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.10.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.9.1 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.9.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.8.1 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.8.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.7.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.6.1 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.6.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.5.2 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.5.1 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.5.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.4.2 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.4.1 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb
rubocop-1.4.0 lib/rubocop/cop/internal_affairs/offense_location_keyword.rb