rubocop-discourse 3.1.0 → 3.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41746c69c5012edbafa4e2f85d902a55a72235316897c0a5afdff69a7b7abbda
-  data.tar.gz: b0128a77bf8387b94c7797c6e3df26a0eb1b0ffb68a87122b005e34aab13a448
+  metadata.gz: 4003717b78bca02f538f48bc23fdd1b0e913bb6816c5d6a1e87401c53c167a14
+  data.tar.gz: acba524c9e7e399a5b69974ce94dfefa33fbd61c5c2197ecb425b1ed22418e23
 SHA512:
-  metadata.gz: abf20aff53a75d624eeb703a3bb86036486ebb6b5dd67b5255312eb8eb7e2ffb04cd57f3cf6ae173bff02a8bee6042fe93acaf038851c2a06011a082e91fd382
-  data.tar.gz: 53b2e0e2bed1e95f94531819aa4f0c5595e1627231f53f626e6f557c59ab42d854f58362211ae8ff23fa60b5ebea4454185de2d9c4ce0322c71f2ed4e89c91e9
+  metadata.gz: 9fd47066d7d8066da4adb2f17d95de3420fbaae18599d07925671a28c58a95a2d39b4ba8319813a0daf2106e7ecce4407a99470a93f2d99f335147bad3142269
+  data.tar.gz: 311df91f7d4cf9b5e296d3dcbf625482a0fdea6ac1da33fe389b7db41ec0339b4918434ce97a13c023ba86e3a54eb81edcb512aba7cb9abd0a21b19bb5b5527d

data/.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '2.6'
+          ruby-version: "3.3"
           bundler-cache: true
 
       - name: Rubocop
@@ -34,7 +34,7 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@v2
+        uses: discourse/publish-rubygems-action@v3
         env:
           RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
           GIT_EMAIL: team@discourse.org

data/.rspec

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

data/.rubocop.yml

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

data/config/default.yml

@@ -1,8 +1,7 @@
 Discourse/NoChdir:
   Enabled: true
   Exclude:
-    - 'spec/**/*' # Specs are run sequentially, so chdir can be used
-    - 'plugins/*/spec/**/*'
+    - "**/spec/**/*" # Specs are run sequentially, so chdir can be used
 
 Discourse/NoTimeNewWithoutArgs:
   Enabled: true
@@ -13,8 +12,8 @@ Discourse/NoURIEscapeEncode:
 Discourse/NoAddReferenceOrAliasesActiveRecordMigration:
   Enabled: true
   Include:
-  - "**/db/migrate/*"
-  - "**/db/post_migrate/*"
+    - "**/db/migrate/*"
+    - "**/db/post_migrate/*"
 
 Discourse/NoNokogiriHtmlFragment:
   Enabled: true
@@ -22,43 +21,71 @@ Discourse/NoNokogiriHtmlFragment:
 Discourse/NoResetColumnInformationInMigrations:
   Enabled: false
   Include:
-  - "**/db/migrate/*"
-  - "**/db/post_migrate/*"
+    - "**/db/migrate/*"
+    - "**/db/post_migrate/*"
 
 # Specs
 
 Discourse/NoDirectMultisiteManipulation:
   Enabled: true
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
 
 Discourse/TimeEqMatcher:
   Enabled: true
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
 
 Discourse/NoJsonParseResponse:
   Enabled: false
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
 
 Discourse/NoMockingJobs:
   Enabled: true
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
 
 Discourse/OnlyTopLevelMultisiteSpecs:
   Enabled: true
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
 
 Discourse/NoMixingMultisiteAndStandardSpecs:
   Enabled: true
