freegenie-factory_girl 1.2.2

data/lib/factory_girl/syntax/generate.rb

@@ -0,0 +1,68 @@
+class Factory
+  module Syntax
+
+    # Extends ActiveRecord::Base to provide generation methods for factories.
+    #
+    # Usage:
+    #
+    #   require 'factory_girl/syntax/generate'
+    #
+    #   Factory.define :user do |factory|
+    #     factory.name 'Billy Bob'
+    #     factory.email 'billy@bob.example.com'
+    #   end
+    #
+    #   # Creates a saved instance without raising (same as saving the result
+    #   # of Factory.build)
+    #   User.generate(:name => 'Johnny')
+    #
+    #   # Creates a saved instance and raises when invalid (same as
+    #   # Factory.create)
+    #   User.generate!
+    #
+    #   # Creates an unsaved instance (same as Factory.build)
+    #   User.spawn
+    #
+    #   # Creates an instance and yields it to the passed block
+    #   User.generate do |user|
+    #     # ...do something with user...
+    #   end
+    #
+    # This syntax was derived from Rick Bradley and Yossef Mendelssohn's
+    # object_daddy.
+    module Generate
+      module ActiveRecord #:nodoc:
+
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods #:nodoc:
+
+          def generate(overrides = {}, &block)
+            instance = Factory.build(name.underscore, overrides)
+            instance.save
+            yield(instance) if block_given?
+            instance
+          end
+
+          def generate!(overrides = {}, &block)
+            instance = Factory.create(name.underscore, overrides)
+            yield(instance) if block_given?
+            instance
+          end
+
+          def spawn(overrides = {}, &block)
+            instance = Factory.build(name.underscore, overrides)
+            yield(instance) if block_given?
+            instance
+          end
+
+        end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Factory::Syntax::Generate::ActiveRecord)

data/lib/factory_girl/syntax/make.rb

@@ -0,0 +1,39 @@
+class Factory
+  module Syntax
+
+    # Extends ActiveRecord::Base to provide a make class method, which is a
+    # shortcut for Factory.create.
+    #
+    # Usage:
+    #
+    #   require 'factory_girl/syntax/make'
+    #   
+    #   Factory.define :user do |factory|
+    #     factory.name 'Billy Bob'
+    #     factory.email 'billy@bob.example.com'
+    #   end
+    #
+    #   User.make(:name => 'Johnny')
+    #
+    # This syntax was derived from Pete Yandell's machinist.
+    module Make
+      module ActiveRecord #:nodoc:
+
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods #:nodoc:
+
+          def make(overrides = {})
+            Factory.create(name.underscore, overrides)
+          end
+
+        end
+
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, Factory::Syntax::Make::ActiveRecord)

data/lib/factory_girl/syntax/sham.rb

@@ -0,0 +1,42 @@
+class Factory
+  module Syntax
+
+    # Adds a Sham module, which provides an alternate interface to
+    # Factory::Sequence.
+    #
+    # Usage:
+    #
+    #   require 'factory_girl/syntax/sham'
+    #
+    #   Sham.email {|n| "somebody#{n}@example.com" }
+    #
+    #   Factory.define :user do |factory|
+    #     factory.email { Sham.email }
+    #   end
+    #
+    # Note that you can also use Faker, but it is recommended that you simply
+    # use a sequence as in the above example, as factory_girl does not provide
+    # protection against duplication in randomized sequences, and a randomized
+    # value does not provide any tangible benefits over an ascending sequence.
+    #
+    # This syntax was derived from Pete Yandell's machinist.
+    module Sham
+      module Sham #:nodoc:
+        def self.method_missing(name, &block)
+          if block_given?
+            Factory.sequence(name, &block)
+          else
+            Factory.next(name)
+          end
+        end
+
+        # overrides name on Module
+        def self.name(&block)
+          method_missing('name', &block)
+        end
+      end
+    end
+  end
+end
+
+include Factory::Syntax::Sham

data/lib/factory_girl/syntax.rb

@@ -0,0 +1,12 @@
+class Factory
+  # Provides alternate syntaxes for factory_girl. If you don't like the default
+  # syntax for defining or using factories, look at one of the Factory::Syntax
+  # modules:
+  #
+  # * Factory::Syntax::Blueprint: definition syntax similar to Machinist
+  # * Factory::Syntax::Generate: usage syntax similar to Object Daddy
+  # * Factory::Syntax::Make: usage syntax similar to Machinist
+  # * Factory::Syntax::Sham: sequence syntax similar to Machinist
+  module Syntax
+  end
+end

data/lib/factory_girl.rb

@@ -0,0 +1,39 @@
+require 'active_support'
+require 'factory_girl/proxy'
+require 'factory_girl/proxy/build'
+require 'factory_girl/proxy/create'
+require 'factory_girl/proxy/attributes_for'
+require 'factory_girl/proxy/stub'
+require 'factory_girl/proxy/find_or_create'
+require 'factory_girl/factory'
+require 'factory_girl/attribute'
+require 'factory_girl/attribute/static'
+require 'factory_girl/attribute/dynamic'
+require 'factory_girl/attribute/association'
+require 'factory_girl/sequence'
+require 'factory_girl/aliases'
+
+
+require 'factory_girl/activerecord'
+
+
+# Shortcut for Factory.default_strategy.
+#
+# Example:
+#   Factory(:user, :name => 'Joe')
+def Factory (name, attrs = {})
+  Factory.default_strategy(name, attrs)
+end
+
+if defined? Rails.configuration
+  Rails.configuration.after_initialize do
+    Factory.definition_file_paths = [
+      File.join(RAILS_ROOT, 'test', 'factories'),
+      File.join(RAILS_ROOT, 'spec', 'factories')
+    ]
+    Factory.find_definitions
+  end
+else
+  Factory.find_definitions
+end
+

