factory_girl 1.2.2 → 1.2.3

data/Rakefile

@@ -6,9 +6,10 @@ require 'rcov/rcovtask'
 require 'date'
 
 require 'spec/rake/spectask'
+require 'cucumber/rake/task'
 
-desc 'Default: run the specs.'
-task :default => :spec
+desc 'Default: run the specs and features.'
+task :default => [:spec, :features]
 
 Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ['--options', "spec/spec.opts"]
@@ -37,7 +38,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name        = %q{factory_girl}
-  s.version     = "1.2.2"
+  s.version     = "1.2.3"
   s.summary     = %q{factory_girl provides a framework and DSL for defining and
                      using model instance factories.}
   s.description = %q{factory_girl provides a framework and DSL for defining and
@@ -73,3 +74,8 @@ task :gemspec do
     f.write spec.to_ruby
   end
 end
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.fork = true
+  t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'progress')]
+end

data/lib/factory_girl.rb

@@ -9,6 +9,7 @@ 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/sequence'
 require 'factory_girl/aliases'
 

data/lib/factory_girl/attribute/association.rb

@@ -3,6 +3,8 @@ class Factory
 
     class Association < Attribute  #:nodoc:
 
+      attr_reader :factory
+
       def initialize(name, factory, overrides)
         super(name)
         @factory   = factory

data/lib/factory_girl/attribute/callback.rb

@@ -0,0 +1,16 @@
+class Factory
+  class Attribute #:nodoc:
+
+    class Callback < Attribute  #:nodoc:
+      def initialize(name, block)
+        @name  = name.to_sym
+        @block = block
+      end
+
+      def add_to(proxy)
+        proxy.add_callback(name, @block)
+      end
+    end
+
+  end
+end

data/lib/factory_girl/factory.rb

@@ -4,6 +4,10 @@ class Factory
   class AssociationDefinitionError < RuntimeError
   end
   
+  # Raised when a callback is defined that has an invalid name
+  class InvalidCallbackNameError < RuntimeError
+  end
+  
   class << self
     attr_accessor :factories #:nodoc:
 
@@ -184,6 +188,25 @@ class Factory
     add_attribute(name) { s.next }
   end
   
+  def after_build(&block)
+    callback(:after_build, &block)
+  end
+  
+  def after_create(&block)
+    callback(:after_create, &block)
+  end
+  
+  def after_stub(&block)
+    callback(:after_stub, &block)
+  end
+  
+  def callback(name, &block)
+    unless [:after_build, :after_create, :after_stub].include?(name.to_sym)
+      raise InvalidCallbackNameError, "#{name} is not a valid callback name. Valid callback names are :after_build, :after_create, and :after_stub"
+    end
+    @attributes << Attribute::Callback.new(name.to_sym, block)
+  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.
@@ -293,12 +316,24 @@ class Factory
     proxy.result
   end
 
-  private
-
   def self.factory_by_name (name)
     factories[name.to_sym] or raise ArgumentError.new("No such factory: #{name.to_s}")
   end
-  
+
+  def human_name(*args, &block)
+    if args.size == 0 && block.nil?
+      factory_name.to_s.gsub('_', ' ')
+    else
+      add_attribute(:human_name, *args, &block)
+    end
+  end
+
+  def associations
+    attributes.select {|attribute| attribute.is_a?(Attribute::Association) }
+  end
+
+  private
+
   def class_for (class_or_to_s)
     if class_or_to_s.respond_to?(:to_sym)
       Object.const_get(variable_name_to_class_name(class_or_to_s))
@@ -316,7 +351,7 @@ class Factory
   end
 
   def attribute_defined? (name)
-    !@attributes.detect {|attr| attr.name == name }.nil?
+    !@attributes.detect {|attr| attr.name == name && !attr.is_a?(Factory::Attribute::Callback) }.nil?
   end
 
   def assert_valid_options(options)

data/lib/factory_girl/proxy.rb

@@ -1,6 +1,9 @@
 class Factory
 
   class Proxy #:nodoc:
+
+    attr_reader :callbacks
+
     def initialize(klass)
     end
 
@@ -14,6 +17,20 @@ class Factory
     def associate(name, factory, attributes)
     end
 
