rubocop-factory_bot 2.24.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2bb256bf3c94a3ff0eca302abed9006719524c843b826f194fbb68c29fea483
-  data.tar.gz: 7b619d4d6732c155369caf1edef5f8c6b1af302ba4114c4ace18eb462e2d14af
+  metadata.gz: f13120d5e06606e2f01a7521724acfcb9d79989c5dcd5725cfb9dc509f4b9244
+  data.tar.gz: a6dc74ea1bed0ae4b52a7449c2e94d11a6d404803f8eaf57b1ff4bb934a7869e
 SHA512:
-  metadata.gz: 79e7569730a8530231ac5b5f584f35a7e0c2d2d23174966cee57ce5b4ea45d32617bff8adf5ba0d2ad8a4fe59a32c9bd6a6bf67d90f587cfec0a9b4a558e1bc7
-  data.tar.gz: '02965c01b59d3583720b8ca926f0cd2db764557ec41ac4992c582e0622d6d5b364a167ed3933485bd8df7e2d882febdd353878e88e1b175145ea350ffcc1da6b'
+  metadata.gz: feb49a6ac85e680b9517a54937e96c0d246723082d92f1f995f90735a2b6af34bff9c8681517e164969aacc84cae22a0f1289723428050787e4096c11ba2d735
+  data.tar.gz: 151c71b63326bcd320be0db9a78a92cff0718214e41a03c349f2c178fdf3c3609a57f911658397934848b58d934b48f85ee12032daff500db8b0b67f2f0ace02

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 
 ## Master (Unreleased)
 
+## 2.26.0 (2024-06-08)
+
+- Fix a false positive for `FactoryBot/AssociationStyle` when using nested factories with traits. ([@jaydorsey])
+- Support `AutoCorrect: contextual` option for LSP. ([@ydah])
+
+## 2.25.1 (2024-01-08)
+
+- Fix a false positive for `FactoryBot/CreateList` when create call does have method calls and repeat multiple times with other argument. ([@ydah])
+- Fix an error occurred for `FactoryBot/IdSequence` when `sequence` with non-symbol argument or without argument. ([@ydah])
+
+## 2.25.0 (2024-01-04)
+
+- Fix a false positive for `FactoryBot/FactoryNameStyle` when namespaced models. ([@ydah])
+- Add new `FactoryBot/ExcessiveCreateList` cop. ([@ddieulivol])
+- Fix a false positive for `FactoryBot/ConsistentParenthesesStyle` when hash pinning. ([@ydah])
+
 ## 2.24.0 (2023-09-18)
 
 - Fix `FactoryBot/AssociationStyle` cop to ignore explicit associations with `strategy: :build`. ([@pirj])
@@ -31,7 +47,7 @@
 
 ## Previously (see [rubocop-rspec's changelist](https://github.com/rubocop/rubocop-rspec/blob/70a97b1895ce4b9bcd6ff336d5d343ddc6175fe6/CHANGELOG.md) for details)
 
-- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on ([@dmitrytsepelev])
+- Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` inside `&&`, `||` and `:?` when `omit_parentheses` is on. ([@dmitrytsepelev])
 - Add new `RSpec/FactoryBot/FactoryNameStyle` cop. ([@ydah])
 - Fix wrong autocorrection in `n_times` style on `RSpec/FactoryBot/CreateList`. ([@r7kamura])
 - Fix a false positive for `RSpec/FactoryBot/ConsistentParenthesesStyle` when using `generate` with multiple arguments. ([@ydah])
@@ -74,8 +90,10 @@
 [@bquorning]: https://github.com/bquorning
 [@composerinteralia]: https://github.com/composerinteralia
 [@darhazer]: https://github.com/Darhazer
+[@ddieulivol]: https://github.com/ddieulivol
 [@dmitrytsepelev]: https://github.com/dmitrytsepelev
 [@harrylewis]: https://github.com/harrylewis
+[@jaydorsey]: https://github.com/jaydorsey
 [@jfragoulis]: https://github.com/jfragoulis
 [@jonatas]: https://github.com/jonatas
 [@leoarnold]: https://github.com/leoarnold

data/config/default.yml

@@ -14,7 +14,7 @@ FactoryBot/AssociationStyle:
   Enabled: pending
   Safe: false
   VersionAdded: '2.23'
-  VersionChanged: "<<next>>"
+  VersionChanged: '2.24'
   EnforcedStyle: implicit
   SupportedStyles:
     - explicit
@@ -26,7 +26,7 @@ FactoryBot/AttributeDefinedStatically:
   Description: Always declare attribute values as blocks.
   Enabled: true
   VersionAdded: '1.28'
-  VersionChanged: "<<next>>"
+  VersionChanged: '2.24'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/AttributeDefinedStatically
 
 FactoryBot/ConsistentParenthesesStyle:
@@ -49,6 +49,7 @@ FactoryBot/ConsistentParenthesesStyle:
 FactoryBot/CreateList:
   Description: Checks for create_list usage.
   Enabled: true
+  AutoCorrect: contextual
   Include:
     - "**/*_spec.rb"
     - "**/spec/**/*"
@@ -61,9 +62,21 @@ FactoryBot/CreateList:
   ExplicitOnly: false
   SafeAutoCorrect: false
   VersionAdded: '1.25'
-  VersionChanged: "<<next>>"
+  VersionChanged: '2.26'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/CreateList
 
+FactoryBot/ExcessiveCreateList:
+  Description: Check for excessive model creation in a list.
+  Enabled: pending
+  Include:
+    - "**/*_spec.rb"
+    - "**/spec/**/*"
+    - "**/test/**/*"
+    - "**/features/support/factories/**/*.rb"
+  MaxAmount: 10
+  VersionAdded: '2.25'
+  Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/ExcessiveCreateList
+
 FactoryBot/FactoryAssociationWithStrategy:
   Description: Use definition in factory association instead of hard coding a strategy.
   Enabled: pending
@@ -80,7 +93,7 @@ FactoryBot/FactoryClassName:
   Description: Use string value when setting the class attribute explicitly.
   Enabled: true
   VersionAdded: '1.37'
-  VersionChanged: "<<next>>"
+  VersionChanged: '2.24'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/FactoryClassName
 
 FactoryBot/FactoryNameStyle:
@@ -103,7 +116,7 @@ FactoryBot/FactoryNameStyle:
 FactoryBot/IdSequence:
   Description: Do not create a FactoryBot sequence for an id column.
   Enabled: pending
-  VersionAdded: "<<next>>"
+  VersionAdded: '2.24'
   Reference: https://www.rubydoc.info/gems/rubocop-factory_bot/RuboCop/Cop/FactoryBot/IdSequence
 
 FactoryBot/RedundantFactoryOption:

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

@@ -67,6 +67,7 @@ module RuboCop
 
         DEFAULT_NON_IMPLICIT_ASSOCIATION_METHOD_NAMES = %w[
           association
+          factory
           sequence
           skip_create
           traits_for_enum

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

@@ -70,7 +70,7 @@ module RuboCop
         end
 
         def receiver_matches_first_block_argument?(receiver, node)
-          first_block_argument = node.arguments.first
+          first_block_argument = node.first_argument
 
           !first_block_argument.nil? &&
             receiver.lvar_type? &&

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

@@ -75,6 +75,17 @@ module RuboCop
           )
         PATTERN
 
+        # @!method omit_hash_value?(node)
+        def_node_matcher :omit_hash_value?, <<~PATTERN
+          (send
+            #factory_call? %FACTORY_CALLS
+            {sym str send lvar}
+            (hash
+              <value_omission? ...>
+            )
+          )
+        PATTERN
+
         def self.autocorrect_incompatible_with
           [Style::MethodCallWithArgsParentheses]
         end
@@ -97,6 +108,7 @@ module RuboCop
         def register_offense_with_parentheses(node)
           return if style == :require_parentheses || !node.parenthesized?
           return unless same_line?(node, node.first_argument)
+          return if omit_hash_value?(node)
 
           add_offense(node.loc.selector,
                       message: MSG_OMIT_PARENS) do |corrector|

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

@@ -69,7 +69,7 @@ module RuboCop
         RESTRICT_ON_SEND = %i[create_list].freeze
 
         # @!method repeat_count(node)
-        def_node_matcher :repeat_count, <<-PATTERN
+        def_node_matcher :repeat_count, <<~PATTERN
           (block
             {
               (send (const {nil? cbase} :Array) :new (int $_))  # Array.new(3) { create(:user) }
@@ -90,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)
@@ -104,7 +104,7 @@ module RuboCop
         PATTERN
 
         # @!method factory_calls_in_array?(node)
-        def_node_search :factory_calls_in_array?, <<-PATTERN
+        def_node_search :factory_calls_in_array?, <<~PATTERN
           (array #factory_call+)
         PATTERN
 

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module FactoryBot
+      # Check for excessive model creation in a list.
+      #
+      # @example MaxAmount: 10 (default)
+      #   # We do not allow more than 10 items to be created
+      #
+      #   # bad
+      #   create_list(:merge_request, 1000, state: :opened)
+      #
+      #   # good
+      #   create_list(:merge_request, 10, state: :opened)
+      #
+      # @example MaxAmount: 20
+      #   # We do not allow more than 20 items to be created
+      #
+      #   # bad
+      #   create_list(:merge_request, 1000, state: :opened)
+      #
+      #   # good
+      #   create_list(:merge_request, 15, state: :opened)
+      #
+      class ExcessiveCreateList < ::RuboCop::Cop::Base
+        include ConfigurableExplicitOnly
+
+        MESSAGE =
+          'Avoid using `create_list` with more than %<max_amount>s items.'
+
+        # @!method create_list?(node)
+        def_node_matcher :create_list?, <<~PATTERN
+          (send #factory_call? :create_list {sym str} $(int _) ...)
+        PATTERN
+
+        RESTRICT_ON_SEND = %i[create_list].freeze
+
+        def on_send(node)
+          number_node = create_list?(node)
+          return unless number_node
+
+          max_amount = cop_config['MaxAmount']
+          return if number_node.value <= max_amount
+
+          add_offense(number_node, message:
+            format(MESSAGE, max_amount: max_amount))
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,9 @@ module RuboCop
       #   create(:user)
       #   build :user, username: "NAME"
       #
+      #   # good - namespaced models
+      #   create('users/internal')
+      #
       # @example EnforcedStyle: string
       #   # bad
       #   create(:user)
@@ -76,13 +79,17 @@ module RuboCop
         private
 
         def offense_for_symbol_style?(name)
-          name.str_type? && style == :symbol
+          name.str_type? && style == :symbol && !namespaced?(name)
         end
 
         def offense_for_string_style?(name)
           name.sym_type? && style == :string
         end
 
+        def namespaced?(name)
+          name.value.include?('/')
+        end
+
         def register_offense(name, prefer)
           add_offense(name,
                       message: format(MSG, prefer: style.to_s)) do |corrector|

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

@@ -19,12 +19,15 @@ module RuboCop
       class IdSequence < ::RuboCop::Cop::Base
         extend AutoCorrector
         include RangeHelp
+        include RuboCop::FactoryBot::Language
 
         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
+          return unless node.receiver.nil? || factory_bot?(node.receiver)
+          return unless node.first_argument&.sym_type? &&
+            node.first_argument.value == :id
 
           add_offense(node) do |corrector|
             range_to_remove = range_by_whole_lines(

data/lib/rubocop/cop/factory_bot_cops.rb

@@ -4,6 +4,7 @@ require_relative 'factory_bot/association_style'
 require_relative 'factory_bot/attribute_defined_statically'
 require_relative 'factory_bot/consistent_parentheses_style'
 require_relative 'factory_bot/create_list'
+require_relative 'factory_bot/excessive_create_list'
 require_relative 'factory_bot/factory_association_with_strategy'
 require_relative 'factory_bot/factory_class_name'
 require_relative 'factory_bot/factory_name_style'

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module FactoryBot
+    module Cop
+      # Source and spec generator for new cops
+      #
+      # This generator will take a cop name and generate a source file
+      # and spec file when given a valid qualified cop name.
+      # @api private
+      class Generator < RuboCop::Cop::Generator
+        def todo
+          <<~TODO
+            Do 4 steps:
+              1. Modify the description of #{badge} in config/default.yml
+              2. Implement your new cop in the generated file!
+              3. Add an entry about new cop to CHANGELOG.md
+              4. Commit your new cop with a message such as
+                 e.g. "Add new `#{badge}` cop"
+          TODO
+        end
+      end
+    end
+  end
+end

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.24.0'
+      STRING = '2.26.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-factory_bot
 version: !ruby/object:Gem::Version
