factory_girl 2.4.2 → 2.5.0

data/Appraisals

@@ -16,5 +16,5 @@ appraise "3.1" do
 end
 
 appraise "3.2" do
-  gem "activerecord", "~> 3.2.0.rc2"
+  gem "activerecord", "~> 3.2"
 end

data/Changelog

@@ -1,3 +1,8 @@
+2.5.0 (January 20, 2012)
+  Revert 'Deprecate build_stubbed and attributes_for'
+  Implement initialize_with to allow overriding object instantiation
+  Ensure FG runs against Rails 3.2.0
+
 2.4.2 (January 18, 2012)
   Fix inline traits' interaction with defaults on the factory
 

data/GETTING_STARTED.md

@@ -590,6 +590,42 @@ To set the attributes for each of the factories, you can pass in a hash as you n
 twenty_year_olds = FactoryGirl.build_list(:user, 25, :date_of_birth => 20.years.ago)
 ```
 
+Custom Construction
+-------------------
+
+Instantiating objects can be overridden in the case where you'd rather not
+call `new` on your build class or you have some other factory method that
+you'd prefer to use. Using custom construction also allows for your objects to
+be instantiated with any number of arguments.
+
+```ruby
+# user.rb
+class User
+  attr_accessor :name, :email
+
+  def initialize(name)
+    @name = name
+  end
+end
+
+# factories.rb
+sequence(:name) {|n| "person#{n}@example.com" }
+
+factory :user do
+  ignore do
+    name { Faker::Name.name }
+  end
+
+  email
+  initialize_with { User.new(name) }
+end
+
+FactoryGirl.build(:user).name # Bob Hope
+```
+
+Notice that I ignored the `name` attribute. If you don't want attributes
+reassigned after your object has been instantiated, you'll want to `ignore` them.
+
 Cucumber Integration
 --------------------
 
@@ -620,4 +656,4 @@ User.blueprint do
 end
 
 User.make(:name => 'Johnny')
-```
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM

data/gemfiles/2.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM

data/gemfiles/2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM

data/gemfiles/3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM

data/gemfiles/3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM

data/gemfiles/3.2.gemfile

@@ -2,6 +2,6 @@
 
 source "http://rubygems.org"
 
-gem "activerecord", "~> 3.2.0.rc2"
+gem "activerecord", "~> 3.2"
 
 gemspec :path=>"../"

data/gemfiles/3.2.gemfile.lock

@@ -1,21 +1,21 @@
 PATH
   remote: /Users/joshuaclayton/dev/gems/factory_girl
   specs:
-    factory_girl (2.4.2)
+    factory_girl (2.5.0)
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.0.rc2)
-      activesupport (= 3.2.0.rc2)
+    activemodel (3.2.0)
+      activesupport (= 3.2.0)
       builder (~> 3.0.0)
-    activerecord (3.2.0.rc2)
-      activemodel (= 3.2.0.rc2)
-      activesupport (= 3.2.0.rc2)
-      arel (~> 3.0.0.rc1)
+    activerecord (3.2.0)
+      activemodel (= 3.2.0)
+      activesupport (= 3.2.0)
+      arel (~> 3.0.0)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.0.rc2)
+    activesupport (3.2.0)
       i18n (~> 0.6)
       multi_json (~> 1.0)
     appraisal (0.3.8)
@@ -34,7 +34,7 @@ GEM
     bourne (1.0)
       mocha (= 0.9.8)
     builder (3.0.0)
-    childprocess (0.2.9)
+    childprocess (0.3.0)
       ffi (~> 1.0.6)
     cucumber (1.0.6)
       builder (>= 2.1.2)
@@ -47,7 +47,7 @@ GEM
     gherkin (2.4.21)
       json (>= 1.4.6)
     i18n (0.6.0)
-    json (1.6.4)
+    json (1.6.5)
     mocha (0.9.8)
       rake
     multi_json (1.0.4)
@@ -75,7 +75,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 3.2.0.rc2)
+  activerecord (~> 3.2)
   appraisal (~> 0.3.8)
   aruba
   bluecloth

data/lib/factory_girl/attribute_assigner.rb

@@ -1,7 +1,7 @@
 module FactoryGirl
   class AttributeAssigner
-    def initialize(build_class, evaluator)
-      @build_class              = build_class
+    def initialize(evaluator, &instance_builder)
+      @instance_builder         = instance_builder
       @evaluator                = evaluator
       @attribute_list           = evaluator.class.attribute_list
       @attribute_names_assigned = []