+    def add_callback(name, block)
+      @callbacks ||= {}
+      @callbacks[name] ||= []
+      @callbacks[name] << block
+    end
+
+    def run_callbacks(name)
+      if @callbacks && @callbacks[name]
+        @callbacks[name].each do |block|
+          block.arity.zero? ? block.call : block.call(@instance)
+        end
+      end
+    end
+
     # Generates an association using the current build strategy.
     #
     # Arguments:

data/lib/factory_girl/proxy/build.rb

@@ -22,6 +22,7 @@ class Factory
       end
 
       def result
+        run_callbacks(:after_build)
         @instance
       end
     end

data/lib/factory_girl/proxy/create.rb

@@ -2,7 +2,9 @@ class Factory
   class Proxy #:nodoc:
     class Create < Build #:nodoc:
       def result
+        run_callbacks(:after_build)
         @instance.save!
+        run_callbacks(:after_create)
         @instance
       end
     end

data/lib/factory_girl/proxy/stub.rb

@@ -4,9 +4,9 @@ class Factory
       @@next_id = 1000
 
       def initialize(klass)
-        @stub = klass.new
-        @stub.id = next_id
-        @stub.instance_eval do
+        @instance = klass.new
+        @instance.id = next_id
+        @instance.instance_eval do
           def new_record?
             id.nil?
           end
@@ -26,11 +26,11 @@ class Factory
       end
 
       def get(attribute)
-        @stub.send(attribute)
+        @instance.send(attribute)
       end
 
       def set(attribute, value)
-        @stub.send(:"#{attribute}=", value)
+        @instance.send(:"#{attribute}=", value)
       end
 
       def associate(name, factory, attributes)
@@ -42,7 +42,8 @@ class Factory
       end
 
       def result
-        @stub
+        run_callbacks(:after_stub)
+        @instance
       end
     end
   end

data/lib/factory_girl/step_definitions.rb

@@ -0,0 +1,54 @@
+module FactoryGirlStepHelpers
+  def convert_association_string_to_instance(factory_name, assignment)
+    attribute, value = assignment.split(':', 2)
+    attributes = convert_human_hash_to_attribute_hash(attribute => value.strip)
+    factory = Factory.factory_by_name(factory_name)
+    model_class = factory.build_class
+    model_class.find(:first, :conditions => attributes) or
+      Factory(factory_name, attributes)
+  end
+
+  def convert_human_hash_to_attribute_hash(human_hash, associations = [])
+    human_hash.inject({}) do |attribute_hash, (human_key, value)|
+      key = human_key.downcase.gsub(' ', '_').to_sym
+      if association = associations.detect {|association| association.name == key }
+        value = convert_association_string_to_instance(association.factory, value)
+      end
+      attribute_hash.merge(key => value)
+    end
+  end
+end
+
+World(FactoryGirlStepHelpers)
+
+Factory.factories.values.each do |factory|
+  # TODO: support irregular pluralizations
+  Given /^the following #{factory.human_name}s? exists?:$/ do |table|
+    table.hashes.each do |human_hash|
+      attributes = convert_human_hash_to_attribute_hash(human_hash, factory.associations)
+      Factory.create(factory.factory_name, attributes)
+    end
+  end
+
+  Given /^an? #{factory.human_name} exists$/ do
+    Factory(factory.factory_name)
+  end
+
+  Given /^(\d+) #{factory.human_name}s exist$/ do |count|
+    count.to_i.times { Factory(factory.human_name) }
+  end
+
+  if factory.build_class.respond_to?(:columns)
+    factory.build_class.columns.each do |column|
+      human_column_name = column.name.downcase.gsub('_', ' ')
+      Given /^an? #{factory.human_name} exists with an? #{human_column_name} of "([^"]*)"$/i do |value|
+        Factory(factory.factory_name, column.name => value)
+      end
+
+      Given /^(\d+) #{factory.human_name}s exist with an? #{human_column_name} of "([^"]*)"$/i do |count, value|
+        count.to_i.times { Factory(factory.factory_name, column.name => value) }
+      end
+    end
+  end
+end
+

data/spec/factory_girl/attribute/association_spec.rb

@@ -12,6 +12,10 @@ describe Factory::Attribute::Association do
     @attr.name.should == @name
   end
 