-  Patterns:
-  - _spec.rb
-  - "(?:^|/)spec/"
+  Include:
+    - "**/spec/**/*"
+
+Discourse/Plugins/CallRequiresPlugin:
+  Enabled: true
+  Include:
+    - "app/controllers/**/*"
+
+Discourse/Plugins/UsePluginInstanceOn:
+  Enabled: true
+
+Discourse/Plugins/NamespaceMethods:
+  Enabled: true
+  Exclude:
+    - "**/spec/**/*"
+    - "**/tasks/**/*.rake"
+    - "**/db/fixtures/**/*"
+
+Discourse/Plugins/NamespaceConstants:
+  Enabled: true
+  Exclude:
+    - "**/spec/**/*"
+    - "**/tasks/**/*.rake"
+    - "**/db/fixtures/**/*"
+
+Discourse/Plugins/UseRequireRelative:
+  Enabled: true
+
+Discourse/Plugins/NoMonkeyPatching:
+  Enabled: true
+
+Discourse/Services/GroupKeywords:
+  Enabled: true
+
+Discourse/Services/EmptyLinesAroundBlocks:
+  Enabled: true

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # When fabricating a record without custom attributes, we can use the
+      # fabricator shorthand as long as the identifier matches the fabricator
+      # name.
+      #
+      # @example
+      #
+      # # bad
+      # fab!(:user) { Fabricate(:user) }
+      #
+      # # good
+      # fab!(:user)
+      #
+      # When using custom attributes or the identifier doesn't match, the
+      # shorthand can't be used.
+      #
+      # @example
+      #
+      # # good
+      # fab!(:user) { Fabricate(:user, trust_level: TrustLevel[0]) }
+      #
+      # # good
+      # fab!(:another_user) { Fabricate(:user) }
+      class FabricatorShorthand < Base
+        extend AutoCorrector
+        include IgnoredNode
+
+        def_node_matcher :offending_fabricator?, <<-MATCHER
+          (block
+            $(send nil? :fab!
+              (sym $_identifier))
+            (args)
+            (send nil? :Fabricate
+              (sym $_identifier)))
+        MATCHER
+
+        def on_block(node)
+          offending_fabricator?(node) do |expression, _identifier|
+            add_offense(
+              node,
+              message: message(expression.source)
+            ) do |corrector|
+              next if part_of_ignored_node?(node)
+              corrector.replace(node, expression.source)
+            end
+            ignore_node(node)
+          end
+        end
+
+        private
+
+        def message(expression)
+          "Use the fabricator shorthand: `#{expression}`"
+        end
+      end
+    end
+  end
+end

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

@@ -44,7 +44,7 @@ module RuboCop
       #     index_posts_on_image_upload_id ON posts USING btree (image_upload_id)
       #   SQL
       # end
-      class NoAddReferenceOrAliasesActiveRecordMigration < Cop
+      class NoAddReferenceOrAliasesActiveRecordMigration < Base
         MSG = <<~MSG
           AR methods add_reference, add_belongs_to, t.references, and t.belongs_to are
           high-risk for large tables and have too many background magic operations.
@@ -70,12 +70,14 @@ module RuboCop
         MATCHER
 
         def on_send(node)
-          return if [
-            using_add_reference?(node),
-            using_add_belongs_to?(node),
-            using_t_references?(node),
-            using_t_belongs_to?(node)
-          ].none?
+          if [
+               using_add_reference?(node),
+               using_add_belongs_to?(node),
+               using_t_references?(node),
+               using_t_belongs_to?(node),
+             ].none?
+            return
+          end
           add_offense(node, message: MSG)
         end
       end

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

@@ -13,7 +13,7 @@ module RuboCop
       # @example
       #   # bad
       #   Dir.chdir("test")
-      class NoChdir < Cop
+      class NoChdir < Base
         MSG = "Chdir is not thread safe."
 
         def_node_matcher :using_dir_chdir?, <<-MATCHER

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

@@ -16,8 +16,9 @@ module RuboCop
       #   it "works", type: :multisite do
       #     do_something
       #   end
