rubocop-discourse 3.1.0 → 3.9.3

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

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config do
+RSpec.describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config do
   subject(:cop) { described_class.new(config) }
 
-  let(:config) do
-    RuboCop::Config.new
-  end
+  let(:config) { RuboCop::Config.new }
+
+  before { config["Discourse/NoResetColumnInformationInMigrations"]["Enabled"] = true }
 
   it "raises an offense if reset_column_information is used" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       class SomeMigration < ActiveRecord::Migration[6.0]
         def up
           Post.reset_column_information
@@ -18,11 +16,11 @@ describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config
       end
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raise an offense if reset_column_information is used without AR model" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       class SomeMigration < ActiveRecord::Migration[6.0]
         def up
           "post".classify.constantize.reset_column_information
@@ -30,6 +28,6 @@ describe RuboCop::Cop::Discourse::NoResetColumnInformationInMigrations, :config
       end
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 end

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

@@ -1,38 +1,34 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :config do
+RSpec.describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :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 multisite config option is used in a sub-describe" do
-    inspect_source(<<~RUBY)
+    offenses = 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)
+    expect(offenses.first.message).to match(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)
+    offenses = 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)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "raises an offense if multisite config option is used in an example" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       describe "test" do
         it "acts as an example" do
         end
@@ -42,33 +38,33 @@ describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :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 multisite config option is used in a context" do
-    inspect_source(<<~RUBY)
+    offenses = 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)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "does not raise an offense if multisite config option is used on top-level describe" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       describe "test", type: :multisite do
         describe "sub-test" do
         end
       end
     RUBY
 
-    expect(cop.offenses).to eq([])
+    expect(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)
+    offenses = inspect_source(<<~RUBY)
       require "rails_helper"
 
       RSpec.describe "test", type: :multisite do
@@ -77,6 +73,6 @@ describe RuboCop::Cop::Discourse::OnlyTopLevelMultisiteSpecs, :config do
       end
     RUBY
 
-    expect(cop.offenses).to eq([])
+    expect(offenses).to eq([])
   end
 end

data/spec/lib/rubocop/cop/plugins/call_requires_plugin_spec.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::CallRequiresPlugin, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when `requires_plugin` is missing" do
+    it "registers an offense" do
+      expect_offense(<<~RUBY)
+        class MyController < ApplicationController
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/CallRequiresPlugin: Use `requires_plugin` in controllers to prevent routes from being accessible when plugin is disabled.
+          requires_login
+        end
+      RUBY
+    end
+  end
+
+  context "when `requires_plugin` is not missing" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        class MyController
+          requires_plugin MyPlugin::PLUGIN_NAME
+          requires_login
+        end
+      RUBY
+    end
+  end
+
+  context "when inheriting" do
+    let(:controllers_path) do
+      Pathname.new("#{__dir__}/../../../../fixtures/controllers").cleanpath
+    end
+
+    before do
+      # As we’re providing real files, we need to get rid of the default config
+      # restricting the cop to `app/controllers/*`
+      configuration.for_cop(cop).delete("Include")
+    end
+
+    context "when `requires_plugin` is called in a parent controller" do
+      let(:good_controller) { controllers_path.join("good_controller.rb") }
+
+      it "does not register an offense" do
+        expect_no_offenses(good_controller.read, good_controller.to_s)
+      end
+    end
+
+    context "when `requires_plugin` is not called in a parent controller" do
+      let(:bad_controller) { controllers_path.join("bad_controller.rb") }
+
+      it "registers an offense" do
+        expect_offense(bad_controller.read, bad_controller.to_s)
+      end
+    end
+
+    context "when parent controller can’t be located" do
+      context "when parent controller is namespaced" do
+        let(:controller) do
+          controllers_path.join("namespaced_parent_controller.rb")
+        end
+
+        it "registers an offense" do
+          expect_offense(controller.read, controller.to_s)
+        end
+      end
+
+      context "when parent controller is not namespaced" do
+        let(:controller) do
+          controllers_path.join("inherit_from_outside_controller.rb")
+        end
+
+        it "registers an offense" do
+          expect_offense(controller.read, controller.to_s)
+        end
+      end
+    end
+  end
+end

