Sha256: b6514001090958388de5bd53b285320c3bb313aeea5a04d06871f195446c62b5

Contents?: true

Size: 1.38 KB

Versions: 7

Compression:

Stored size: 1.38 KB

Contents

# frozen_string_literal: true

module RuboCop
  module Cop
    module Discourse
      # Use `type: :multisite` only on a top-level `describe`.
      # Mixing multisite and standard specs can lead to errors,
      # e.g. when using `fab!` helper.
      #
      # @example
      #   # bad
      #   describe "something" do
      #     describe "x", type: :multisite do
      #     end
      #
      #     it "does X", type: :multisite do
      #     end
      #   end
      #
      #   # good
      #   describe "something", type: :multisite do
      #     describe "x" do
      #     end
      #
      #     it "does X" do
      #     end
      #   end
      class OnlyTopLevelMultisiteSpecs < Cop
        MSG = "Use `type: :multisite` only on a top-level `describe`"

        def on_block(node)
          return if top_level?(node)
          return if !multisite_describe?(node.children.first)

          add_offense(node, message: MSG)
        end

        private

        def_node_matcher :multisite_describe?, <<~MATCHER
          (send
            {nil? (const nil? :RSpec)}
            {:describe :context :it}
            _
            (hash (pair (sym :type) (sym :multisite)) ...)
          )
        MATCHER

        def top_level?(node)
          if node.parent&.begin_type?
            node.parent.root?
          else
            node.root?
          end
        end
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
rubocop-discourse-3.1.0 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-3.0.3 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-3.0.2 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-3.0.1 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-3.0 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-2.6.0 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
rubocop-discourse-2.5.0 lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb