factory_bot 6.3.0 → 6.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be53175a79d79c70dbaae41a86638d7013b968cecf59aaaa1cedc813ef4e4bc6
-  data.tar.gz: 4d3312a1ec50b608daa376d41e176ee713fba29ee80c1ce0acd0a646ce4a9956
+  metadata.gz: 3a7ebed6c784cdfb3ea79c03d84a65a36727a1410365921f559f342810c3302d
+  data.tar.gz: 5b3c7a8d107633fa5025cbd3c1d5e3fceac5ba53a820a17328be22ca1aa80f8c
 SHA512:
-  metadata.gz: 6077f43c7fc1486a2b1ac6d009f3c95e5c736afbe76c62d1818eb8ad26e77aa9f249b74dd1715b11da3bc989abee47a9a28f4da250e8fe10b036aa4121afc786
-  data.tar.gz: c4de0a35286906b04e4d4d0e489e437135a1553241f80e5338332b90657e253f055084e5c040e4dc6097b79102a5781c5226a89d89c9108edfb97c1b616fdaa0
+  metadata.gz: 0d067eb0c20f31211b496b34c6470df84d31a3db63d7e6b9f7f051ed890669c8220224dfb5451d13397c0b24a395ff032cb2e1be05b15f0ef13fd034293878cd
+  data.tar.gz: 988911756ac353fb3db10d73280b1acdb07618166e7fdec256601dd1051c2a15200c47ecbd18490253d76abc2bf46b3652c9c7f8aee47816210e3c3ee2d93b30

data/GETTING_STARTED.md

@@ -285,6 +285,9 @@ user = create(:user)
 # Returns a hash of attributes that can be used to build a User instance
 attrs = attributes_for(:user)
 
+# Integrates with Ruby 3.0's support for pattern matching assignment
+attributes_for(:user) => {email:, name:, **attrs}
+
 # Returns an object with all defined attributes stubbed out
 stub = build_stubbed(:user)
 
@@ -297,7 +300,7 @@ end
 ### Attribute overrides
 
 No matter which strategy is used, it's possible to override the defined
-attributes by passing a hash:
+attributes by passing a Hash:
 
 ```ruby
 # Build a User instance and override the first_name property
@@ -306,6 +309,29 @@ user.first_name
 # => "Joe"
 ```
 
+Overriding associations is also supported:
+
+```ruby
+account = build(:account, :deluxe)
+friends = build_list(:user, 2)
+
+user = build(:user, account: account, friends: friends)
+```
+
+Ruby 3.1's support for [omitting values][] from `Hash` literals dovetails with
+attribute overrides and provides an opportunity to limit the repetition of
+variable names:
+
+```ruby
+account = build(:account, :deluxe)
+friends = build_list(:user, 2)
+
+# The keyword arguments correspond to local variable names, so omit their values
+user = build(:user, account:, friends:)
+```
+
+[omitting values]: https://docs.ruby-lang.org/en/3.1/syntax/literals_rdoc.html#label-Hash+Literals
+
 ### `build_stubbed` and `Marshal.dump`
 
 Note that objects created with `build_stubbed` cannot be serialized with
@@ -945,7 +971,7 @@ end
 Note that this approach works with `build`, `build_stubbed`, and `create`, but
 the associations will return `nil` when using `attributes_for`.
 
-Also, note that if you assign any attributes inside a custom `initialize_with` 
+Also, note that if you assign any attributes inside a custom `initialize_with`
 (e.g. `initialize_with { new(**attributes) }`), those attributes should not refer to `instance`,
 since it will be `nil`.
 
@@ -1008,6 +1034,17 @@ factory :user do
 end
 ```
 
+With Ruby 2.7's support for [numbered parameters][], inline definitions can be
+even more abbreviated:
+
+```ruby
+factory :user do
+  sequence(:email) { "person#{_1}@example.com" }
+end
+```
+
+[numbered parameters]: https://ruby-doc.org/core-2.7.1/Proc.html#class-Proc-label-Numbered+parameters
+
 ### Initial value
 
 You can override the initial value. Any value that responds to the `#next`
@@ -1222,11 +1259,11 @@ FactoryBot.define do
     created_at { 8.days.ago }
     updated_at { 4.days.ago }
   end
-  
+
   factory :user, traits: [:timestamps] do
     username { "john_doe" }
   end
-  
+
   factory :post do
     timestamps
     title { "Traits rock" }

data/NEWS.md

@@ -1,5 +1,46 @@
 # News
 