+  it "should have a factory" do
+    @attr.factory.should == @factory
+  end
+
   it "should tell the proxy to associate when being added to a proxy" do
     proxy = "proxy"
     stub(proxy).associate

data/spec/factory_girl/attribute/callback_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Factory::Attribute::Callback do
+  before do
+    @name  = :after_create
+    @block = proc{ 'block' }
+    @attr  = Factory::Attribute::Callback.new(@name, @block)
+  end
+
+  it "should have a name" do
+    @attr.name.should == @name
+  end
+
+  it "should set its callback on a proxy" do
+    @proxy = "proxy"
+    mock(@proxy).add_callback(@name, @block)
+    @attr.add_to(@proxy)
+  end
+
+  it "should convert names to symbols" do
+    Factory::Attribute::Callback.new('name', nil).name.should == :name
+  end
+end

data/spec/factory_girl/factory_spec.rb

@@ -27,6 +27,10 @@ describe Factory do
       Factory.define(@name) {|f| }
       @factory.should == Factory.factories[@name]
     end
+
+    it "should allow that factory to be found by name" do
+      Factory.factory_by_name(@name).should == @factory
+    end
   end
 
   describe "a factory" do
@@ -90,6 +94,38 @@ describe Factory do
       end
     end
 
+    describe "adding a callback" do
+      it "should add a callback attribute when the after_build attribute is defined" do
+        mock(Factory::Attribute::Callback).new(:after_build, is_a(Proc)) { 'after_build callback' }
+        @factory.after_build {}
+        @factory.attributes.should include('after_build callback')
+      end
+
+      it "should add a callback attribute when the after_create attribute is defined" do
+        mock(Factory::Attribute::Callback).new(:after_create, is_a(Proc)) { 'after_create callback' }
+        @factory.after_create {}
+        @factory.attributes.should include('after_create callback')
+      end
+
+      it "should add a callback attribute when the after_stub attribute is defined" do
+        mock(Factory::Attribute::Callback).new(:after_stub, is_a(Proc)) { 'after_stub callback' }
+        @factory.after_stub {}
+        @factory.attributes.should include('after_stub callback')
+      end
+
+      it "should add a callback attribute when defining a callback" do
+        mock(Factory::Attribute::Callback).new(:after_create, is_a(Proc)) { 'after_create callback' }
+        @factory.callback(:after_create) {}
+        @factory.attributes.should include('after_create callback')
+      end
+
+      it "should raise an InvalidCallbackNameError when defining a callback with an invalid name" do
+        lambda{
+          @factory.callback(:invalid_callback_name) {}
+        }.should raise_error(Factory::InvalidCallbackNameError)
+      end
+    end
+
     describe "after adding an attribute" do
       before do
         @attribute = "attribute"
@@ -130,6 +166,16 @@ describe Factory do
       factory.attributes.should include(attr)
     end
 
+    it "should return associations" do
+      factory = Factory.new(:post)
+      factory.association(:author)
+      factory.association(:editor)
+      factory.associations.each do |association|
+        association.should be_a(Factory::Attribute::Association)
+      end
+      factory.associations.size.should == 2
+    end
+
     it "should add an association with overrides" do
       factory   = Factory.new(:post)
       name      = :user
@@ -172,6 +218,21 @@ describe Factory do
       @factory.attributes.should include(attribute)
     end
 
+    it "should allow human_name as a static attribute name" do
+      attribute = 'attribute'
+      stub(attribute).name { :name }
+      mock(Factory::Attribute::Static).new(:human_name, 'value') { attribute}
+      @factory.human_name 'value'
+    end
+
+    it "should allow human_name as a dynamic attribute name" do
+      attribute = 'attribute'
+      stub(attribute).name { :name }
+      block     = lambda {}
+      mock(Factory::Attribute::Dynamic).new(:human_name, block) { attribute }
+      @factory.human_name(&block)
+    end
+
     describe "when overriding generated attributes with a hash" do
       before do
         @attr  = :name
@@ -397,6 +458,20 @@ describe Factory do
       child.attributes.size.should == 1
       child.attributes.first.should be_kind_of(Factory::Attribute::Dynamic)
     end
