factory_girl 1.1.1 → 1.1.2

data/Changelog

@@ -0,0 +1,16 @@
+1.1.2 (July 30, 2008)
+  Improved error handling for invalid and undefined factories/attributes
+	Improved handling of strings vs symbols vs classes
+	Added a prettier syntax for handling associations
+  Updated documentation and fixed compatibility with Rails 2.1
+
+1.1.1 (June 23, 2008)
+  The attribute "name" no longer requires using #add_attribute
+
+1.1.0 (June 3, 2008)
+	Added support for dependent attributes
+	Fixed the attributes_for build strategy to not build associations
+  Added support for sequences
+
+1.0.0 (May 31, 208)
+  First version

data/README.textile

@@ -12,6 +12,13 @@ Github: "Page":http://github.com/thoughtbot/factory_girl/tree/master "Clone":git
 
 Gem: <pre>gem install thoughtbot-factory_girl --source http://gems.github.com</pre>
 
+Note: if you install factory_girl using the gem from Github, you'll need this
+in your environment.rb if you want to use Rails 2.1's dependency manager:
+
+config.gem "thoughtbot-factory_girl",
+           :lib    => "factory_girl",
+           :source => "http://gems.github.com"
+
 h2. Defining factories
 
 <pre><code># This will guess the User class
@@ -88,6 +95,21 @@ Factory.build(:post)
 post.new_record?       # => true
 post.author.new_record # => true</code></pre>
 
+Because this pattern is so common, a prettier syntax is available for defining
+associations:
+
+<pre><code># The following definitions are equivilent:
+Factory.define :post do |p|
+  p.author {|a| a.association(:user) }
+end
+
+Factory.define :post do |p|
+  p.association :author, :factory => :user
+end</code></pre>
+
+If the factory name is the same as the association name, the factory name can
+be left out.
+
 
 h2. Sequences
 

data/Rakefile

@@ -31,7 +31,7 @@ end
 
 spec = Gem::Specification.new do |s|
   s.name        = %q{factory_girl}
-  s.version     = "1.1.1"
+  s.version     = "1.1.2"
   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

data/lib/factory_girl.rb

@@ -1,4 +1,4 @@
-require 'activesupport'
+require 'active_support'
 require 'factory_girl/factory'
 require 'factory_girl/attribute_proxy'
 require 'factory_girl/sequence'

data/lib/factory_girl/factory.rb

@@ -1,5 +1,8 @@
 class Factory
-
+  
+  class AttributeDefinitionError < RuntimeError
+  end
+  
   cattr_accessor :factories, :sequences #:nodoc:
   self.factories = {}
   self.sequences = {}
@@ -22,7 +25,7 @@ class Factory
   def self.define (name, options = {})
     instance = Factory.new(name, options)
     yield(instance)
-    self.factories[name] = instance
+    self.factories[instance.factory_name] = instance
   end
 
   # Defines a new sequence that can be used to generate unique values in a specific format.
@@ -61,12 +64,12 @@ class Factory
   end
 
   def build_class #:nodoc:
-    @build_class ||= @options[:class] || factory_name.to_s.classify.constantize
+    @build_class ||= class_for(@options[:class] || factory_name)
   end
 
   def initialize (name, options = {}) #:nodoc:
     options.assert_valid_keys(:class)
-    @factory_name = name
+    @factory_name = factory_name_for(name)
     @options      = options
 
     @static_attributes     = {}
@@ -93,6 +96,14 @@ class Factory
   #   value: (Object)
   #     If no block is given, this value will be used for this attribute.
   def add_attribute (name, value = nil, &block)
+    name = name.to_sym
+
+    if name.to_s =~ /=$/
+      raise AttributeDefinitionError, 
+        "factory_girl uses 'f.#{name.to_s.chop} #{value}' syntax " +
+        "rather than 'f.#{name} #{value}'" 
+    end
+    
     if block_given?
       unless value.nil?
         raise ArgumentError, "Both value and block given"
