factory_girl 3.0.0 → 3.1.0

data/GETTING_STARTED.md

@@ -7,7 +7,7 @@ Update Your Gemfile
 If you're using Rails, you'll need to change the required version of `factory_girl_rails`:
 
 ```ruby
-gem "factory_girl_rails", "~> 2.0"
+gem "factory_girl_rails", "~> 3.0"
 ```
 
 If you're *not* using Rails, you'll just have to change the required version of `factory_girl`:
@@ -27,23 +27,16 @@ Each factory has a name and a set of attributes. The name is used to guess the c
 # This will guess the User class
 FactoryGirl.define do
   factory :user do
-    first_name 'John'
-    last_name  'Doe'
+    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
-  end
-
-  # The same, but using a string instead of class constant
-  factory :admin, :class => 'user' do
-    first_name 'Admin'
-    last_name  'User'
-    admin true
+  factory :admin, class: User do
+    first_name "Admin"
+    last_name  "User"
+    admin      true
   end
 end
 ```
@@ -88,7 +81,7 @@ No matter which strategy is used, it's possible to override the defined attribut
 
 ```ruby
 # Build a User instance and override the first_name property
-user = FactoryGirl.build(:user, :first_name => 'Joe')
+user = FactoryGirl.build(:user, first_name: "Joe")
 user.first_name
 # => "Joe"
 ```
@@ -103,15 +96,18 @@ end
 
 # Test::Unit
 class Test::Unit::TestCase
-  include Factory::Syntax::Methods
+  include FactoryGirl::Syntax::Methods
 end
+
+# Cucumber
+World(FactoryGirl::Syntax::Methods)
 ```
 
 This would allow you to write:
 
 ```ruby
 describe User, "#full_name" do
-  subject { create(:user, :first_name => "John", :last_name => "Doe") }
+  subject { create(:user, first_name: "John", last_name: "Doe") }
 
   its(:full_name) { should == "John Doe" }
 end
@@ -140,7 +136,7 @@ Aliases
 Aliases allow you to use named associations more easily.
 
 ```ruby
-factory :user, :aliases => [:author, :commenter] do
+factory :user, aliases: [:author, :commenter] do
   first_name    "John"
   last_name     "Doe"
   date_of_birth { 18.years.ago }
@@ -149,7 +145,7 @@ end
 factory :post do
   author
   # instead of
-  # association :author, :factory => :user
+  # association :author, factory: :user
   title "How to read a book effectively"
   body  "There are five steps involved."
 end
@@ -157,7 +153,7 @@ end
 factory :comment do
   commenter
   # instead of
-  # association :commenter, :factory => :user
+  # association :commenter, factory: :user
   body "Great article!"
 end
 ```
@@ -169,12 +165,12 @@ Attributes can be based on the values of other attributes using the evaluator th
 
 ```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
 
-FactoryGirl.create(:user, :last_name => 'Doe').email
+FactoryGirl.create(:user, last_name: "Doe").email
 # => "joe.doe@example.com"
 ```
 
@@ -187,7 +183,7 @@ There may be times where your code can be DRYed up by passing in transient attri
 factory :user do
   ignore do
     rockstar true
-    upcased { false }
+    upcased  false
   end
 
   name  { "John Doe#{" - Rockstar" if rockstar}" }
@@ -198,7 +194,7 @@ factory :user do
   end
 end
 
-FactoryGirl.create(:user, :upcased => true).name
+FactoryGirl.create(:user, upcased: true).name
 #=> "JOHN DOE - ROCKSTAR"
 ```
 
@@ -228,7 +224,7 @@ You can also specify a different factory or override attributes:
 ```ruby
 factory :post do
   # ...
-  association :author, :factory => :user, :last_name => 'Writely'
+  association :author, factory: :user, last_name: "Writely"
 end
 ```
 
@@ -246,12 +242,12 @@ post.new_record?        # => true
 post.author.new_record? # => false
 ```
 
-To not save the associated object, specify :strategy => :build in the factory:
+To not save the associated object, specify strategy: :build in the factory:
 
 ```ruby
 factory :post do
   # ...
-  association :author, :factory => :user, :strategy => :build
+  association :author, factory: :user, strategy: :build
 end
 
 # Builds a User, and then builds a Post, but does not save either
@@ -290,7 +286,7 @@ FactoryGirl.define do
       # attributes; `create_list`'s second argument is the number of records
       # to create and we make sure the user is associated properly to the post
       after_create do |user, evaluator|
-        FactoryGirl.create_list(:post, evaluator.posts_count, :user => user)
+        FactoryGirl.create_list(:post, evaluator.posts_count, user: user)
       end
     end
   end
@@ -302,7 +298,7 @@ This allows us to do:
 ```ruby
 FactoryGirl.create(:user).posts.length # 0
 FactoryGirl.create(:user_with_posts).posts.length # 5
-FactoryGirl.create(:user_with_posts, :posts_count => 15).posts.length # 15
+FactoryGirl.create(:user_with_posts, posts_count: 15).posts.length # 15
 ```
 
 Inheritance
