Sha256: 29b09edbb8ec3c24030f3c768b83eacce0ef599f26a6eafd4af58bc2de7e4a32

Contents?: true

Size: 814 Bytes

Versions: 24

Compression:

Stored size: 814 Bytes

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 < 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

Version data entries

24 entries across 24 versions & 5 rubygems

Version Path
minato_ruby_api_client-0.2.2 vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-3.0.3/lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.3.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.2.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.1.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.5 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.4 lib/rubocop/cop/rspec/describe_symbol.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.3 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.2 lib/rubocop/cop/rspec/describe_symbol.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.1 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-3.0.0.pre lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.31.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.30.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.29.2 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.29.1 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.29.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.28.0 lib/rubocop/cop/rspec/describe_symbol.rb
rubocop-rspec-2.27.1 lib/rubocop/cop/rspec/describe_symbol.rb