rubocop-discourse 3.12.1 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c23f2ba852064ff6f46f7ccc959294a718a7cd3c9ab4d3a554aa479aa28f026a
-  data.tar.gz: 666d63c356fc1e5f6df11e6a0bfcc4fccf797c9ed55efb2dc5fdc0779f52bc70
+  metadata.gz: 01e08f365da90a2bd0cbf1cff4caf796a8ea368a169d8db4bc647df66d689397
+  data.tar.gz: 99a8598e0ad4fe8564f6cbcc106476ca3baace52d16390b81f4cd8b047f3b37d
 SHA512:
-  metadata.gz: 00f091b837a9e0a1df5e9223de49e6660c76a3fba8941a5c5e2a18284d07c7bbd191ebe840f9e2cda20f5f1ef21b5b89bf8e8935d27c8727d045a08b69811371
-  data.tar.gz: d79910e774fa4ca02bddda8f935aada31641127d20699c5b3bf6283724db5eb6a202e116898cdd703eea188771314ed0c99f28477e8c2f09c19590c69daee077
+  metadata.gz: 795176837d6a53075c5b357673e9198503390772b3a2da8197a713a8c58538c15d5699685343286ae711f9435092092efd49ec348f01ae220b8b91fda98482a9
+  data.tar.gz: d8841c96033254114c4bb52e2d03973274dfbf3f1e88a058e934ff85fe54886f8b20edd00c9662606326d7a4cfbfad0b234f7d8b6f3e3b934679c567b833f291

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

@@ -15,8 +15,18 @@ module RuboCop
       # # good
       # fab!(:user)
       #
-      # When using custom attributes or the identifier doesn't match, the
-      # shorthand can't be used.
+      # When the variable name doesn't match the fabricator name but no custom
+      # attributes are used, we can use a more explicit syntax.
+      #
+      # @example
+      #
+      # # bad
+      # fab!(:other_user) { Fabricate(:user) }
+      #
+      # # good
+      # fab!(:other_user, :user)
+      #
+      # When using custom attributes, the block form must be used.
       #
       # @example
       #
@@ -24,12 +34,12 @@ module RuboCop
       # fab!(:user) { Fabricate(:user, trust_level: TrustLevel[0]) }
       #
       # # good
-      # fab!(:another_user) { Fabricate(:user) }
+      # fab!(:other_user) { Fabricate(:user, trust_level: TrustLevel[0]) }
       class FabricatorShorthand < Base
         extend AutoCorrector
         include IgnoredNode
 
-        def_node_matcher :offending_fabricator?, <<-MATCHER
+        def_node_matcher :same_name_fabricator?, <<-MATCHER
           (block
             $(send nil? :fab!
               (sym $_identifier))
@@ -38,14 +48,35 @@ module RuboCop
               (sym $_identifier)))
         MATCHER
 
+        def_node_matcher :different_name_fabricator?, <<-MATCHER
+          (block
+            $(send nil? :fab!
+              (sym $_variable_name))
+            (args)
+            (send nil? :Fabricate
+              (sym $_fabricator_name)))
+        MATCHER
+
         def on_block(node)
-          offending_fabricator?(node) do |expression, _identifier|
+          same_name_fabricator?(node) do |expression, _identifier|
+            add_offense(node, message: message_for_matching(expression.source)) do |corrector|
+              next if part_of_ignored_node?(node)
+              corrector.replace(node, expression.source)
+            end
+            ignore_node(node)
+            return
+          end
+
+          different_name_fabricator?(node) do |expression, variable_name, fabricator_name|
+            # Only apply when names don't match but there are no extra arguments
+            next if variable_name == fabricator_name || has_extra_arguments?(node)
+
             add_offense(
               node,
-              message: message(expression.source)
+              message: message_for_different_names(variable_name, fabricator_name),
             ) do |corrector|
               next if part_of_ignored_node?(node)
-              corrector.replace(node, expression.source)
+              corrector.replace(node, "fab!(:#{variable_name}, :#{fabricator_name})")
             end
             ignore_node(node)
           end
@@ -53,9 +84,19 @@ module RuboCop
 
         private
 
-        def message(expression)
+        def has_extra_arguments?(node)
+          fabricate_node = node.children.last
+          # Check if Fabricate has more than one argument
+          fabricate_node.arguments.size > 1
+        end
+
+        def message_for_matching(expression)
           "Use the fabricator shorthand: `#{expression}`"
         end