+## 6.4.6 (January 30, 2023)
+
+ * Fix: Bump minimum required Ruby in gemspec (Earlopain).
+ * Fix: Broken link in `FactoryBot.modify` docs (Matt Brictson).
+ * Fix: Broken link in `FactoryBot.lint` docs (Anton Dieterle).
+
+## 6.4.5 (December 29, 2023)
+
+  * Changed: Support Ruby 3.0+, Rails 6.1+ (Mike Burns).
+
+## 6.4.4 (December 27, 2023)
+
+  * Internal: Remove observer dependency (Earlopain).
+
+## 6.4.3 (December 26, 2023)
+
+  * Fix: Support models without ID setters in build_stubbed (Olivier Bellone).
+  * Fix: Explicit observer dependency (Oleg Antonyan).
+  * Internal: Add Rails 7.1 to CI (Olivier Bellone).
+  * Internal: Bump github actions/checkout to v4 (Lorenzo Zabot)
+  * Internal: Stop passing disable-error_highlight in CI (Mike Burns).
+  * Internal: Relax the exception message check (Mike Burns).
+
+## 6.4.2 (November 22, 2023)
+
+  * Fix: top-level traits pass their class to ActiveSupport::Notifications
+    (makicamel).
+
+## 6.4.1 (November 20, 2023)
+
+  * Fix: factories with traits pass their class to ActiveSupport::Notifications
+    (makicamel).
+
+## 6.4.0 (November 17, 2023)
+
+  * Added: if `build_stubbed` detects a UUID primary key, generate the correct
+    type (Peter Boling, Alexandre Ruban).
+  * Docs: show examples of Ruby 3 syntactic sugars (Sean Doyle).
+  * Internal: resolve test warning messages (Mike Burns).
+
+
 ## 6.3.0 (September 1, 2023)
 
   * Fix: link to changelog for RubyGems (Berkan Ünal).

data/lib/factory_bot/decorator.rb

@@ -6,24 +6,12 @@ module FactoryBot
       @component = component
     end
 
-    if ::Gem::Version.new(::RUBY_VERSION) >= ::Gem::Version.new("2.7")
-      class_eval(<<~RUBY, __FILE__, __LINE__ + 1)
-          def method_missing(...) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
-          @component.send(...)
-        end
-
-        def send(...)
-          __send__(...)
-        end
-      RUBY
-    else
-      def method_missing(name, *args, &block) # rubocop:disable Style/MissingRespondToMissing
-        @component.send(name, *args, &block)
-      end
+    def method_missing(...) # rubocop:disable Style/MethodMissingSuper
+      @component.send(...)
+    end
 
-      def send(symbol, *args, &block)
-        __send__(symbol, *args, &block)
-      end
+    def send(...)
+      __send__(...)
     end
 
     def respond_to_missing?(name, include_private = false)

data/lib/factory_bot/definition.rb

@@ -2,6 +2,7 @@ module FactoryBot
   # @api private
   class Definition
     attr_reader :defined_traits, :declarations, :name, :registered_enums
+    attr_accessor :klass
 
     def initialize(name, base_traits = [])
       @name = name
@@ -51,7 +52,9 @@ module FactoryBot
 
         declarations.attributes
 
+        self.klass ||= klass
         defined_traits.each do |defined_trait|
+          defined_trait.klass ||= klass
           base_traits.each { |bt| bt.define_trait defined_trait }
           additional_traits.each { |at| at.define_trait defined_trait }
         end
@@ -62,7 +65,7 @@ module FactoryBot
           name: name,
           attributes: declarations.attributes,
           traits: defined_traits,
-          class: klass
+          class: klass || self.klass
         }
       end
     end
@@ -150,7 +153,7 @@ module FactoryBot
     end
 
     def trait_by_name(name)
-      trait_for(name) || Internal.trait_by_name(name)
+      trait_for(name) || Internal.trait_by_name(name, klass)
     end
 
     def trait_for(name)

data/lib/factory_bot/definition_proxy.rb

@@ -119,8 +119,8 @@ module FactoryBot
     #   end
     #
     # Except that no globally available sequence will be defined.
-    def sequence(name, *args, &block)
-      sequence = Sequence.new(name, *args, &block)
+    def sequence(name, ...)
+      sequence = Sequence.new(name, ...)
       FactoryBot::Internal.register_inline_sequence(sequence)
       add_attribute(name) { increment_sequence(sequence) }
     end

data/lib/factory_bot/evaluation.rb

@@ -1,13 +1,10 @@
-require "observer"
-
 module FactoryBot
   class Evaluation
-    include Observable
-
-    def initialize(evaluator, attribute_assigner, to_create)
+    def initialize(evaluator, attribute_assigner, to_create, observer)
       @evaluator = evaluator
       @attribute_assigner = attribute_assigner
       @to_create = to_create
