spawn 0.1.2 → 0.1.3

data/README.markdown

@@ -7,8 +7,8 @@ choice.
 Description
 -----------
 
-Spawn is a very small library (just 14 lines of code) that can
-effectively replace fixtures or any other huge library for the same task.
+Spawn is a very small library that can effectively replace fixtures or
+any other huge library for the same task.
 
 Usage
 -----
@@ -16,7 +16,7 @@ Usage
 In the examples below we are using [Faker](http://faker.rubyforge.org/)
 to generate random data, but you can use any method.
 
-With ActiveRecord:
+With [ActiveRecord](http://api.rubyonrails.org/classes/ActiveRecord/Base.html):
 
     class User < ActiveRecord::Base
       spawner do |user|
@@ -25,7 +25,7 @@ With ActiveRecord:
       end
     end
 
-With Sequel:
+With [Sequel](http://sequel.rubyforge.org/):
 
     class User < Sequel::Model
       extend Spawn
@@ -36,6 +36,20 @@ With Sequel:
       end
     end
 
+With [Ohm](http://ohm.keyvalue.org):
+
+    class User < Ohm::Model
+      extend Spawn
+
+      attribute :name
+      attribute :email
+
+      spawner do |user|
+        user.name = Faker::Name.name
+        user.email = Faker::Internet.email
+      end
+    end
+
 If you don't want to pollute your class definition, you
 can of course use it from outside:
 
@@ -52,6 +66,15 @@ Or, if you need something special:
 
     @user = User.spawn :name => "Michel Martens"
 
+This sends to User.new all the attributes defined in the spawner block, along with
+the hash of attributes passed when spawning.
+
+If you want a reference to the model before the validity is checked, you can pass
+a block:
+
+    @user = User.spawn { |u| u.name = "Michel Martens" }
+
+
 Conditional evaluation
 ----------------------
 

data/lib/spawn.rb

@@ -1,14 +1,26 @@
 require "ostruct"
 
 module Spawn
+
+  Invalid = Class.new(ArgumentError)
+
   def spawner &default
     @@spawn ||= Hash.new
     @@spawn[self] = default
   end
 
-  def spawn attrs = {}
-    @@spawn[self].call(model = OpenStruct.new(attrs))
-    factory_method = respond_to?(:create!) ? :create! : :create
-    send(factory_method, model.send(:table).merge(attrs))
+  def spawn params = {}
+
+    # Grab default parameters from spawner block.
+    @@spawn[self].call(attrs = OpenStruct.new(params))
+
+    # Initialize model
+    model = new(attrs.send(:table).merge(params))
+
+    # Yield model for changes to be made before saving.
+    yield(model) if block_given?
+
+    # Raise an error if the model is invalid or couldn't be saved.
+    model.valid? and model.save and model or raise(Invalid, model.errors.inspect)
   end
 end

data/spawn.gemspec

@@ -1,12 +1,11 @@
 Gem::Specification.new do |s|
   s.name = 'spawn'
-  s.version = '0.1.2'
+  s.version = '0.1.3'
   s.summary = %{Simple fixtures replacement for Sequel, ActiveRecord, Ohm and probably many other ORMs}
   s.description = %{Spawn is a very small library (just 14 lines of code) that can effectively replace fixtures or any other library for the same task.}
   s.authors = ["Michel Martens", "Damian Janowski"]
   s.email = ["michel@soveran.com", "djanowski@dimaion.com"]
   s.homepage = "http://github.com/soveran/spawn"
-  s.files = ["lib/spawn.rb", "rails/init.rb", "README.markdown", "LICENSE", "Rakefile", "test/active_record_test.rb", "test/all_test.rb", "test/sequel_test.rb", "spawn.gemspec"]
-  s.require_paths = ['lib']
+  s.files = ["lib/spawn.rb", "rails/init.rb", "README.markdown", "LICENSE", "Rakefile", "test/active_record_test.rb", "test/all_test.rb", "test/ohm_test.rb", "test/sequel_test.rb", "spawn.gemspec"]
   s.rubyforge_project = "spawner"
 end

data/test/active_record_test.rb

@@ -18,25 +18,24 @@ class ActiveRecordUser < ActiveRecord::Base
   validates_presence_of :name
 
   spawner do |user|
-    user.name = Faker::Name.name
     user.email = Faker::Internet.email
   end
 end
 
 class TestSpawnWithActiveRecord < Test::Unit::TestCase
-  setup do
-    @user = ActiveRecordUser.spawn :name => "John"
-  end
-
   context "spawned user" do
+    setup do
+      @user = ActiveRecordUser.spawn :name => "John"
+    end
+
     should "have John as name" do
       assert_equal "John", @user.name
     end
 
     context "with invalid attributes" do
       should "raise an error" do
-        assert_raise ActiveRecord::RecordInvalid do
-          ActiveRecordUser.spawn :name => nil
+        assert_raise Spawn::Invalid do
+          ActiveRecordUser.spawn
         end
       end
     end

data/test/all_test.rb

@@ -16,6 +16,17 @@ class Base
   def bar; attributes[:bar] end
   def baz; attributes[:baz] end
 
+  def bar=(value); attributes[:bar] = value; end
+  def baz=(value); attributes[:baz] = value; end
+
+  def save
+    self
+  end
+
+  def valid?
+    true
+  end
+
   extend Spawn
 end
 
@@ -114,6 +125,16 @@ class TestFoo < Test::Unit::TestCase
         end
       end
 
+      context "with a block supplied" do
+        should "override the default values with single assignments" do
+          foo = Foo.spawn(:bar => 1) do |f|
+            f.baz = 2
+          end
+          assert_equal 1, foo.bar
+          assert_equal 2, foo.baz
+        end
+      end
+
       context "and a class Bar" do
         context "that also implements Spawn" do
           should "be kind of Spawn" do

data/test/ohm_test.rb

@@ -0,0 +1,41 @@
+require "rubygems"
+require "ohm"
+require "contest"
+require File.dirname(__FILE__) + "/../lib/spawn"
+
+Ohm.connect
+
+class OhmUser < Ohm::Model
+  extend Spawn
+
+  attribute :name
+  attribute :email
+
+  def validate
+    assert_present :name
+  end
+
+  spawner do |user|
+    user.email = "albert@example.com"
+  end
+end
+
+class TestSpawnWithOhm < Test::Unit::TestCase
+  setup do
+    @user = OhmUser.spawn :name => "John"
+  end
+
+  context "spawned user" do
+    should "have John as name" do
+      assert_equal "John", @user.name
+    end
+
+    context "with invalid attributes" do
+      should "raise an error" do
+        assert_raise Spawn::Invalid do
+          OhmUser.spawn
+        end
+      end
+    end
+  end
+end

data/test/sequel_test.rb

@@ -15,7 +15,6 @@ class SequelUser < Sequel::Model
   end
 
   spawner do |user|
-    user.name = Faker::Name.name
     user.email = Faker::Internet.email
   end
 end
@@ -32,8 +31,8 @@ class TestSpawnWithSequel < Test::Unit::TestCase
 
     context "with invalid attributes" do
       should "raise an error" do
-        assert_raise Sequel::Error::InvalidValue do
-          SequelUser.spawn :name => nil
+        assert_raise Spawn::Invalid do
+          SequelUser.spawn
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: spawn
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Michel Martens
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-16 00:00:00 -03:00
+date: 2009-11-20 00:00:00 -03:00
 default_executable: 
 dependencies: []
 
@@ -32,6 +32,7 @@ files:
 - Rakefile
 - test/active_record_test.rb
 - test/all_test.rb
+- test/ohm_test.rb
 - test/sequel_test.rb
 - spawn.gemspec
 has_rdoc: true
@@ -58,7 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: spawner
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Simple fixtures replacement for Sequel, ActiveRecord, Ohm and probably many other ORMs