rubocop-factory_bot 2.23.1 → 2.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d8a45a48d47318e9e16e7b3bbde99ae9dcf94f6e90c068f0916ff2945511e85
-  data.tar.gz: 52ff0ffe8fb20bc0ed3ec4dca29aa13a29b106e39f7bacac370388f0c789bf1c
+  metadata.gz: f2bb256bf3c94a3ff0eca302abed9006719524c843b826f194fbb68c29fea483
+  data.tar.gz: 7b619d4d6732c155369caf1edef5f8c6b1af302ba4114c4ace18eb462e2d14af
 SHA512:
-  metadata.gz: 53082b6baa7e6ebe69f3ebcc1404f2c8421bfcd3ee6905eba12789faca59c1c090b84abc4696a0773598ab06eb97e8aa2b70384864376b58e568d9eef5ce2549
-  data.tar.gz: 26f1817b168218b61f7657400f777ec5eb972cedab14501b2f6a5b1bd8691af9b4c3b04607969923eb58ffca49e4070622040950a7d00742624d4d5b03cf9ee1
+  metadata.gz: 79e7569730a8530231ac5b5f584f35a7e0c2d2d23174966cee57ce5b4ea45d32617bff8adf5ba0d2ad8a4fe59a32c9bd6a6bf67d90f587cfec0a9b4a558e1bc7
+  data.tar.gz: '02965c01b59d3583720b8ca926f0cd2db764557ec41ac4992c582e0622d6d5b364a167ed3933485bd8df7e2d882febdd353878e88e1b175145ea350ffcc1da6b'

data/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 ## Master (Unreleased)
 
+## 2.24.0 (2023-09-18)
+
+- Fix `FactoryBot/AssociationStyle` cop to ignore explicit associations with `strategy: :build`. ([@pirj])
+- Change `FactoryBot/CreateList` so that it is not an offense if not repeated multiple times. ([@ydah])
+- Fix a false positive for `FactoryBot/AssociationStyle` when `association` is called in trait block and column name is keyword. ([@ydah])
+- Fix a false positive for `FactoryBot/AssociationStyle` when `EnforcedStyle: Explicit` and using trait within trait. ([@ydah])
+- Change `FactoryBot/AssociationStyle`, `FactoryBot/AttributeDefinedStatically`, `FactoryBot/CreateList` and `FactoryBot/FactoryClassName` to work with minitest style directory. ([@ydah])
+- Add `FactoryBot/IdSequence` cop. ([@owst])
+
 ## 2.23.1 (2023-05-15)
 
 - Fix `FactoryBot/AssociationStyle` cop for a blockless `factory`. ([@pirj])
@@ -73,6 +82,7 @@
 [@liberatys]: https://github.com/Liberatys
 [@morissetcl]: https://github.com/morissetcl
 [@ngouy]: https://github.com/ngouy
+[@owst]: https://github.com/owst
 [@pirj]: https://github.com/pirj
 [@r7kamura]: https://github.com/r7kamura
 [@seanpdoyle]: https://github.com/seanpdoyle

data/config/default.yml

@@ -2,9 +2,10 @@
 FactoryBot:
   Enabled: true
   Include:
-    - "**/*_spec.rb"
-    - "**/spec/**/*"
-    - "**/test/**/*"
+    - "**/spec/factories.rb"
+    - "**/spec/factories/**/*.rb"
+    - "**/test/factories.rb"
+    - "**/test/factories/**/*.rb"
     - "**/features/support/factories/**/*.rb"
   DocumentationBaseURL: https://docs.rubocop.org/rubocop-factory_bot
 
@@ -12,11 +13,8 @@ FactoryBot/AssociationStyle:
   Description: Use a consistent style to define associations.
   Enabled: pending
   Safe: false
-  Include:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
   VersionAdded: '2.23'
+  VersionChanged: "<<next>>"
   EnforcedStyle: implicit
   SupportedStyles:
     - explicit
@@ -27,17 +25,18 @@ FactoryBot/AssociationStyle:
 FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: true