+
+    it "inherit all callbacks" do
+      Factory.define(:child, :parent => :object) do |f|
+        f.after_stub {|o| o.name = 'Stubby' }
+      end
+
+      grandchild = Factory.define(:grandchild, :parent => :child) do |f|
+        f.after_stub {|o| o.name = "#{o.name} McStubby" }
+      end
+
+      grandchild.attributes.size.should == 3
+      grandchild.attributes.first.should be_kind_of(Factory::Attribute::Callback)
+      grandchild.attributes[1].should be_kind_of(Factory::Attribute::Callback)
+    end
   end
 
   describe 'defining a factory with a default strategy parameter' do
@@ -487,4 +562,10 @@ describe Factory do
       it { should require_definitions_from("#{dir}/factories/person_factory.rb") }
     end
   end
+
+  it "should return the factory name without underscores for the human name" do
+    factory = Factory.new(:name_with_underscores)
+    factory.human_name.should == 'name with underscores'
+  end
+
 end

data/spec/factory_girl/proxy/build_spec.rb

@@ -45,6 +45,14 @@ describe Factory::Proxy::Build do
     @proxy.result.should == @instance
   end
 
+  it "should run the :after_build callback when retrieving the result" do
+    spy = Object.new
+    stub(spy).foo
+    @proxy.add_callback(:after_build, proc{ spy.foo })
+    @proxy.result
+    spy.should have_received.foo
+  end
+
   describe "when setting an attribute" do
     before do
       stub(@instance).attribute = 'value'

data/spec/factory_girl/proxy/create_spec.rb

@@ -44,6 +44,12 @@ describe Factory::Proxy::Create do
 
   describe "when asked for the result" do
     before do
+      @build_spy = Object.new
+      @create_spy = Object.new
+      stub(@build_spy).foo
+      stub(@create_spy).foo
+      @proxy.add_callback(:after_build,  proc{ @build_spy.foo })
+      @proxy.add_callback(:after_create, proc{ @create_spy.foo })
       @result = @proxy.result
     end
 
@@ -54,6 +60,11 @@ describe Factory::Proxy::Create do
     it "should return the built instance" do
       @result.should == @instance
     end
+
+    it "should run both the build and the create callbacks" do
+      @build_spy.should have_received.foo
+      @create_spy.should have_received.foo
+    end
   end
 
   describe "when setting an attribute" do

data/spec/factory_girl/proxy/stub_spec.rb

@@ -45,8 +45,18 @@ describe Factory::Proxy::Stub do
       @stub.association(:user).should == @user
     end
 
-    it "should return the actual instance when asked for the result" do
-      @stub.result.should == @instance
+    describe "when asked for the result" do
+      it "should return the actual instance" do
+        @stub.result.should == @instance
+      end
+
+      it "should run the :after_stub callback" do
+        @spy = Object.new
+        stub(@spy).foo
+        @stub.add_callback(:after_stub, proc{ @spy.foo })
+        @stub.result
+        @spy.should have_received.foo
+      end
     end
   end
 

data/spec/factory_girl/proxy_spec.rb

@@ -25,4 +25,60 @@ describe Factory::Proxy do
   it "should raise an error when asked for the result" do
     lambda { @proxy.result }.should raise_error(NotImplementedError)
   end
+
+  describe "when adding callbacks" do
+    before do
+      @first_block  = proc{ 'block 1' }
+      @second_block = proc{ 'block 2' }
+    end
+    it "should add a callback" do
+      @proxy.add_callback(:after_create, @first_block)
+      @proxy.callbacks[:after_create].should be_eql([@first_block])
+    end
+
+    it "should add multiple callbacks of the same name" do
+      @proxy.add_callback(:after_create, @first_block)
+      @proxy.add_callback(:after_create, @second_block)
+      @proxy.callbacks[:after_create].should be_eql([@first_block, @second_block])
+    end
+
+    it "should add multiple callbacks of different names" do
+      @proxy.add_callback(:after_create, @first_block)
+      @proxy.add_callback(:after_build,  @second_block)
+      @proxy.callbacks[:after_create].should be_eql([@first_block])
+      @proxy.callbacks[:after_build].should be_eql([@second_block])
+    end
+  end
+
+  describe "when running callbacks" do
+    before do
+      @first_spy = Object.new
+      @second_spy = Object.new
+      stub(@first_spy).foo
+      stub(@second_spy).foo
+    end
+
+    it "should run all callbacks with a given name" do
+      @proxy.add_callback(:after_create, proc{ @first_spy.foo })
+      @proxy.add_callback(:after_create, proc{ @second_spy.foo })
+      @proxy.run_callbacks(:after_create)
+      @first_spy.should have_received.foo
+      @second_spy.should have_received.foo
+    end
+
+    it "should only run callbacks with a given name" do
+      @proxy.add_callback(:after_create, proc{ @first_spy.foo })
+      @proxy.add_callback(:after_build,  proc{ @second_spy.foo })
+      @proxy.run_callbacks(:after_create)
+      @first_spy.should have_received.foo
+      @second_spy.should_not have_received.foo
+    end
+
+    it "should pass in the instance if the block takes an argument" do
+      @proxy.instance_variable_set("@instance", @first_spy)
+      @proxy.add_callback(:after_create, proc{|spy| spy.foo })
+      @proxy.run_callbacks(:after_create)
+      @first_spy.should have_received.foo
+    end
+  end
 end

