machinist 1.0.6 → 2.0

data/machinist.gemspec

@@ -1,72 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "machinist/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{machinist}
-  s.version = "1.0.6"
+  s.name     = "machinist"
+  s.version  = Machinist::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.authors  = ["Pete Yandell"]
+  s.email    = ["pete@notahat.com"]
+  s.homepage = "http://github.com/notahat/machinist"
+  s.summary  = "Fixtures aren't fun. Machinist is."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Pete Yandell"]
-  s.date = %q{2009-11-29}
-  s.email = %q{pete@notahat.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    ".autotest",
-     ".gitignore",
-     "FAQ.markdown",
-     "MIT-LICENSE",
-     "README.markdown",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/machinist.rb",
-     "lib/machinist/active_record.rb",
-     "lib/machinist/blueprints.rb",
-     "lib/machinist/data_mapper.rb",
-     "lib/machinist/object.rb",
-     "lib/machinist/sequel.rb",
-     "lib/sham.rb",
-     "machinist.gemspec",
-     "spec/active_record_spec.rb",
-     "spec/data_mapper_spec.rb",
-     "spec/db/.gitignore",
-     "spec/db/schema.rb",
-     "spec/log/.gitignore",
-     "spec/machinist_spec.rb",
-     "spec/sequel_spec.rb",
-     "spec/sham_spec.rb",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/notahat/machinist}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
-  s.summary = %q{Fixtures aren't fun. Machinist is.}
-  s.test_files = [
-    "spec/active_record_spec.rb",
-     "spec/data_mapper_spec.rb",
-     "spec/db/schema.rb",
-     "spec/machinist_spec.rb",
-     "spec/sequel_spec.rb",
-     "spec/sham_spec.rb",
-     "spec/spec_helper.rb"
-  ]
+  s.rubyforge_project = "machinist"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.8"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.8"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.8"])
-  end
+  s.add_development_dependency "activerecord"
+  s.add_development_dependency "mysql"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rcov"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rdoc"
 end
-

data/spec/active_record_spec.rb

@@ -1,194 +1,108 @@
 require File.dirname(__FILE__) + '/spec_helper'
-require 'machinist/active_record'
-require 'active_support/whiny_nil'
+require 'support/active_record_environment'
 
-module MachinistActiveRecordSpecs
-  
-  class Person < ActiveRecord::Base
-    attr_protected :password
-  end
+describe Machinist::ActiveRecord do
+  include ActiveRecordEnvironment
 
-  class Admin < Person
+  before(:each) do
+    empty_database!
   end
 
-  class Post < ActiveRecord::Base
-    has_many :comments
+  context "make" do
+    it "returns an unsaved object" do
+      Post.blueprint { }
+      post = Post.make
+      post.should be_a(Post)
+      post.should be_new_record
+    end
   end
 
-  class Comment < ActiveRecord::Base
-    belongs_to :post
-    belongs_to :author, :class_name => "Person"
-  end
+  context "make!" do
+    it "makes and saves objects" do
+      Post.blueprint { }
+      post = Post.make!
+      post.should be_a(Post)
+      post.should_not be_new_record
+    end
 
-  describe Machinist, "ActiveRecord adapter" do
-    before(:suite) do
-      ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/log/test.log")
-      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
-      load(File.dirname(__FILE__) + "/db/schema.rb")
+    it "raises an exception for an invalid object" do
+      User.blueprint { }
+      lambda {
+        User.make!(:username => "")
+      }.should raise_error(ActiveRecord::RecordInvalid)
     end
-  
-    before(:each) do
-      [Person, Admin, Post, Comment].each(&:clear_blueprints!)
+  end
+
+  context "associations support" do
+    it "handles belongs_to associations" do
+      User.blueprint do
+        username { "user_#{sn}" }
+      end
+      Post.blueprint do
+        author
+      end
+      post = Post.make!
+      post.should be_a(Post)
+      post.should_not be_new_record
+      post.author.should be_a(User)
+      post.author.should_not be_new_record
     end
-  
-    describe "make method" do
-      it "should support single-table inheritance" do
-        Person.blueprint { }
-        Admin.blueprint  { }
-        admin = Admin.make
-        admin.should_not be_new_record
-        admin.type.should == "Admin"
-      end
 
-      it "should save the constructed object" do
-        Person.blueprint { }
-        person = Person.make
-        person.should_not be_new_record
-      end
-  
-      it "should create an object through belongs_to association" do
-        Post.blueprint { }
-        Comment.blueprint { post }
-        Comment.make.post.class.should == Post
-      end
-  
-      it "should create an object through belongs_to association with a class_name attribute" do
-        Person.blueprint { }
-        Comment.blueprint { author }
-        Comment.make.author.class.should == Person
+    it "handles has_many associations" do
+      Post.blueprint do
+        comments(3)
+      end
+      Comment.blueprint { }
+      post = Post.make!
+      post.should be_a(Post)
+      post.should_not be_new_record
+      post.should have(3).comments
+      post.comments.each do |comment|
+        comment.should be_a(Comment)
+        comment.should_not be_new_record
       end
+    end
 
-      it "should create an object through belongs_to association using a named blueprint" do
-        Post.blueprint { }
-        Post.blueprint(:dummy) { title 'Dummy Post' }
-        Comment.blueprint { post(:dummy) }
-        Comment.make.post.title.should == 'Dummy Post'
-      end
-      
-      it "should allow creating an object through a has_many association" do
-        Post.blueprint do
-          comments { [Comment.make] }
-        end
-        Comment.blueprint { }
-        Post.make.comments.should have(1).instance_of(Comment)
-      end
-      
-      it "should allow setting a protected attribute in the blueprint" do
-        Person.blueprint do
-          password "Test"
-        end
-        Person.make.password.should == "Test"
-      end
-      
-      it "should allow overriding a protected attribute" do
-        Person.blueprint do
-          password "Test"
-        end
-        Person.make(:password => "New").password.should == "New"
+    it "handles habtm associations" do
+      Post.blueprint do
+        tags(3)
       end
-      
-      it "should allow setting the id attribute in a blueprint" do
-        Person.blueprint { id 12345 }
-        Person.make.id.should == 12345
+      Tag.blueprint do
+        name { "tag_#{sn}" }
       end
-      
-      it "should allow setting the type attribute in a blueprint" do
-        Person.blueprint { type "Person" }
-        Person.make.type.should == "Person"
-      end
-
-      describe "on a has_many association" do
-        before do 
-          Post.blueprint { }
-          Comment.blueprint { post }
-          @post = Post.make
-          @comment = @post.comments.make
-        end
-    
-        it "should save the created object" do
-          @comment.should_not be_new_record
-        end
-    
-        it "should set the parent association on the created object" do
-          @comment.post.should == @post
-        end
+      post = Post.make!
+      post.should be_a(Post)
+      post.should_not be_new_record
+      post.should have(3).tags
+      post.tags.each do |tag|
+        tag.should be_a(Tag)
+        tag.should_not be_new_record
       end
     end
 
-    describe "plan method" do
-      it "should not save the constructed object" do
-        person_count = Person.count
-        Person.blueprint { }
-        person = Person.plan
-        Person.count.should == person_count
-      end
-  
-      it "should create an object through a belongs_to association, and return its id" do
-        Post.blueprint { }
-        Comment.blueprint { post }
-        post_count = Post.count
-        comment = Comment.plan
-        Post.count.should == post_count + 1
-        comment[:post].should be_nil
-        comment[:post_id].should_not be_nil
-      end
-
-      describe "on a belongs_to association" do
-        it "should allow explicitly setting the association to nil" do
-          Comment.blueprint { post }
-          Comment.blueprint(:no_post) { post { nil } }
-          lambda {
-            @comment = Comment.plan(:no_post)
-          }.should_not raise_error
-        end
-      end
-  
-      describe "on a has_many association" do
-        before do
-          Post.blueprint { }
-          Comment.blueprint do
-            post
-            body { "Test" }
-          end
-          @post = Post.make
-          @post_count = Post.count
-          @comment = @post.comments.plan
-        end
-    
-        it "should not include the parent in the returned hash" do
-          @comment[:post].should be_nil
-          @comment[:post_id].should be_nil
-        end
-    
-        it "should not create an extra parent object" do
-          Post.count.should == @post_count
-        end
-      end
+    it "handles overriding associations" do
+      User.blueprint do
+        username { "user_#{sn}" }
+      end
+      Post.blueprint do
+        author { User.make(:username => "post_author_#{sn}") }
+      end
+      post = Post.make!
+      post.should be_a(Post)
+      post.should_not be_new_record
+      post.author.should be_a(User)
+      post.author.should_not be_new_record
+      post.author.username.should =~ /^post_author_\d+$/
     end
+  end
 
-    describe "make_unsaved method" do
-      it "should not save the constructed object" do
-        Person.blueprint { }
-        person = Person.make_unsaved
-        person.should be_new_record
-      end
-  
-      it "should not save associated objects" do
-        Post.blueprint { }
-        Comment.blueprint { post }
-        comment = Comment.make_unsaved
-        comment.post.should be_new_record
-      end
-  
-      it "should save objects made within a passed-in block" do
-        Post.blueprint { }
-        Comment.blueprint { }
-        comment = nil
-        post = Post.make_unsaved { comment = Comment.make }
-        post.should be_new_record
-        comment.should_not be_new_record
-      end
+  context "error handling" do
+    it "raises an exception for an attribute with no value" do
+      User.blueprint { username }
+      lambda {
+        User.make
+      }.should raise_error(ArgumentError)
     end
-  
   end
+
 end

data/spec/blueprint_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'ostruct'
+
+describe Machinist::Blueprint do
+
+  it "makes an object of the given class" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) { }
+    blueprint.make.should be_an(OpenStruct)
+  end
+
+  it "constructs an attribute from the blueprint" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { "Fred" }
+    end
+    blueprint.make.name.should == "Fred"
+  end
+
+  it "constructs an array for an attribute in the blueprint" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      things(3) { Object.new }
+    end
+    things = blueprint.make.things
+    things.should be_an(Array)
+    things.should have(3).elements
+    things.each {|thing| thing.should be_an(Object) }
+    things.uniq.should == things
+  end
+
+  it "allows passing in attributes to override the blueprint" do
+    block_called = false
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { block_called = true; "Fred" }
+    end
+    blueprint.make(:name => "Bill").name.should == "Bill"
+    block_called.should be_false
+  end
+
+  it "provides a serial number within the blueprint" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { "Fred #{sn}" }
+    end
+    blueprint.make.name.should == "Fred 0001"
+    blueprint.make.name.should == "Fred 0002"
+  end
+
+  it "provides access to the object being constructed within the blueprint" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      title { "Test" }
+      body  { object.title }
+    end
+    blueprint.make.body.should == "Test"
+  end
+
+  it "allows attribute names to be strings" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { "Fred" }
+    end
+    blueprint.make("name" => "Bill").name.should == "Bill"
+  end
+
+  # These are normally a problem because of name clashes with the standard (but
+  # deprecated) Ruby methods. This test makes sure we work around this.
+  it "works with type and id attributes" do
+    klass = Class.new do
+      attr_accessor :id, :type
+    end
+    blueprint = Machinist::Blueprint.new(klass) do
+      id   { "custom id" }
+      type { "custom type" }
+    end
+    object = blueprint.make
+    object.id.should == "custom id"
+    object.type.should == "custom type"
+  end
+
+end