@@ -122,6 +133,35 @@ class Factory
     add_attribute(name, *args, &block)
   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.define :user do |f|
+  #     f.name 'Joey'
+  #   end
+  #
+  #   Factory.define :post do |f|
+  #     f.association :author, :factory => :user
+  #   end
+  #
+  # Arguments:
+  #   name: (Symbol)
+  #     The name of this attribute.
+  #   options: (Hash)
+  #     factory: (Symbol)
+  #       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 = {})
+    name    = name.to_sym
+    options = options.symbolize_keys
+    association_factory = options[:factory] || name
+
+    add_attribute(name) {|a| a.association(association_factory) }
+  end
+
   def attributes_for (attrs = {}) #:nodoc:
     build_attributes_hash(attrs, :attributes_for)
   end
@@ -188,7 +228,7 @@ class Factory
     private
 
     def factory_by_name (name)
-      factories[name] or raise ArgumentError.new("No such factory: #{name.inspect}")
+      factories[name.to_sym] or raise ArgumentError.new("No such factory: #{name.to_s}")
     end
 
   end
@@ -196,6 +236,7 @@ class Factory
   private
 
   def build_attributes_hash (override, strategy)
+    override = override.symbolize_keys
     result = @static_attributes.merge(override)
     @lazy_attribute_names.each do |name|
       proxy = AttributeProxy.new(self, name, strategy, result)
@@ -213,4 +254,20 @@ class Factory
     instance
   end
 
+  def class_for (class_or_to_s)
+    if class_or_to_s.respond_to?(:to_sym)
+      class_or_to_s.to_s.classify.constantize
+    else
+      class_or_to_s
+    end
+  end
+
+  def factory_name_for (class_or_to_s)
+    if class_or_to_s.respond_to?(:to_sym)
+      class_or_to_s.to_sym
+    else
+      class_or_to_s.to_s.underscore.to_sym
+    end
+  end
+
 end

data/test/factory_test.rb

@@ -26,12 +26,13 @@ class FactoryTest < Test::Unit::TestCase
     setup do
       @name    = :user
       @factory = mock('factory')
+      @factory.stubs(:factory_name).returns(@name)
       @options = { :class => 'magic' }
       Factory.stubs(:new).returns(@factory)
     end
 
     should "create a new factory using the specified name and options" do
-      Factory.expects(:new).with(@name, @options)
+      Factory.expects(:new).with(@name, @options).returns(@factory)
       Factory.define(@name, @options) {|f| }
     end
 
@@ -51,6 +52,14 @@ class FactoryTest < Test::Unit::TestCase
     end
 
   end
+  
+  should "raise an error when defining a factory when using attribute setters" do
+    assert_raise Factory::AttributeDefinitionError do
+      Factory.define(:user) do |f|
+        f.name = 'test'
+      end
+    end
+  end
 
   context "defining a sequence" do
 
@@ -167,6 +176,46 @@ class FactoryTest < Test::Unit::TestCase
 
     end
 
+    context "when adding an association without a factory name" do
+
+      setup do
+        @factory = Factory.new(:post)
+        @name    = :user
+        @factory.association(@name)
+        Post.any_instance.stubs(:user=)
+      end
+
+      should "add an attribute with the name of the association" do
+        assert @factory.attributes_for.key?(@name)
+      end
+
+      should "create a block that builds the association" do
+        Factory.expects(:build).with(@name, {})
+        @factory.build
+      end
+
+    end
+
+    context "when adding an association with a factory name" do
+
+      setup do
+        @factory      = Factory.new(:post)
+        @name         = :author
+        @factory_name = :user
+        @factory.association(@name, :factory => @factory_name)
+      end
+
+      should "add an attribute with the name of the association" do
+        assert @factory.attributes_for.key?(@name)
+      end
+
+      should "create a block that builds the association" do
+        Factory.expects(:build).with(@factory_name, {})
+        @factory.build
+      end
+
+    end
+
     should "add an attribute using the method name when passed an undefined method" do
       @attr  = :first_name
       @value = 'Sugar'
