Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module RSpec
      # Check that the first argument to the top level describe is a constant.
      #
      # @example
      #   # bad
      #   describe 'Do something' do
      #   end
      #
      #   # good
      #   describe TestedClass do
      #   end
      #
      #   describe "A feature example", type: :feature do
      #   end
      class DescribeClass < Cop
        include RuboCop::RSpec::TopLevelDescribe

        MSG = 'The first argument to describe should be '\
              'the class or module being tested.'.freeze

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

        def_node_matcher :describe_with_metadata, <<-PATTERN
          (send {(const nil? :RSpec) nil?} :describe
            !const
            ...
            (hash $...))
        PATTERN

        def_node_matcher :rails_metadata?, <<-PATTERN
          (pair
            (sym :type)
            (sym {:request :feature :system :routing :view}))
        PATTERN

        def_node_matcher :shared_group?, <<-PATTERN
          (block (send {(const nil? :RSpec) nil?} #{SharedGroups::ALL.node_pattern_union} ...) ...)
        PATTERN

        def on_top_level_describe(node, args)
          return if shared_group?(root_node)
          return if valid_describe?(node)

          describe_with_metadata(node) do |pairs|
            return if pairs.any?(&method(:rails_metadata?))
          end

          add_offense(args.first, location: :expression)
        end
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
rubocop-rspec-1.25.1	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.25.0	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.24.0	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.23.0	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.22.2	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.22.1	lib/rubocop/cop/rspec/describe_class.rb
rubocop-rspec-1.22.0	lib/rubocop/cop/rspec/describe_class.rb