data/spec/lib/rubocop/cop/plugins/namespace_constants_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::NamespaceConstants, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when defining a constant outside any namespace" do
+    it "registers an offense" do
+      expect_offense(<<~RUBY)
+        MY_CONSTANT = "my_value"
+        ^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/NamespaceConstants: Don’t define constants outside a class or a module.
+
+        class MyClass
+          MY_CONSTANT = "my_value"
+        end
+      RUBY
+    end
+  end
+
+  context "when defining a constant inside a class" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        class MyClass
+          MY_CONSTANT = "my_value"
+        end
+      RUBY
+    end
+  end
+
+  context "when defining a constant inside a module" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        module MyModule
+          MY_CONSTANT = "my_value"
+        end
+      RUBY
+    end
+  end
+end

data/spec/lib/rubocop/cop/plugins/namespace_methods_spec.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::NamespaceMethods, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when defining a method outside any namespace" do
+    it "registers an offense" do
+      expect_offense(<<~RUBY)
+        def my_method
+        ^^^^^^^^^^^^^ Discourse/Plugins/NamespaceMethods: Don’t define methods outside a class or a module.
+          "my_value"
+        end
+
+        class MyClass
+          def my_method
+            "my_method"
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when defining a method inside a class" do
+    context "when defining an instance method" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyClass
+            def my_method
+              "my_value"
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when defining a class method" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          class MyClass
+            class << self
+              def my_method
+                "my_value"
+              end
+
+              def another_method
+                "plop"
+              end
+            end
+          end
+        RUBY
+      end
+    end
+  end
+
+  context "when defining a method inside a module" do
+    context "when defining an instance method" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          module MyModule
+            def my_method
+              "my_value"
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when defining a class method" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY)
+          module MyModule
+            class << self
+              def my_method
+                "my_value"
+              end
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/spec/lib/rubocop/cop/plugins/no_monkey_patching_spec.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::NoMonkeyPatching, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when outside `plugin.rb`" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY, "my_class.rb")
+        class ::MyClass
+          def my_method
+            "my_value"
+          end
+        end
+
+        class AnotherClass
+          def my_method
+            "my_value"
+          end
+        end
+      RUBY
+    end
+  end
+
+  context "when inside `plugin.rb`" do
+    context "when opening an existing class" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY, "plugin.rb")
+          after_initialize do
+            module MyPlugin
+              class Engine < Rails::Engine
+                isolate_namespace MyPlugin
+              end
+            end
+
+            class ::Topic
+            ^^^^^^^^^^^^^ Discourse/Plugins/NoMonkeyPatching: Don’t reopen existing classes. [...]
+              def self.new_method
+                :new_value
+              end
+
+              def my_new_method
+                "my_new_value"
+              end
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when opening an existing serializer" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY, "plugin.rb")
+          class ::TopicSerializer
+          ^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/NoMonkeyPatching: Don’t reopen serializers. [...]
+            def new_attribute
+              "my_attribute"
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when calling `.class_eval` on a class" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          User.class_eval do
+          ^^^^^^^^^^^^^^^ Discourse/Plugins/NoMonkeyPatching: Don’t call `class_eval`. [...]
+            def a_new_method
+              :new_value
+            end
+          end
+        RUBY
+      end
+    end
+
+    context "when calling `.class_eval` on a serializer" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY)
+          UserSerializer.class_eval do
+          ^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/NoMonkeyPatching: Don’t call `class_eval` on a serializer. [...]
+            def a_new_method
+              :new_value
+            end
+          end
+        RUBY
+      end
+    end
+  end
+end

