gabrielg-factory_girl 1.1.6

data/lib/factory_girl/factory.rb

@@ -0,0 +1,281 @@
+class Factory
+  
+  cattr_accessor :factories #:nodoc:
+  self.factories = {}
+
+  # An Array of strings specifying locations that should be searched for
+  # factory definitions. By default, factory_girl will attempt to require
+  # "factories," "test/factories," and "spec/factories." Only the first
+  # existing file will be loaded.
+  cattr_accessor :definition_file_paths
+  self.definition_file_paths = %w(factories test/factories spec/factories)
+
+  attr_reader :factory_name
+
+  # Defines a new factory that can be used by the build strategies (create and
+  # build) to build new objects.
+  #
+  # Arguments:
+  #   name: (Symbol)
+  #     A unique name used to identify this factory.
+  #   options: (Hash)
+  #     class: the class that will be used when generating instances for this
+  #            factory. If not specified, the class will be guessed from the 
+  #            factory name.
+  #
+  # Yields:
+  #    The newly created factory (Factory)
+  def self.define (name, options = {})
+    inherit_from = options.delete(:inherit)
+    instance = (inherit_from.nil?) ? Factory.new(name, options) : self.factories[inherit_from]
+    yield(instance)
+    self.factories[instance.factory_name] = instance
+  end
+
+  def build_class #:nodoc:
+    @build_class ||= class_for(@options[:class] || factory_name)
+  end
+
+  def initialize (name, options = {}) #:nodoc:
+    options.assert_valid_keys(:class)
+    @factory_name = factory_name_for(name)
+    @options      = options
+    @attributes   = []
+    @static_attributes     = {}
+    @lazy_attribute_blocks = {}
+    @lazy_attribute_names  = []
+    @callbacks = {}
+  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 overriden for a specific instance.
+  #
+  # When defining lazy attributes, an instance of Factory::AttributeProxy will
+  # be yielded, allowing associations to be built using the correct build
+  # strategy.
+  #
+  # Arguments:
+  #   name: (Symbol)
+  #     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)
+    attribute = Attribute.new(name, value, block)
+
+    if attribute_defined?(attribute.name)
+      raise AttributeDefinitionError, "Attribute already defined: #{name}"
+    end
+
+    @attributes << attribute
+  end
+
+  # Calls add_attribute using the missing method name as the name of the
+  # attribute, so that:
+  #
+  #   Factory.define :user do |f|
+  #     f.name 'Billy Idol'
+  #   end
+  #
+  # and:
+  #
+  #   Factory.define :user do |f|
+  #     f.add_attribute :name, 'Billy Idol'
+  #   end
+  #
+  # are equivilent. 
+  def method_missing (name, *args, &block)
+    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[:count] ? (options[:factory] || name.to_s.singularize) : (options[:factory] || name)).to_sym
+
+    add_attribute(name) { |a| a.association(association_factory, {}, {:count => options[:count]}) }
+  end
+
+  def attributes_for (attrs = {}) #:nodoc:
+    build_attributes_hash(attrs, :attributes_for)
+  end
+
+  def build (attrs = {}) #:nodoc:
+    build_instance(attrs, :build)
+  end
+
+  def create (attrs = {}) #:nodoc:
+    instance = build_instance(attrs, :create)
+    instance.save!
+    @callbacks[:after_create].call(instance) unless @callbacks[:after_create].nil?
+    instance
+  end
+
+  # Allows a block to be evaluated after the factory object has been built, but before 
+  # it is saved to the database.  The block is passed the instance so you can do stuff 
+  # to it. For example, maybe you want to stub a method whose result normally relies on 
+  # complex computation on attributes and associations:
+  #
+  #   Factory.define :a_boy_that_never_goes_out, :class => Boy do |f|
+  #     f.name 'Morrisey'
+  #     f.after_build do |b|
+  #       b.stubs(:goes_out).returns(false)
+  #     end
+  #   end
+  def after_build(&block)
+    @callbacks[:after_build] = block
+  end
+
+  # Allows a block to be evaluated after the factory object has been saved to the 
+  # database.  The block is passed the instance so you can do stuff to it. For example
+  # maybe you want to stub a method whose result normally relies on complex computation
+  # on attributes and associations:
+  #
+  #   Factory.define :a_boy_that_never_goes_out, :class => Boy do |f|
+  #     f.name 'Morrisey'
+  #     f.after_create do |b|
+  #       b.stubs(:goes_out).returns(false)
+  #     end
+  #   end
+  def after_create(&block)
+    @callbacks[:after_create] = block
+  end
+
+  class << self
+
+    # 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:
+    #   attrs: (Hash)
+    #     Attributes to overwrite for this set.
+    #
+    # Returns:
+    #   A set of attributes that can be used to build an instance of the class
+    #   this factory generates. (Hash)
+    def attributes_for (name, attrs = {})
+      factory_by_name(name).attributes_for(attrs)
+    end
+
+    # Generates and returns an instance from this factory. Attributes can be
+    # individually overridden by passing in a Hash of attribute => value pairs.
+    #
+    # Arguments:
+    #   attrs: (Hash)
+    #     See attributes_for
+    #
+    # Returns:
+    #   An instance of the class this factory generates, with generated
+    #   attributes assigned.
+    def build (name, attrs = {})
+      factory_by_name(name).build(attrs)
+    end
+
+    # Generates, saves, and returns an instance from this factory. Attributes can
+    # be individually overridden by passing in a Hash of attribute => value
+    # pairs.
+    #
+    # If the instance is not valid, an ActiveRecord::Invalid exception will be
+    # raised.
+    #
+    # Arguments:
+    #   attrs: (Hash)
+    #     See attributes_for
+    #
+    # Returns:
+    #   A saved instance of the class this factory generates, with generated
+    #   attributes assigned.
+    def create (name, attrs = {})
+      factory_by_name(name).create(attrs)
+    end
+
+    def find_definitions #:nodoc:
+      definition_file_paths.each do |path|
+        begin
+          require(path)
+          break
+        rescue LoadError
+        end
+      end
+    end
+
+    private
+
+    def factory_by_name (name)
+      factories[name.to_sym] or raise ArgumentError.new("No such factory: #{name.to_s}")
+    end
+
+  end
+
+  private
+
+  def build_attributes_hash (values, strategy)
+    values = values.symbolize_keys
+    passed_keys = values.keys.collect {|key| Factory.aliases_for(key) }.flatten
+    @attributes.each do |attribute|
+      unless passed_keys.include?(attribute.name)
+        proxy = AttributeProxy.new(self, attribute.name, strategy, values)
+        values[attribute.name] = attribute.value(proxy)
+      end
+    end
+    values
+  end
+
+  def build_instance (override, strategy)
+    instance = build_class.new
+    attrs = build_attributes_hash(override, strategy)
+    attrs.each do |attr, value|
+      instance.send(:"#{attr}=", value)
+    end
+    @callbacks[:after_build].call(instance) unless @callbacks[:after_build].nil?
+    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
+
+  def attribute_defined? (name)
+    !@attributes.detect {|attr| attr.name == name }.nil?
+  end
+
+end