-      class NoDirectMultisiteManipulation < Cop
-        MSG = "Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`."
+      class NoDirectMultisiteManipulation < Base
+        MSG =
+          "Use `type: :multisite` example setting instead of modifying `Rails.configuration.multisite`."
 
         def_node_matcher :multisite_setter?, <<-MATCHER
           (send

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

@@ -11,7 +11,7 @@ module RuboCop
       #
       #   # good
       #   expect(response.parsed_body).to eq({})
-      class NoJsonParseResponse < Cop
+      class NoJsonParseResponse < Base
         MSG = "Use `response.parsed_body` instead of `JSON.parse(response.body)` in specs."
 
         def_node_matcher :json_parse_body?, <<-MATCHER
@@ -28,9 +28,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, "response.parsed_body")
-          end
+          lambda { |corrector| corrector.replace(node.loc.expression, "response.parsed_body") }
         end
       end
     end

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

@@ -23,8 +23,9 @@ module RuboCop
       #   # 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."
+      class NoMixingMultisiteAndStandardSpecs < Base
+        MSG =
+          "Do not mix multisite and standard specs. Consider moving multisite describes to a separate file."
 
         def initialize(config = nil, options = nil)
           super
@@ -64,11 +65,7 @@ module RuboCop
         MATCHER
 
         def top_level?(node)
-          if node.parent&.begin_type?
-            node.parent.root?
-          else
-            node.root?
-          end
+          node.parent&.begin_type? ? node.parent.root? : node.root?
         end
       end
     end

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

@@ -3,8 +3,9 @@
 module RuboCop
   module Cop
     module Discourse
-      class NoMockingJobs < Cop
-        MSG = "Use the test helpers provided by Sidekiq instead of mocking `Jobs.expects(:enqueue)`."
+      class NoMockingJobs < Base
+        MSG =
+          "Use the test helpers provided by Sidekiq instead of mocking `Jobs.expects(:enqueue)`."
 
         def_node_matcher :mocking_jobs_enqueue?, <<~MATCHER
         (send (const nil? :Jobs) :expects (:sym :enqueue))

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

@@ -12,7 +12,7 @@ module RuboCop
       #
       #   # good
       #   Nokogiri::HTML5.fragment("<p>test</p>")
-      class NoNokogiriHtmlFragment < Cop
+      class NoNokogiriHtmlFragment < Base
         MSG = "Nokogiri::HTML.fragment is deprecated and should not be used."
 
         def_node_matcher :using_nokogiri_html_fragment?, <<-MATCHER

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

@@ -7,11 +7,12 @@ module RuboCop
       # migrations. The method is not thread safe and we run migrations
       # concurrently for multisites. Also, we don't encourage the use of
       # ActiveRecord methods in migrations and prefer to write SQL directly.
-      class NoResetColumnInformationInMigrations < Cop
-        MSG = "ActiveRecord::ModelSchema.reset_column_information is not thread-safe " \
-          "and we run migrations concurrently on multisite clusters. Using this " \
-          "method also means ActiveRecord methods are being used in migration "\
-          "which is discouraged at Discourse. Instead, you should write SQL in your migrations instead."
+      class NoResetColumnInformationInMigrations < Base
+        MSG =
+          "ActiveRecord::ModelSchema.reset_column_information is not thread-safe " \
+            "and we run migrations concurrently on multisite clusters. Using this " \
+            "method also means ActiveRecord methods are being used in migration " \
+            "which is discouraged at Discourse. Instead, you should write SQL in your migrations instead."
 
         def on_send(node)
           return if node.method_name != :reset_column_information

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

@@ -11,7 +11,7 @@ module RuboCop
       #
       #   # good
       #   now = Time.zone.now
-      class NoTimeNewWithoutArgs < Cop
+      class NoTimeNewWithoutArgs < Base
         MSG = "Use `Time.zone.now` instead of `Time.new` without arguments."
 
         def_node_matcher :time_new_without_args?, <<-MATCHER
@@ -25,9 +25,7 @@ module RuboCop
         end
 
         def autocorrect(node)
-          lambda do |corrector|
-            corrector.replace(node.loc.expression, "Time.zone.now")
-          end
+          lambda { |corrector| corrector.replace(node.loc.expression, "Time.zone.now") }
         end
       end
     end

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

