factory_girl 1.3.3 → 2.0.0.beta1

data/README.rdoc

@@ -1,10 +1,15 @@
+= NOTE: this documentation is for the beta version of factory_girl 2
+
+Up-to-date documentation for the stable branch can be found here:
+
+http://github.com/thoughtbot/factory_girl/tree/1.3.x
+
 = factory_girl
 
 factory_girl is a fixtures replacement with a straightforward definition syntax, support for multiple build strategies (saved instances, unsaved instances, attribute hashes, and stubbed objects), and support for multiple factories for the same class (user, admin_user, and so on), including factory inheritance.
 
-If you want to use factory_girl with Rails 3, use the factory_girl_rails gem, not this one.
-
-If you want to use factory_girl with Rails versions prior to Rails 3, use version 1.2.4.
+If you want to use factory_girl with Rails 3, see
+http://github.com/thoughtbot/factory_girl_rails
 
 == Download
 
@@ -18,24 +23,26 @@ Gem:
 Each factory has a name and a set of attributes. The name is used to guess the class of the object by default, but it's possible to explicitly specify it:
 
   # This will guess the User class
-  Factory.define :user do |u|
-    u.first_name 'John'
-    u.last_name  'Doe'
-    u.admin false
-  end
-
-  # This will use the User class (Admin would have been guessed)
-  Factory.define :admin, :class => User do |u|
-    u.first_name 'Admin'
-    u.last_name  'User'
-    u.admin true
-  end
-
-  # The same, but using a string instead of class constant
-  Factory.define :admin, :class => 'user' do |u|
-    u.first_name 'Admin'
-    u.last_name  'User'
-    u.admin true
+  FactoryGirl.define :user do
+    factory :user do
+      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
+    end
   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.
@@ -74,7 +81,7 @@ You can use the Factory method as a shortcut for the default build strategy:
 The default strategy can be overriden:
 
   # Now same as Factory.build(:user)
-  Factory.define :user, :default_strategy => :build do |u|
+  factory :user, :default_strategy => :build do
     ...
   end
 
@@ -91,19 +98,19 @@ No matter which strategy is used, it's possible to override the defined attribut
 
 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.define :user do |u|
+  factory :user do
     # ...
-    u.activation_code { User.generate_activation_code }
+    activation_code { User.generate_activation_code }
   end
 
 == Dependent Attributes
 
 Attributes can be based on the values of other attributes using the proxy that is yieled to lazy attribute blocks:
 
-  Factory.define :user do |u|
-    u.first_name 'Joe'
-    u.last_name  'Blow'
-    u.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
+  factory :user do
+    first_name 'Joe'
+    last_name  'Blow'
+    email { "#{first_name}.#{last_name}@example.com".downcase }
   end
 
   Factory(:user, :last_name => 'Doe').email
@@ -114,9 +121,16 @@ Attributes can be based on the values of other attributes using the proxy that i
 Associated instances can be generated by using the association method when
 defining a lazy attribute:
 
-  Factory.define :post do |p|
+  factory :post do
+    # ...
+    author
+  end
+
+You can also specify a different factory or override attributes:
+
+  factory :post do
     # ...
-    p.author {|author| author.association(:user, :last_name => 'Writely') }
+    association :author, :factory => :user, :last_name => 'Writely'
   end
 
 The behavior of the association method varies depending on the build strategy used for the parent object.
@@ -131,18 +145,6 @@ The behavior of the association method varies depending on the build strategy us
   post.new_record?       # => true
   post.author.new_record # => false
 
-Because this pattern is so common, a prettier syntax is available for defining
-associations:
-
-  # The following definitions are equivalent:
-  Factory.define :post do |p|
-    p.author {|a| a.association(:user) }
-  end
-
-  Factory.define :post do |p|
-    p.association :author, :factory => :user
-  end
-
 If the factory name is the same as the association name, the factory name can
 be left out.
 
@@ -150,15 +152,15 @@ be left out.
 
 You can easily create multiple factories for the same class without repeating common attributes by using inheritance:
 
-  Factory.define :post do |p|
+  factory :post do
     # the 'title' attribute is required for all posts
-    p.title 'A title'
+    title 'A title'
   end
 
-  Factory.define :approved_post, :parent => :post do |p|
-    p.approved true
+  factory :approved_post, :parent => :post do
+    approved true
     # the 'approver' association is required for an approved post
-    p.association :approver, :factory => :user
+    association :approver, :factory => :user
   end
 
 == Sequences
@@ -168,7 +170,7 @@ generated using sequences. Sequences are defined by calling Factory.sequence,
 and values in a sequence are generated by calling Factory.next:
 
   # Defines a new sequence
-  Factory.sequence :email do |n|
+  FactoryGirl.sequence :email do |n|
     "person#{n}@example.com"
   end
 
@@ -178,16 +180,22 @@ and values in a sequence are generated by calling Factory.next:
   Factory.next :email
   # => "person2@example.com"
 
-Sequences can be used in lazy attributes:
+Sequences can be used as attributes:
+
+  factory :user do
+    email
+  end
+
+Or in lazy attributes:
 
