factory_bot 4.10.0 → 4.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f6cddf8a7633587c40928e1b9bd981a644d0f2f99259eaafdd0ac986fa19775
-  data.tar.gz: 4300e1bc0e6204159ca66ef4ec2a3a9eb1cc131693b7907591e1a94f1f1e93f7
+  metadata.gz: 89e05780d4f57018d6825a36765bae4eafd20a5ea7ef0dd087f056a467d7c04a
+  data.tar.gz: 57af145df0452c560e27c979f3f76a1ee680e6e0e7f10dbb6af253a02943f942
 SHA512:
-  metadata.gz: 9583c5fb81fd3be6241566123cc1ffa590f54cc58c441868aff8efb679405b2c52bf38fd8ca9c3a4bf89079d12505d64565161ff300fca3d186cfcafc3573dd6
-  data.tar.gz: 10723a4fdc450038aa2d515e3df7ff26d59d634439e6632daa44ba91f6ca87491f52edfb9c9595da8fd3621dda4a2b707dd8523c4eb42c156fda04411d75c332
+  metadata.gz: 7bcda07de6b55b94f5ab976c058520adf4340cd6ca4518b06ceda03dc2a76ec190a0ef7519d3273440868b2f2f772f0b56f9c9aa71a990db6c32986b1a4f97c4
+  data.tar.gz: 57506e51449c9b2516862498a3078e79c4426ff441e96ee46577b83dbafc97bb91b610b176d1d7b9167b722515954cafa2816c98b866ac8b8586cdbe73273e54

data/GETTING_STARTED.md

@@ -30,13 +30,17 @@ Configure your test suite
 
 ### RSpec
 
+If you're using Rails:
+
 ```ruby
-# spec/support/factory_bot.rb
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
 end
+```
 
-# RSpec without Rails
+If you're *not* using Rails:
+
+```ruby
 RSpec.configure do |config|
   config.include FactoryBot::Syntax::Methods
 
@@ -46,12 +50,6 @@ RSpec.configure do |config|
 end
 ```
 
-Remember to require the above file in your rails_helper since the support folder isn't eagerly loaded
-
-```ruby
-require 'support/factory_bot'
-```
-
 ### Test::Unit
 
 ```ruby
@@ -110,20 +108,29 @@ Each factory has a name and a set of attributes. The name is used to guess the c
 # This will guess the User class
 FactoryBot.define do
   factory :user do
-    first_name "John"
-    last_name  "Doe"
-    admin false
+    first_name { "John" }
+    last_name  { "Doe" }
+    admin { false }
   end
 
   # This will use the User class (Admin would have been guessed)
   factory :admin, class: User do
-    first_name "Admin"
-    last_name  "User"
-    admin      true
+    first_name { "Admin" }
+    last_name { "User" }
+    admin { true }
   end
 end
 ```
 
+Because of the block syntax in Ruby, defining attributes as `Hash`es (for
+serialized/JSON columns, for example) requires two sets of curly brackets:
+
+```ruby
+factory :program do
+  configuration { { auto_resolve: false, auto_define: true } }
+end
+```
+
 It is highly recommended that you have one factory for each class that provides the simplest set of attributes necessary to create an instance of that class. If you're creating ActiveRecord objects, that means that you should only provide attributes that are required through validations and that do not have defaults. Other factories can be created through inheritance to cover common scenarios for each class.
 
 Attempting to define multiple factories with the same name will raise an error.
@@ -170,40 +177,30 @@ user.first_name
 # => "Joe"
 ```
 
-Dynamic Attributes
+Static Attributes
 ------------------
 
-Most factory attributes can be added using static values that are evaluated when
-the factory is defined, but some attributes (such as associations and other
-attributes that must be dynamically generated) will need values assigned each
-time an instance is generated. These "dynamic" attributes can be added by passing a
-block instead of a parameter:
+Static attributes, without a block, are deprecated and will be removed in
+factory\_bot 5. 
 
 ```ruby
 factory :user do
-  # ...
-  activation_code { User.generate_activation_code }
-  date_of_birth   { 21.years.ago }
-end
-```
+  # Do not use deprecated static attributes
+  admin true
 
-Because of the block syntax in Ruby, defining attributes as `Hash`es (for
-serialized/JSON columns, for example) requires two sets of curly brackets:
-
-```ruby
-factory :program do
-  configuration { { auto_resolve: false, auto_define: true } }
+  # Use dynamic attribues instead
+  admin { true }
 end
 ```
 
 Aliases
 -------
-factory_bot allows you to define aliases to existing factories to make them easier to re-use. This could come in handy when, for example, your Post object has an author attribute that actually refers to an instance of a User class. While normally factory_bot can infer the factory name from the association name, in this case it will look for a author factory in vain. So, alias your user factory so it can be used under alias names.
+factory_bot allows you to define aliases to existing factories to make them easier to re-use. This could come in handy when, for example, your Post object has an author attribute that actually refers to an instance of a User class. While normally factory_bot can infer the factory name from the association name, in this case it will look for an author factory in vain. So, alias your user factory so it can be used under alias names.
 
 ```ruby
 factory :user, aliases: [:author, :commenter] do