data/spec/lib/rubocop/cop/plugins/use_plugin_instance_on_spec.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::UsePluginInstanceOn, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when outside `plugin.rb`" do
+    context "when `DiscourseEvent.on` is called" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY, "another_file.rb")
+          DiscourseEvent.on(:topic_status_updated) { do_something }
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/UsePluginInstanceOn: Don’t call `DiscourseEvent.on` outside `plugin.rb`.
+        RUBY
+      end
+    end
+  end
+
+  context "when inside `plugin.rb`" do
+    context "when `DiscourseEvent.on` is called" do
+      it "registers an offense" do
+        expect_offense(<<~RUBY, "plugin.rb")
+          DiscourseEvent.on(:topic_status_updated) { do_something }
+          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/UsePluginInstanceOn: Use `on` instead of `DiscourseEvent.on` [...]
+        RUBY
+      end
+    end
+
+    context "when `on` is called" do
+      it "does not register an offense" do
+        expect_no_offenses(<<~RUBY, "plugin.rb")
+          on(:topic_status_updated) { do_something }
+        RUBY
+      end
+    end
+  end
+end

data/spec/lib/rubocop/cop/plugins/use_require_relative_spec.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+RSpec.describe RuboCop::Cop::Discourse::Plugins::UseRequireRelative, :config do
+  subject(:cop) { described_class.new(config) }
+
+  let(:config) { RuboCop::Config.new }
+
+  context "when using `load`" do
+    it "registers an offense" do
+      expect_offense(<<~RUBY)
+        load File.expand_path("../app/jobs/onceoff/voting_ensure_consistency.rb", __FILE__)
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/Plugins/UseRequireRelative: Use `require_relative` instead of `load`.
+      RUBY
+    end
+  end
+
+  context "when using `require_relative`" do
+    it "does not register an offense" do
+      expect_no_offenses(<<~RUBY)
+        require_relative "app/controllers/encrypt_controller.rb"
+      RUBY
+    end
+  end
+end

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

@@ -1,27 +1,23 @@
 # frozen_string_literal: true
 
-require 'spec_helper'
-
-describe RuboCop::Cop::Discourse::TimeEqMatcher, :config do
+RSpec.describe RuboCop::Cop::Discourse::TimeEqMatcher, :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 a timestamp is compared using `eq`" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
     expect(user.created_at).to eq(Time.zone.now)
     RUBY
 
-    expect(cop.offenses.first.message).to eq(described_class::MSG)
+    expect(offenses.first.message).to match(described_class::MSG)
   end
 
   it "passes if a timestamp is compared using `eq_time`" do
-    inspect_source(<<~RUBY)
+    offenses = inspect_source(<<~RUBY)
       expect(user.created_at).to eq_time(Time.zone.now)
     RUBY
 
-    expect(cop.offenses).to be_empty
+    expect(offenses).to be_empty
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'bundler/setup'
+require "bundler/setup"
 Bundler.setup
 
 # Require supporting files exposed for testing.
-require 'rubocop'
-require 'rubocop/rspec/support'
+require "rubocop"
+require "rubocop/rspec/support"
 
-require 'rubocop-discourse' # and any other gems you need
+require "rubocop-discourse" # and any other gems you need
 
 RSpec.configure do |config|
   config.include RuboCop::RSpec::ExpectOffense

data/stree-compat.yml

@@ -3,10 +3,14 @@ require:
 
 inherit_from:
   - ./rubocop-core.yml
+  - ./rubocop-capybara.yml
+  - ./rubocop-factory_bot.yml
   - ./rubocop-rspec.yml
+  - ./rubocop-rails.yml
 
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.2
+  SuggestExtensions: false
   DisabledByDefault: true
   Exclude:
     - "db/schema.rb"
@@ -19,3 +23,8 @@ AllCops:
 
 Discourse:
   Enabled: true
+
+Discourse/FabricatorShorthand:
+  Enabled: true
+  Include:
+    - "**/spec/**/*"