data/spec/exceptions_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Machinist, "exceptions" do
+
+  describe Machinist::BlueprintCantSaveError do
+    it "presents the right message" do
+      blueprint = Machinist::Blueprint.new(String) { }
+      exception = Machinist::BlueprintCantSaveError.new(blueprint)
+      exception.message.should == "make! is not supported by blueprints for class String"
+    end
+  end
+
+  describe Machinist::NoBlueprintError do
+    it "presents the right message" do
+      exception = Machinist::NoBlueprintError.new(String, :master)
+      exception.message.should == "No master blueprint defined for class String"
+    end
+  end
+
+end

data/spec/inheritance_spec.rb

@@ -0,0 +1,104 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'ostruct'
+
+module InheritanceSpecs
+  class Grandpa
+    extend Machinist::Machinable
+    attr_accessor :name, :age
+  end
+  
+  class Dad < Grandpa
+    extend Machinist::Machinable
+    attr_accessor :name, :age
+  end
+
+  class Son < Dad
+    extend Machinist::Machinable
+    attr_accessor :name, :age
+  end
+end
+
+describe Machinist::Blueprint do
+
+  describe "explicit inheritance" do
+    it "inherits attributes from the parent blueprint" do
+      parent_blueprint = Machinist::Blueprint.new(OpenStruct) do
+        name { "Fred" }
+        age  { 97 }
+      end
+
+      child_blueprint = Machinist::Blueprint.new(OpenStruct, :parent => parent_blueprint) do
+        name { "Bill" } 
+      end
+
+      child = child_blueprint.make
+      child.name.should == "Bill"
+      child.age.should == 97
+    end
+
+    it "takes the serial number from the parent" do
+      parent_blueprint = Machinist::Blueprint.new(OpenStruct) do
+        parent_serial { sn }
+      end
+
+      child_blueprint = Machinist::Blueprint.new(OpenStruct, :parent => parent_blueprint) do
+        child_serial { sn }
+      end
+
+      parent_blueprint.make.parent_serial.should == "0001"
+      child_blueprint.make.child_serial.should == "0002"
+      parent_blueprint.make.parent_serial.should == "0003"
+    end
+  end
+
+  describe "class inheritance" do
+    before(:each) do
+      [InheritanceSpecs::Grandpa, InheritanceSpecs::Dad, InheritanceSpecs::Son].each(&:clear_blueprints!)
+    end
+
+    it "inherits blueprinted attributes from the parent class" do
+      InheritanceSpecs::Dad.blueprint do
+        name { "Fred" }
+      end
+      InheritanceSpecs::Son.blueprint { }
+      InheritanceSpecs::Son.make.name.should == "Fred"
+    end
+
+    it "overrides blueprinted attributes in the child class" do
+      InheritanceSpecs::Dad.blueprint do
+        name { "Fred" }
+      end
+      InheritanceSpecs::Son.blueprint do
+        name { "George" }
+      end
+      InheritanceSpecs::Dad.make.name.should == "Fred"
+      InheritanceSpecs::Son.make.name.should == "George"
+    end
+
+    it "inherits from blueprinted attributes in ancestor class" do
+      InheritanceSpecs::Grandpa.blueprint do
+        name { "Fred" }
+      end
+      InheritanceSpecs::Son.blueprint { }
+      InheritanceSpecs::Grandpa.make.name.should == "Fred"
+      lambda { InheritanceSpecs::Dad.make }.should raise_error(RuntimeError)
+      InheritanceSpecs::Son.make.name.should == "Fred"
+    end
+
+    it "follows inheritance for named blueprints correctly" do
+      InheritanceSpecs::Dad.blueprint do
+        name { "John" }
+        age  { 56 }
+      end
+      InheritanceSpecs::Dad.blueprint(:special) do
+        name { "Paul" }
+      end
+      InheritanceSpecs::Son.blueprint(:special) do
+        age { 37 }
+      end
+      InheritanceSpecs::Son.make(:special).name.should == "John"
+      InheritanceSpecs::Son.make(:special).age.should == 37
+    end
+  end
+
+end

