machinist 1.0.6 → 2.0.0.beta1

data/spec/blueprint_spec.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'ostruct'
+
+describe Machinist::Blueprint do
+
+  it "should make an object of the given class" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) { }
+    blueprint.make.should be_an(OpenStruct)
+  end
+
+  it "should construct an attribute in the blueprint" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { "Fred" }
+    end
+    blueprint.make.name.should == "Fred"
+  end
+
+  it "should construct 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 "should allow 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 "should provide 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 "should provide 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 "should allow attribute names to be strings" do
+    blueprint = Machinist::Blueprint.new(OpenStruct) do
+      name { "Fred" }
+    end
+    blueprint.make("name" => "Bill").name.should == "Bill"
+  end
+
+  it "should work 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 "should present 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 "should present 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 "should inherit 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 "should take 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 "should inherit 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 "should override 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 "should inherit 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 "should follow 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 "should make 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 "should make 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 "should make 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 "should make 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 "should fail 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 "should fail 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/shop_spec.rb

@@ -0,0 +1,94 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require 'support/active_record_environment'
+
+describe Machinist::Shop do
+
+  before(:each) do
+    @shop = Machinist::Shop.new
+  end
+
+  def fake_a_test
+    ActiveRecord::Base.transaction do
+      @shop.restock
+      yield
+      raise ActiveRecord::Rollback
+    end
+  end
+  
+  it "should cache an object" do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test { post_a = @shop.buy(blueprint) }
+    fake_a_test { post_b = @shop.buy(blueprint) }
+
+    post_b.should == post_a
+    post_b.should_not equal(post_a)
+  end
+  
+  it "should cache an object with attributes" do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test { post_a = @shop.buy(blueprint, :title => "Test Title") }
+    fake_a_test { post_b = @shop.buy(blueprint, :title => "Test Title") }
+
+    post_b.should == post_a
+    post_b.should_not equal(post_a)
+  end
+
+  it "should not confuse objects with different blueprints" do
+    blueprint_a = Machinist::ActiveRecord::Blueprint.new(Post) { }
+    blueprint_b = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test { post_a = @shop.buy(blueprint_a) }
+    fake_a_test { post_b = @shop.buy(blueprint_b) }
+
+    post_b.should_not == post_a
+  end
+
+  it "should not confuse objects with the same blueprint but different attributes" do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test { post_a = @shop.buy(blueprint, :title => "A Title") }
+    fake_a_test { post_b = @shop.buy(blueprint, :title => "Not A Title") }
+
+    post_b.should_not == post_a
+  end
+
+  it "should cache multiple similar objects" do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test do
+      post_a = @shop.buy(blueprint, :title => "Test Title")
+      post_b = @shop.buy(blueprint, :title => "Test Title")
+      post_b.should_not == post_a
+    end
+
+    fake_a_test do
+      @shop.buy(blueprint, :title => "Test Title").should == post_a
+      @shop.buy(blueprint, :title => "Test Title").should == post_b
+      post_c = @shop.buy(blueprint, :title => "Test Title")
+      post_c.should_not == post_a
+      post_c.should_not == post_b
+    end
+  end
+  
+  it "should ensure future copies of a cached object do not reflect changes to the original" do
+    blueprint = Machinist::ActiveRecord::Blueprint.new(Post) { }
+
+    post_a, post_b = nil, nil
+    fake_a_test do
+      post_a = @shop.buy(blueprint, :title => "Test Title")
+      post_a.title = "Changed Title"
+      post_a.save!
+    end
+    fake_a_test { post_b = @shop.buy(blueprint, :title => "Test Title") }
+
+    post_b.title.should == "Test Title"
+  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'

data/spec/support/active_record_environment.rb

@@ -0,0 +1,65 @@
+require 'active_record'
+require 'machinist/active_record'
+
+ActiveRecord::Base.establish_connection(
+  :adapter  => "mysql",
+  :database => "machinist",
+  :username => "root",
+  :password => ""
+)
+
+ActiveRecord::Schema.define(:version => 0) do
+  create_table :users, :force => true do |t|
+    t.column :username, :string
+  end
+
+  create_table :posts, :force => true do |t|
+    t.column :title, :string
+    t.column :author_id, :integer
+    t.column :body, :text
+  end
+
+  create_table :comments, :force => true do |t|
+    t.column :post_id, :integer
+    t.column :body, :text
+  end
+
+  create_table :tags, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :posts_tags, :id => false, :force => true do |t|
+    t.column :post_id, :integer
+    t.column :tag_id, :integer
+  end
+end
+
+class User < ActiveRecord::Base
+  validates_presence_of :username
+  validates_uniqueness_of :username
+end
+
+class Post < ActiveRecord::Base
+  has_many :comments
+  belongs_to :author, :class_name => "User"
+  has_and_belongs_to_many :tags
+end
+
+class Comment < ActiveRecord::Base
+  belongs_to :post
+end
+
+class Tag < ActiveRecord::Base
+  has_and_belongs_to_many :posts
+end
+
+module ActiveRecordEnvironment
+
+  def empty_database!
+    [User, Post, Comment].each do |klass|
+      klass.delete_all
+      klass.clear_blueprints!
+    end
+  end
+
+end