-  Include:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
   VersionAdded: '1.28'
-  VersionChanged: '2.0'
+  VersionChanged: "<<next>>"
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/AttributeDefinedStatically
 
 FactoryBot/ConsistentParenthesesStyle:
   Description: Use a consistent style for parentheses in factory_bot calls.
   Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   EnforcedStyle: require_parentheses
   SupportedStyles:
     - require_parentheses
@@ -53,9 +52,8 @@ FactoryBot/CreateList:
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   EnforcedStyle: create_list
   SupportedStyles:
     - create_list
@@ -63,12 +61,17 @@ FactoryBot/CreateList:
   ExplicitOnly: false
   SafeAutoCorrect: false
   VersionAdded: '1.25'
-  VersionChanged: '2.23'
+  VersionChanged: "<<next>>"
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/CreateList
 
 FactoryBot/FactoryAssociationWithStrategy:
   Description: Use definition in factory association instead of hard coding a strategy.
   Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   VersionAdded: '2.23'
   VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/FactoryAssociationWithStrategy
@@ -76,17 +79,18 @@ FactoryBot/FactoryAssociationWithStrategy:
 FactoryBot/FactoryClassName:
   Description: Use string value when setting the class attribute explicitly.
   Enabled: true
-  Include:
-    - spec/factories.rb
-    - spec/factories/**/*.rb
-    - features/support/factories/**/*.rb
   VersionAdded: '1.37'
-  VersionChanged: '2.0'
+  VersionChanged: "<<next>>"
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/FactoryClassName
 
 FactoryBot/FactoryNameStyle:
   Description: Checks for name style for argument of FactoryBot::Syntax::Methods.
   Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   EnforcedStyle: symbol
   SupportedStyles:
     - symbol
@@ -96,15 +100,31 @@ FactoryBot/FactoryNameStyle:
   VersionChanged: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/FactoryNameStyle
 
+FactoryBot/IdSequence:
+  Description: Do not create a FactoryBot sequence for an id column.
+  Enabled: pending
+  VersionAdded: "<<next>>"
+  Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/IdSequence
+
 FactoryBot/RedundantFactoryOption:
   Description: Checks for redundant `factory` option.
   Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   VersionAdded: '2.23'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/RedundantFactoryOption
 
 FactoryBot/SyntaxMethods:
   Description: Use shorthands from `FactoryBot::Syntax::Methods` in your specs.
   Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
   SafeAutoCorrect: false
   VersionAdded: '2.7'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/SyntaxMethods

data/lib/rubocop/cop/factory_bot/association_style.rb

@@ -21,6 +21,16 @@ module RuboCop
       #     user
       #   end
       #
+      #   # bad
+      #   factory :post do
+      #     association :user, :author
+      #   end
+      #
+      #   # good
+      #   factory :post do
+      #     user factory: %i[user author]
+      #   end
+      #
       # @example EnforcedStyle: explicit
       #   # bad
       #   factory :post do
@@ -32,6 +42,16 @@ module RuboCop
       #     association :user
       #   end
       #
+      #   # bad
+      #   factory :post do
+      #     user factory: %i[user author]
+      #   end
+      #
+      #   # good
+      #   factory :post do
+      #     association :user, :author
+      #   end
+      #
       #   # good (NonImplicitAssociationMethodNames: ['email'])
       #   sequence :email do |n|
       #     "person#{n}@example.com"
@@ -53,6 +73,11 @@ module RuboCop
         ].freeze
 
         RESTRICT_ON_SEND = %i[factory trait].freeze
+        KEYWORDS = %i[alias and begin break case class def defined? do
+                      else elsif end ensure false for if in module
+                      next nil not or redo rescue retry return self
+                      super then true undef unless until when while
+                      yield __FILE__ __LINE__ __ENCODING__].freeze
 
         def on_send(node)
           bad_associations_in(node).each do |association|
@@ -72,6 +97,13 @@ module RuboCop
           (send nil? :association sym ...)
         PATTERN
 
