blueprints 0.1.1 → 0.2.0

data/README.rdoc

@@ -4,27 +4,27 @@ Another replacement for factories and fixtures that focuses on being DRY and mak
 
 == Usage
 
-Plans look like:
+Blueprints look like this:
 
-    plan :apple do
+    blueprint :apple do
       Fruit.create! :species => 'apple'
     end
 
-    plan :orange do
+    blueprint :orange do
       Fruit.create! :species => 'orange'
     end
 
-    plan :fruitbowl => [:apple, :orange] do
+    blueprint :fruitbowl => [:apple, :orange] do
       FruitBowl.create! :fruit => [@apple,@orange]
     end
 
-    plan :kitchen => :fruitbowl do
+    blueprint :kitchen => :fruitbowl do
       Kitchen.create! :fruitbowl => @fruitbowl
     end
 
 ...and you use them in specs like:
 
-    describe Fruit, "@apple" do
+    describe Fruit, "apple" do
       before do
         build :apple
       end
@@ -44,23 +44,26 @@ Plans look like:
       end
     end
 
-Result of 'plan' block is evaluated and assigned to instance variable with the same name. You can also assign your own instance variables
-inside 'plan' block and they will be accessible in tests that build this plan.
+Result of 'blueprint' block is assigned to an instance variable with the same name. You can also assign your own instance variables
+inside 'blueprint' block and they will be accessible in tests that build this blueprint.
 
-All scenarios are run only once, no matter how many times they were called, meaning that you don't need to worry about
-duplicating data.
+Instead of SomeModel.create! you can also use SomeModel.blueprint, which does the same thing but also bypasses attr_protected
+and attr_accessible restrictions (which is what you usually want in tests).
+
+There's also a shorthand for these type of scenarios:
+
+    blueprint :something do
+      @something = SomeModel.blueprint :field => 'value'
+    end
+
+You can just type:
 
-There's also a possibility to delete preloaded data with demolish. When called without arguments it will drop all data.
-You can also pass it table names, that will be cleared of any data. Beware that any scenarios already executed will still be
-marked as executed, so you won't be able to execute them again. If you want to execute those scenarios later in test, you
-can pass :undo option with list of scenarios to mark as not executed or :all if you want to mark that no scenario has been executed.
+    SomeModel.blueprint :something, :field => 'value'
 
-    demolish :fruits, :trees # Deletes trees and fruits tables
-    demolish # Deletes all data except tables that are defined by Hornsby.skip_tables
-    demolish :fruits, :undo => :apples # Deletes fruits table and marks :apples scenario as not executed
-    demolish :undo => :all # Deletes all tables and marks all scenario as not executed (fresh start)
+All blueprints are run only once, no matter how many times they were called, meaning that you don't need to worry about
+duplicating data.
 