-  Factory.define :user do |f|
-    f.email { Factory.next(:email) }
+  factory :invite do
+    invitee { Factory.next(:email) }
   end
 
 And it's also possible to define an in-line sequence that is only used in
 a particular factory:
 
-  Factory.define :user do |f|
+  factory :user do
     f.sequence(:email) {|n| "person#{n}@example.com" }
   end
 
@@ -202,24 +210,24 @@ Factory_girl makes available three callbacks for injecting some code:
 Examples:
 
   # Define a factory that calls the generate_hashed_password method after it is built
-  Factory.define :user do |u|
-    u.after_build { |user| do_something_to(user) }
+  factory :user do
+    after_build { |user| do_something_to(user) }
   end
 
 Note that you'll have an instance of the user in the block.  This can be useful.
 
 You can also define multiple types of callbacks on the same factory:
 
-  Factory.define :user do |u|
-    u.after_build  { |user| do_something_to(user) }
-    u.after_create { |user| do_something_else_to(user) }
+  factory :user do
+    after_build  { |user| do_something_to(user) }
+    after_create { |user| do_something_else_to(user) }
   end
 
 Factories can also define any number of the same kind of callback.  These callbacks will be executed in the order they are specified:
 
-  Factory.define :user do |u|
-    u.after_create { this_runs_first }
-    u.after_create { then_this }
+  factory :user do
+    after_create { this_runs_first }
+    after_create { then_this }
   end
 
 Calling Factory.create will invoke both after_build and after_create callbacks.

data/lib/factory_girl.rb

@@ -11,18 +11,12 @@ require 'factory_girl/attribute/association'
 require 'factory_girl/attribute/callback'
 require 'factory_girl/sequence'
 require 'factory_girl/aliases'
-
-# Shortcut for Factory.default_strategy.
-#
-# Example:
-#   Factory(:user, :name => 'Joe')
-def Factory (name, attrs = {})
-  Factory.default_strategy(name, attrs)
-end
-
-class Factory
-  VERSION = "1.3.3"
-end
+require 'factory_girl/definition_proxy'
+require 'factory_girl/syntax/default'
+require 'factory_girl/syntax/vintage'
+require 'factory_girl/find_definitions'
+require 'factory_girl/deprecated'
+require 'factory_girl/version'
 
 if defined?(Rails) && Rails::VERSION::MAJOR == 2
   require 'factory_girl/rails2'

data/lib/factory_girl/aliases.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
 
   class << self
     attr_accessor :aliases #:nodoc:
@@ -8,35 +8,7 @@ class Factory
     [/(.*)/, '\1_id']
   ]
 
-  # Defines a new alias for attributes.
-  #
-  # Arguments:
-  # * pattern: +Regexp+
-  #   A pattern that will be matched against attributes when looking for
-  #   aliases. Contents captured in the pattern can be used in the alias.
-  # * replace: +String+
-  #   The alias that results from the matched pattern. Captured strings can
-  #   be substituted like with +String#sub+.
-  #
-  # Example:
-  #
-  #   Factory.alias /(.*)_confirmation/, '\1'
-  #
-  # factory_girl starts with aliases for foreign keys, so that a :user
-  # association can be overridden by a :user_id parameter:
-  #
-  #   Factory.define :post do |p|
-  #     p.association :user
-  #   end
-  #
-  #   # The user association will not be built in this example. The user_id
-  #   # will be used instead.
-  #   Factory(:post, :user_id => 1)
-  def self.alias (pattern, replace)
-    self.aliases << [pattern, replace]
-  end
-
-  def self.aliases_for (attribute) #:nodoc:
+  def self.aliases_for(attribute) #:nodoc:
     aliases.collect do |params|
       pattern, replace = *params
       if pattern.match(attribute.to_s)
@@ -46,5 +18,4 @@ class Factory
       end
     end.compact << attribute
   end
-
 end

data/lib/factory_girl/attribute.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
 
   # Raised when defining an invalid attribute:
   # * Defining an attribute which has a name ending in "="

data/lib/factory_girl/attribute/association.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
   class Attribute #:nodoc:
 
     class Association < Attribute  #:nodoc:

data/lib/factory_girl/attribute/callback.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
   class Attribute #:nodoc:
 
     class Callback < Attribute  #:nodoc:

data/lib/factory_girl/attribute/dynamic.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
   class Attribute #:nodoc:
 
     class Dynamic < Attribute  #:nodoc:
@@ -8,8 +8,8 @@ class Factory
       end
 
       def add_to(proxy)
-        value = @block.arity.zero? ? @block.call : @block.call(proxy)
-        if Factory::Sequence === value
+        value = @block.arity == 1 ? @block.call(proxy) : proxy.instance_eval(&@block)
+        if FactoryGirl::Sequence === value
           raise SequenceAbuseError
         end
         proxy.set(name, value)

data/lib/factory_girl/attribute/static.rb

@@ -1,4 +1,4 @@
-class Factory
+module FactoryGirl
   class Attribute #:nodoc:
 
     class Static < Attribute  #:nodoc:

data/lib/factory_girl/definition_proxy.rb

@@ -0,0 +1,180 @@
+module FactoryGirl
+  class DefinitionProxy
+    instance_methods.each do |method|
+      undef_method(method) unless method =~ /(^__|^nil\?$|^send$|^object_id$|^extend$|^instance_eval$)/
+    end
+
+    def initialize(factory)
+      @factory = factory
+    end
+
+    # Adds an attribute that should be assigned on generated instances for this
+    # factory.
+    #
+    # This method should be called with either a value or block, but not both. If
+    # called with a block, the attribute will be generated "lazily," whenever an
+    # instance is generated. Lazy attribute blocks will not be called if that
+    # attribute is overridden for a specific instance.
+    #
+    # When defining lazy attributes, an instance of FactoryGirl::Proxy will
+    # be yielded, allowing associations to be built using the correct build
+    # strategy.
+    #
+    # Arguments:
+    # * name: +Symbol+ or +String+
+    #   The name of this attribute. This will be assigned using :"#{name}=" for
+    #   generated instances.
+    # * value: +Object+
+    #   If no block is given, this value will be used for this attribute.
+    def add_attribute(name, value = nil, &block)
+      if block_given?
+        if value
+          raise AttributeDefinitionError, "Both value and block given"
+        else
+          attribute = Attribute::Dynamic.new(name, block)
+        end
+      else
+        attribute = Attribute::Static.new(name, value)
+      end
+
+      @factory.define_attribute(attribute)
+    end
+
+    # Calls add_attribute using the missing method name as the name of the
+    # attribute, so that:
+    #
+    #   factory :user do
+    #     name 'Billy Idol'
+    #   end
+    #
+    # and:
+    #
+    #   factory :user do
+    #     add_attribute :name, 'Billy Idol'
+    #   end
+    #
+    # are equivilent.
+    #
+    # If no argument or block is given, factory_girl will look for a sequence
+    # or association with the same name. This means that:
+    #
+    #   factory :user do
+    #     email { Factory.next(:email) }
+    #     association :account
+    #   end
+    #
+    # and:
+    #
+    #   factory :user do
+    #     email
+    #     account
+    #   end
+    #
+    # are equivilent.
+    def method_missing(name, *args, &block)
+      if args.empty? && block.nil?
+        if sequence = FactoryGirl.sequences[name]
+          add_attribute(name) { sequence.next }
+        else
+          association(name)
+        end
+      else
+        add_attribute(name, *args, &block)
+      end
+    end
+
+    # Adds an attribute that will have unique values generated by a sequence with
+    # a specified format.
+    #
+    # The result of:
+    #   factory :user do
+    #     sequence(:email) { |n| "person#{n}@example.com" }
+    #   end
+    #
+    # Is equal to:
+    #   sequence(:email) { |n| "person#{n}@example.com" }
+    #
+    #   factory :user do
+    #     email { Factory.next(:email) }
+    #   end
+    #
+    # Except that no globally available sequence will be defined.
+    def sequence(name, start_value = 1, &block)
+      sequence = Sequence.new(start_value, &block)
+      add_attribute(name) { sequence.next }
+    end
+
+    # Adds an attribute that builds an association. The associated instance will
+    # be built using the same build strategy as the parent instance.
+    #
+    # Example:
+    #   factory :user do
+    #     name 'Joey'
+    #   end
+    #
+    #   factory :post do
+    #     association :author, :factory => :user
+    #   end
+    #
+    # Arguments:
+    # * name: +Symbol+
+    #   The name of this attribute.
+    # * options: +Hash+
+    #
+    # Options:
+    # * factory: +Symbol+ or +String+
+    #    The name of the factory to use when building the associated instance.
+    #    If no name is given, the name of the attribute is assumed to be the
+    #    name of the factory. For example, a "user" association will by
+    #    default use the "user" factory.
+    def association(name, options = {})
+      factory_name = options.delete(:factory) || name
+      @factory.define_attribute(Attribute::Association.new(name, factory_name, options))
+    end
+
+    # Registers an alias for this factory using the given name.
+    #
+    # Arguments:
+    # * name: +Symbol+
+    #   The name of the alias.
+    #
+    # Example:
+    #
+    #   factory :user do
+    #     aliased_as :author
+    #   end
+    #
+    #   Factory(:author).class
+    #   # => User
+    #
+    # Because an attribute defined without a value or block will build an
+    # association with the same name, this allows associations to be defined
+    # without factories, such as:
+    #
+    #   factory :user do
+    #     aliased_as :author
+    #   end
+    #
+    #   factory :post do
+    #     author
+    #   end
+    #
+    #   Factory(:post).author.class
+    #   # => User
+    def aliased_as(name)
+      FactoryGirl.register_factory(@factory, :as => name)
+    end
+
+    def after_build(&block)
+      @factory.add_callback(:after_build, &block)
+    end
+
+    def after_create(&block)
+      @factory.add_callback(:after_create, &block)
+    end
+
+    def after_stub(&block)
+      @factory.add_callback(:after_stub, &block)
+    end
+  end
+end