factory_girl: update

factory_girl.md

@@ -1,12 +1,18 @@
 ---
-title: FactoryGirl
+title: Factory Girl
 category: Ruby libraries
-layout: default-ad
+layout: 2017/sheet
+weight: -3
+updated: 2017-09-01
 ---
 
 ## Factories
+{: .-three-column}
 
-    FactoryGirl.define do
+### Defining factories
+
+```ruby
+FactoryGirl.define do
   factory :user do
     first_name 'John'
     last_name  'Doe'
@@ -15,71 +21,149 @@ layout: default-ad
 
     sequence(:username) { |n| "user#{n}" }
   end
-    end
+end
+```
+{: data-line="2"}
 
-    # Also available:
-    factory :user, class: 'User'
-    factory :user, aliases: [:author]
+See: [Defining factories](http://www.rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md#Defining_factories)
 
-## Using
+### Extra options
 
-    FactoryGirl.build(:user)
+```ruby
+# Custom class names
+factory :user, class: 'User' do
+  ···
+end
+```
 
-    build(:user)          # not saved
-    create(:user)         # saved
-    attributes_for(:user) # hash
-    build_stubbed(:user)  # stubbed out attributes
+```ruby
+# Aliases
+factory :user, aliases: [:author] do
+  ···
+end
+```
 
-    build(:user, name: 'John')
+### Using
 
-    create_list(:user, 3)
-    build_list(:user, 3)
+```ruby
+FactoryGirl.build(:user)
+```
+
+```ruby
+build(:user)           # not saved
+create(:user)          # saved
+attributes_for(:user)  # hash
+build_stubbed(:user)   # stubbed out attributes
+```
+
+```ruby
+# With options:
+build(:user, name: 'John')
+```
+
+```ruby
+# List:
+create_list(:user, 3)
+build_list(:user, 3)
+```
 
 ## Associations
 
-    factory :post do
+### Defining
+
+```ruby
+factory :post do
   association :author, factory: :user
   association :author, factory: [:user, :admin]
+end
+```
+{: data-line="2,3"}
 
+or:
+
+```ruby
+factory :post do
   author  # assumes there's a factory :author
-    end
+end
+```
 
 ### After-create hooks
 
-    factory :post do
+```ruby
+factory :post do
   after :create do |post|
     create :theme, post: post             # has_one
     create_list :comment, 3, post: post   # has_many
   end
-    end
+end
+```
+{: data-line="2"}
 
-## Traits
+## Other features
+{: .-three-column}
 
-    factory :user do
+### Traits
+
+```ruby
+factory :user do
   trait :admin do
     admin true
   end
-    end
+end
+```
+{: data-line="2,3,4"}
 
-    create :user, :admin
+```ruby
+create :user, :admin
+```
 
-## Nested factories
+Traits allow you to group attributes together.
+See: [Traits](http://www.rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md#Traits)
 
-    factory :user do
+### Nested factories
+
+```ruby
+factory :user do
   first_name 'John'
 
   factory :sample_user do
     first_name { FFaker::Name.first_name }
   end
-    end
+end
+```
+{: data-line="4,5,6"}
 
-    # create :sample_user
+```ruby
+create :sample_user
+```
 
-    # Also: factory :sample_user, parent: :user
+See: [Inheritance](http://www.rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md#Inheritance)
 
-## Options (transients)
+### Sub-factories
 
-    factory :user do
+```ruby
+factory :user do
+  ···
+end
+```
+
+```ruby
+factory :sample_user, parent: :user do
+  first_name { FFaker::Name.first_name }
+end
+```
+{: data-line="1"}
+
+```ruby
+create :sample_user
+```
+
+Works the same as nested factories.
+
+### Options (transients)
+
+```ruby
+factory :user do
   transient do
     upcased true
   end
@@ -87,17 +171,28 @@ layout: default-ad
   after :create do |user, options|
     user.name.upcase! if options.upcased
   end
-    end
+end
+```
+{: data-line="2,3,4"}
 
-    create(user, upcased: true)
+```ruby
+create(user, upcased: true)
+```
 
-## Paths
+Transient attributes will not get passed to the model, but will be available in after-create hooks.
+See: [Transient attributes](http://www.rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md#Transient_Attributes)
 
-    test/factories.rb
-    spec/factories.rb
-    test/factories/*.rb
-    spec/factories/*.rb
+### Paths
+
+* test/factories.rb
+* spec/factories.rb
+* test/factories/*.rb
+* spec/factories/*.rb
+
+Place your factories in these locations.
+{: .-setup}
 
 ## See also
+{: .-one-column}
 
 * <http://rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md>