-Blueprints searches for scenario files in this particular order in Rails (Merb) root:
+Blueprints searches for blueprints files in this particular order in Rails (Merb) root:
 * blueprints.rb
 * blueprints/*.rb
 * blueprint.rb
@@ -79,22 +82,23 @@ You can pass :root option to override framework root and :filename option to pas
 
 The easiest way to install this gem for Ruby on Rails is just add this line to config/environment.rb (or config/environments/test.rb):
 
-    config.gem 'sinsiliux-blueprints', :lib => 'blueprints', :source => 'http://gems.github.com'
+    config.gem 'blueprints', :source => 'http://gemcutter.org'
 
 If you’re not using rails, then you can install it through command line
 
-    gem sources -a http://gems.github.com
-    sudo gem install sinsiliux-blueprints
+    gem sources -a http://gemcutter.org
+    sudo gem install blueprints
 
 Lastly you could use it as plugin:
 
     ruby script/plugin install git://github.com/sinsiliux/blueprints.git
 
-Hornsby scenarios is activated by calling enable_blueprints. For specifics on how to call that in your testing framework see a little lower.
-enable_blueprintssupports these parameters:
-* root - custom framework root if automatic detection fails for some reason (eg. not rails/merb project)
-* filename - custom files pattern with blueprints plans
-* prebuild - list of blueprints plans that should be preloaded (available in all tests, never reloaded so they're much faster)
+Blueprints is activated by calling enable_blueprints. For specifics on how to call that in your testing framework see a little lower.
+enable_blueprints supports these parameters:
+* :root - custom framework root if automatic detection fails for some reason (eg. not rails/merb project)
+* :filename - custom files pattern with blueprints plans
+* :prebuild - list of blueprints plans that should be preloaded (available in all tests, never reloaded so they're much faster)
+* :delete_policy - set custom delete policy when deleting everything from tables (before test suite or when calling demolish). Can be :truncate or :delete, defaults to :delete
 
 === RSpec
 

data/lib/blueprints.rb

@@ -2,6 +2,7 @@ require File.join(File.dirname(__FILE__), 'blueprints/plan')
 require File.join(File.dirname(__FILE__), 'blueprints/file_context')
 require File.join(File.dirname(__FILE__), 'blueprints/helper')
 require File.join(File.dirname(__FILE__), 'blueprints/errors')
+require File.join(File.dirname(__FILE__), 'blueprints/ar_extensions')
 if defined? Spec
   require File.join(File.dirname(__FILE__), 'blueprints/rspec_extensions')
 else

data/lib/blueprints/ar_extensions.rb

@@ -0,0 +1,20 @@
+require 'active_record'
+
+module ActiveRecord
+  class Base
+    def self.blueprint(*args)
+      options = args.extract_options!
+      if args.present?
+        klass = self
+        Blueprints::Plan.new(*args) do
+          klass.blueprint options
+        end
+      else
+        returning(self.new) do |object|
+          options.each {|attr, value| object.send("#{attr}=", value)}
+          object.save!
+        end
+      end
+    end
+  end
+end

data/spec/blueprints.rb

@@ -32,4 +32,10 @@ blueprint :cherry_basket => [:big_cherry, :cherry] do
   [@cherry, @big_cherry]
 end
 
-blueprint :parent_not_existing => :not_existing
+blueprint :parent_not_existing => :not_existing
+
+Tree.blueprint :oak, :name => 'Oak', :size => 'large'
+
+blueprint :pine do
+  @the_pine = Tree.blueprint :name => 'Pine', :size => 'medium'
+end

data/spec/blueprints_spec.rb

@@ -125,21 +125,21 @@ describe Blueprints do
 
   describe 'delete policies' do
     before do
-      Blueprints::Plan.plans.should_receive(:empty?).and_return(true)
-      Blueprints.should_receive(:load_scenarios_files).with(Blueprints::PLAN_FILES)
-      Blueprints::Plan.should_receive(:prebuild).with(nil)
+      Blueprints::Plan.plans.expects(:empty?).returns(true)
+      Blueprints.expects(:load_scenarios_files).with(Blueprints::PLAN_FILES)
+      Blueprints::Plan.expects(:prebuild).with(nil)
     end
 
     it "should allow using custom delete policy" do
-      ActiveRecord::Base.connection.should_receive(:delete).with("TRUNCATE fruits")
-      ActiveRecord::Base.connection.should_receive(:delete).with("TRUNCATE trees")
+      ActiveRecord::Base.connection.expects(:delete).with("TRUNCATE fruits")
+      ActiveRecord::Base.connection.expects(:delete).with("TRUNCATE trees")
 
       Blueprints.load(:delete_policy => :truncate)
     end
 
     it "should default to :delete policy if unexisting policy given" do
-      ActiveRecord::Base.connection.should_receive(:delete).with("DELETE FROM fruits")
-      ActiveRecord::Base.connection.should_receive(:delete).with("DELETE FROM trees")
+      ActiveRecord::Base.connection.expects(:delete).with("DELETE FROM fruits")
+      ActiveRecord::Base.connection.expects(:delete).with("DELETE FROM trees")
 
       Blueprints.load(:delete_policy => :ukndown)
     end
@@ -203,6 +203,22 @@ describe Blueprints do
     end
   end
 
+  describe 'with active record blueprints extensions' do
+    it "should build oak correctly" do
+      build :oak
+      @oak.should_not be_nil
+      @oak.name.should == 'Oak'
+      @oak.size.should == 'large'
+    end
+
+    it "should build pine correctly" do
+      build :pine
+      @the_pine.should_not be_nil
+      @the_pine.name.should == 'Pine'
+      @the_pine.size.should == 'medium'
+    end
+  end
+
 #describe "with pitted namespace" do
 #  before do
 #    Hornsby.build('pitted:peach').copy_ivars(self)

data/spec/db/schema.rb

@@ -6,5 +6,6 @@ ActiveRecord::Schema.define(:version => 0) do
 
   create_table :trees, :force => true do |t|
     t.string :name
+    t.string :size
   end
 end

data/spec/spec_helper.rb

@@ -19,5 +19,6 @@ require 'spec/db/fruit'
 require 'spec/db/tree'
 
 Spec::Runner.configure do |config|
+  config.mock_with :mocha
   config.enable_blueprints :root => File.expand_path(File.join(File.dirname(__FILE__), '..')), :prebuild => :big_cherry
 end

data/test/blueprints_test.rb

@@ -123,6 +123,28 @@ class BlueprintsTest < ActiveSupport::TestCase
     end
   end
 
+  context 'delete policies' do
+    setup do
+      Blueprints::Plan.plans.expects(:empty?).returns(true)
+      Blueprints.expects(:load_scenarios_files).with(Blueprints::PLAN_FILES)
+      Blueprints::Plan.expects(:prebuild).with(nil)
+    end
+
+    should "allow using custom delete policy" do
+      ActiveRecord::Base.connection.expects(:delete).with("TRUNCATE fruits")
+      ActiveRecord::Base.connection.expects(:delete).with("TRUNCATE trees")
+
+      Blueprints.load(:delete_policy => :truncate)
+    end
+
+    should "default to :delete policy if unexisting policy given" do
+      ActiveRecord::Base.connection.expects(:delete).with("DELETE FROM fruits")
+      ActiveRecord::Base.connection.expects(:delete).with("DELETE FROM trees")
+
+      Blueprints.load(:delete_policy => :ukndown)
+    end
+  end
+
   context 'with many apples scenario' do
     setup do
       build :many_apples, :cherry, :cherry_basket

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require 'activerecord'
 require 'test/unit'
 require 'active_record/test_case'
 require 'shoulda'
+require 'mocha'
 begin
   require 'mysqlplus'
 rescue LoadError

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: blueprints
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Andrius Chamentauskas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-27 00:00:00 +03:00
+date: 2009-10-01 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -36,6 +36,7 @@ files:
 - lib/blueprints/file_context.rb
 - lib/blueprints/helper.rb
 - lib/blueprints/plan.rb
+- lib/blueprints/ar_extensions.rb
 - lib/blueprints/rspec_extensions.rb
 - lib/blueprints/test_unit_extensions.rb
 - README.rdoc