Sha256: df0fe66f7bc95f8474137b5ae2c6639f998aec2720498b9fa10f1a4a554f6c72

Contents?: true

Size: 1.34 KB

Versions: 39

Compression:

Stored size: 1.34 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Checks that the second argument to `describe` specifies a method.
      #
      # @example
      #   # bad
      #   describe MyClass, 'do something' do
      #   end
      #
      #   # good
      #   describe MyClass, '#my_instance_method' do
      #   end
      #
      #   describe MyClass, '.my_class_method' do
      #   end
      #
      class DescribeMethod < Base
        include TopLevelGroup

        MSG = 'The second argument to describe should be the method ' \
              "being tested. '#instance' or '.class'."

        # @!method second_string_literal_argument(node)
        def_node_matcher :second_string_literal_argument, <<~PATTERN
          (block
            (send #rspec? :describe _first_argument ${str dstr} ...)
          ...)
        PATTERN

        # @!method method_name?(node)
        def_node_matcher :method_name?, <<~PATTERN
          {(str #method_name_prefix?) (dstr (str #method_name_prefix?) ...)}
        PATTERN

        def on_top_level_group(node)
          second_string_literal_argument(node) do |argument|
            add_offense(argument) unless method_name?(argument)
          end
        end

        private

        def method_name_prefix?(description)
          description.start_with?('.', '#')
        end
      end
    end
  end
end

Version data entries

39 entries across 39 versions & 7 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_method.rb
rubocop-rspec-3.3.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.2.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.1.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.5 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.4 lib/rubocop/cop/rspec/describe_method.rb
blacklight-spotlight-3.6.0.beta8 vendor/bundle/ruby/3.2.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.3 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.2 lib/rubocop/cop/rspec/describe_method.rb
katalyst-govuk-formbuilder-1.9.2 vendor/bundle/ruby/3.3.0/gems/rubocop-rspec-3.0.1/lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.1 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-3.0.0.pre lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.31.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.30.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.29.2 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.29.1 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.29.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.28.0 lib/rubocop/cop/rspec/describe_method.rb
rubocop-rspec-2.27.1 lib/rubocop/cop/rspec/describe_method.rb