@@ -180,6 +229,11 @@ class FactoryTest < Test::Unit::TestCase
       end
     end
 
+    should "allow attributes to be added with strings as names" do
+      @factory.add_attribute('name', 'value')
+      assert_equal 'value', @factory.attributes_for[:name]
+    end
+
     context "when overriding generated attributes with a hash" do
 
       setup do
@@ -198,6 +252,12 @@ class FactoryTest < Test::Unit::TestCase
         @factory.attributes_for(@hash)
       end
 
+      should "override a symbol parameter with a string parameter" do
+        @factory.add_attribute(@attr, 'The price is wrong, Bob!')
+        @hash = { @attr.to_s => @value }
+        assert_equal @value, @factory.attributes_for(@hash)[@attr]
+      end
+
     end
 
     should "guess the build class from the factory name" do
@@ -217,6 +277,36 @@ class FactoryTest < Test::Unit::TestCase
 
     end
 
+    context "when defined with a class instead of a name" do
+
+      setup do
+        @class   = ArgumentError
+        @name    = :argument_error
+        @factory = Factory.new(@class)
+      end
+
+      should "guess the name from the class" do
+        assert_equal @name, @factory.factory_name
+      end
+
+      should "use the class as the build class" do
+        assert_equal @class, @factory.build_class
+      end
+
+    end
+    context "when defined with a custom class name" do
+
+      setup do
+        @class   = ArgumentError
+        @factory = Factory.new(:author, :class => :argument_error)
+      end
+
+      should "use the specified class as the build class" do
+        assert_equal @class, @factory.build_class
+      end
+
+    end
+
     context "with some attributes added" do
 
       setup do
@@ -267,6 +357,33 @@ class FactoryTest < Test::Unit::TestCase
 
   end
 
+  context "a factory with a string for a name" do
+
+    setup do
+      @name    = :user
+      @factory = Factory.new(@name.to_s) {}
+    end
+
+    should "convert the string to a symbol" do
+      assert_equal @name, @factory.factory_name
+    end
+
+  end
+
+  context "a factory defined with a string name" do
+
+    setup do
+      Factory.factories = {}
+      @name    = :user
+      @factory = Factory.define(@name.to_s) {}
+    end
+
+    should "store the factory using a symbol" do
+      assert_equal @factory, Factory.factories[@name]
+    end
+
+  end
+
   context "Factory class" do
 
     setup do
@@ -296,6 +413,11 @@ class FactoryTest < Test::Unit::TestCase
         assert_raise(ArgumentError) { Factory.send(method, :bogus) }
       end
 
+      should "recognize either 'name' or :name for Factory.#{method}" do
+        assert_nothing_raised { Factory.send(method, @name.to_s) }
+        assert_nothing_raised { Factory.send(method, @name.to_sym) }
+      end
+
     end
 
     should "call the create method from the top-level Factory() method" do

data/test/integration_test.rb

@@ -3,16 +3,16 @@ require(File.join(File.dirname(__FILE__), 'test_helper'))
 class IntegrationTest < Test::Unit::TestCase
 
   def setup
-    Factory.define :user do |f|
+    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
 
-    Factory.define :post do |f|
+    Factory.define Post do |f|
       f.name   'Test Post'
-      f.author {|a| a.association(:user) }
+      f.association :author, :factory => :user
     end
 
     Factory.define :admin, :class => User do |f|
@@ -79,7 +79,7 @@ class IntegrationTest < Test::Unit::TestCase
   context "a created instance" do
 
     setup do
-      @instance = Factory.create(:post)
+      @instance = Factory.create('post')
     end
 
     should "be saved" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: factory_girl
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - Joe Ferris
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-06-23 00:00:00 -04:00
+date: 2008-07-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files: 
 - README.textile
 files: 
+- Changelog
 - LICENSE
 - Rakefile
 - README.textile