data/spec/integration_spec.rb

@@ -31,6 +31,21 @@ describe "integration" do
       f.username  'GuestUser'
     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.define :user_with_inherited_callbacks, :parent => :user_with_callbacks do |f|
+      f.callback(:after_stub) {|u| u.last_name = 'Double-Stubby' }
+    end
+
+    Factory.define :business do |f|
+      f.name 'Supplier of Awesome'
+      f.association :owner, :factory => :user
+    end
+
     Factory.sequence :email do |n|
       "somebody#{n}@example.com"
     end
@@ -262,4 +277,28 @@ describe "integration" do
       Factory(:sequence_abuser)
     }.should raise_error(Factory::SequenceAbuseError)
   end
+
+  describe "an instance with callbacks" do
+    it "should run the after_stub callback when stubbing" do
+      @user = Factory.stub(:user_with_callbacks)
+      @user.first_name.should == 'Stubby'
+    end
+
+    it "should run the after_build callback when building" do
+      @user = Factory.build(:user_with_callbacks)
+      @user.first_name.should == 'Buildy'
+    end
+
+    it "should run both the after_build and after_create callbacks when creating" do
+      @user = Factory(:user_with_callbacks)
+      @user.first_name.should == 'Buildy'
+      @user.last_name.should == 'Createy'
+    end
+
+    it "should run both the after_stub callback on the factory and the inherited after_stub callback" do
+      @user = Factory.stub(:user_with_inherited_callbacks)
+      @user.first_name.should == 'Stubby'
+      @user.last_name.should == 'Double-Stubby'
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: factory_girl
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors: 
 - Joe Ferris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-15 00:00:00 -04:00
+date: 2009-10-16 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - README.rdoc
 - lib/factory_girl/aliases.rb
 - lib/factory_girl/attribute/association.rb
+- lib/factory_girl/attribute/callback.rb
 - lib/factory_girl/attribute/dynamic.rb
 - lib/factory_girl/attribute/static.rb
 - lib/factory_girl/attribute.rb
@@ -42,6 +43,7 @@ files:
 - lib/factory_girl/proxy/stub.rb
 - lib/factory_girl/proxy.rb
 - lib/factory_girl/sequence.rb
+- lib/factory_girl/step_definitions.rb
 - lib/factory_girl/syntax/blueprint.rb
 - lib/factory_girl/syntax/generate.rb
 - lib/factory_girl/syntax/make.rb
@@ -50,6 +52,7 @@ files:
 - lib/factory_girl.rb
 - spec/factory_girl/aliases_spec.rb
 - spec/factory_girl/attribute/association_spec.rb
+- spec/factory_girl/attribute/callback_spec.rb
 - spec/factory_girl/attribute/dynamic_spec.rb
 - spec/factory_girl/attribute/static_spec.rb
 - spec/factory_girl/attribute_spec.rb
@@ -100,6 +103,7 @@ summary: factory_girl provides a framework and DSL for defining and using model
 test_files: 
 - spec/factory_girl/aliases_spec.rb
 - spec/factory_girl/attribute/association_spec.rb
+- spec/factory_girl/attribute/callback_spec.rb
 - spec/factory_girl/attribute/dynamic_spec.rb
 - spec/factory_girl/attribute/static_spec.rb
 - spec/factory_girl/attribute_spec.rb