@@ -29,7 +29,7 @@ module FactoryGirl
     private
 
     def build_class_instance
-      @build_class_instance ||= @build_class.new
+      @build_class_instance ||= @evaluator.instance_exec(&@instance_builder)
     end
 
     def get(attribute_name)

data/lib/factory_girl/definition.rb

@@ -1,6 +1,6 @@
 module FactoryGirl
   class Definition
-    attr_reader :callbacks, :defined_traits, :declarations
+    attr_reader :callbacks, :defined_traits, :declarations, :constructor
 
     def initialize(name = nil, base_traits = [])
       @declarations      = DeclarationList.new(name)
@@ -9,6 +9,7 @@ module FactoryGirl
       @to_create         = lambda {|instance| instance.save! }
       @base_traits       = base_traits
       @additional_traits = []
+      @constructor       = nil
     end
 
     delegate :declare_attribute, :to => :declarations
@@ -50,6 +51,10 @@ module FactoryGirl
       @defined_traits << trait
     end
 
+    def define_constructor(&block)
+      @constructor = block
+    end
+
     private
 
     def base_traits

data/lib/factory_girl/definition_proxy.rb

@@ -161,5 +161,9 @@ module FactoryGirl
     def trait(name, &block)
       @definition.define_trait(Trait.new(name, &block))
     end
+
+    def initialize_with(&block)
+      @definition.define_constructor(&block)
+    end
   end
 end

data/lib/factory_girl/factory.rb

@@ -43,7 +43,7 @@ module FactoryGirl
       proxy = proxy_class.new
 
       evaluator = evaluator_class.new(proxy, overrides.symbolize_keys)
-      attribute_assigner = AttributeAssigner.new(build_class, evaluator)
+      attribute_assigner = AttributeAssigner.new(evaluator, &instance_builder)
 
       proxy.result(attribute_assigner, to_create).tap(&block)
     end
@@ -123,6 +123,10 @@ module FactoryGirl
       processing_order.map {|factory| factory.callbacks }.flatten
     end
 
+    def constructor
+      @constructor ||= @definition.constructor || parent.constructor
+    end
+
     private
 
     def assert_valid_options(options)
@@ -143,6 +147,11 @@ module FactoryGirl
       end
     end
 
+    def instance_builder
+      build_class = self.build_class
+      constructor || lambda { build_class.new }
+    end
+
     def initialize_copy(source)
       super
       @definition = @definition.clone

data/lib/factory_girl/null_factory.rb

@@ -6,7 +6,7 @@ module FactoryGirl
       @definition = Definition.new
     end
 
-    delegate :defined_traits, :callbacks, :attributes, :to => :definition
+    delegate :defined_traits, :callbacks, :attributes, :constructor, :to => :definition
 
     def compile; end
     def class_name; end

data/lib/factory_girl/syntax/methods.rb

@@ -5,10 +5,6 @@ module FactoryGirl
       # can be individually overridden by passing in a Hash of attribute => value
       # pairs.
       #
-      # DEPRECATED
-      #
-      # Use build or create instead, calling attributes on the result
-      #
       # Arguments:
       # * name: +Symbol+ or +String+
       #   The name of the factory that should be used.
@@ -22,7 +18,6 @@ module FactoryGirl
       # A set of attributes that can be used to build an instance of the class
       # this factory generates.
       def attributes_for(name, *traits_and_overrides, &block)
-        $stderr.puts "DEPRECATION WARNING: FactoryGirl.attributes_for is deprecated; use FactoryGirl.build or FactoryGirl.create and call #attributes on the result instead."
         run_factory_girl_proxy(name, traits_and_overrides, Proxy::AttributesFor, &block)
       end
 
@@ -72,10 +67,6 @@ module FactoryGirl
       # stubbed out. Attributes can be individually overridden by passing in a Hash
       # of attribute => value pairs.
       #
-      # DEPRECATED
-      #
-      # Use build instead
-      #
       # Arguments:
       # * name: +Symbol+ or +String+
       #   The name of the factory that should be used.
@@ -88,7 +79,6 @@ module FactoryGirl
       # Returns: +Object+
       # An object with generated attributes stubbed out.
       def build_stubbed(name, *traits_and_overrides, &block)