@@ -15,8 +15,9 @@ module RuboCop
       #   # good
       #   UrlHelper.encode("https://a%20a.com?a='a%22")
       #   Addressable::URI.encode("https://a%20a.com?a='a%22")
-      class NoURIEscapeEncode < Cop
-        MSG = "URI.escape, URI.encode, URI.unescape, URI.decode are deprecated and should not be used."
+      class NoURIEscapeEncode < Base
+        MSG =
+          "URI.escape, URI.encode, URI.unescape, URI.decode are deprecated and should not be used."
 
         def_node_matcher :using_uri_escape?, <<-MATCHER
           (send (const nil? :URI) :escape ...)
@@ -35,12 +36,14 @@ module RuboCop
         MATCHER
 
         def on_send(node)
-          return if [
-            using_uri_escape?(node),
-            using_uri_encode?(node),
-            using_uri_unescape?(node),
-            using_uri_decode?(node)
-          ].none?
+          if [
+               using_uri_escape?(node),
+               using_uri_encode?(node),
+               using_uri_unescape?(node),
+               using_uri_decode?(node),
+             ].none?
+            return
+          end
           add_offense(node, message: MSG)
         end
       end

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

@@ -25,7 +25,7 @@ module RuboCop
       #     it "does X" do
       #     end
       #   end
-      class OnlyTopLevelMultisiteSpecs < Cop
+      class OnlyTopLevelMultisiteSpecs < Base
         MSG = "Use `type: :multisite` only on a top-level `describe`"
 
         def on_block(node)
@@ -47,11 +47,7 @@ module RuboCop
         MATCHER
 
         def top_level?(node)
-          if node.parent&.begin_type?
-            node.parent.root?
-          else
-            node.root?
-          end
+          node.parent&.begin_type? ? node.parent.root? : node.root?
         end
       end
     end

