factory_girl 2.1.0 → 2.1.2

data/.travis.yml

@@ -8,3 +8,6 @@ gemfile:
   - gemfiles/2.3.gemfile
   - gemfiles/3.0.gemfile
   - gemfiles/3.1.gemfile
+branches:
+  only:
+    - master

data/Changelog

@@ -1,3 +1,12 @@
+2.1.0 (September 02, 2011)
+  Bugfix: created_at now defined for stubbed models
+  Gemspec updated for use with Rails 3.1
+  Factories can now be modified post-definition (useful for overriding defaults from gems/plugins)
+  All factories can now be reloaded with Factory.reload
+  Add :method => build to factory associations to prevent saving of associated objects
+  Factories defined in {Rails.root}/factories are now loaded by default
+  Various documentation updates
+
 1.1.4 (November 28, 2008)
   Factory.build now uses Factory.create for associations of the built object
   Factory definitions are now detected in subdirectories, such as

data/GETTING_STARTED.md

@@ -4,13 +4,13 @@ Getting Started
 Update Your Gemfile
 -------------------
 
-If you're using Rails, you'll need to upgrade `factory_girl_rails` to the latest RC:
+If you're using Rails, you'll need to change the required version of `factory_girl_rails`:
 
-    gem "factory_girl_rails", "~> 1.1"
+    gem "factory_girl_rails", "~> 1.2"
 
 If you're *not* using Rails, you'll just have to change the required version of `factory_girl`:
 
-    gem "factory_girl", "~> 2.0.0"
+    gem "factory_girl", "~> 2.1.0"
 
 Once your Gemfile is updated, you'll want to update your bundle.
 
@@ -57,7 +57,7 @@ are defined in files at the following locations:
 Using factories
 ---------------
 
-factory_girl supports several different build strategies: build, create, attributes_for and stub:
+factory\_girl supports several different build strategies: build, create, attributes\_for and stub:
 
     # Returns a User instance that's not saved
     user = FactoryGirl.build(:user)
@@ -101,7 +101,11 @@ This would allow you to write:
 Lazy 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 "lazy" attributes can be added by passing a block instead of a parameter:
+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 "lazy" attributes can be added by passing a
+block instead of a parameter:
 
     factory :user do
       # ...
@@ -169,9 +173,14 @@ There may be times where your code can be DRYed up by passing in transient attri
     FactoryGirl.create(:user, :upcased => true).name
     #=> "JOHN DOE - ROCKSTAR"
 
-Static and dynamic attributes can be ignored. Ignored 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.
+Static and dynamic attributes can be ignored. Ignored 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.
 
-Within Factory Girl's dynamic attributes, you can access ignored attributes as you would expect. If you need to access the proxy in a Factory Girl callback, you'll need to declare a second block argument (for the proxy) and access ignored attributes from there.
+Within Factory Girl's dynamic attributes, you can access ignored attributes as
+you would expect. If you need to access the proxy in a Factory Girl callback,
+you'll need to declare a second block argument (for the proxy) and access
+ignored attributes from there.
 
 Associations
 ------------
@@ -241,7 +250,10 @@ You can also assign the parent explicitly:
       approved true
     end
 
-As mentioned above, it's good practice to define a basic factory for each class with only the attributes required to create it. Then, create more specific factories that inherit from this basic parent. Factory definitions are still code, so keep them DRY.
+As mentioned above, it's good practice to define a basic factory for each class
+with only the attributes required to create it. Then, create more specific
+factories that inherit from this basic parent. Factory definitions are still
+code, so keep them DRY.
 
 Sequences
 ---------
@@ -367,10 +379,28 @@ the trait that defines the attribute latest gets precedence.
       factory :female_admin, :traits => [:admin, :female] # login will be "Jane Doe (F)"
     end
 
+You can also override individual attributes granted by a trait in subclasses.
+
+    factory :user do
+      name "Friendly User"
+      login { name }
+
+      trait :male do
+        name   "John Doe"
+        gender "Male"
+        login { "#{name} (M)" }
+      end
+
+      factory :brandon do
+        male
+        name "Brandon"
+      end
+    end
+
 Callbacks
 ---------
 
-Factory_girl makes available three callbacks for injecting some code:
+factory\_girl makes available three callbacks for injecting some code:
 
 * after_build  - called after a factory is built   (via FactoryGirl.build)
 * after_create - called after a factory is saved   (via FactoryGirl.create)
@@ -399,7 +429,7 @@ Factories can also define any number of the same kind of callback.  These callba
       after_create { then_this }
     end
 
