factory_girl 1.3.3 → 2.0.0.beta1

data/lib/factory_girl/syntax/vintage.rb

@@ -0,0 +1,196 @@
+module FactoryGirl
+  module Syntax
+    module Vintage
+      module Factory
+        # Defines a new factory that can be used by the build strategies (create and
+        # build) to build new objects.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   A unique name used to identify this factory.
+        # * options: +Hash+
+        #
+        # Options:
+        # * class: +Symbol+, +Class+, or +String+
+        #   The class that will be used when generating instances for this factory. If not specified, the class will be guessed from the factory name.
+        # * parent: +Symbol+
+        #   The parent factory. If specified, the attributes from the parent
+        #   factory will be copied to the current one with an ability to override
+        #   them.
+        # * default_strategy: +Symbol+
+        #   The strategy that will be used by the Factory shortcut method.
+        #   Defaults to :create.
+        #
+        # Yields: +Factory+
+        # The newly created factory.
+        def self.define(name, options = {})
+          factory = FactoryGirl::Factory.new(name, options)
+          proxy = FactoryGirl::DefinitionProxy.new(factory)
+          yield(proxy)
+          if parent = options.delete(:parent)
+            factory.inherit_from(FactoryGirl.factory_by_name(parent))
+          end
+          FactoryGirl.register_factory(factory)
+        end
+
+        # Generates and returns a Hash of attributes from this factory. Attributes
+        # can be individually overridden by passing in a Hash of attribute => value
+        # pairs.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   The name of the factory that should be used.
+        # * overrides: +Hash+
+        #   Attributes to overwrite for this set.
+        #
+        # Returns: +Hash+
+        # A set of attributes that can be used to build an instance of the class
+        # this factory generates.
+        def self.attributes_for(name, overrides = {})
+          FactoryGirl.factory_by_name(name).run(Proxy::AttributesFor, overrides)
+        end
+
+        # Generates and returns an instance from this factory. Attributes can be
+        # individually overridden by passing in a Hash of attribute => value pairs.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   The name of the factory that should be used.
+        # * overrides: +Hash+
+        #   Attributes to overwrite for this instance.
+        #
+        # Returns: +Object+
+        # An instance of the class this factory generates, with generated attributes
+        # assigned.
+        def self.build(name, overrides = {})
+          FactoryGirl.factory_by_name(name).run(Proxy::Build, overrides)
+        end
+
+        # Generates, saves, and returns an instance from this factory. Attributes can
+        # be individually overridden by passing in a Hash of attribute => value
+        # pairs.
+        #
+        # Instances are saved using the +save!+ method, so ActiveRecord models will
+        # raise ActiveRecord::RecordInvalid exceptions for invalid attribute sets.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   The name of the factory that should be used.
+        # * overrides: +Hash+
+        #   Attributes to overwrite for this instance.
+        #
+        # Returns: +Object+
+        # A saved instance of the class this factory generates, with generated
+        # attributes assigned.
+        def self.create(name, overrides = {})
+          FactoryGirl.factory_by_name(name).run(Proxy::Create, overrides)
+        end
+
+        # Generates and returns an object with all attributes from this factory
+        # stubbed out. Attributes can be individually overridden by passing in a Hash
+        # of attribute => value pairs.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   The name of the factory that should be used.
+        # * overrides: +Hash+
+        #   Attributes to overwrite for this instance.
+        #
+        # Returns: +Object+
+        # An object with generated attributes stubbed out.
+        def self.stub(name, overrides = {})
+          FactoryGirl.factory_by_name(name).run(Proxy::Stub, overrides)
+        end
+
+        # Executes the default strategy for the given factory. This is usually create,
+        # but it can be overridden for each factory.
+        #
+        # Arguments:
+        # * name: +Symbol+ or +String+
+        #   The name of the factory that should be used.
+        # * overrides: +Hash+
+        #   Attributes to overwrite for this instance.
+        #
+        # Returns: +Object+
+        # The result of the default strategy.
+        def self.default_strategy(name, overrides = {})
+          self.send(FactoryGirl.factory_by_name(name).default_strategy, name, overrides)
+        end
+
+        # Defines a new sequence that can be used to generate unique values in a specific format.
+        #
+        # Arguments:
+        #   name: (Symbol)
+        #     A unique name for this sequence. This name will be referenced when
+        #     calling next to generate new values from this sequence.
+        #   block: (Proc)
+        #     The code to generate each value in the sequence. This block will be
+        #     called with a unique number each time a value in the sequence is to be
+        #     generated. The block should return the generated value for the
+        #     sequence.
+        #
+        # Example:
+        #
+        #   Factory.sequence(:email) {|n| "somebody_#{n}@example.com" }
+        def self.sequence(name, start_value = 1, &block)
+          FactoryGirl.sequences[name] = Sequence.new(start_value, &block)
+        end
+
+        # Generates and returns the next value in a sequence.
+        #
+        # Arguments:
+        #   name: (Symbol)
+        #     The name of the sequence that a value should be generated for.
+        #
+        # Returns:
+        #   The next value in the sequence. (Object)
+        def self.next(sequence)
+          unless FactoryGirl.sequences.key?(sequence)
+            raise "No such sequence: #{sequence}"
+          end
+
+          FactoryGirl.sequences[sequence].next
+        end
+
+        # 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)
+          FactoryGirl.aliases << [pattern, replace]
+        end
+
+      end
+
+      # Shortcut for Factory.default_strategy.
+      #
+      # Example:
+      #   Factory(:user, :name => 'Joe')
+      def Factory(name, attrs = {})
+        Factory.default_strategy(name, attrs)
+      end
+    end
+  end
+end
+
+include FactoryGirl::Syntax::Vintage