data/lib/factory_girl/sequence.rb

@@ -0,0 +1,56 @@
+class Factory
+
+  class Sequence
+
+    def initialize (&proc) #:nodoc:
+      @proc  = proc
+      @value = 0
+    end
+
+    # Returns the next value for this sequence
+    def next
+      @value += 1
+      @proc.call(@value)
+    end
+
+  end
+
+  cattr_accessor :sequences #:nodoc:
+  self.sequences = {}
+
+  # 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, &block)
+    self.sequences[name] = Sequence.new(&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 self.sequences.key?(sequence)
+      raise "No such sequence: #{sequence}"
+    end
+
+    self.sequences[sequence].next
+  end
+
+end

data/lib/factory_girl.rb

@@ -0,0 +1,16 @@
+require 'active_support'
+require 'factory_girl/factory'
+require 'factory_girl/attribute_proxy'
+require 'factory_girl/attribute'
+require 'factory_girl/sequence'
+require 'factory_girl/aliases'
+
+# Shortcut for Factory.create.
+#
+# Example:
+#   Factory(:user, :name => 'Joe')
+def Factory (name, attrs = {})
+  Factory.create(name, attrs)
+end
+
+Factory.find_definitions

data/test/aliases_test.rb

@@ -0,0 +1,29 @@
+require(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class AliasesTest < Test::Unit::TestCase
+
+  should "include an attribute as an alias for itself by default" do
+    assert Factory.aliases_for(:test).include?(:test)
+  end
+
+  should "include the root of a foreign key as an alias by default" do
+    assert Factory.aliases_for(:test_id).include?(:test)
+  end
+
+  should "include an attribute's foreign key as an alias by default" do
+    assert Factory.aliases_for(:test).include?(:test_id)
+  end
+
+  context "after adding an alias" do
+
+    setup do
+      Factory.alias(/(.*)_suffix/, '\1')
+    end
+
+    should "return the alias in the aliases list" do
+      assert Factory.aliases_for(:test_suffix).include?(:test)
+    end
+
+  end
+
+end

data/test/attribute_proxy_test.rb

@@ -0,0 +1,101 @@
+require(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class AttributeProxyTest < Test::Unit::TestCase
+
+  context "an association proxy" do
+
+    setup do
+      @factory  = mock('factory')
+      @attr     = :user
+      @attrs    = { :first_name => 'John' }
+      @strategy = :create
+      @proxy  = Factory::AttributeProxy.new(@factory, @attr, @strategy, @attrs)
+    end
+
+    should "have a factory" do
+      assert_equal @factory, @proxy.factory
+    end
+
+    should "have an attribute name" do
+      assert_equal @attr, @proxy.attribute_name
+    end
+
+    should "have a build strategy" do
+      assert_equal @strategy, @proxy.strategy
+    end
+
+    should "have attributes" do
+      assert_equal @attrs, @proxy.current_values
+    end
+
+    context "building an association" do
+
+      setup do
+        @association = mock('built-user')
+        @name        = :user
+        @attribs     = { :first_name => 'Billy' }
+
+        Factory.stubs(@strategy).returns(@association)
+      end
+
+      should "delegate to the appropriate method on Factory" do
+        Factory.expects(@strategy).with(@name, @attribs).returns(@association)
+        @proxy.association(@name, @attribs)
+      end
+
+      should "return the built association" do
+        assert_equal @association, @proxy.association(@name)
+      end
+
+    end
+
+    context "building an association using the attributes_for strategy" do
+
+      setup do
+        @strategy = :attributes_for
+        @proxy  = Factory::AttributeProxy.new(@factory, @attr, @strategy, @attrs)
+      end
+
+      should "not build the association" do
+        Factory.expects(@strategy).never
+        @proxy.association(:user)
+      end
+
+      should "return nil for the association" do
+        Factory.stubs(@strategy).returns(:user)
+        assert_nil @proxy.association(:user)
+      end
+
+    end
+
+    context "fetching the value of an attribute" do
+
+      setup do
+        @attr = :first_name
+      end
+
+      should "return the correct value" do
+        assert_equal @attrs[@attr], @proxy.value_for(@attr)
+      end
+
+      should "call value_for for undefined methods" do
+        assert_equal @attrs[@attr], @proxy.send(@attr)
+      end
+
+    end
+
+    context "fetching the value of an undefined attribute" do
+
+      setup do
+        @attr = :beachball
+      end
+
+      should "raise an ArgumentError" do
+        assert_raise(ArgumentError) { @proxy.value_for(@attr) }
+      end
+
+    end
+
+  end
+
+end

data/test/attribute_test.rb

@@ -0,0 +1,70 @@
+require(File.join(File.dirname(__FILE__), 'test_helper'))
+
+class AttributeTest < Test::Unit::TestCase
+
+  def setup
+    @proxy = mock('attribute-proxy')
+  end
+
+  context "an attribute" do
+
+    setup do
+      @name  = :user
+      @attr  = Factory::Attribute.new(@name, 'test', nil)
+    end
+
+    should "have a name" do
+      assert_equal @name, @attr.name
+    end
+
+  end
+
+  context "an attribute with a static value" do
+
+    setup do
+      @value = 'test'
+      @attr  = Factory::Attribute.new(:user, @value, nil)
+    end
+
+    should "return the value" do
+      assert_equal @value, @attr.value(@proxy)
+    end
+
+  end
+
+  context "an attribute with a lazy value" do
+
+    setup do
+      @block = lambda { 'value' }
+      @attr  = Factory::Attribute.new(:user, nil, @block)
+    end
+
+    should "call the block to return a value" do
+      assert_equal 'value', @attr.value(@proxy)
+    end
+
+    should "yield the attribute proxy to the block" do
+      @block = lambda {|a| a }
+      @attr  = Factory::Attribute.new(:user, nil, @block)
+      assert_equal @proxy, @attr.value(@proxy)
+    end
+
+  end
+
+  should "raise an error when defining an attribute writer" do
+    assert_raise Factory::AttributeDefinitionError do
+      Factory::Attribute.new('test=', nil, nil)
+    end
+  end
+
+  should "not allow attributes to be added with both a value parameter and a block" do
+    assert_raise(Factory::AttributeDefinitionError) do
+      Factory::Attribute.new(:name, 'value', lambda {})
+    end
+  end
+
+  should "convert names to symbols" do
+    assert_equal :name, Factory::Attribute.new('name', nil, nil).name
+  end
+
+end