-  first_name    "John"
-  last_name     "Doe"
+  first_name { "John" }
+  last_name { "Doe" }
   date_of_birth { 18.years.ago }
 end
 
@@ -211,15 +208,15 @@ factory :post do
   author
   # instead of
   # association :author, factory: :user
-  title "How to read a book effectively"
-  body  "There are five steps involved."
+  title { "How to read a book effectively" }
+  body { "There are five steps involved." }
 end
 
 factory :comment do
   commenter
   # instead of
   # association :commenter, factory: :user
-  body "Great article!"
+  body { "Great article!" }
 end
 ```
 
@@ -231,8 +228,8 @@ that is yielded to dynamic attribute blocks:
 
 ```ruby
 factory :user do
-  first_name "Joe"
-  last_name  "Blow"
+  first_name { "Joe" }
+  last_name  { "Blow" }
   email { "#{first_name}.#{last_name}@example.com".downcase }
 end
 
@@ -248,11 +245,11 @@ There may be times where your code can be DRYed up by passing in transient attri
 ```ruby
 factory :user do
   transient do
-    rockstar true
-    upcased  false
+    rockstar { true }
+    upcased { false }
   end
 
-  name  { "John Doe#{" - Rockstar" if rockstar}" }
+  name { "John Doe#{" - Rockstar" if rockstar}" }
   email { "#{name.downcase}@example.com" }
 
   after(:create) do |user, evaluator|
@@ -296,10 +293,10 @@ You can easily create multiple factories for the same class without repeating co
 
 ```ruby
 factory :post do
-  title "A title"
+  title { "A title" }
 
   factory :approved_post do
-    approved true
+    approved { true }
   end
 end
 
@@ -312,11 +309,11 @@ You can also assign the parent explicitly:
 
 ```ruby
 factory :post do
-  title "A title"
+  title { "A title" }
 end
 
 factory :approved_post, parent: :post do
-  approved true
+  approved { true }
 end
 ```
 
@@ -392,20 +389,20 @@ FactoryBot.define do
 
   # post factory with a `belongs_to` association for the user
   factory :post do
-    title "Through the Looking Glass"
+    title { "Through the Looking Glass" }
     user
   end
 
   # user factory without associated posts
   factory :user do
-    name "John Doe"
+    name { "John Doe" }
 
     # user_with_posts will create post data after the user has been created
     factory :user_with_posts do
       # posts_count is declared as a transient attribute and available in
       # attributes on the factory, as well as the callback via the evaluator
       transient do
-        posts_count 5
+        posts_count { 5 }
       end
 
       # the after(:create) yields two values; the user instance itself and the
@@ -441,13 +438,13 @@ FactoryBot.define do
 
   # language factory with a `belongs_to` association for the profile
   factory :language do
-    title "Through the Looking Glass"
+    title { "Through the Looking Glass" }
     profile
   end
 
   # profile factory without associated languages
   factory :profile do
-    name "John Doe"
+    name { "John Doe" }
 
     # profile_with_languages will create language data after the profile has
     # been created
@@ -455,7 +452,7 @@ FactoryBot.define do
       # languages_count is declared as an ignored attribute and available in
       # attributes on the factory, as well as the callback via the evaluator
       transient do
-        languages_count 5
+        languages_count { 5 }
       end
 
       # the after(:create) yields two values; the profile instance itself and
@@ -598,25 +595,25 @@ to any factory.
 factory :user, aliases: [:author]
 
 factory :story do
-  title "My awesome story"
+  title { "My awesome story" }
   author
 
   trait :published do
-    published true
+    published { true }
   end
 
   trait :unpublished do
-    published false
+    published { false }
   end
 
   trait :week_long_publishing do
     start_at { 1.week.ago }
-    end_at   { Time.now }
+    end_at { Time.now }
   end
 
   trait :month_long_publishing do
     start_at { 1.month.ago }
-    end_at   { Time.now }
+    end_at { Time.now }
   end
 
   factory :week_long_published_story,    traits: [:published, :week_long_publishing]
@@ -641,23 +638,23 @@ the trait that defines the attribute latest gets precedence.
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
   login { name }
 
   trait :male do
-    name   "John Doe"
-    gender "Male"
+    name { "John Doe" }
+    gender { "Male" }
     login { "#{name} (M)" }
   end
 
   trait :female do
-    name   "Jane Doe"
-    gender "Female"
+    name { "Jane Doe" }
+    gender { "Female" }
     login { "#{name} (F)" }
   end
 
   trait :admin do
-    admin true
+    admin { true }
     login { "admin-#{name}" }
   end
 