data/lib/factory_girl/version.rb

@@ -0,0 +1,4 @@
+module FactoryGirl
+  VERSION = "2.0.0.beta1"
+end
+

data/spec/acceptance/acceptance_spec.rb

@@ -3,61 +3,60 @@ require 'acceptance/acceptance_helper'
 
 describe "integration" do
   before do
-    Factory.define :user, :class => 'user' do |f|
-      f.first_name 'Jimi'
-      f.last_name  'Hendrix'
-      f.admin       false
-      f.email {|a| "#{a.first_name}.#{a.last_name}@example.com".downcase }
-    end
+    FactoryGirl.define do
+      sequence :email do |n|
+        "somebody#{n}@example.com"
+      end
 
-    Factory.define Post, :default_strategy => :attributes_for do |f|
-      f.name   'Test Post'
-      f.association :author, :factory => :user
-    end
+      factory :user, :class => 'user' do
+        first_name 'Jimi'
+        last_name  'Hendrix'
+        admin       false
+        email { "#{first_name}.#{last_name}@example.com".downcase }
 
-    Factory.define :admin, :class => User do |f|
-      f.first_name 'Ben'
-      f.last_name  'Stein'
-      f.admin       true
-      f.sequence(:username) { |n| "username#{n}" }
-      f.email { Factory.next(:email) }
-    end
+        aliased_as :author
+      end
 
-    Factory.define :sequence_abuser, :class => User do |f|
-      f.first_name { Factory.sequence(:email) }
-    end
+      factory Post, :default_strategy => :attributes_for do
+        name   'Test Post'
+        author
+      end
 
-    Factory.define :guest, :parent => :user do |f|
-      f.last_name 'Anonymous'
-      f.username  'GuestUser'
-    end
+      factory :admin, :class => User do
+        first_name 'Ben'
+        last_name  'Stein'
+        admin       true
+        sequence(:username) { |n| "username#{n}" }
+        email
+      end
 
-    Factory.define :user_with_callbacks, :parent => :user do |f|
-      f.after_stub   {|u| u.first_name = 'Stubby' }
-      f.after_build  {|u| u.first_name = 'Buildy' }
-      f.after_create {|u| u.last_name  = 'Createy' }
-    end
+      factory :sequence_abuser, :class => User do
+        first_name { Factory.sequence(:email) }
+      end
 
-    Factory.define :user_with_inherited_callbacks, :parent => :user_with_callbacks do |f|
-      f.callback(:after_stub) {|u| u.last_name = 'Double-Stubby' }
-    end
+      factory :guest, :parent => :user do
+        last_name 'Anonymous'
+        username  'GuestUser'
+      end
 
-    Factory.define :business do |f|
-      f.name 'Supplier of Awesome'
-      f.association :owner, :factory => :user
-    end
+      factory :user_with_callbacks, :parent => :user do
+        after_stub   {|u| u.first_name = 'Stubby' }
+        after_build  {|u| u.first_name = 'Buildy' }
+        after_create {|u| u.last_name  = 'Createy' }
+      end
 
