factory_bot 6.5.1 → 6.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 71c90d06521a4d6e1bbd613bdc1494919b2acde4117153524a11d8fbea53301c
-  data.tar.gz: 7e19bf127cf040c9f59fea525894019358e0502de695cf5957ac5eb91280e1d1
+  metadata.gz: 5268f67c49f294395edabe86ef2bf7bdd3644db872328f0134d832b8cbfe5396
+  data.tar.gz: 5e51702b4c819af99587ea2355b43b5770b228e1f0b81483b1bc9aa28806c630
 SHA512:
-  metadata.gz: ff1b56b976b423b91d8f633fdb0d1ed2d13b5c75665547adbb4d6f1d90b15aff35459dcb2fd6479e6dccdfd98ce3a9bd2a13b1ced002704fb84c39e2d5ebb3f3
-  data.tar.gz: dfc7713d8511e0723ab41da77257c901ca2d5abdf04b21b8f81332bd4f6e6568d403a68fc7831529ab8cbed531c25bc068458ee28fb2b1d7f0b7ebeafda02a3a
+  metadata.gz: 80f08c8d63755aa32390aadfd2b5c653915a2d8920b58d56b89a6091c029a0194a007b5f6c99277f94c175a0c0c83463ce24d5849268ac8d3ab76c059379116d
+  data.tar.gz: f092552d291c38644d02d77a73722b5966cc33397a1dcd06cb90164da65779c14f8a0352c77fd19890d30ccbe112d66a21c130865486da0b8059168e3f4a30e7

data/GETTING_STARTED.md

@@ -17,9 +17,9 @@ at any time.
 Getting Started
 ===============
 