@@ -670,18 +667,18 @@ You can also override individual attributes granted by a trait in subclasses.
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
   login { name }
 
   trait :male do
-    name   "John Doe"
-    gender "Male"
+    name { "John Doe" }
+    gender { "Male" }
     login { "#{name} (M)" }
   end
 
   factory :brandon do
     male
-    name "Brandon"
+    name { "Brandon" }
   end
 end
 ```
@@ -690,15 +687,15 @@ Traits can also be passed in as a list of symbols when you construct an instance
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
 
   trait :male do
-    name   "John Doe"
-    gender "Male"
+    name { "John Doe" }
+    gender { "Male" }
   end
 
   trait :admin do
-    admin true
+    admin { true }
   end
 end
 
@@ -714,10 +711,10 @@ the number of instances to create/build as second parameter, as documented in th
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
 
   trait :admin do
-    admin true
+    admin { true }
   end
 end
 
@@ -729,10 +726,10 @@ Traits can be used with associations easily too:
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
 
   trait :admin do
-    admin true
+    admin { true }
   end
 end
 
@@ -748,10 +745,10 @@ When you're using association names that're different than the factory:
 
 ```ruby
 factory :user do
-  name "Friendly User"
+  name { "Friendly User" }
 
   trait :admin do
-    admin true
+    admin { true }
   end
 end
 
@@ -786,7 +783,7 @@ Finally, traits can accept transient attributes.
 factory :invoice do
   trait :with_amount do
     transient do
-      amount 1
+      amount { 1 }
     end
 
     after(:create) do |invoice, evaluator|
@@ -860,7 +857,7 @@ FactoryBot.define do
   after(:create) { |object| AuditLog.create(attrs: object.attributes) }
 
   factory :user do
-    name "John Doe"
+    name { "John Doe" }
   end
 end
 ```
@@ -898,7 +895,7 @@ FactoryBot.define do
   factory :user do
     full_name "John Doe"
     sequence(:username) { |n| "user#{n}" }
-    password "password"
+    password { "password" }
   end
 end
 ```
@@ -908,10 +905,10 @@ Instead of creating a child factory that added additional attributes:
 ```ruby
 FactoryBot.define do
   factory :application_user, parent: :user do
-    full_name     "Jane Doe"
+    full_name { "Jane Doe" }
     date_of_birth { 21.years.ago }
-    gender        "Female"
-    health        90
+    gender { "Female" }
+    health { 90 }
   end
 end
 ```
@@ -921,10 +918,10 @@ You could modify that factory instead.
 ```ruby
 FactoryBot.modify do
   factory :user do
-    full_name     "Jane Doe"
+    full_name { "Jane Doe" }
     date_of_birth { 21.years.ago }
-    gender        "Female"
-    health        90
+    gender { "Female" }
+    health { 90 }
   end
 end
 ```
@@ -1072,7 +1069,7 @@ end
 sequence(:email) { |n| "person#{n}@example.com" }
 
 factory :user do
-  name "Jane Doe"
+  name { "Jane Doe" }
   email
 
   initialize_with { new(name) }
@@ -1102,7 +1099,7 @@ For example:
 
 ```ruby
 factory :user do
-  name "John Doe"
+  name { "John Doe" }
 
   initialize_with { User.build_with_name(name) }
 end
@@ -1114,7 +1111,7 @@ by calling `attributes`:
 ```ruby
 factory :user do
   transient do
-    comments_count 5
+    comments_count { 5 }
   end
 
   name "John Doe"
@@ -1125,7 +1122,7 @@ end
 
 This will build a hash of all attributes to be passed to `new`. It won't
 include transient attributes, but everything else defined in the factory will be
-passed (associations, evalued sequences, etc.)
+passed (associations, evaluated sequences, etc.)
 
 You can define `initialize_with` for all factories by including it in the
 `FactoryBot.define` block:
@@ -1287,7 +1284,7 @@ FactoryBot.define do
 
 
   factory :user do
-    name "John Doe"
+    name { "John Doe" }
   end
 end
 ```
@@ -1341,12 +1338,12 @@ with associations, as below:
 ```ruby
 FactoryBot.define do
   factory :united_states, class: Location do
-    name 'United States'
+    name { 'United States' }
     association :location_group, factory: :north_america
   end
 
   factory :north_america, class: LocationGroup do
-    name 'North America'
+    name { 'North America' }
   end
 end
 ```
@@ -1378,7 +1375,7 @@ require 'factory_bot'
 ```
 
 Once required, assuming you have a directory structure of `spec/factories` or
-`test/factories`, all you'll need to do is run
+`test/factories`, all you'll need to do is run:
 
 ```ruby
 FactoryBot.find_definitions
@@ -1400,7 +1397,7 @@ require 'factory_bot'
 
 FactoryBot.define do
   factory :user do
-    name 'John Doe'
+    name { 'John Doe' }
     date_of_birth { 21.years.ago }
   end
 end