rubocop-discourse 3.13.3 → 3.14.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 3.13.3
+  version: 3.14.0
 platform: ruby
 authors:
 - Discourse Team
@@ -24,19 +24,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '6.1'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-discourse-base
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.73.2
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.73.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -153,15 +153,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".streerc"
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
 - config/default.yml
 - default.yml
 - lib/rubocop-discourse.rb
@@ -196,29 +189,6 @@ files:
 - rubocop-layout.yml
 - rubocop-rails.yml
 - rubocop-rspec.yml
-- spec/fixtures/controllers/bad_controller.rb
-- spec/fixtures/controllers/base_controller.rb
-- spec/fixtures/controllers/good_controller.rb
-- spec/fixtures/controllers/inherit_from_outside_controller.rb
-- spec/fixtures/controllers/namespaced_parent_controller.rb
-- spec/fixtures/controllers/no_requires_plugin_controller.rb
-- spec/fixtures/controllers/requires_plugin_controller.rb
-- spec/lib/rubocop/cop/discourse/services/empty_lines_around_blocks_spec.rb
-- spec/lib/rubocop/cop/discourse/services/group_keywords_spec.rb
-- spec/lib/rubocop/cop/fabricator_shorthand_spec.rb
-- 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/lib/rubocop/cop/plugins/call_requires_plugin_spec.rb
-- spec/lib/rubocop/cop/plugins/namespace_constants_spec.rb
-- spec/lib/rubocop/cop/plugins/namespace_methods_spec.rb
-- spec/lib/rubocop/cop/plugins/no_monkey_patching_spec.rb
-- spec/lib/rubocop/cop/plugins/use_plugin_instance_on_spec.rb
-- spec/lib/rubocop/cop/plugins/use_require_relative_spec.rb
-- spec/lib/rubocop/cop/time_eq_matcher_spec.rb
-- spec/spec_helper.rb
 - stree-compat.yml
 homepage: https://github.com/discourse/rubocop-discourse
 licenses:
@@ -232,7 +202,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.github/workflows/ci.yml

@@ -1,41 +0,0 @@
-name: CI
-
-on:
-  pull_request:
-  push:
-    branches:
-      - main
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Setup ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.3"
-          bundler-cache: true
-
-      - name: Rubocop
-        run: bundle exec rubocop
-
-      - name: Rspec
-        run: bundle exec rspec spec
-
-  publish:
-    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-    needs: build
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Release Gem
-        uses: discourse/publish-rubygems-action@v3
-        env:
-          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
-          GIT_EMAIL: team@discourse.org
-          GIT_NAME: discoursebot

data/.gitignore

@@ -1 +0,0 @@
-Gemfile.lock

data/.rspec

@@ -1 +0,0 @@
---require 'spec_helper'

data/.rubocop.yml

@@ -1,9 +0,0 @@
-inherit_from:
-  - default.yml
-
-AllCops:
-  inherit_mode:
-    merge:
-      - Exclude
-  Exclude:
-    - "**/spec/fixtures/**/*"

data/.streerc

@@ -1,2 +0,0 @@
---print-width=100
---plugins=plugin/trailing_comma,plugin/disable_auto_ternary

data/Gemfile

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify dependencies in gemspec
-gemspec
-
-group :development, :test do
-  gem "syntax_tree"
-  gem "byebug"
-end

data/Rakefile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rubocop/rake_task"
-
-RuboCop::RakeTask.new
-
-task default: :rubocop

data/spec/fixtures/controllers/bad_controller.rb

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

data/spec/fixtures/controllers/base_controller.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-class BaseController
-  class << self
-    def requires_plugin(*)
-    end
-
-    def requires_login
-    end
-  end
-end

data/spec/fixtures/controllers/good_controller.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-class GoodController < RequiresPluginController
-end

data/spec/fixtures/controllers/inherit_from_outside_controller.rb

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

data/spec/fixtures/controllers/namespaced_parent_controller.rb

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

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

data/spec/fixtures/controllers/requires_plugin_controller.rb

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

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

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