-* [Setup](#setup)
-  + [Update Your Gemfile](#update-your-gemfile)
-  + [Configure your test suite](#configure-your-test-suite)
+- [Setup](#setup)
+  - [Update Your Gemfile](#update-your-gemfile)
+  - [Configure your test suite](#configure-your-test-suite)
     - [RSpec](#rspec)
     - [Test::Unit](#testunit)
     - [Cucumber](#cucumber)
@@ -27,76 +27,77 @@ Getting Started
     - [Minitest](#minitest)
     - [Minitest::Spec](#minitestspec)
     - [minitest-rails](#minitest-rails)
-* [Defining factories](#defining-factories)
-  + [Factory name and attributes](#factory-name-and-attributes)
-  + [Specifying the class explicitly](#specifying-the-class-explicitly)
-  + [Hash attributes](#hash-attributes)
-  + [Best practices](#best-practices)
-  + [Definition file paths](#definition-file-paths)
-  + [Static Attributes](#static-attributes)
-* [Using factories](#using-factories)
-  + [Build strategies](#build-strategies)
-  + [Attribute overrides](#attribute-overrides)
-  + [`build_stubbed` and `Marshal.dump`](#build_stubbed-and-marshaldump)
-* [Aliases](#aliases)
-* [Dependent Attributes](#dependent-attributes)
-* [Transient Attributes](#transient-attributes)
-  + [With other attributes](#with-other-attributes)
-  + [With `attributes_for`](#with-attributes_for)
-  + [With callbacks](#with-callbacks)
-  + [With associations](#with-associations)
-* [Method Name / Reserved Word Attributes](#method-name--reserved-word-attributes)
-* [Inheritance](#inheritance)
-  + [Nested factories](#nested-factories)
-  + [Assigning parent explicitly](#assigning-parent-explicitly)
-  + [Best practices](#best-practices-1)
-* [Associations](#associations)
-  + [Implicit definition](#implicit-definition)
-  + [Explicit definition](#explicit-definition)
-  + [Inline definition](#inline-definition)
-  + [Specifying the factory](#specifying-the-factory)
-  + [Overriding attributes](#overriding-attributes)
-  + [Association overrides](#association-overrides)
-  + [Build strategies](#build-strategies-1)
-  + [`has_many` associations](#has_many-associations)
-  + [`has_and_belongs_to_many` associations](#has_and_belongs_to_many-associations)
-  + [Polymorphic associations](#polymorphic-associations)
-  + [Interconnected associations](#interconnected-associations)
-* [Sequences](#sequences)
-  + [Global sequences](#global-sequences)
-  + [With dynamic attributes](#with-dynamic-attributes)
-  + [As implicit attributes](#as-implicit-attributes)
-  + [Inline sequences](#inline-sequences)
-  + [Initial value](#initial-value)
-  + [Without a block](#without-a-block)
-  + [Aliases](#aliases-1)
-  + [Rewinding](#rewinding)
-  + [Uniqueness](#uniqueness)
-* [Traits](#traits)
-  + [Defining traits](#defining-traits)
-  + [As implicit attributes](#as-implicit-attributes-1)
-  + [Attribute precedence](#attribute-precedence)
-  + [In child factories](#in-child-factories)
-  + [Using traits](#using-traits)
-  + [With associations](#with-associations-1)
-  + [Traits within traits](#traits-within-traits)
-  + [With transient attributes](#with-transient-attributes)
-  + [Enum traits](#enum-traits)
-* [Callbacks](#callbacks)
-  + [Default callbacks](#default-callbacks)
-  + [Multiple callbacks](#multiple-callbacks)
-  + [Global callbacks](#global-callbacks)
-  + [Symbol#to_proc](#symbolto_proc)
-* [Modifying factories](#modifying-factories)
-* [Building or Creating Multiple Records](#building-or-creating-multiple-records)
-* [Linting Factories](#linting-factories)
-* [Custom Construction](#custom-construction)
-* [Custom Strategies](#custom-strategies)
-* [Custom Callbacks](#custom-callbacks)
-* [Custom Methods to Persist Objects](#custom-methods-to-persist-objects)
-* [ActiveSupport Instrumentation](#activesupport-instrumentation)
-* [Rails Preloaders and RSpec](#rails-preloaders-and-rspec)
-* [Using Without Bundler](#using-without-bundler)
+- [Defining factories](#defining-factories)
+  - [Factory name and attributes](#factory-name-and-attributes)
+  - [Specifying the class explicitly](#specifying-the-class-explicitly)
+  - [Hash attributes](#hash-attributes)
+  - [Best practices](#best-practices)
+  - [Definition file paths](#definition-file-paths)
+  - [Static Attributes](#static-attributes)
+- [Using factories](#using-factories)
+  - [Build strategies](#build-strategies)
+  - [Attribute overrides](#attribute-overrides)
+  - [build\_stubbed and Marshal.dump](#build_stubbed-and-marshaldump)
+- [Aliases](#aliases)
+- [Dependent Attributes](#dependent-attributes)
+- [Transient Attributes](#transient-attributes)
+  - [With other attributes](#with-other-attributes)
+  - [With attributes\_for](#with-attributes_for)
+  - [With callbacks](#with-callbacks)
+  - [With associations](#with-associations)
+- [Method Name / Reserved Word Attributes](#method-name--reserved-word-attributes)
+- [Inheritance](#inheritance)
+  - [Nested factories](#nested-factories)
+  - [Assigning parent explicitly](#assigning-parent-explicitly)
+  - [Best practices](#best-practices-1)
+- [Associations](#associations)
+  - [Implicit definition](#implicit-definition)
+  - [Explicit definition](#explicit-definition)
+  - [Inline definition](#inline-definition)
+  - [Specifying the factory](#specifying-the-factory)
+  - [Overriding attributes](#overriding-attributes)
+  - [Association overrides](#association-overrides)
+  - [Build strategies](#build-strategies-1)
+  - [has\_many associations](#has_many-associations)
+  - [has\_and\_belongs\_to\_many associations](#has_and_belongs_to_many-associations)
+  - [Polymorphic associations](#polymorphic-associations)
+  - [Interconnected associations](#interconnected-associations)
+- [Sequences](#sequences)
+  - [Global sequences](#global-sequences)
+  - [With dynamic attributes](#with-dynamic-attributes)
+  - [As implicit attributes](#as-implicit-attributes)
+  - [Inline sequences](#inline-sequences)
+  - [Initial value](#initial-value)
+  - [Without a block](#without-a-block)
+  - [Aliases](#aliases-1)
+  - [Rewinding](#rewinding)
+  - [Uniqueness](#uniqueness)
+- [Traits](#traits)
+  - [Defining traits](#defining-traits)
+  - [As implicit attributes](#as-implicit-attributes-1)
+  - [Attribute precedence](#attribute-precedence)
+  - [In child factories](#in-child-factories)
+  - [As mixins](#as-mixins)
+  - [Using traits](#using-traits)
+  - [With associations](#with-associations-1)
+  - [Traits within traits](#traits-within-traits)
+  - [With transient attributes](#with-transient-attributes)
+  - [Enum traits](#enum-traits)
+- [Callbacks](#callbacks)
+  - [Default callbacks](#default-callbacks)
+  - [Multiple callbacks](#multiple-callbacks)
+  - [Global callbacks](#global-callbacks)
+  - [Symbol#to\_proc](#symbolto_proc)
+- [Modifying factories](#modifying-factories)
+- [Building or Creating Multiple Records](#building-or-creating-multiple-records)
+- [Linting Factories](#linting-factories)
+- [Custom Construction](#custom-construction)
+- [Custom Strategies](#custom-strategies)
+- [Custom Callbacks](#custom-callbacks)
+- [Custom Methods to Persist Objects](#custom-methods-to-persist-objects)
+- [ActiveSupport Instrumentation](#activesupport-instrumentation)
+- [Rails Preloaders and RSpec](#rails-preloaders-and-rspec)
+- [Using Without Bundler](#using-without-bundler)
 
 Setup
 -----
@@ -219,6 +220,26 @@ It is also possible to explicitly specify the class:
 factory :admin, class: "User"
 ```
 
+Explicit specification of the class, _with the full namespace_, is necessary when defining factories for classes nested within other modules or classes:
+
+```ruby
+# foo/bar.rb
+module Foo
+  class Bar
+    ...
+  end
+end
+
+# factories.rb
+FactoryBot.define do
+  factory :bar, class: 'Foo::Bar' do
+    ...
+  end
+end
+```
+
+If the full namespace is not provided in the `factory` statement, you will receive a `NameError: uninitialized constant Bar` error.
+
 You can pass a constant as well, if the constant is available (note that this
 can cause test performance problems in large Rails applications, since
 referring to the constant will cause it to be eagerly loaded).
@@ -255,10 +276,12 @@ Factories can be defined anywhere, but will be automatically loaded after
 calling `FactoryBot.find_definitions` if factories are defined in files at the
 following locations:
 
+    factories.rb
+    factories/**/*.rb
     test/factories.rb
+    test/factories/**/*.rb
     spec/factories.rb
-    test/factories/*.rb
-    spec/factories/*.rb
+    spec/factories/**/*.rb
 
 ### Static Attributes
 
@@ -332,7 +355,7 @@ 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`
+### build_stubbed and Marshal.dump
 
 Note that objects created with `build_stubbed` cannot be serialized with
 `Marshal.dump`, since factory\_bot defines singleton methods on these objects.
@@ -413,7 +436,7 @@ create(:user, rockstar: false).name
 #=> "John Doe"
 ```
 
-### With `attributes_for`
+### With attributes_for
 
 Transient attributes will be ignored within attributes\_for and won't be set on
 the model, even if the attribute exists or you attempt to override it.
@@ -619,7 +642,7 @@ end
 
 Or inline using attributes from the factory:
 
-```rb
+```ruby
 factory :post do
   # ...
   author_last_name { "Writely" }
@@ -713,7 +736,7 @@ factory :post do
   author strategy: :build    # <<< this does *not* work; causes author_id to be nil
 ```
 
-### `has_many` associations
+### has_many associations
 
 There are a few ways to generate data for a `has_many` relationship. The
 simplest approach is to write a helper method in plain Ruby to tie together the
@@ -840,7 +863,7 @@ build(:user_with_posts, posts_count: 15).posts.length # 15
 build_stubbed(:user_with_posts, posts_count: 15).posts.length # 15
 ```
 
-### `has_and_belongs_to_many` associations
+### has_and_belongs_to_many associations
 
 Generating data for a `has_and_belongs_to_many` relationship is very similar
 to the above `has_many` relationship, with a small change: you need to pass an
@@ -1130,7 +1153,7 @@ When working with uniqueness constraints, be careful not to pass in override val
 
 In this example the email will be the same for both users. If email must be unique, this code will error:
 
-```rb
+```ruby
 factory :user do
   sequence(:email) { |n| "person#{n}@example.com" }
 end
@@ -1396,7 +1419,7 @@ create :invoice, :with_amount, amount: 2
 
 Given an Active Record model with an enum attribute:
 
-```rb
+```ruby
 class Task < ActiveRecord::Base
   enum status: {queued: 0, started: 1, finished: 2}
 end
@@ -1406,7 +1429,7 @@ end
 factory\_bot will automatically define traits for each possible value of the
 enum:
 
-```rb
+```ruby
 FactoryBot.define do
   factory :task
 end
@@ -1418,7 +1441,7 @@ FactoryBot.build(:task, :finished)
 
 Writing the traits out manually would be cumbersome, and is not necessary:
 
-```rb
+```ruby
 FactoryBot.define do
   factory :task do
     trait :queued do
@@ -1443,7 +1466,7 @@ desired, it is possible to disable the feature by setting
 In that case, it is still possible to explicitly define traits for an enum
 attribute in a particular factory:
 
-```rb
+```ruby
 FactoryBot.automatically_define_enum_traits = false
 
 FactoryBot.define do
@@ -1458,7 +1481,7 @@ specifically tied to Active Record enum attributes.
 
 With an array:
 
-```rb
+```ruby
 class Task
   attr_accessor :status
 end
@@ -1472,7 +1495,7 @@ end
 
 Or with a hash:
 
-```rb
+```ruby
 class Task
   attr_accessor :status
 end