rubocop-discourse 3.14.0 → 3.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e722863ce072ee0a4d928e09b36a1e12e3b653618fdc0fe70a2f417d466e0ffa
-  data.tar.gz: bd4a868a26bd7df10e3196c9d9c419f1b4268051d6302b335994eb539ae6e61e
+  metadata.gz: 6c45b71e5356cb68292653738d05f27653a5e922d62442130751e8c341506680
+  data.tar.gz: 89e1f0b302c37bf300ceb97cea9a2035e49811c33e8d32dc50c22972f128f563
 SHA512:
-  metadata.gz: 0e266174ecceb19102b630bdb01419b0b22580fcadaf5cc5f69a3ba7c7c91a6274ff391a7cf43769c71cb035699e1867d96b0c72ba28cd0706335a5821ce3fe4
-  data.tar.gz: 3e5d42d6aa34bf2eb23daaf91eef254623cd83fe812525c2bda429cd96e9f3ec0b0d0b19129d3faa5e64e749decf0164f012d99755787559d2e715ec3e16441c
+  metadata.gz: fa562f62898674a35e4d7d12c513d648727fa20d982812ed4e7af1a30e08b65e6249fd1f20cd250f1a9e422dd15509b7409bec1ed1a9ac4897dedd5e56e1b0e7
+  data.tar.gz: 2cf1e4dd9cdaf5a57dfe7d3814c2624c46b3179b93ce5b9341be33e763270bb2f5ffd3ebb66ff74c86e269a4e23c27081b02232a40822d2689c1089e79378a0a

data/config/default.yml

@@ -56,6 +56,11 @@ Discourse/NoMixingMultisiteAndStandardSpecs:
   Include:
     - "**/spec/**/*"
 
+Discourse/NoSystemSpecMetadata:
+  Enabled: true
+  Include:
+    - "**/spec/**/*"
+
 Discourse/Plugins/CallRequiresPlugin:
   Enabled: true
   Include:
@@ -89,3 +94,6 @@ Discourse/Services/GroupKeywords:
 
 Discourse/Services/EmptyLinesAroundBlocks:
   Enabled: true
