modelfactory 0.8.9 → 0.9.0

data/History.txt

@@ -1,3 +1,7 @@
+== 0.9.0 2009-06-04
+* More API changes
+* Built-in counters for generating values
+
 == 0.8.9 2009-05-19
 * Renamed the required lib to 'modelfactory'
 * Completely redesigned API, see the documentation in README.txt

data/Manifest.txt

@@ -14,9 +14,13 @@ script/fixtures2factories
 script/generate
 script/txt2html
 setup.rb
+test/counter_test.rb
+test/fixtures/category.rb
 test/fixtures/schema.rb
 test/fixtures/strict_widget.rb
 test/fixtures/widget.rb
-test/model_factory_legacy_test.rb
-test/model_factory_test.rb
+test/legacy_test.rb
+test/modelfactory_test.rb
+test/named_test.rb
+test/relation_test.rb
 test/test_helper.rb

data/README.txt

@@ -18,64 +18,84 @@ opaque ActiveRecord objects whose contents are unimportant.
  require 'modelfactory'
 
  ModelFactory.configuration do
-   default(User) do |m|
-     m.name = "Factory User"
-     m.email = "user@factory.ws"
+   default(User) do
+     name  { "Factory User" }
+     email { "user@factory.ws" }
    end
  end
 
  ModelFactory[User].create.name  # => 'Factory User'
 
+Defaults can be overriden on instance creation. By not specifying unimportant
+values, the intention of your tests becomes clearer:
+
+ def test_welcome
+    user = ModelFactory[User].create(:name => 'bob')
+    assert_equal 'Welcome, bob!', user.welcome
+ end
+
 If you don't care for the factory creation syntax, ModelFactory defines the
 factory class method on ActiveRecord models. The following is equivalent
 to ModelFactory[User].create:
 
  User.factory.create
 
-Since factory-created instances are meant to be valid, you will probably
-need a way to generate unique values. ModelFactory keeps a counter for each
-type that increments when each new instance is created. This counter is passed
-to configuration blocks to make it easier to generate unique values:
+When you use a factory to create an instance, the save! and reload methods are
+called before the instance is returned. This means instances must be valid after
+being initialized by the factory, or an ActiveRecord validation error will be
+raised.
+
+ class Widget < ActiveRecord::Base
+   validates_presence_of :name, :desc
+ end
+
+ ModelFactory.configure do
+   default(Widget) { name { 'widget' } }
+ end
+
+ # Raises an error because no desc was provided:
+ Widget.factory.create
+
+ # Doesn't raise, a desc is provided:
+ Widget.factory.create(:desc => 'widget desc')
+
+ # Doesn't raise, required values are defined in the default factory:
+ ModelFactory.configure do
+   default(Widget) do
+     name { 'widget' }
+     desc { 'widget desc' }
+   end
+ end
+ Widget.factory.create
+
+Since creating valid objects usually means having unique values, ModelFactory
+keeps a counter for each type that increments when each new instance is
+created. This counter is passed to model initialization blocks to make it
+easier to generate unique values:
 
  ModelFactory.configuration do
-   default(User) do |m, i|
-     m.name = "Factory User #{i}"
-     m.email = "user#{i}@factory.ws"
+   default(User) do
+     name  {|i| "Factory User #{i}" }
+     email {|i| "user#{i}@factory.ws" }
    end
  end
 
  User.factory.create.name  # => 'Factory User 1'
  User.factory.create.email # => 'user2@factory.ws'
 
-Defaults can be overriden on instance creation. By not specifying unimportant
-values, the intention of your tests becomes clearer:
-
- def test_welcome
-    user = ModelFactory[User].create(:name => 'bob')
-    assert_equal 'Welcome, bob!', user.welcome
- end
-
 It's possible to configure named factories:
 
  ModelFactory.configuration do
-   admin(User) do |m, i|
-     m.name = "Admin User #{i}"
-     m.admin = true
+   admin(User) do
+     name  {|i| "Admin User #{i}" }
+     admin { true }
    end
  end
 
  User.factory.create_admin.admin  # => true
 
 Named factories do not inherit anything from the default, so you'll still need to