-Calling FactoryGirl.create will invoke both after_build and after_create callbacks.
+Calling FactoryGirl.create will invoke both after\_build and after\_create callbacks.
 
 Also, like standard attributes, child factories will inherit (and can also define) callbacks from their parent factory.
 
@@ -445,10 +475,8 @@ When modifying a factory, you can change any of the attributes you want (aside f
 
 `FactoryGirl.modify` must be called outside of a `FactoryGirl.define` block as it operates on factories differently.
 
-A couple caveats: you can only modify factories (not sequences or traits) and callbacks *still compound as they normally would*. So, if
+A caveat: you can only modify factories (not sequences or traits) and callbacks *still compound as they normally would*. So, if
 the factory you're modifying defines an `after_create` callback, you defining an `after_create` won't override it, it'll just get run after the first callback.
-You also can't modify attributes assigned by traits. So, if you have a trait that grants a name attribute, and you modify the factory to set the name,
-it currently will reflect the name in the trait instead of the modified name.
 
 Building or Creating Multiple Records
 -------------------------------------
@@ -466,14 +494,17 @@ To set the attributes for each of the factories, you can pass in a hash as you n
 Cucumber Integration
 --------------------
 
-factory_girl ships with step definitions that make calling factories from Cucumber easier. To use them:
+factory\_girl ships with step definitions that make calling factories from Cucumber easier. To use them, add the following to features/support/env.rb:
 
-    require 'factory_girl/step_definitions' 
+    require 'factory_girl/step_definitions'
 
 Alternate Syntaxes
 ------------------
 
-Users' tastes for syntax vary dramatically, but most users are looking for a common feature set. Because of this factory_girl supports "syntax layers" which provide alternate interfaces. See Factory::Syntax for information about the various layers available. For example, the Machinist-style syntax is popular:
+Users' tastes for syntax vary dramatically, but most users are looking for a
+common feature set. Because of this factory\_girl supports "syntax layers" which
+provide alternate interfaces. See Factory::Syntax for information about the
+various layers available. For example, the Machinist-style syntax is popular:
 
     require 'factory_girl/syntax/blueprint'
     require 'factory_girl/syntax/make'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    factory_girl (2.1.0)
+    factory_girl (2.1.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/
@@ -28,31 +29,31 @@ GEM
       cucumber (>= 1.0.2)
       rdiscount (>= 1.6.8)
       rspec (>= 2.6.0)
-    bcat (0.6.1)
+    bcat (0.6.2)
       rack (~> 1.0)
-    bcrypt-ruby (3.0.0)
+    bcrypt-ruby (3.0.1)
     bluecloth (2.1.0)
     bourne (1.0)
       mocha (= 0.9.8)
     builder (3.0.0)
     childprocess (0.2.2)
       ffi (~> 1.0.6)
-    cucumber (1.0.2)
+    cucumber (1.0.6)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
-      gherkin (~> 2.4.5)
+      gherkin (~> 2.4.18)
       json (>= 1.4.6)
-      term-ansicolor (>= 1.0.5)
+      term-ansicolor (>= 1.0.6)
     diff-lcs (1.1.3)
     ffi (1.0.9)
-    gherkin (2.4.16)
+    gherkin (2.4.21)
       json (>= 1.4.6)
     i18n (0.6.0)
-    json (1.5.4)
+    json (1.6.1)
     mocha (0.9.8)
       rake
     multi_json (1.0.3)
-    rack (1.3.2)
+    rack (1.3.3)
     rake (0.9.2)
     rcov (0.9.10)
     rdiscount (1.6.8)

data/gemfiles/2.1.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.0)
+    factory_girl (2.1.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/

data/gemfiles/2.3.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.0)
+    factory_girl (2.1.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.0)
+    factory_girl (2.1.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/

data/gemfiles/3.1.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.1.0)
+    factory_girl (2.1.2)
+      activesupport
 
 GEM
   remote: http://rubygems.org/

data/lib/factory_girl.rb

@@ -9,10 +9,13 @@ require 'factory_girl/attribute'
 require 'factory_girl/attribute/static'
 require 'factory_girl/attribute/dynamic'
 require 'factory_girl/attribute/association'
-require 'factory_girl/attribute/callback'
 require 'factory_girl/attribute/sequence'
-require 'factory_girl/attribute/implicit'
-require 'factory_girl/attribute/trait'
+require 'factory_girl/callback'
+require 'factory_girl/declaration'
+require 'factory_girl/declaration/static'
+require 'factory_girl/declaration/dynamic'
+require 'factory_girl/declaration/association'
+require 'factory_girl/declaration/implicit'
 require 'factory_girl/sequence'
 require 'factory_girl/attribute_list'
 require 'factory_girl/trait'

data/lib/factory_girl/attribute/static.rb

@@ -3,6 +3,8 @@ module FactoryGirl
 
     class Static < Attribute  #:nodoc:
 
+      attr_reader :value
+
       def initialize(name, value)
         super(name)
         @value = value
@@ -15,6 +17,12 @@ module FactoryGirl
       def priority
         0
       end
+
+      def ==(another)
+        self.name == another.name &&
+          self.value == another.value &&
+          self.ignored == another.ignored
+      end
     end
   end
 end

data/lib/factory_girl/attribute_list.rb

@@ -2,9 +2,17 @@ module FactoryGirl
   class AttributeList
     include Enumerable
 
+    attr_reader :callbacks, :declarations
+
     def initialize
       @attributes  = {}
+      @declarations = []
       @overridable = false
+      @callbacks = []
+    end
+
+    def declare_attribute(declaration)
+      @declarations << declaration
     end
 
     def define_attribute(attribute)
@@ -15,12 +23,8 @@ module FactoryGirl
       add_attribute attribute
     end
 
-    def add_callback(name, &block)
-      unless valid_callback_names.include?(name.to_sym)
-        raise InvalidCallbackNameError, "#{name} is not a valid callback name. Valid callback names are #{valid_callback_names.inspect}"
-      end
-
-      add_attribute Attribute::Callback.new(name.to_sym, block)
+    def add_callback(callback)
+      @callbacks << callback
     end
 
     def each(&block)
@@ -32,6 +36,7 @@ module FactoryGirl
     end
 
     def apply_attributes(attributes_to_apply)
+      attributes_to_apply.callbacks.reverse.each { |callback| prepend_callback(callback) }
       new_attributes = []
 
       attributes_to_apply.each do |attribute|
@@ -56,12 +61,12 @@ module FactoryGirl
       @overridable
     end
 
-    private
-
-    def valid_callback_names
-      [:after_build, :after_create, :after_stub]
+    def size
+      to_a.size
     end
 
+    private
+
     def add_attribute(attribute)
       delete_attribute(attribute.name) if overridable?
 
@@ -70,6 +75,10 @@ module FactoryGirl
       attribute
     end
 
+    def prepend_callback(callback)
+      @callbacks.unshift(callback)
+    end
+
     def prepend_attributes(new_attributes)
       new_attributes.group_by {|attr| attr.priority }.each do |priority, attributes|
         @attributes[priority] ||= []
@@ -86,8 +95,7 @@ module FactoryGirl
 
     def find_attribute(attribute_name)
       @attributes.values.flatten.detect do |attribute|
-        attribute.name == attribute_name &&
-          !attribute.is_a?(FactoryGirl::Attribute::Callback)
+        attribute.name == attribute_name
       end
     end
 

data/lib/factory_girl/callback.rb

@@ -0,0 +1,30 @@
+module FactoryGirl
+  class Callback
+    VALID_NAMES = [:after_build, :after_create, :after_stub].freeze
+
+    attr_reader :name, :block
+
+    def initialize(name, block)
+      @name  = name.to_sym
+      @block = block
+      check_name
+    end
+
+    def run(instance, proxy)
+      case block.arity
+      when 1 then block.call(instance)
+      when 2 then block.call(instance, proxy)
+      else block.call
+      end
+    end
+
+    private
+
+    def check_name
+      unless VALID_NAMES.include?(name)
+        raise InvalidCallbackNameError, "#{name} is not a valid callback name. " +
+          "Valid callback names are #{VALID_NAMES.inspect}"
+      end
+    end
+  end
+end

data/lib/factory_girl/declaration.rb

@@ -0,0 +1,19 @@
+module FactoryGirl
+  class Declaration
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def ignore
+      @ignored = true
+    end
+
+    def to_attributes
+      build.tap do |attributes|
+        attributes.each(&:ignore) if @ignored
+      end
+    end
+  end
+end

data/lib/factory_girl/declaration/association.rb

@@ -0,0 +1,17 @@
+module FactoryGirl
+  class Declaration
+    class Association < Declaration
+      def initialize(name, options)
+        super(name)
+        @options = options
+      end
+
+      private
+
+      def build
+        factory_name = @options.delete(:factory) || name
+        [Attribute::Association.new(name, factory_name, @options)]
+      end
+    end
+  end
+end

data/lib/factory_girl/declaration/dynamic.rb

@@ -0,0 +1,16 @@
+module FactoryGirl
+  class Declaration
+    class Dynamic < Declaration
+      def initialize(name, block)
+        super(name)
+        @block = block
+      end
+
+      private
+
+      def build
+        [Attribute::Dynamic.new(name, @block)]
+      end
+    end
+  end
+end