+      @observer = observer
     end
 
     delegate :object, :hash, to: :@attribute_assigner
@@ -20,8 +17,7 @@ module FactoryBot
     end
 
     def notify(name, result_instance)
-      changed
-      notify_observers(name, result_instance)
+      @observer.update(name, result_instance)
     end
   end
 end

data/lib/factory_bot/evaluator.rb

@@ -35,14 +35,13 @@ module FactoryBot
 
     attr_accessor :instance
 
-    def method_missing(method_name, *args, &block)
+    def method_missing(method_name, ...)
       if @instance.respond_to?(method_name)
-        @instance.send(method_name, *args, &block)
+        @instance.send(method_name, ...)
       else
-        SyntaxRunner.new.send(method_name, *args, &block)
+        SyntaxRunner.new.send(method_name, ...)
       end
     end
-    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
     def respond_to_missing?(method_name, _include_private = false)
       @instance.respond_to?(method_name) || SyntaxRunner.new.respond_to?(method_name)

data/lib/factory_bot/factory.rb

@@ -36,9 +36,9 @@ module FactoryBot
       evaluator = evaluator_class.new(strategy, overrides.symbolize_keys)
       attribute_assigner = AttributeAssigner.new(evaluator, build_class, &compiled_constructor)
 
+      observer = CallbacksObserver.new(callbacks, evaluator)
       evaluation =
-        Evaluation.new(evaluator, attribute_assigner, compiled_to_create)
-      evaluation.add_observer(CallbacksObserver.new(callbacks, evaluator))
+        Evaluation.new(evaluator, attribute_assigner, compiled_to_create, observer)
 
       strategy.result(evaluation).tap(&block)
     end

data/lib/factory_bot/internal.rb

@@ -39,8 +39,8 @@ module FactoryBot
         trait
       end
 
-      def trait_by_name(name)
-        traits.find(name)
+      def trait_by_name(name, klass)
+        traits.find(name).tap { |t| t.klass = klass }
       end
 
       def register_sequence(sequence)

data/lib/factory_bot/strategy/stub.rb

@@ -47,13 +47,17 @@ module FactoryBot
 
       private
 
-      def next_id
-        @@next_id += 1
+      def next_id(result_instance)
+        if uuid_primary_key?(result_instance)
+          SecureRandom.uuid
+        else
+          @@next_id += 1
+        end
       end
 
       def stub_database_interaction_on_result(result_instance)
         if has_settable_id?(result_instance)
-          result_instance.id ||= next_id
+          result_instance.id ||= next_id(result_instance)
         end
 
         result_instance.instance_eval do
@@ -79,8 +83,16 @@ module FactoryBot
       end
 
       def has_settable_id?(result_instance)
-        !result_instance.class.respond_to?(:primary_key) ||
-          result_instance.class.primary_key
+        result_instance.respond_to?(:id=) &&
+          (!result_instance.class.respond_to?(:primary_key) ||
+          result_instance.class.primary_key)
+      end
+
+      def uuid_primary_key?(result_instance)
+        result_instance.respond_to?(:column_for_attribute) &&
+          (column = result_instance.column_for_attribute(result_instance.class.primary_key)) &&
+          column.respond_to?(:sql_type) &&
+          column.sql_type == "uuid"
       end
 
       def clear_changes_information(result_instance)

data/lib/factory_bot/syntax/default.rb

@@ -25,8 +25,8 @@ module FactoryBot
           end
         end
 
-        def sequence(name, *args, &block)
-          Internal.register_sequence(Sequence.new(name, *args, &block))
+        def sequence(name, ...)
+          Internal.register_sequence(Sequence.new(name, ...))
         end
 
         def trait(name, &block)

data/lib/factory_bot/trait.rb

@@ -15,7 +15,7 @@ module FactoryBot
     end
 
     delegate :add_callback, :declare_attribute, :to_create, :define_trait, :constructor,
-      :callbacks, :attributes, to: :@definition
+      :callbacks, :attributes, :klass, :klass=, to: :@definition
 
     def names
       [@name]

data/lib/factory_bot/version.rb

@@ -1,3 +1,3 @@
 module FactoryBot
-  VERSION = "6.3.0".freeze
+  VERSION = "6.4.6".freeze
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: factory_bot
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.6
 platform: ruby
 authors:
 - Josh Clayton
 - Joe Ferris
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2024-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -238,7 +238,7 @@ licenses:
 - MIT
 metadata:
   changelog_uri: https://github.com/thoughtbot/factory_bot/blob/main/NEWS.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -246,15 +246,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: factory_bot provides a framework and DSL for defining and using model instance
   factories.