-        $stderr.puts "DEPRECATION WARNING: FactoryGirl.build_stubbed is deprecated; use FactoryGirl.build instead."
         run_factory_girl_proxy(name, traits_and_overrides, Proxy::Stub, &block)
       end
 

data/lib/factory_girl/syntax/vintage.rb

@@ -110,10 +110,6 @@ module FactoryGirl
         end
 
         # Alias for FactoryGirl.attributes_for
-        #
-        # DEPRECATED
-        #
-        # Use build or create instead, calling attributes on the result
         def self.attributes_for(name, overrides = {})
           FactoryGirl.attributes_for(name, overrides)
         end
@@ -129,10 +125,6 @@ module FactoryGirl
         end
 
         # Alias for FactoryGirl.build_stubbed.
-        #
-        # DEPRECATED
-        #
-        # Use build instead
         def self.stub(name, overrides = {})
           FactoryGirl.build_stubbed(name, overrides)
         end

data/lib/factory_girl/version.rb

@@ -1,4 +1,4 @@
 module FactoryGirl
-  VERSION = "2.4.2"
+  VERSION = "2.5.0"
 end
 

data/spec/acceptance/initialize_with_spec.rb

@@ -0,0 +1,147 @@
+require "spec_helper"
+
+describe "initialize_with with non-FG attributes" do
+  include FactoryGirl::Syntax::Methods
+
+  before do
+    define_model("User", :name => :string, :age => :integer) do
+      def self.construct(name, age)
+        new(:name => name, :age => age)
+      end
+    end
+
+    FactoryGirl.define do
+      factory :user do
+        initialize_with { User.construct("John Doe", 21) }
+      end
+    end
+  end
+
+  subject    { build(:user) }
+  its(:name) { should == "John Doe" }
+  its(:age)  { should == 21 }
+end
+
+describe "initialize_with with FG attributes that are ignored" do
+  include FactoryGirl::Syntax::Methods
+
+  before do
+    define_model("User", :name => :string) do
+      def self.construct(name)
+        new(:name => "#{name} from .construct")
+      end
+    end
+
+    FactoryGirl.define do
+      factory :user do
+        ignore do
+          name { "Handsome Chap" }
+        end
+
+        initialize_with { User.construct(name) }
+      end
+    end
+  end
+
+  subject    { build(:user) }
+  its(:name) { should == "Handsome Chap from .construct" }
+end
+
+describe "initialize_with with FG attributes that are not ignored" do
+  include FactoryGirl::Syntax::Methods
+
+  before do
+    define_model("User", :name => :string) do
+      def self.construct(name)
+        new(:name => "#{name} from .construct")
+      end
+    end
+
+    FactoryGirl.define do
+      factory :user do
+        name { "Handsome Chap" }
+
+        initialize_with { User.construct(name) }
+      end
+    end
+  end
+
+  it "assigns each attribute even if the attribute has been used in the constructor" do
+    build(:user).name.should == "Handsome Chap"
+  end
+end
+
+describe "initialize_with non-ORM-backed objects" do
+  include FactoryGirl::Syntax::Methods
+
+  before do
+    define_class("ReportGenerator") do
+      attr_reader :name, :data
+
+      def initialize(name, data)
+        @name = name
+        @data = data
+      end
+    end
+
+    FactoryGirl.define do
+      sequence(:random_data) { 5.times.map { Kernel.rand(200) } }
+
+      factory :report_generator do
+        ignore do
+          name "My Awesome Report"
+        end
+
+        initialize_with { ReportGenerator.new(name, FactoryGirl.generate(:random_data)) }
+      end
+    end
+  end
+
+  it "allows for overrides" do
+    build(:report_generator, :name => "Overridden").name.should == "Overridden"
+  end
+
+  it "generates random data" do
+    build(:report_generator).data.length.should == 5
+  end
+end
+
+describe "initialize_with parent and child factories" do
+  before do
+    define_class("Awesome") do
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+
+    FactoryGirl.define do
+      factory :awesome do
+        ignore do
+          name "Great"
+        end
+
+        initialize_with { Awesome.new(name) }
+
+        factory :sub_awesome do
+          ignore do
+            name "Sub"
+          end
+        end
+
+        factory :super_awesome do
+          initialize_with { Awesome.new("Super") }
+        end
+      end
+    end
+  end
+
+  it "uses the parent's constructor when the child factory doesn't assign it" do
+    FactoryGirl.build(:sub_awesome).name.should == "Sub"
+  end
+
+  it "allows child factories to override initialize_with" do
+    FactoryGirl.build(:super_awesome).name.should == "Super"
+  end
+end