data/spec/factory_girl/aliases_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Factory, "aliases" do
+
+  it "should include an attribute as an alias for itself by default" do
+    Factory.aliases_for(:test).should include(:test)
+  end
+
+  it "should include the root of a foreign key as an alias by default" do
+    Factory.aliases_for(:test_id).should include(:test)
+  end
+
+  it "should include an attribute's foreign key as an alias by default" do
+    Factory.aliases_for(:test).should include(:test_id)
+  end
+
+  describe "after adding an alias" do
+
+    before do
+      Factory.alias(/(.*)_suffix/, '\1')
+    end
+
+    it "should return the alias in the aliases list" do
+      Factory.aliases_for(:test_suffix).should include(:test)
+    end
+
+  end
+
+end

data/spec/factory_girl/attribute/association_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Factory::Attribute::Association do
+  before do
+    @name      = :author
+    @factory   = :user
+    @overrides = { :first_name => 'John' }
+    @attr      = Factory::Attribute::Association.new(@name, @factory, @overrides)
+  end
+
+  it "should have a name" 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
+    @attr.add_to(proxy)
+    proxy.should have_received.associate(@name, @factory, @overrides)
+  end
+
+  it "should convert names to symbols" do
+    Factory::Attribute::Association.new('name', :user, {}).name.should == :name
+  end
+end

data/spec/factory_girl/attribute/dynamic_spec.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Factory::Attribute::Dynamic do
+  before do
+    @name  = :first_name
+    @block = lambda { 'value' }
+    @attr  = Factory::Attribute::Dynamic.new(@name, @block)
+  end
+
+  it "should have a name" do
+    @attr.name.should == @name
+  end
+
+  it "should call the block to set a value" do
+    @proxy = "proxy"
+    stub(@proxy).set
+    @attr.add_to(@proxy)
+    @proxy.should have_received.set(@name, 'value')
+  end
+
+  it "should yield the proxy to the block when adding its value to a proxy" do
+    @block = lambda {|a| a }
+    @attr  = Factory::Attribute::Dynamic.new(:user, @block)
+    @proxy = "proxy"
+    stub(@proxy).set
+    @attr.add_to(@proxy)
+    @proxy.should have_received.set(:user, @proxy)
+  end
+
+  it "should raise an error when defining an attribute writer" do
+    lambda {
+      Factory::Attribute::Dynamic.new('test=', nil)
+    }.should raise_error(Factory::AttributeDefinitionError)
+  end
+
+  it "should raise an error when returning a sequence" do
+    stub(Factory).sequence { Factory::Sequence.new }
+    block = lambda { Factory.sequence(:email) }
+    attr = Factory::Attribute::Dynamic.new(:email, block)
+    proxy = stub!.set.subject
+    lambda {
+      attr.add_to(proxy)
+    }.should raise_error(Factory::SequenceAbuseError)
+  end
+
+  it "should convert names to symbols" do
+    Factory::Attribute::Dynamic.new('name', nil).name.should == :name
+  end
+end

data/spec/factory_girl/attribute/static_spec.rb

@@ -0,0 +1,29 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'spec_helper'))
+
+describe Factory::Attribute::Static do
+  before do
+    @name  = :first_name
+    @value = 'John'
+    @attr  = Factory::Attribute::Static.new(@name, @value)
+  end
+
+  it "should have a name" do
+    @attr.name.should == @name
+  end
+
+  it "should set its static value on a proxy" do
+    @proxy = "proxy"
+    mock(@proxy).set(@name, @value)
+    @attr.add_to(@proxy)
+  end
+
+  it "should raise an error when defining an attribute writer" do
+    lambda {
+      Factory::Attribute::Static.new('test=', nil)
+    }.should raise_error(Factory::AttributeDefinitionError)
+  end
+
+  it "should convert names to symbols" do
+    Factory::Attribute::Static.new('name', nil).name.should == :name
+  end
+end

data/spec/factory_girl/attribute_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'spec_helper'))
+
+describe Factory::Attribute do
+  before do
+    @name  = :user
+    @attr  = Factory::Attribute.new(@name)
+  end
+
+  it "should have a name" do
+    @attr.name.should == @name
+  end
+
+  it "should do nothing when being added to a proxy" do
+    @proxy = "proxy"
+    stub(@proxy).set
+    @attr.add_to(@proxy)
+    @proxy.should have_received.set.never
+  end
+
+  it "should raise an error when defining an attribute writer" do
+    error_message = %{factory_girl uses 'f.test value' syntax rather than 'f.test = value'}
+    lambda {
+      Factory::Attribute.new('test=')
+    }.should raise_error(Factory::AttributeDefinitionError, error_message)
+  end
+
+  it "should convert names to symbols" do
+    Factory::Attribute.new('name').name.should == :name
+  end
+end