rubocop-discourse 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a72b547f01dafa6cb189e9bfa4478817b6235ae725707b36e4b7f692351c3707
-  data.tar.gz: 2bfc96ac97e72886e781ddf5bc94f38c04a6f7ce45946dea2823f35d8db8e798
+  metadata.gz: 3a1dd5d5b8d79de5bcda354a31c6f993460f11875065c64edd9f7cc3cce71bff
+  data.tar.gz: 175c1f83d9300537bac93184d5e8bf5d21cffc8196e996d59cc9298f69d8bdb5
 SHA512:
-  metadata.gz: cbcd4c1f22751539ee6a1c9550a08170d91f92b26e7098362bcf3039f0d3658b5df789c72b947e857fa38ba7523ca53b5061feff1b9bd6135940db61ce6baef6
-  data.tar.gz: 1f1d6460703cf74e03ce57ac50deed273f7a1a0f2df3d8a1ab9d6a9d0ec18aa53be63ad442c79dd08cfbf664811ea79caa02ae65127b23ae78a14c1c8721d71f
+  metadata.gz: ada5c637849f829f0d8d0247b86fbec1a1cc9182d06b6385f6ac13f081f9782a7d9cd38d8a3dd30c2bf121f834171a9f28933deaee4ab8a53a022aa3af5d06fc
+  data.tar.gz: ab731fee843a5a8ef9821c613751906457672eb11bed54ec0aae3856588b723a77c03aa26f258a3c1e19c25b1edac4d198ae8ffbfd3e4bbaf397d4e2f1332c8f

data/.github/workflows/ci.yml

@@ -5,9 +5,7 @@ on:
   push:
     branches:
       - master
-    tags:
-      - v*
-
+      - main
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -33,7 +31,7 @@ jobs:
         run: bundle exec rspec spec
 
   publish:
-    if: contains(github.ref, 'refs/tags/v')
+    if: github.event_name == 'push' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master')
     needs: build
     runs-on: ubuntu-latest
 
@@ -41,6 +39,8 @@ jobs:
       - uses: actions/checkout@v2
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@main
+        uses: discourse/publish-rubygems-action@v2
         env:
-          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+          GIT_EMAIL: team@discourse.org
+          GIT_NAME: discoursebot

data/config/default.yml

@@ -50,3 +50,15 @@ Discourse/NoMockingJobs:
   Patterns:
   - _spec.rb
   - "(?:^|/)spec/"
+
+Discourse/OnlyTopLevelMultisiteSpecs:
+  Enabled: true
+  Patterns:
+  - _spec.rb
+  - "(?:^|/)spec/"
+
+Discourse/NoMixingMultisiteAndStandardSpecs:
+  Enabled: true
+  Patterns:
+  - _spec.rb
+  - "(?:^|/)spec/"

data/lib/rubocop/cop/discourse/no_mixing_multisite_and_standard_specs.rb

@@ -0,0 +1,76 @@
+# 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 "x" do
+      #   end
+      #
+      #   describe "x", type: :multisite do
+      #   end
+      #
+      #   # good
+      #   # x_spec.rb
+      #   describe "x" do
+      #   end
+      #
+      #   # x_multisite_spec.rb
+      #   describe "x", type: :multisite do
+      #   end
+      class NoMixingMultisiteAndStandardSpecs < Cop
+        MSG = "Do not mix multisite and standard specs. Consider moving multisite describes to a separate file."
+
+        def initialize(config = nil, options = nil)
+          super
+          @describes = nil
+        end
+
+        def on_block(node)
+          return if !top_level?(node)
+          return if !describe?(node.children.first)
+
+          type = !!multisite_describe?(node.children.first)
+
+          if !@describes.nil? && @describes != type
+            add_offense(node, message: MSG)
+          else
+            @describes = type
+          end
+        end
+
+        private
+
+        def_node_matcher :describe?, <<~MATCHER
+          (send
+            {nil? (const nil? :RSpec)}
+            {:describe :context :it}
+            ...
+          )
+        MATCHER
+
+        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

data/lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb

@@ -0,0 +1,59 @@
+# 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

data/rubocop-core.yml

@@ -1,3 +1,9 @@
+Security:
+  Enabled: true
+
+Security/IoMethods:
+  Enabled: true
+
 # Prefer &&/|| over and/or.
 Style/AndOr:
   Enabled: true

data/rubocop-discourse.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = "rubocop-discourse"
-  s.version     = "2.4.2"
+  s.version     = "2.5.0"
   s.summary     = "Custom rubocop cops used by Discourse"
   s.authors     = ["David Taylor"]
   s.license     = "MIT"