-  version: 2.24.0
+  version: 2.26.0
 platform: ruby
 authors:
 - John Backus
@@ -9,10 +9,10 @@ authors:
 - Phil Pirozhkov
 - Maxim Krizhanovsky
 - Andrew Bromwich
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-18 00:00:00.000000000 Z
+date: 2024-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -20,18 +20,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.41'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.33'
+        version: '1.41'
 description: |
   Code style checking for factory_bot files.
   A plugin for the RuboCop code style enforcing & linting tool.
-email:
+email: 
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -48,6 +48,7 @@ files:
 - lib/rubocop/cop/factory_bot/attribute_defined_statically.rb
 - lib/rubocop/cop/factory_bot/consistent_parentheses_style.rb
 - lib/rubocop/cop/factory_bot/create_list.rb
+- lib/rubocop/cop/factory_bot/excessive_create_list.rb
 - 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
@@ -57,6 +58,7 @@ files:
 - lib/rubocop/cop/factory_bot/syntax_methods.rb
 - lib/rubocop/cop/factory_bot_cops.rb
 - lib/rubocop/factory_bot/config_formatter.rb
+- lib/rubocop/factory_bot/cop/generator.rb
 - lib/rubocop/factory_bot/description_extractor.rb
 - lib/rubocop/factory_bot/factory_bot.rb
 - lib/rubocop/factory_bot/language.rb
@@ -68,7 +70,7 @@ metadata:
   changelog_uri: https://github.com/rubocop/rubocop-factory_bot/blob/master/CHANGELOG.md
   documentation_uri: https://docs.rubocop.org/rubocop-factory_bot/
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -83,8 +85,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.5.9
+signing_key: 
 specification_version: 4
 summary: Code style checking for factory_bot files
 test_files: []