+        # @!method with_strategy_build_option?(node)
+        def_node_matcher :with_strategy_build_option?, <<~PATTERN
+          (send nil? :association sym ...
+            (hash <(pair (sym :strategy) (sym :build)) ...>)
+          )
+        PATTERN
+
         # @!method implicit_association?(node)
         def_node_matcher :implicit_association?, <<~PATTERN
           (send nil? !#non_implicit_association_method_name? ...)
@@ -103,6 +135,16 @@ module RuboCop
           (send nil? :association _ (sym $_)* ...)
         PATTERN
 
+        # @!method association_names(node)
+        def_node_search :association_names, <<~PATTERN
+          (send nil? :association $...)
+        PATTERN
+
+        # @!method trait_name(node)
+        def_node_search :trait_name, <<~PATTERN
+          (send nil? :trait (sym $_) )
+        PATTERN
+
         def autocorrect(corrector, node)
           if style == :explicit
             autocorrect_to_explicit_style(corrector, node)
@@ -131,9 +173,22 @@ module RuboCop
 
         def bad?(node)
           if style == :explicit
-            implicit_association?(node)
+            implicit_association?(node) &&
+              !trait_within_trait?(node)
           else
-            explicit_association?(node)
+            explicit_association?(node) &&
+              !with_strategy_build_option?(node) &&
+              !keyword?(node)
+          end
+        end
+
+        def keyword?(node)
+          association_names(node).any? do |associations|
+            associations.any? do |association|
+              next unless association.sym_type?
+
+              KEYWORDS.include?(association.value)
+            end
           end
         end
 
@@ -190,6 +245,14 @@ module RuboCop
           end
           options
         end
+
+        def trait_within_trait?(node)
+          factory_node = node.ancestors.reverse.find do |ancestor|
+            ancestor.method?(:factory) if ancestor.block_type?
+          end
+
+          trait_name(factory_node).include?(node.method_name)
+        end
       end
     end
   end

data/lib/rubocop/cop/factory_bot/create_list.rb

@@ -58,7 +58,7 @@ module RuboCop
       #   create_list :user, 3
       #   3.times { create :user }
       #
-      class CreateList < ::RuboCop::Cop::Base
+      class CreateList < ::RuboCop::Cop::Base # rubocop:disable Metrics/ClassLength
         extend AutoCorrector
         include ConfigurableEnforcedStyle
         include RuboCop::FactoryBot::Language
@@ -68,24 +68,15 @@ module RuboCop
         MSG_N_TIMES = 'Prefer %<number>s.times.map.'
         RESTRICT_ON_SEND = %i[create_list].freeze
 
-        # @!method repetition_block?(node)
-        def_node_matcher :repetition_block?, <<-PATTERN
-          (block {#array_new? #n_times? #n_times_map?} ...)
-        PATTERN
-
-        # @!method array_new?(node)
-        def_node_matcher :array_new?, <<-PATTERN
-          (send (const {nil? cbase} :Array) :new (int _))
-        PATTERN
-
-        # @!method n_times?(node)
-        def_node_matcher :n_times?, <<-PATTERN
-          (send (int _) :times)
-        PATTERN
-
-        # @!method n_times_map?(node)
-        def_node_matcher :n_times_map?, <<-PATTERN
-          (send #n_times? :map)
+        # @!method repeat_count(node)
+        def_node_matcher :repeat_count, <<-PATTERN
+          (block
+            {
+              (send (const {nil? cbase} :Array) :new (int $_))  # Array.new(3) { create(:user) }
+              (send (int $_) :times)                            # 3.times { create(:user) }
+              (send (send (int $_) :times) :map)                # 3.times.map { create(:user) }
+            }
+          ...)
         PATTERN
 
         # @!method block_with_arg_and_used?(node)
@@ -99,7 +90,7 @@ module RuboCop
 
         # @!method arguments_include_method_call?(node)
         def_node_matcher :arguments_include_method_call?, <<~PATTERN
-          (send #factory_call? :create sym `$(send ...))
+          (send #factory_call? :create sym `(send ...))
         PATTERN
 
         # @!method factory_call(node)
@@ -119,6 +110,7 @@ module RuboCop
 
         def on_array(node)
           return unless same_factory_calls_in_array?(node)
+          return if node.values.size < 2
 
           add_offense(
             node,
@@ -128,10 +120,9 @@ module RuboCop
           end
         end
 
-        def on_block(node) # rubocop:todo InternalAffairs/NumblockHandler
+        def on_block(node) # rubocop:disable InternalAffairs/NumblockHandler, Metrics/CyclomaticComplexity
           return unless style == :create_list
-
-          return unless repetition_block?(node)
+          return unless repeat_multiple_time?(node)
           return if block_with_arg_and_used?(node)
           return unless node.body
           return if arguments_include_method_call?(node.body)
@@ -146,6 +137,8 @@ module RuboCop
           return unless style == :n_times
 
           factory_list_call(node) do |count|
+            next if count < 2
+
             message = format(MSG_N_TIMES, number: count)
             add_offense(node.loc.selector, message: message) do |corrector|
               TimesCorrector.new(node).call(corrector)
@@ -155,6 +148,12 @@ module RuboCop
 
         private
 
+        def repeat_multiple_time?(node)
+          return false unless (count = repeat_count(node))
+
+          count > 1
+        end
+
         # For ease of modification, it is replaced with the `n_times` style,
         # but if it is not appropriate for the configured style,
         # it will be replaced in the subsequent autocorrection.

data/lib/rubocop/cop/factory_bot/id_sequence.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module FactoryBot
+      # Do not create a FactoryBot sequence for an id column.
+      #
+      # @example
+      #   # bad - can lead to conflicts between FactoryBot and DB sequences
+      #   factory :foo do
+      #     sequence :id
+      #   end
+      #
+      #   # good - a non-id column
+      #   factory :foo do
+      #     sequence :some_non_id_column
+      #   end
+      #
+      class IdSequence < ::RuboCop::Cop::Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Do not create a sequence for an id attribute'
+        RESTRICT_ON_SEND = %i[sequence].freeze
+
+        def on_send(node)
+          return unless node.first_argument.value == :id
+
+          add_offense(node) do |corrector|
+            range_to_remove = range_by_whole_lines(
+              node.source_range,
+              include_final_newline: true
+            )
+
+            corrector.remove(range_to_remove)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/factory_bot_cops.rb

@@ -7,5 +7,6 @@ require_relative 'factory_bot/create_list'
 require_relative 'factory_bot/factory_association_with_strategy'
 require_relative 'factory_bot/factory_class_name'
 require_relative 'factory_bot/factory_name_style'
+require_relative 'factory_bot/id_sequence'
 require_relative 'factory_bot/redundant_factory_option'
 require_relative 'factory_bot/syntax_methods'

data/lib/rubocop/factory_bot/version.rb

@@ -4,7 +4,7 @@ module RuboCop
   module FactoryBot
     # Version information for the factory_bot RuboCop plugin.
     module Version
-      STRING = '2.23.1'
+      STRING = '2.24.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-factory_bot
 version: !ruby/object:Gem::Version
-  version: 2.23.1
+  version: 2.24.0
 platform: ruby
 authors:
 - John Backus
@@ -12,7 +12,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -51,6 +51,7 @@ files:
 - lib/rubocop/cop/factory_bot/factory_association_with_strategy.rb
 - lib/rubocop/cop/factory_bot/factory_class_name.rb
 - lib/rubocop/cop/factory_bot/factory_name_style.rb
+- lib/rubocop/cop/factory_bot/id_sequence.rb
 - lib/rubocop/cop/factory_bot/mixin/configurable_explicit_only.rb
 - lib/rubocop/cop/factory_bot/redundant_factory_option.rb
 - lib/rubocop/cop/factory_bot/syntax_methods.rb
@@ -82,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Code style checking for factory_bot files