-provide enough to data to allow the creation of valid objects.
-
-=== A Note About Defaults
-
-The purpose of default values is to generate valid instances, not to serve as
-replacements for fixture data. When writing tests that use factory-generated
-objects, it's important never to depend on default values in your test assertions.
-If you depend on defaults in your tests they become more fragile and the intention
-is harder to discern. Alway override values you care about when using factory objects.
+provide enough data to allow the creation of valid objects.
 
 == Installing ModelFactory
 

data/Rakefile

@@ -1,5 +1,6 @@
 require 'rubygems'
 require 'hoe'
+require 'hanna/rdoctask'
 $:.unshift(File.dirname(__FILE__) + "/lib")
 require 'modelfactory/version'
 
@@ -15,7 +16,10 @@ Hoe.new('ModelFactory', ModelFactory::VERSION::STRING) do |p|
   p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
   p.test_globs = ["test/**/*_test.rb"]
   p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']
-  p.extra_dev_deps = ['active_record', 'mocha', 'thoughtbot-shoulda', 'sqlite3-ruby']
+  p.extra_deps = %w[ activesupport ]
+  p.extra_dev_deps = %w[
+    activerecord mocha thoughtbot-shoulda sqlite3-ruby mislav-hanna 
+  ]
 end
 
 

data/lib/modelfactory.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'active_record'
-require 'modelfactory/factory'
-require 'modelfactory/legacy'
+require File.dirname(__FILE__) + '/modelfactory/factory'
+require File.dirname(__FILE__) + '/modelfactory/legacy'
 
 ActiveRecord::Base.class_eval do
   def self.factory ; ModelFactory[self] ; end

data/lib/modelfactory/factory.rb

@@ -1,3 +1,5 @@
+require 'active_support' # instance_exec
+
 module ModelFactory # :nodoc:
   # This API allows you to instantiate models.
   class Factory # :nodoc:
@@ -34,16 +36,7 @@ module ModelFactory # :nodoc:
 
     def new_named(name, opt = {}, &block)
       instance = @class.new
-      if @options[name]
-        case @options[name].arity
-        when 2
-          @options[name].call(instance, next_counter) if @options[name]
-        else
-          @options[name].call(instance) if @options[name]
-        end
-      end
-      opt.each {|k,v| instance.send("#{k}=", v) }
-      yield instance if block_given?
+      InstanceBuilder.new(instance, opt, next_counter, &@options[name])
       instance
     end
 
@@ -56,4 +49,23 @@ module ModelFactory # :nodoc:
 
   end
 
+  class InstanceBuilder # :nodoc:
+    def initialize(instance, params, counter, &block)
+      @instance = instance
+      @params = params
+      @counter = counter
+      @params.each { |attr, value| @instance.send "#{attr}=", value }
+      instance_eval(&block) if block_given?
+    end
+
+    def method_missing(method, &block)
+      if block_given? && !@params.key?(method.to_sym)
+        @instance.send "#{method}=",
+          (block.arity == 1) ?
+            @instance.instance_exec(@counter, &block) :
+            @instance.instance_eval(&block)
+      end
+    end
+  end
+
 end

data/lib/modelfactory/version.rb

@@ -1,8 +1,8 @@
 module ModelFactory #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 8
-    TINY  = 9
+    MINOR = 9
+    TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/test/counter_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/modelfactory'
+
+class ModelFactoryTest < Test::Unit::TestCase
+  context "with a specified default that uses automatic numbering" do
+    setup do
+      ModelFactory.configure do
+        default(Widget) { price {|i| i } }
+      end
+    end
+  
+    should "start counting at 1 after configuration" do
+      assert_equal 1.0, Widget.factory.create.price
+    end
+
+    should "generate a unique sequence" do
+      w = []
+      3.times { w << Widget.factory.create.price }
+      assert_equal w.uniq, w
+    end
+
+  end
+end
+
+

data/test/fixtures/category.rb