-    Factory.sequence :email do |n|
-      "somebody#{n}@example.com"
-    end
-  end
+      factory :user_with_inherited_callbacks, :parent => :user_with_callbacks do
+        after_stub {|u| u.last_name = 'Double-Stubby' }
+      end
 
-  after do
-    Factory.factories.clear
+      factory :business do
+        name 'Supplier of Awesome'
+        association :owner, :factory => :user
+      end
+    end
   end
 
   describe "a generated attributes hash" do
-
     before do
       @attrs = Factory.attributes_for(:user, :first_name => 'Bill')
     end
@@ -79,11 +78,9 @@ describe "integration" do
     it "should not assign associations" do
       Factory.attributes_for(:post)[:author].should be_nil
     end
-
   end
 
   describe "a built instance" do
-
     before do
       @instance = Factory.build(:post)
     end
@@ -103,11 +100,9 @@ describe "integration" do
     it "should not assign both an association and its foreign key" do
       Factory.build(:post, :author_id => 1).author_id.should == 1
     end
-
   end
 
   describe "a created instance" do
-
     before do
       @instance = Factory.create('post')
     end
@@ -123,11 +118,9 @@ describe "integration" do
     it "should save associations" do
       @instance.author.should_not be_new_record
     end
-
   end
 
   describe "a generated stub instance" do
-
     before do
       @stub = Factory.stub(:user, :first_name => 'Bill')
     end
@@ -174,7 +167,6 @@ describe "integration" do
   end
 
   describe "an instance generated by a factory with a custom class name" do
-
     before do
       @instance = Factory.create(:admin)
     end
@@ -186,7 +178,6 @@ describe "integration" do
     it "should use the correct factory definition" do
       @instance.should be_admin
     end
-
   end
 
   describe "an instance generated by a factory that inherits from another factory" do
@@ -212,7 +203,6 @@ describe "integration" do
   end
 
   describe "an attribute generated by a sequence" do
-
     before do
       @email = Factory.attributes_for(:admin)[:email]
     end
@@ -222,7 +212,6 @@ describe "integration" do
     end
 
     describe "after the attribute has already been generated once" do
-
       before do
         @another_email = Factory.attributes_for(:admin)[:email]
       end
@@ -234,13 +223,10 @@ describe "integration" do
       it "should not be the same as the first generated value" do
         @another_email.should_not == @email
       end
-
     end
-
   end
 
   describe "an attribute generated by an in-line sequence" do
-
     before do
       @username = Factory.attributes_for(:admin)[:username]
     end
@@ -250,7 +236,6 @@ describe "integration" do
     end
 
     describe "after the attribute has already been generated once" do
-
       before do
         @another_username = Factory.attributes_for(:admin)[:username]
       end
@@ -262,9 +247,7 @@ describe "integration" do
       it "should not be the same as the first generated value" do
         @another_username.should_not == @username
       end
-
     end
-
   end
 
   describe "a factory with a default strategy specified" do
@@ -276,7 +259,7 @@ describe "integration" do
   it "should raise Factory::SequenceAbuseError" do
     lambda {
       Factory(:sequence_abuser)
-    }.should raise_error(Factory::SequenceAbuseError)
+    }.should raise_error(FactoryGirl::SequenceAbuseError)
   end
 
   describe "an instance with callbacks" do

data/spec/acceptance/syntax/blueprint_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'acceptance/acceptance_helper'
 
 require 'factory_girl/syntax/blueprint'
 
@@ -12,11 +13,6 @@ describe "a blueprint" do
     end
   end
 
-  after do
-    Factory.factories.clear
-    Factory.sequences.clear
-  end
-
   describe "after making an instance" do
     before do
       @instance = Factory(:user, :last_name => 'Rye')

data/spec/acceptance/syntax/generate_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'acceptance/acceptance_helper'
 
 require 'factory_girl/syntax/generate'
 
@@ -11,10 +12,6 @@ describe "a factory using generate syntax" do
     end
   end
 
-  after do
-    Factory.factories.clear
-  end
-
   it "should not raise an error when generating an invalid instance" do
     lambda { User.generate(:first_name => nil) }.should_not raise_error
   end

data/spec/acceptance/syntax/make_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'acceptance/acceptance_helper'
 
 require 'factory_girl/syntax/make'
 
@@ -11,10 +12,6 @@ describe "a factory using make syntax" do
     end
   end
 
-  after do
-    Factory.factories.clear
-  end
-
   describe "after making an instance" do
     before do
       @instance = User.make(:last_name => 'Rye')