@@ -312,7 +308,7 @@ 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
@@ -320,7 +316,7 @@ factory :post do
 end
 
 approved_post = FactoryGirl.create(:approved_post)
-approved_post.title # => 'A title'
+approved_post.title    # => "A title"
 approved_post.approved # => true
 ```
 
@@ -328,10 +324,10 @@ You can also assign the parent explicitly:
 
 ```ruby
 factory :post do
-  title 'A title'
+  title "A title"
 end
 
-factory :approved_post, :parent => :post do
+factory :approved_post, parent: :post do
   approved true
 end
 ```
@@ -405,6 +401,35 @@ factory :post do
 end
 ```
 
+Sequences can also have aliases. The sequence aliases share the same counter:
+
+```ruby
+factory :user do
+  sequence(:email, 1000, aliases: [:sender, :receiver]) {|n| "person#{n}@example.com" }
+end
+
+# will increase value counter for :email which is shared by :sender and :receiver
+FactoryGirl.next(:sender)
+```
+
+Define aliases and use default value (1) for the counter
+
+```ruby
+factory :user do
+  sequence(:email, aliases: [:sender, :receiver]) {|n| "person#{n}@example.com" }
+end
+```
+
+Setting the value:
+
+```ruby
+factory :user do
+  sequence(:email, 'a', aliases: [:sender, :receiver]) {|n| "person#{n}@example.com" }
+end
+```
+
+The value just needs to support the `#next` method. Here the next value will be 'a', then 'b', etc.
+
 Traits
 ------
 
@@ -412,7 +437,7 @@ Traits allow you to group attributes together and then apply them
 to any factory.
 
 ```ruby
-factory :user, :aliases => [:author]
+factory :user, aliases: [:author]
 
 factory :story do
   title "My awesome story"
@@ -436,17 +461,17 @@ factory :story do
     end_at   { Time.now }
   end
 
-  factory :week_long_published_story,    :traits => [:published, :week_long_publishing]
-  factory :month_long_published_story,   :traits => [:published, :month_long_publishing]
-  factory :week_long_unpublished_story,  :traits => [:unpublished, :week_long_publishing]
-  factory :month_long_unpublished_story, :traits => [:unpublished, :month_long_publishing]
+  factory :week_long_published_story,    traits: [:published, :week_long_publishing]
+  factory :month_long_published_story,   traits: [:published, :month_long_publishing]
+  factory :week_long_unpublished_story,  traits: [:unpublished, :week_long_publishing]
+  factory :month_long_unpublished_story, traits: [:unpublished, :month_long_publishing]
 end
 ```
 
 Traits can be used as attributes:
 
 ```ruby
-factory :week_long_published_story_with_title, :parent => :story do
+factory :week_long_published_story_with_title, parent: :story do
   published
   week_long_publishing
   title { "Publishing that was started at {start_at}" }
@@ -478,8 +503,8 @@ factory :user do
     login { "admin-#{name}" }
   end
 
-  factory :male_admin,   :traits => [:male, :admin]   # login will be "admin-John Doe"
-  factory :female_admin, :traits => [:admin, :female] # login will be "Jane Doe (F)"
+  factory :male_admin,   traits: [:male, :admin]   # login will be "admin-John Doe"
+  factory :female_admin, traits: [:admin, :female] # login will be "Jane Doe (F)"
 end
 ```
 
@@ -520,7 +545,7 @@ factory :user do
 end
 
 # creates an admin user with gender "Male" and name "Jon Snow"
-FactoryGirl.create(:user, :admin, :male, :name => "Jon Snow")
+FactoryGirl.create(:user, :admin, :male, name: "Jon Snow")
 ```
 
 This ability works with `build`, `build_stubbed`, `attributes_for`, and `create`.
@@ -539,7 +564,7 @@ factory :user do
 end
 
 # creates 3 admin users with gender "Male" and name "Jon Snow"
-FactoryGirl.create_list(:user, 3, :admin, :male, :name => "Jon Snow")
+FactoryGirl.create_list(:user, 3, :admin, :male, name: "Jon Snow")
 ```
 
 
@@ -607,7 +632,7 @@ Instead of creating a child factory that added additional attributes:
 
 ```ruby
 FactoryGirl.define do
-  factory :application_user, :parent => :user do
+  factory :application_user, parent: :user do
     full_name     { Faker::Name.name }
     date_of_birth { 21.years.ago }
     gender        "Female"
@@ -650,7 +675,7 @@ These methods will build or create a specific amount of factories and return the
 To set the attributes for each of the factories, you can pass in a hash as you normally would.
 
 ```ruby
-twenty_year_olds = FactoryGirl.build_list(:user, 25, :date_of_birth => 20.years.ago)
+twenty_year_olds = FactoryGirl.build_list(:user, 25, date_of_birth: 20.years.ago)
 ```
 
 Custom Construction
@@ -708,7 +733,7 @@ Cucumber Integration
 factory\_girl ships with step definitions that make calling factories from Cucumber easier. To use them, add the following to features/support/env.rb:
 
 ```ruby
