rubocop-discourse 3.1.0 → 3.9.3

data/spec/fixtures/controllers/namespaced_parent_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class InheritFromOutsideController < MyPlugin::ApplicationController
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/CallRequiresPlugin: Use `requires_plugin` in controllers to prevent routes from being accessible when plugin is disabled.
+end

data/spec/fixtures/controllers/no_requires_plugin_controller.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class NoRequiresPluginController < BaseController
+  requires_login
+end

data/spec/fixtures/controllers/requires_plugin_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class RequiresPluginController < BaseController
+  requires_plugin "my_plugin"
+  requires_login
+end

data/spec/lib/rubocop/cop/discourse/services/empty_lines_around_blocks_spec.rb

@@ -0,0 +1,309 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Services::EmptyLinesAroundBlocks,
+               :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when not in a service class" do
+    it "does nothing" do
+      expect_no_offenses(<<~RUBY)
+        class NotAService
+          step :first_step
+          params do
+            attribute :my_attribute
+          end
+          step :another_step
+        end
+      RUBY
+    end
+  end
+
+  context "when in a service class" do
+    context "when a blank line is missing before a block" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            step :first_step
+            params do
+            ^^^^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+              attribute :my_attribute
+            end
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            step :first_step
+
+            params do
+              attribute :my_attribute
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when a blank line is missing after a block" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            params do
+            ^^^^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+              attribute :my_attribute
+            end
+            step :last_step
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            params do
+              attribute :my_attribute
+            end
+
+            step :last_step
+          end
+        RUBY
+      end
+    end
+
+    context "when two blocks are next to each other" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            params do
+            ^^^^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+              attribute :attribute
+              validates :attribute, presence: true
+            end
+            transaction do
+            ^^^^^^^^^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+              step :first
+              step :second
+            end
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            params do
+              attribute :attribute
+              validates :attribute, presence: true
+            end
+
+            transaction do
+              step :first
+              step :second
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when a block is a one-liner" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            try { step :might_raise }
+            step :last_step
+          end
+        RUBY
+      end
+    end
+
+    context "when blocks are nested" do
+      context "when there is just one nested block" do
+        it "does not register an offense" do
+          expect_no_offenses(<<~RUBY)
+            class MyService
+              include Service::Base
+
+              transaction do
+                try do
+                  step :first_step
+                  step :second_step
+                end
+              end
+            end
+          RUBY
+        end
+      end
+
+      context "when the nested block is in the first position" do
+        context "when there is no empty line before" do
+          it "does not register an offense" do
+            expect_no_offenses(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  try do
+                    step :first_step
+                    step :second_step
+                  end
+
+                  step :third_step
+                end
+              end
+            RUBY
+          end
+        end
+
+        context "when there is no empty line after" do
+          it "registers an offense" do
+            expect_offense(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  try do
+                  ^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+                    step :first_step
+                    step :second_step
+                  end
+                  step :third_step
+                end
+              end
+            RUBY
+
+            expect_correction(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  try do
+                    step :first_step
+                    step :second_step
+                  end
+
+                  step :third_step
+                end
+              end
+            RUBY
+          end
+        end
+      end
+
+      context "when the nested block is in the last position" do
+        context "when there is no empty line after" do
+          it "does not register an offense" do
+            expect_no_offenses(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  step :first_step
+
+                  try do
+                    step :second_step
+                    step :third_step
+                  end
+                end
+              end
+            RUBY
+          end
+        end
+
+        context "when there is no empty line before" do
+          it "registers an offense" do
+            expect_offense(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  step :first_step
+                  try do
+                  ^^^^^^ Discourse/Services/EmptyLinesAroundBlocks: Add empty lines around a step block.
+                    step :second_step
+                    step :third_step
+                  end
+                end
+              end
+            RUBY
+
+            expect_correction(<<~RUBY)
+              class MyService
+                include Service::Base
+
+                transaction do
+                  step :first_step
+
+                  try do
+                    step :second_step
+                    step :third_step
+                  end
+                end
+              end
+            RUBY
+          end
+        end
+      end
+    end
+
+    context "when blocks are used in methods" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            step :first_step
+
+            def first_step(model:)
+              model.transaction do
+                do_something
+              end
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "with a full valid example" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            step :first_step
+
+            params do
+              attribute :my_attribute
+
+              validates :my_attributes, presence: true
+            end
+
+            policy :allowed?
+            model :user
+
+            transaction do
+              try do
+                step :save_user
+                step :log
+              end
+
+              step :other_step
+            end
+
+            step :last_step
+          end
+        RUBY
+      end
+    end
+  end
+end

data/spec/lib/rubocop/cop/discourse/services/group_keywords_spec.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Services::GroupKeywords, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when not in a service class" do
+    it "does nothing" do
+      expect_no_offenses(<<~RUBY)
+        class NotAService
+          step :first_step
+
+          step :another_step
+        end
+      RUBY
+    end
+  end
+
+  context "when in a service class" do
+    context "when keywords are not grouped together" do
+      it "reports an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            model :user
+            ^^^^^^^^^^^ Discourse/Services/GroupKeywords: Group one-liner steps together by removing extra empty lines.
+
+            policy :allowed?
+            step :save
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            model :user
+            policy :allowed?
+            step :save
+          end
+        RUBY
+      end
+    end
+
+    context "when a one-liner block has an empty line before a keyword" do
+      it "reports an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            model :user
+            policy :allowed?
+            ^^^^^^^^^^^^^^^^ Discourse/Services/GroupKeywords: Group one-liner steps together by removing extra empty lines.
+
+            try { step :save }
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            model :user
+            policy :allowed?
+            try { step :save }
+          end
+        RUBY
+      end
+    end
+
+    context "when keywords with empty lines appear in a nested block" do
+      it "reports an offense" do
+        expect_offense(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            transaction do
+              step :save
+              ^^^^^^^^^^ Discourse/Services/GroupKeywords: Group one-liner steps together by removing extra empty lines.
+
+              step :log
+            end
+          end
+        RUBY
+
+        expect_correction(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            transaction do
+              step :save
+              step :log
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when keywords are grouped together" do
+      it "does not report an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            model :user
+            policy :allowed?
+
+            transaction do
+              step :save
+              step :log
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when keywords are not at the top level" do
+      it "does not report an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyService
+            include Service::Base
+
+            private
+
+            def my_method
+              step(:save)
+
+              step(:log)
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::FabricatorShorthand, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  it "registers an offense when not using the fabricator shorthand" do
+    expect_offense(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:foo) { Fabricate(:foo) }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/FabricatorShorthand: Use the fabricator shorthand: `fab!(:foo)`
+      end
+    RUBY
+  end
+
+  it "does not register an offense when the fabricator has attributes" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:foo) { Fabricate(:foo, bar: 1) }
+      end
+    RUBY
+  end
+
+  it "does not register an offense when the identifier doesn't match" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:bar) { Fabricate(:foo) }
+      end
+    RUBY
+  end
+
+  it "supports autocorrect" do
+    expect_offense(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:foo) { Fabricate(:foo) }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/FabricatorShorthand: Use the fabricator shorthand: `fab!(:foo)`
+      end
+    RUBY
+
+    expect_correction(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:foo)
+      end
+    RUBY
+  end
+end

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

@@ -1,29 +1,26 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration, :config do
+RSpec.describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration, :config do
   subject(:cop) { described_class.new(config) }
-  let(:config) do
-    RuboCop::Config.new
-  end
+
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if add_reference is used, with or without arguments" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       add_reference :posts, :users, foreign_key: true, null: false
     RUBY
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raises an offense if add_belongs_to is used, with or without arguments" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       add_belongs_to :posts, :users, foreign_key: true, null: false
     RUBY
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raises an offense if t.references, or any variable.references is used, with or without arguments" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       create_table do |t|
         t.references :topic, null: false
       end
@@ -31,12 +28,12 @@ describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration,
         mytable.references :topic, null: false
       end
     RUBY
-    expect(cop.offenses.count).to eq(2)
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.count).to eq(2)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raises an offense if t.belongs_to, or any variable.belongs_to is used, with or without arguments" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       create_table do |t|
         t.belongs_to :topic, null: false
       end
@@ -44,7 +41,7 @@ describe RuboCop::Cop::Discourse::NoAddReferenceOrAliasesActiveRecordMigration,
         mytable.belongs_to :topic, null: false
       end
     RUBY
-    expect(cop.offenses.count).to eq(2)
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.count).to eq(2)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 end

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

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
+RSpec.describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if there are multisite and standard top-level describes" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       RSpec.describe "test" do
       end
 
@@ -18,11 +14,11 @@ describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
       end
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raises an offense if there are multiple multisite and standard top-level describes" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       describe "test", type: :multisite do
       end
 
@@ -33,11 +29,11 @@ describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
       end
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "does not raise an offense if there are only multisite describes" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       require "foo"
 
       describe "test", type: :multisite do
@@ -51,11 +47,11 @@ describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
       end
     RUBY
 
-    expect(cop.offenses).to eq([])
+    expect(offenses).to eq([])
   end
 
   it "does not raise an offense if there are only standard describes" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       require "rails_helper"
 
       describe "test" do
@@ -67,6 +63,6 @@ describe RuboCop::Cop::Discourse::NoMixingMultisiteAndStandardSpecs, :config do
       end
     RUBY
 
-    expect(cop.offenses).to eq([])
+    expect(offenses).to eq([])
   end
 end

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

@@ -1,35 +1,31 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::NoMockingJobs, :config do
+RSpec.describe RuboCop::Cop::Discourse::NoMockingJobs, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
 
   it "raises an offense if Jobs is mocked with :enqueue" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
     Jobs.expects(:enqueue)
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to end_with(described_class::MSG)
   end
 
   it "raises an offense if Jobs is mocked with :enqueue_in" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
     Jobs.expects(:enqueue_in)
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to end_with(described_class::MSG)
   end
 
   it "does not raise an offense if Jobs is not mocked with :enqueue or :enqueue_in" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
     Jobs.enqueue(:some_job)
     RUBY
 
-    expect(cop.offenses).to eq([])
+    expect(offenses).to eq([])
   end
 end