data/spec/machinable_spec.rb

@@ -0,0 +1,101 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+module MachinableSpecs
+  class Post
+    extend Machinist::Machinable
+    attr_accessor :title, :body, :comments
+  end
+
+  class Comment
+    extend Machinist::Machinable
+    attr_accessor :post, :title
+  end
+end
+
+describe Machinist::Machinable do
+
+  before(:each) do
+    MachinableSpecs::Post.clear_blueprints!
+  end
+
+  it "makes an object" do
+    MachinableSpecs::Post.blueprint do
+      title { "First Post" }
+    end
+
+    post = MachinableSpecs::Post.make
+    post.should be_a(MachinableSpecs::Post)
+    post.title.should == "First Post"
+  end
+
+  it "makes an object from a named blueprint" do
+    MachinableSpecs::Post.blueprint do
+      title { "First Post" }
+      body  { "Woot!" }
+    end
+
+    MachinableSpecs::Post.blueprint(:extra) do
+      title { "Extra!" }
+    end
+
+    post = MachinableSpecs::Post.make(:extra)
+    post.should be_a(MachinableSpecs::Post)
+    post.title.should == "Extra!"
+    post.body.should == "Woot!"
+  end
+
+  it "makes an array of objects" do
+    MachinableSpecs::Post.blueprint do
+      title { "First Post" }
+    end
+
+    posts = MachinableSpecs::Post.make(3)
+    posts.should be_an(Array)
+    posts.should have(3).elements
+    posts.each do |post|
+      post.should be_a(MachinableSpecs::Post)
+      post.title.should == "First Post"
+    end
+  end
+
+  it "makes array attributes from the blueprint" do
+    MachinableSpecs::Comment.blueprint { }
+    MachinableSpecs::Post.blueprint do 
+      comments(3) { MachinableSpecs::Comment.make }
+    end
+
+    post = MachinableSpecs::Post.make
+    post.comments.should be_a(Array)
+    post.comments.should have(3).elements
+    post.comments.each do |comment|
+      comment.should be_a(MachinableSpecs::Comment)
+    end
+  end
+
+  it "fails without a blueprint" do
+    expect do
+      MachinableSpecs::Post.make
+    end.should raise_error(Machinist::NoBlueprintError) do |exception|
+      exception.klass.should == MachinableSpecs::Post
+      exception.name.should  == :master
+    end
+
+    expect do
+      MachinableSpecs::Post.make(:some_name)
+    end.should raise_error(Machinist::NoBlueprintError) do |exception|
+      exception.klass.should == MachinableSpecs::Post
+      exception.name.should  == :some_name
+    end
+  end
+
+  it "fails when calling make! on an unsavable object" do
+    MachinableSpecs::Post.blueprint { }
+
+    expect do
+      MachinableSpecs::Post.make!
+    end.should raise_error(Machinist::BlueprintCantSaveError) do |exception|
+      exception.blueprint.klass.should == MachinableSpecs::Post
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,9 +1,7 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH.unshift File.dirname(__FILE__)
+
 require 'rubygems'
 require 'test/unit'
-require 'spec'
-require 'sham'
-
-Spec::Runner.configure do |config|
-  config.before(:each) { Sham.reset }
-end
+require 'rspec'
+require 'machinist'