-require 'factory_girl/step_definitions'
+require "factory_girl/step_definitions"
 ```
 
 Alternate Syntaxes
@@ -720,16 +745,16 @@ provide alternate interfaces. See Factory::Syntax for information about the
 various layers available. For example, the Machinist-style syntax is popular:
 
 ```ruby
-require 'factory_girl/syntax/blueprint'
-require 'factory_girl/syntax/make'
-require 'factory_girl/syntax/sham'
+require "factory_girl/syntax/blueprint"
+require "factory_girl/syntax/make"
+require "factory_girl/syntax/sham"
 
 Sham.email {|n| "#{n}@example.com" }
 
 User.blueprint do
-  name  { 'Billy Bob' }
+  name  { "Billy Bob" }
   email { Sham.email  }
 end
 
-User.make(:name => 'Johnny')
+User.make(name: "Johnny")
 ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_girl (3.0.0)
+    factory_girl (3.1.0)
       activesupport (>= 3.0.0)
 
 GEM
@@ -19,7 +19,7 @@ GEM
       tzinfo (~> 0.3.29)
     activesupport (3.1.0)
       multi_json (~> 1.0)
-    appraisal (0.3.8)
+    appraisal (0.4.1)
       bundler
       rake
     arel (2.2.1)
@@ -38,23 +38,23 @@ GEM
     builder (3.0.0)
     childprocess (0.2.2)
       ffi (~> 1.0.6)
-    cucumber (1.0.6)
+    cucumber (1.1.9)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.18)
+      gherkin (~> 2.9.0)
       json (>= 1.4.6)
       term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
     ffi (1.0.9)
-    gherkin (2.4.21)
+    gherkin (2.9.3)
       json (>= 1.4.6)
     i18n (0.6.0)
-    json (1.6.1)
+    json (1.6.6)
     mocha (0.9.8)
       rake
     multi_json (1.0.3)
     rack (1.3.3)
-    rake (0.9.2)
+    rake (0.9.2.2)
     rdiscount (1.6.8)
     rspec (2.6.0)
       rspec-core (~> 2.6.0)
@@ -71,7 +71,7 @@ GEM
     sqlite3 (1.3.4)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
-    term-ansicolor (1.0.6)
+    term-ansicolor (1.0.7)
     timecop (0.3.5)
     tzinfo (0.3.29)
     yard (0.7.2)
@@ -81,11 +81,11 @@ PLATFORMS
 
 DEPENDENCIES
   activerecord
-  appraisal (~> 0.3.8)
+  appraisal (~> 0.4)
   aruba
   bluecloth
   bourne
-  cucumber (~> 1.0.0)
+  cucumber (~> 1.1)
   factory_girl!
   mocha
   rspec (~> 2.0)

data/{Changelog → NEWS}

@@ -1,3 +1,10 @@
+3.1.0 (April 6, 2012)
+  Sequences support aliases, which reference the same block
+  Update documentation
+  Add before_create callback
+  Support use of #attribute_names method to determine available attributes for steps
+  Use ActiveSupport::Deprecation for all deprecations
+
 3.0.0 (March 23, 2012)
   Deprecate the vintage syntax
   Remove Rails 2.x support

data/README.md

@@ -25,6 +25,13 @@ gem 'factory_girl'
 ```
 and run `bundle install` from your shell.
 
+Supported Ruby versions
+-----------------------
+
+The Factory Girl 3.x series supports Ruby 1.9.x.
+
+For older versions of Ruby, please use the Factory Girl 2.x series.
+
 More Information
 ----------------
 

data/factory_girl.gemspec

@@ -24,13 +24,13 @@ Gem::Specification.new do |s|
   s.add_dependency("activesupport", ">= 3.0.0")
 
   s.add_development_dependency("rspec",    "~> 2.0")
-  s.add_development_dependency("cucumber", "~> 1.0.0")
+  s.add_development_dependency("cucumber", "~> 1.1")
   s.add_development_dependency("timecop")
   s.add_development_dependency("simplecov")
   s.add_development_dependency("aruba")
   s.add_development_dependency("mocha")
   s.add_development_dependency("bourne")
-  s.add_development_dependency("appraisal", "~> 0.3.8")
+  s.add_development_dependency("appraisal", "~> 0.4")
   s.add_development_dependency("sqlite3-ruby")
   s.add_development_dependency("yard")
   s.add_development_dependency("bluecloth")

data/features/factory_girl_steps.feature

@@ -235,3 +235,7 @@ Feature: Use step definitions generated by factories
   Scenario: step definitions work correctly with ORMs that have simple `columns`
     Given a simple column exists
     Then there should be 1 SimpleColumn
+
+  Scenario: step definitions work correctly with model classes that simply have attribute names
+    Given a named attribute model exists with a title of "a fun title"
+    Then there should be 1 NamedAttributeModel