data/spec/lib/rubocop/cop/no_mixing_multisite_and_standard_specs_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) do
+    RuboCop::Config.new
+  end
+
+  it "raises an offense if there are multisite and standard top-level describes" do
+    inspect_source(<<~RUBY)
+      RSpec.describe "test" do
+      end
+
+      describe "test2", type: :multisite do
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if there are multiple multisite and standard top-level describes" do
+    inspect_source(<<~RUBY)
+      describe "test", type: :multisite do
+      end
+
+      describe "test2", type: :multisite do
+      end
+
+      describe "test2" do
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "does not raise an offense if there are only multisite describes" do
+    inspect_source(<<~RUBY)
+      require "foo"
+
+      describe "test", type: :multisite do
+        describe "inner-test" do
+          it "test" do
+          end
+        end
+      end
+
+      RSpec.describe "test2", type: :multisite do
+      end
+    RUBY
+
+    expect(cop.offenses).to eq([])
+  end
+
+  it "does not raise an offense if there are only standard describes" do
+    inspect_source(<<~RUBY)
+      require "rails_helper"
+
+      describe "test" do
+      end
+
+      describe "test2" do
+        RSpec.describe "inner-test" do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses).to eq([])
+  end
+end

data/spec/lib/rubocop/cop/only_top_level_multisite_specs_spec.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) do
+    RuboCop::Config.new
+  end
+
+  it "raises an offense if multisite config option is used in a sub-describe" do
+    inspect_source(<<~RUBY)
+      describe "test" do
+        describe "sub-test", type: :multisite do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if multisite config option is used in a sub-describe (RSpec const version)" do
+    inspect_source(<<~RUBY)
+      RSpec.describe "test" do
+        RSpec.describe "sub-test", type: :multisite do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if multisite config option is used in an example" do
+    inspect_source(<<~RUBY)
+      describe "test" do
+        it "acts as an example" do
+        end
+
+        it "does a thing", type: :multisite do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "raises an offense if multisite config option is used in a context" do
+    inspect_source(<<~RUBY)
+      describe "test" do
+        context "special circumstances", type: :multisite do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses.first.message).to eq(described_class::MSG)
+  end
+
+  it "does not raise an offense if multisite config option is used on top-level describe" do
+    inspect_source(<<~RUBY)
+      describe "test", type: :multisite do
+        describe "sub-test" do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses).to eq([])
+  end
+
+  it "does not raise an offense if multisite config option is used on top-level describe (RSpec const version)" do
+    inspect_source(<<~RUBY)
+      require "rails_helper"
+
+      RSpec.describe "test", type: :multisite do
+        describe "sub-test" do
+        end
+      end
+    RUBY
+
+    expect(cop.offenses).to eq([])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - David Taylor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-07 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -86,11 +86,13 @@ files:
 - lib/rubocop/cop/discourse/no_chdir.rb
 - lib/rubocop/cop/discourse/no_direct_multisite_manipulation.rb
 - lib/rubocop/cop/discourse/no_json_parse_response.rb
+- lib/rubocop/cop/discourse/no_mixing_multisite_and_standard_specs.rb
 - lib/rubocop/cop/discourse/no_mocking_jobs.rb
 - lib/rubocop/cop/discourse/no_nokogiri_html_fragment.rb
 - lib/rubocop/cop/discourse/no_reset_column_information_in_migrations.rb
 - lib/rubocop/cop/discourse/no_time_new_without_args.rb
 - lib/rubocop/cop/discourse/no_uri_escape_encode.rb
+- lib/rubocop/cop/discourse/only_top_level_multisite_specs.rb
 - lib/rubocop/cop/discourse/time_eq_matcher.rb
 - lib/rubocop/cop/discourse_cops.rb
 - lib/rubocop/discourse.rb
@@ -99,8 +101,10 @@ files:
 - rubocop-discourse.gemspec
 - rubocop-rspec.yml
 - spec/lib/rubocop/cop/no_add_reference_active_record_migrations_spec.rb
+- spec/lib/rubocop/cop/no_mixing_multisite_and_standard_specs_spec.rb
 - spec/lib/rubocop/cop/no_mocking_jobs_enqueue_spec.rb
 - spec/lib/rubocop/cop/no_reset_column_information_migrations_spec.rb
+- spec/lib/rubocop/cop/only_top_level_multisite_specs_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/discourse/rubocop-discourse
 licenses:
@@ -121,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Custom rubocop cops used by Discourse