@@ -0,0 +1,4 @@
+class Category < ActiveRecord::Base
+  has_many :widgets
+end
+

data/test/fixtures/schema.rb

@@ -3,6 +3,11 @@ ActiveRecord::Schema.define do
     t.string   "name"
     t.decimal  "price"
     t.string   "type"
+    t.integer  "category_id"
+  end
+
+  create_table "categories", :force => true do |t|
+    t.string   "name"
   end
 end
 

data/test/fixtures/widget.rb

@@ -1,4 +1,4 @@
-
 class Widget < ActiveRecord::Base
+  belongs_to :category
 end
 

data/test/modelfactory_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/modelfactory'
+
+class ModelFactoryTest < Test::Unit::TestCase
+
+  should "not instantiate when using new" do
+    assert Widget.factory.new.new_record?
+  end
+
+  should "instantiate when using create" do
+    assert !Widget.factory.create.new_record?
+  end
+
+  should "raise on creation of invalid records" do
+    assert_raises(ActiveRecord::RecordInvalid) { StrictWidget.factory.create }
+  end
+  
+  context "with a specified default" do
+    setup do
+      ModelFactory.configure do
+        default(Widget) { name {'foobaz' } }
+      end
+    end
+  
+    should "initialize defaults with no arguments" do
+      assert_equal 'foobaz', Widget.factory.create.name
+    end
+  
+    should "initialize defaults with an unspecified argument" do
+      assert_equal 'foobaz', Widget.factory.create(:price => 4.0).name
+    end
+  
+    should "initialize with an unspecified argument" do
+      assert_equal 4, Widget.factory.create(:price => 4.0).price
+    end
+  end
+
+end
+
+

data/test/named_test.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/modelfactory'
+
+class ModelFactoryTest < Test::Unit::TestCase
+  context "with a named factory" do
+    setup do
+      ModelFactory.configure do
+        default(Widget) { name { 'wubbo' } }
+        favorite(Widget) { name { 'foobaz' } }
+      end
+    end
+  
+    should "not apply named config to default" do
+      assert_equal 'wubbo', Widget.factory.create.name
+    end
+  
+    should "not apply any config to unrecognized name" do
+      assert_equal nil, Widget.factory.create_emptyfoo.name
+    end
+  
+    should "initialize defaults with no arguments" do
+      assert_equal 'foobaz', Widget.factory.create_favorite.name
+    end
+  
+    should "initialize defaults with an unspecified argument" do
+      assert_equal 'foobaz', Widget.factory.create_favorite(:price => 4.0).name
+    end
+  
+    should "initialize with an unspecified argument" do
+      assert_equal 4, Widget.factory.create_favorite(:price => 4.0).price
+    end
+  end
+end
+
+

data/test/relation_test.rb

@@ -0,0 +1,57 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/../lib/modelfactory'
+
+class ModelFactoryTest < Test::Unit::TestCase
+  context "default refers to previously initialized value" do
+    setup do
+      ModelFactory.configure do
+        default(Category) do
+          name { "Factory Category" }
+        end
+        default(Widget) do
+          category { Category.factory.create }
+          name { "#{category.name} Widget" }
+        end
+      end
+    end
+
+    should "refer to fields initialized by default block" do
+      assert_equal "Factory Category Widget", Widget.factory.create.name
+    end
+
+    should "refer to fields initialized on create" do
+      cat = Category.create(:name => 'Foobar')
+      assert_equal "Foobar Widget", Widget.factory.create(:category => cat).name
+    end
+  end
+
+  context "initializing a belongs_to relation" do
+    setup do
+      ModelFactory.configure do
+        default(Category) do
+          name { "Factory Category" }
+        end
+        default(Widget) do
+          category { Category.factory.create }
+        end
+      end
+    end
+
+    should "automatically create parent instance" do
+      old_count = Category.count
+      assert !Widget.factory.create.category.nil?
+      assert_equal old_count + 1, Category.count
+    end
+
+    should "do not create a parent when one is passed in" do
+      old_count = Category.count
+      Widget.factory.create(:category => nil)
+      assert_equal old_count, Category.count
+    end
+
+    should "do not assign a parent when nil is passed in" do
+      assert Widget.factory.create(:category => nil).category.nil?
+    end
+  end
+end
+  

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: modelfactory
 version: !ruby/object:Gem::Version 
