Contents

# 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 < Cop
        MSG = 'Avoid describing symbols.'.freeze

        def_node_matcher :describe_symbol?, <<-PATTERN
          (send {(const nil? :RSpec) nil?} :describe $sym ...)
        PATTERN

        def on_send(node)
          describe_symbol?(node) do |match|
            add_offense(match, location: :expression)
          end
        end
      end
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
rubocop-rspec-1.24.0	lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-1.23.0	lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-1.22.2	lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-1.22.1	lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-1.22.0	lib/rubocop/cop/rspec/describe_symbol.rb