+
+        def message_for_different_names(variable_name, fabricator_name)
+          "Use the fabricator shorthand: `fab!(:#{variable_name}, :#{fabricator_name})`"
+        end
       end
     end
   end

data/lib/rubocop/discourse/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Discourse
-    VERSION = "3.12.1"
+    VERSION = "3.13.0"
   end
 end

data/rubocop-rails.yml

@@ -12,3 +12,94 @@ Rails/EnumUniqueness:
 
 Rails/ReversibleMigrationMethodDefinition:
   Enabled: true
+
+Rails/ActiveSupportAliases:
+  Enabled: true
+
+Rails/AddColumnIndex:
+  Enabled: true
+  AutoCorrect: false
+
+Rails/AttributeDefaultBlockValue:
+  Enabled: true
+
+Rails/DurationArithmetic:
+  Enabled: true
+
+Rails/EnvLocal:
+  Enabled: true
+
+Rails/EnvironmentComparison:
+  Enabled: true
+
+Rails/ExpandedDateRange:
+  Enabled: true
+
+Rails/FindBy:
+  Enabled: true
+
+Rails/FindById:
+  Enabled: true
+
+Rails/HttpStatus:
+  Enabled: true
+
+Rails/IndexBy:
+  Enabled: true
+
+Rails/MatchRoute:
+  Enabled: true
+
+Rails/PluralizationGrammar:
+  Enabled: true
+
+Rails/Presence:
+  Enabled: true
+
+Rails/Present:
+  Enabled: true
+  Exclude:
+    - "bin/*"
+
+Rails/ReadWriteAttribute:
+  Enabled: true
+
+Rails/RedundantAllowNil:
+  Enabled: true
+
+Rails/RedundantReceiverInWithOptions:
+  Enabled: true
+
+Rails/RenderPlainText:
+  Enabled: true
+
+Rails/RootPublicPath:
+  Enabled: true
+
+Rails/ScopeArgs:
+  Enabled: true
+
+Rails/StripHeredoc:
+  Enabled: true
+
+Rails/ToFormattedS:
+  Enabled: true
+  EnforcedStyle: to_formatted_s
+
+Rails/TopLevelHashWithIndifferentAccess:
+  Enabled: true
+
+Rails/Validation:
+  Enabled: true
+
+Rails/UnusedRenderContent:
+  Enabled: true
+
+Rails/WhereMissing:
+  Enabled: true
+
+Rails/WhereNot:
+  Enabled: true
+
+Rails/ActiveRecordCallbacksOrder:
+  Enabled: true

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

@@ -22,15 +22,24 @@ RSpec.describe RuboCop::Cop::Discourse::FabricatorShorthand, :config do
     RUBY
   end
 
-  it "does not register an offense when the identifier doesn't match" do
-    expect_no_offenses(<<~RUBY)
+  it "registers an offense when the identifier doesn't match and can be simplified" do
+    expect_offense(<<~RUBY)
       RSpec.describe "Foo" do
         fab!(:bar) { Fabricate(:foo) }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/FabricatorShorthand: Use the fabricator shorthand: `fab!(:bar, :foo)`
+      end
+    RUBY
+  end
+
+  it "does not register an offense when the identifier doesn't match and the fabricator has attributes" do
+    expect_no_offenses(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:bar) { Fabricate(:foo, bar: 1) }
       end
     RUBY
   end
 
-  it "supports autocorrect" do
+  it "supports autocorrect when the name and fabricator matches" do
     expect_offense(<<~RUBY)
       RSpec.describe "Foo" do
         fab!(:foo) { Fabricate(:foo) }
@@ -44,4 +53,19 @@ RSpec.describe RuboCop::Cop::Discourse::FabricatorShorthand, :config do
       end
     RUBY
   end
+
+  it "supports autocorrect when the name and fabricator don't match" do
+    expect_offense(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:bar) { Fabricate(:foo) }
+        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Discourse/FabricatorShorthand: Use the fabricator shorthand: `fab!(:bar, :foo)`
+      end
+    RUBY
+
+    expect_correction(<<~RUBY)
+      RSpec.describe "Foo" do
+        fab!(:bar, :foo)
+      end
+    RUBY
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-discourse
 version: !ruby/object:Gem::Version
-  version: 3.12.1
+  version: 3.13.0
 platform: ruby
 authors:
 - Discourse Team
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -239,7 +239,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Custom rubocop cops used by Discourse
 test_files: []