data/spec/factory_girl/definition_proxy_spec.rb

@@ -184,3 +184,14 @@ describe FactoryGirl::DefinitionProxy, "#trait" do
     subject.should have_trait(:male).with_block(male_trait)
   end
 end
+
+describe FactoryGirl::DefinitionProxy, "#initialize_with" do
+  subject     { FactoryGirl::Definition.new }
+  let(:proxy) { FactoryGirl::DefinitionProxy.new(subject) }
+
+  it "defines the constructor on the definition" do
+    constructor = Proc.new { Array.new }
+    proxy.initialize_with(&constructor)
+    subject.constructor.should == constructor
+  end
+end

data/spec/factory_girl/null_factory_spec.rb

@@ -4,6 +4,7 @@ describe FactoryGirl::NullFactory do
   it { should delegate(:defined_traits).to(:definition) }
   it { should delegate(:callbacks).to(:definition) }
   it { should delegate(:attributes).to(:definition) }
+  it { should delegate(:constructor).to(:definition) }
 
   its(:compile)          { should be_nil }
   its(:class_name)       { should be_nil }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: factory_girl
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-18 00:00:00.000000000Z
+date: 2012-01-21 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70205633314300 !ruby/object:Gem::Requirement
+  requirement: &70146233062280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70205633314300
+  version_requirements: *70146233062280
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70205633310180 !ruby/object:Gem::Requirement
+  requirement: &70146233061680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *70205633310180
+  version_requirements: *70146233061680
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70205633309440 !ruby/object:Gem::Requirement
+  requirement: &70146233061160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70205633309440
+  version_requirements: *70146233061160
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70205633308320 !ruby/object:Gem::Requirement
+  requirement: &70146233060780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633308320
+  version_requirements: *70146233060780
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70205633307580 !ruby/object:Gem::Requirement
+  requirement: &70146233060320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633307580
+  version_requirements: *70146233060320
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70205633306600 !ruby/object:Gem::Requirement
+  requirement: &70146233059900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633306600
+  version_requirements: *70146233059900
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70205633305800 !ruby/object:Gem::Requirement
+  requirement: &70146233059460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633305800
+  version_requirements: *70146233059460
 - !ruby/object:Gem::Dependency
   name: bourne
-  requirement: &70205633305240 !ruby/object:Gem::Requirement
+  requirement: &70146233059040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633305240
+  version_requirements: *70146233059040
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &70205633304740 !ruby/object:Gem::Requirement
+  requirement: &70146233058540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 0.3.8
   type: :development
   prerelease: false
-  version_requirements: *70205633304740
+  version_requirements: *70146233058540
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &70205633304300 !ruby/object:Gem::Requirement
+  requirement: &70146233058120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633304300
+  version_requirements: *70146233058120
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &70205633303840 !ruby/object:Gem::Requirement
+  requirement: &70146233057620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,10 +131,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633303840
+  version_requirements: *70146233057620
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &70205633303340 !ruby/object:Gem::Requirement
+  requirement: &70146233057180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,7 +142,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70205633303340
+  version_requirements: *70146233057180
 description: ! "factory_girl provides a framework and DSL for defining and\n                       using
   factories - less error-prone, more explicit, and\n                       all-around
   easier to work with than fixtures."
@@ -243,6 +243,7 @@ files:
 - spec/acceptance/define_child_before_parent_spec.rb
 - spec/acceptance/definition_spec.rb
 - spec/acceptance/definition_without_block_spec.rb
+- spec/acceptance/initialize_with_spec.rb
 - spec/acceptance/modify_factories_spec.rb
 - spec/acceptance/modify_inherited_spec.rb
 - spec/acceptance/overrides_spec.rb
@@ -349,6 +350,7 @@ test_files:
 - spec/acceptance/define_child_before_parent_spec.rb
 - spec/acceptance/definition_spec.rb
 - spec/acceptance/definition_without_block_spec.rb
+- spec/acceptance/initialize_with_spec.rb
 - spec/acceptance/modify_factories_spec.rb
 - spec/acceptance/modify_inherited_spec.rb
 - spec/acceptance/overrides_spec.rb