data/lib/rubocop/cop/discourse/plugins/call_requires_plugin.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Plugin controllers must call `requires_plugin` to prevent routes from
+        # being accessible when the plugin is disabled.
+        #
+        # @example
+        #   # bad
+        #   class MyController
+        #     def my_action
+        #     end
+        #   end
+        #
+        #   # good
+        #   class MyController
+        #     requires_plugin PLUGIN_NAME
+        #     def my_action
+        #     end
+        #   end
+        #
+        class CallRequiresPlugin < Base
+          MSG =
+            "Use `requires_plugin` in controllers to prevent routes from being accessible when plugin is disabled."
+
+          def_node_matcher :requires_plugin_present?, <<~MATCHER
+            (class _ _
+              {
+                (begin <(send nil? :requires_plugin _) ...>)
+                <(send nil? :requires_plugin _) ...>
+              }
+            )
+          MATCHER
+
+          def on_class(node)
+            return if requires_plugin_present?(node)
+            return if requires_plugin_present_in_parent_classes(node)
+            add_offense(node, message: MSG)
+          end
+
+          private
+
+          def requires_plugin_present_in_parent_classes(node)
+            return unless processed_source.path
+            controller_path =
+              base_controller_path(node.parent_class&.const_name.to_s)
+            return unless controller_path
+            Commissioner
+              .new([self.class.new(config, @options)])
+              .investigate(parse(controller_path.read, controller_path.to_s))
+              .offenses
+              .empty?
+          end
+
+          def base_controller_path(base_class)
+            return if base_class.blank?
+            base_path = "#{base_class.underscore}.rb"
+            path = Pathname.new("#{processed_source.path}/../").cleanpath
+            until path.root?
+              controller_path = path.join(base_path)
+              return controller_path if controller_path.exist?
+              path = path.join("..").cleanpath
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/plugins/namespace_constants.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Constants must be defined inside the plugin namespace (module or class).
+        #
+        # @example
+        #   # bad
+        #   MY_CONSTANT = :value
+        #
+        #   # good
+        #   module MyPlugin
+        #     MY_CONSTANT = :value
+        #   end
+        #
+        class NamespaceConstants < Base
+          MSG = "Don’t define constants outside a class or a module."
+
+          def on_casgn(node)
+            return if inside_namespace?(node)
+            add_offense(node, message: MSG)
+          end
+
+          private
+
+          def inside_namespace?(node)
+            node.each_ancestor.detect { _1.class_type? || _1.module_type? }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/plugins/namespace_methods.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Methods must be defined inside the plugin namespace (module or class).
+        #
+        # @example
+        #   # bad
+        #   def my_method
+        #   end
+        #
+        #   # good
+        #   module MyPlugin
+        #     def my_method
+        #     end
+        #   end
+        #
+        class NamespaceMethods < Base
+          MSG = "Don’t define methods outside a class or a module."
+
+          def on_def(node)
+            return if inside_namespace?(node)
+            add_offense(node, message: MSG)
+          end
+
+          private
+
+          def inside_namespace?(node)
+            node.each_ancestor.detect { _1.class_type? || _1.module_type? }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/plugins/no_monkey_patching.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Plugins
+        # Don’t monkey-patch classes directly in `plugin.rb`. Instead, define
+        # additional methods in a dedicated mixin (an ActiveSupport concern for
+        # example) and use `prepend` (this allows calling `super` from the mixin).
+        #
+        # If you’re just adding new methods to an existing serializer, then use
+        # `add_to_serializer` instead.
+        #
+        # @example generic monkey-patching
+        #   # bad
+        #   ::Topic.class_eval do
+        #     has_many :new_items
+        #
+        #     def new_method
+        #     end
+        #   end
+        #
+        #   # good
+        #   module MyPlugin::TopicExtension
+        #     extend ActiveSupport::Concern
+        #
+        #     prepended do
+        #       has_many :new_items
+        #     end
+        #
+        #     def new_method
+        #     end
+        #   end
+        #
+        #   reloadable_patch { ::Topic.prepend(MyPlugin::TopicExtension) }
+        #
+        # @example for serializers
+        #   # bad
+        #   UserSerializer.class_eval do
+        #     def new_method
+        #       do_processing
+        #     end
+        #   end
+        #
+        #   # good
+        #   add_to_serializer(:user, :new_method) { do_processing }
+        #
+        class NoMonkeyPatching < Base
+          MSG =
+            "Don’t reopen existing classes. Instead, create a mixin and use `prepend`."
+          MSG_CLASS_EVAL =
+            "Don’t call `class_eval`. Instead, create a mixin and use `prepend`."
+          MSG_CLASS_EVAL_SERIALIZERS =
+            "Don’t call `class_eval` on a serializer. If you’re adding new methods, use `add_to_serializer`. Otherwise, create a mixin and use `prepend`."
+          MSG_SERIALIZERS =
+            "Don’t reopen serializers. Instead, use `add_to_serializer`."
+          RESTRICT_ON_SEND = [:class_eval].freeze
+
+          def_node_matcher :existing_class?, <<~MATCHER
+            (class (const (cbase) _) ...)
+          MATCHER
+
+          def_node_matcher :serializer?, <<~MATCHER
+            ({class send} (const _ /Serializer$/) ...)
+          MATCHER
+
+          def on_send(node)
+            if serializer?(node)
+              return add_offense(node, message: MSG_CLASS_EVAL_SERIALIZERS)
+            end
+            add_offense(node, message: MSG_CLASS_EVAL)
+          end
+
+          def on_class(node)
+            return unless in_plugin_rb_file?
+            return unless existing_class?(node)
+            if serializer?(node)
+              return add_offense(node, message: MSG_SERIALIZERS)
+            end
+            add_offense(node, message: MSG)
+          end
+
+          private
+
+          def in_plugin_rb_file?
+            processed_source.path.split("/").last == "plugin.rb"
+          end
+        end
+      end
+    end
+  end
+end