-  version: 0.8.9
+  version: 0.9.0
 platform: ruby
 authors: 
 - Justin Balthrop
@@ -10,11 +10,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-19 00:00:00 -07:00
+date: 2009-06-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: active_record
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -53,6 +63,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: mislav-hanna
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -91,11 +111,15 @@ files:
 - script/generate
 - script/txt2html
 - setup.rb
+- test/counter_test.rb
+- test/fixtures/category.rb
 - test/fixtures/schema.rb
 - test/fixtures/strict_widget.rb
 - test/fixtures/widget.rb
-- test/model_factory_legacy_test.rb
-- test/model_factory_test.rb
+- test/legacy_test.rb
+- test/modelfactory_test.rb
+- test/named_test.rb
+- test/relation_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://modelfactory.rubyforge.org/
@@ -125,5 +149,8 @@ signing_key:
 specification_version: 2
 summary: A replacement for fixtures.
 test_files: 
-- test/model_factory_test.rb
-- test/model_factory_legacy_test.rb
+- test/counter_test.rb
+- test/modelfactory_test.rb
+- test/relation_test.rb
+- test/legacy_test.rb
+- test/named_test.rb

data/test/model_factory_test.rb

@@ -1,86 +0,0 @@
-require File.dirname(__FILE__) + '/test_helper'
-require File.dirname(__FILE__) + '/../lib/modelfactory'
-
-class ModelFactoryTest < Test::Unit::TestCase
-
-  should "not instantiate when using new" do
-    assert Widget.factory.new.new_record?
-  end
-
-  should "instantiate when using create" do
-    assert !Widget.factory.create.new_record?
-  end
-
-  should "raise on creation of invalid records" do
-    assert_raises(ActiveRecord::RecordInvalid) { StrictWidget.factory.create }
-  end
-  
-  context "with a specified default that uses automatic numbering" do
-    setup do
-      ModelFactory.configure do
-        default(Widget) {|w, i| w.price = i }
-      end
-    end
-  
-    should "start counting at 1 after configuration" do
-      assert_equal 1.0, Widget.factory.create.price
-    end
-
-    should "generate a unique sequence" do
-      w = []
-      3.times { w << Widget.factory.create.price }
-      assert_equal w.uniq, w
-    end
-  end
-
-  context "with a specified default" do
-    setup do
-      ModelFactory.configure do
-        default(Widget) {|w| w.name = 'foobaz' }
-      end
-    end
-  
-    should "initialize defaults with no arguments" do
-      assert_equal 'foobaz', Widget.factory.create.name
-    end
-  
-    should "initialize defaults with an unspecified argument" do
-      assert_equal 'foobaz', Widget.factory.create(:price => 4.0).name
-    end
-  
-    should "initialize with an unspecified argument" do
-      assert_equal 4, Widget.factory.create(:price => 4.0).price
-    end
-  end
-
-  context "with a named factory" do
-    setup do
-      ModelFactory.configure do
-        default(Widget) {|w| w.name = 'wubbo' }
-        favorite(Widget) {|w| w.name = 'foobaz' }
-      end
-    end
-  
-    should "not apply named config to default" do
-      assert_equal 'wubbo', Widget.factory.create.name
-    end
-  
-    should "not apply any config to unrecognized name" do
-      assert_equal nil, Widget.factory.create_emptyfoo.name
-    end
-  
-    should "initialize defaults with no arguments" do
-      assert_equal 'foobaz', Widget.factory.create_favorite.name
-    end
-  
-    should "initialize defaults with an unspecified argument" do
-      assert_equal 'foobaz', Widget.factory.create_favorite(:price => 4.0).name
-    end
-  
-    should "initialize with an unspecified argument" do
-      assert_equal 4, Widget.factory.create_favorite(:price => 4.0).price
-    end
-  end
-end
-
-