+
+Discourse/Services/MutableAttributeDefault:
+  Enabled: true

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      # System spec metadata is inferred from the file path, so explicit
+      # `type: :system` and `system: true` metadata on `RSpec.describe` is redundant.
+      #
+      # @example
+      #   # bad
+      #   RSpec.describe "login", system: true do
+      #   end
+      #
+      #   # good
+      #   RSpec.describe "login" do
+      #   end
+      class NoSystemSpecMetadata < Base
+        extend AutoCorrector
+
+        MSG = "Remove redundant `type: :system` and `system: true` metadata from `RSpec.describe`."
+        RESTRICT_ON_SEND = %i[describe].freeze
+
+        def_node_matcher :describe?, <<~PATTERN
+          (send
+            {nil? (const nil? :RSpec)}
+            :describe
+            ...
+          )
+        PATTERN
+
+        def_node_matcher :system_type_pair?, <<~PATTERN
+          (pair (sym :type) (sym :system))
+        PATTERN
+
+        def_node_matcher :system_true_pair?, <<~PATTERN
+          (pair (sym :system) true)
+        PATTERN
+
+        def on_send(node)
+          return unless describe?(node)
+          return unless node.last_argument&.hash_type?
+
+          hash = node.last_argument
+          offending_pairs =
+            hash.pairs.select { |pair| system_type_pair?(pair) || system_true_pair?(pair) }
+
+          return if offending_pairs.empty?
+
+          add_offense(offending_pairs.first) do |corrector|
+            corrector.replace(node, corrected_send_source(node, hash, offending_pairs))
+          end
+        end
+
+        private
+
+        def corrected_send_source(node, hash, offending_pairs)
+          remaining_pairs = hash.pairs - offending_pairs
+          before_hash = source_for(node.source_range.begin_pos, hash.source_range.begin_pos)
+          after_hash = source_for(hash.source_range.end_pos, node.source_range.end_pos)
+
+          return "#{before_hash.sub(/,\s*\z/m, "")}#{after_hash}" if remaining_pairs.empty?
+
+          "#{before_hash}#{corrected_hash_source(hash, remaining_pairs)}#{after_hash}"
+        end
+
+        def corrected_hash_source(hash, remaining_pairs)
+          body =
+            remaining_pairs
+              .each_with_index
+              .map do |pair, index|
+                separator = index.zero? ? "" : pair_separator(hash, pair)
+                "#{separator}#{pair.source}"
+              end
+              .join
+
+          return body unless hash.braces?
+
+          return "{ #{body} }" unless hash.multiline?
+
+          indentation = " " * remaining_pairs.first.loc.expression.column
+          closing_indentation = " " * hash.loc.end.column
+
+          "{\n#{indentation}#{body}\n#{closing_indentation}}"
+        end
+
+        def pair_separator(hash, pair)
+          return ", " unless hash.multiline?
+
+          ",\n#{" " * pair.loc.expression.column}"
+        end
+
+        def source_for(begin_pos, end_pos)
+          processed_source.buffer.source[begin_pos...end_pos]
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/discourse/services/mutable_attribute_default.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Discourse
+      module Services
+        # Wrap mutable `attribute` defaults in a proc — `ActiveModel::Attributes`
+        # shares the literal across instances, so mutations leak between calls.
+        # `:array`-typed attributes are exempt; the type dups on read.
+        #
+        # @example
+        #   # bad
+        #   options do
+        #   attribute :overrides, default: {}
+        #     attribute :ids, default: [1, 2]
+        #   end
+        #
+        #   # good
+        #   options do
+        #   attribute :overrides, default: -> { {} }
+        #     attribute :ids, default: -> { [1, 2] }
+        #     attribute :tags, :array, default: [] # :array dups per read
+        #   end
+        #
+        class MutableAttributeDefault < Base
+          extend AutoCorrector
+
+          MSG =
+            "Mutable `default: %<source>s` is shared across all instances; wrap it in a proc: `-> { %<source>s }`."
+          RESTRICT_ON_SEND = %i[attribute].freeze
+
+          def_node_matcher :service_include?, <<~MATCHER
+            (class _ _
+             {
+               (begin <(send nil? :include (const (const nil? :Service) :Base)) ...>)
+               <(send nil? :include (const (const nil? :Service) :Base)) ...>
+             }
+            )
+          MATCHER
+
+          def_node_matcher :mutable_default, <<~PATTERN
+            (send nil? :attribute _ ... (hash <(pair (sym :default) ${hash array}) ...>))
+          PATTERN
+
+          def_node_matcher :array_typed?, <<~PATTERN
+            (send nil? :attribute _ (sym :array) ...)
+          PATTERN
+
+          def on_class(node)
+            @service = true if service_include?(node)
+          end
+
+          def on_send(node)
+            return unless @service
+            return if array_typed?(node)
+            default = mutable_default(node)
+            return unless default
+
+            source = default.source
+            add_offense(default, message: format(MSG, source: source)) do |corrector|
+              corrector.replace(default, "-> { #{source} }")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/discourse/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Discourse
-    VERSION = "3.14.0"
+    VERSION = "3.17.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 3.14.0
+  version: 3.17.0
 platform: ruby
 authors:
 - Discourse Team
@@ -167,6 +167,7 @@ files:
 - 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_system_spec_metadata.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
@@ -178,6 +179,7 @@ files:
 - lib/rubocop/cop/discourse/plugins/use_require_relative.rb
 - lib/rubocop/cop/discourse/services/empty_lines_around_blocks.rb
 - lib/rubocop/cop/discourse/services/group_keywords.rb
+- lib/rubocop/cop/discourse/services/mutable_attribute_default.rb
 - lib/rubocop/cop/discourse/time_eq_matcher.rb
 - lib/rubocop/cop/discourse_cops.rb
 - lib/rubocop/discourse/plugin.rb