describe_symbol.rb

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Avoid describing symbols.
      #
      # @example
      #   # bad
      #   describe :my_method do
      #     # ...
      #   end
      #
      #   # good
      #   describe '#my_method' do
      #     # ...
      #   end
      #
      # @see https://github.com/rspec/rspec-core/issues/1610
      class DescribeSymbol < Base
        MSG = 'Avoid describing symbols.'
        RESTRICT_ON_SEND = %i[describe].freeze

        # @!method describe_symbol?(node)
        def_node_matcher :describe_symbol?, <<~PATTERN
          (send #rspec? :describe $sym ...)
        PATTERN

        def on_send(node)
          describe_symbol?(node) do |match|
            add_offense(match)
          end
        end
      end
    end
  end
end