sinsiliux-hornsby 0.2.5 → 0.3.0

data/README.rdoc

@@ -47,6 +47,16 @@ Scenarios look like:
 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.
 
+There's also a possibility to delete preloaded data with hornsby_clear. 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.
+
+    hornsby_clear :fruits, :trees # Deletes trees and fruits tables
+    hornsby_clear # Deletes all data except tables that are defined by Hornsby.skip_tables
+    hornsby_clear :fruits, :undo => :apples # Deletes fruits table and marks :apples scenario as not executed
+    hornsby_clear :undo => :all # Deletes all tables and marks all scenario as not executed (fresh start)
+
 == Setup
 
 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):
@@ -62,6 +72,8 @@ Lastly you could use it as plugin:
 
     ruby script/plugin install git://github.com/sinsiliux/hornsby.git
 
+=== RSpec
+
 Add the following to spec_helper.rb
 
     Spec::Runner.configure do |config|
@@ -74,6 +86,25 @@ configure_rspec supports two parameters:
 * filename - file with hornsby scenarios (by default Rails.root/spec/hornsby_scenarios.rb)
 * scenarios - list of hornsby scenarios that should be preloaded (available in all tests, never reloaded so they're much faster)
 
+=== Test::Unit
+
+Add the following lines to test_helper.rb
+
+    Hornsby.load(:filename => File.join('..', 'spec', 'hornsby_scenario.rb'), :scenarios => :preloaded_scenario)
+    class ActiveSupport::TestCase
+      include HornsbyHelper
+
+      def setup
+        Hornsby.setup(self)
+      end
+
+      def teardown
+        Hornsby.teardown
+      end
+    end
+
+Hornsby.load supports same options as configure_rspec.
+
 == Advanced Usage
 
 Its just ruby, right? So go nuts:

data/lib/hornsby.rb

@@ -8,6 +8,7 @@ class Hornsby
   end
 
   cattr_reader :scenarios
+  cattr_accessor :executed_scenarios
   # @@namespaces = {}
   @@scenarios = {}
   @@executed_scenarios = Set.new
@@ -17,29 +18,43 @@ class Hornsby
   @@context = nil
 
   def self.configure_rspec(config, options = {})
-    load(options[:filename])
-
-    @@context = @@global_context
-    @@global_scenarios = Hornsby.build(options[:scenarios]) if options[:scenarios]
-    @@global_executed_scenarios = @@executed_scenarios.to_a
-
-    config.include(HornsbySpecHelper)
+    load(options)
 
+    config.include(HornsbyHelper)
     config.before do
-      Hornsby.send(:class_variable_set, '@@context', Hornsby.send(:class_variable_get, '@@global_context').clone)
-      Hornsby.send(:class_variable_set, '@@executed_scenarios', Set.new(Hornsby.send(:class_variable_get, '@@global_executed_scenarios')))
-      Hornsby.copy_ivars(self, true)
-      ActiveRecord::Base.connection.increment_open_transactions
-      ActiveRecord::Base.connection.transaction_joinable = false
-      ActiveRecord::Base.connection.begin_db_transaction
+      Hornsby.setup(self)
     end
-
     config.after do
-      ActiveRecord::Base.connection.rollback_db_transaction
-      ActiveRecord::Base.connection.decrement_open_transactions
+      Hornsby.teardown
+    end
+  end
+
+  def self.configure_test(config, options)
+    load(options)
+    
+    config.send(:include, HornsbyHelper)
+    config.setup do
+      Hornsby.setup(self)
+    end
+    config.teardown do
+      Hornsby.teardown
     end
   end
 
+  def self.setup(current_context)
+    @@context = @@global_context.clone
+    @@executed_scenarios = Set.new(@@global_executed_scenarios)
+    copy_ivars(current_context, true)
+    ActiveRecord::Base.connection.increment_open_transactions
+    ActiveRecord::Base.connection.transaction_joinable = false
+    ActiveRecord::Base.connection.begin_db_transaction
+  end
+
+  def self.teardown
+    ActiveRecord::Base.connection.rollback_db_transaction
+    ActiveRecord::Base.connection.decrement_open_transactions
+  end
+
   def self.build(*names)
     scenarios = names.map {|name| @@scenarios[name.to_sym] or raise "scenario #{name} not found"}
 
@@ -49,20 +64,25 @@ class Hornsby
   def self.[](name)
   end
 
-  def self.load(scenarios_file=nil)
+  def self.load(options = {})
     return unless @@scenarios.empty?
 
     delete_tables
-    scenarios_file ||= File.join(framework_root, 'spec', 'hornsby_scenarios.rb')
+    scenarios_file = options[:filename] || File.join(framework_root, 'spec', 'hornsby_scenarios.rb')
     self.module_eval File.read(scenarios_file)
+
+    @@context = @@global_context
+    @@global_scenarios = Hornsby.build(options[:scenarios]) if options[:scenarios]
+    @@global_executed_scenarios = @@executed_scenarios.to_a
   end
 
   def self.scenario(scenario, &block)
     self.new(scenario, &block)
   end
 
-  def self.delete_tables
-    tables.each { |t| ActiveRecord::Base.connection.delete(@@delete_sql % t)  }
+  def self.delete_tables(*args)
+    args = tables if args.blank?
+    args.each { |t| ActiveRecord::Base.connection.delete(@@delete_sql % t)  }
   end
 
   def self.tables
@@ -134,13 +154,24 @@ class Hornsby
 end
 
 
-module HornsbySpecHelper
+module HornsbyHelper
   def hornsby_scenario(*names)
     Hornsby.build(*names)
     Hornsby.copy_ivars(self)
   end
 
-  def hornsby_clear
-    Hornsby.delete_tables
+  def hornsby_clear(*args)
+    options = args.extract_options!
+    Hornsby.delete_tables(*args)
+
+    if options[:undo] == :all
+      Hornsby.executed_scenarios.clear
+    else
+      undo = [options[:undo]].flatten.compact
+      unless (not_found = undo - Hornsby.executed_scenarios.to_a).blank?
+        raise(ArgumentError, "Scenario(s) #{not_found} not found")
+      end
+      Hornsby.executed_scenarios -= undo
+    end
   end
 end

data/spec/db/schema.rb

@@ -3,4 +3,8 @@ ActiveRecord::Schema.define(:version => 0) do
     t.string :species
     t.integer :average_diameter
   end
+
+  create_table :trees, :force => true do |t|
+    t.string :name
+  end
 end

data/spec/hornsby_spec.rb

@@ -1,130 +1,167 @@
 require File.dirname(__FILE__) + '/spec_helper'
 
-describe Hornsby, "with just_apple scenario" do
-  before do
-    hornsby_scenario :just_apple
-  end
-  
-  it "should create @apple" do
-    @apple.should_not be_nil
-  end
-  
-  it "should create Fruit @apple" do
-    @apple.should be_instance_of(Fruit)
-  end
-  
-  it "should not create @banana" do
-    @banana.should be_nil
-  end
-  
-  it "should have correct species" do
-    @apple.species.should == 'apple'
-  end
-end
+describe Hornsby do
+  describe "with just_apple scenario" do
+    before do
+      hornsby_scenario :just_apple
+    end
 
-describe Hornsby, "with bananas_and_apples scenario" do
-  before do
-    hornsby_scenario :bananas_and_apples
-  end
-  
-  it "should have correct @apple species" do
-    @apple.species.should == 'apple'
-  end
-  
-  it "should have correct @banana species" do
-    @banana.species.should == 'banana'
-  end
-end
+    it "should create @apple" do
+      @apple.should_not be_nil
+    end
 
-describe Hornsby, "with fruit scenario" do
-  before do
-    hornsby_scenario :fruit
-  end
+    it "should create Fruit @apple" do
+      @apple.should be_instance_of(Fruit)
+    end
 
-  it "should have 2 fruits" do
-    @fruit.should have(2).items
-  end
-  
-  it "should have an @apple" do
-    @apple.species.should == 'apple'
-  end
-  
-  it "should have an @orange" do
-    @orange.species.should == 'orange'
-  end
-  
-  it "should have no @banana" do
-    @banana.should be_nil
-  end
-end
+    it "should not create @banana" do
+      @banana.should be_nil
+    end
 
-describe Hornsby, 'with preloaded cherry scenario' do
-  it "should have correct size after changed by second test" do
-    @cherry.average_diameter.should == 3
-    @cherry.update_attribute(:average_diameter, 1)
-    @cherry.average_diameter.should == 1
+    it "should have correct species" do
+      @apple.species.should == 'apple'
+    end
   end
 
-  it "should have correct size" do
-    @cherry.average_diameter.should == 3
-    @cherry.update_attribute(:average_diameter, 5)
-    @cherry.average_diameter.should == 5
-  end
+  describe "with bananas_and_apples scenario" do
+    before do
+      hornsby_scenario :bananas_and_apples
+    end
 
-  it "should create big cherry" do
-    @big_cherry.species.should == 'cherry'
-  end
+    it "should have correct @apple species" do
+      @apple.species.should == 'apple'
+    end
 
-  it "should clear scenarios when calling hornsby_clear" do
-    hornsby_clear
-    Fruit.count.should == 0
+    it "should have correct @banana species" do
+      @banana.species.should == 'banana'
+    end
   end
-end
 
-describe Hornsby, 'with many apples scenario' do
-  before do
-    hornsby_scenario :many_apples, :cherry, :cherry_basket
-  end
+  describe "with fruit scenario" do
+    before do
+      hornsby_scenario :fruit
+    end
+
+    it "should have 2 fruits" do
+      @fruit.should have(2).items
+    end
+
+    it "should have an @apple" do
+      @apple.species.should == 'apple'
+    end
 
-  it "should create only one apple" do
-    Fruit.all(:conditions => 'species = "apple"').size.should == 1
+    it "should have an @orange" do
+      @orange.species.should == 'orange'
+    end
+
+    it "should have no @banana" do
+      @banana.should be_nil
+    end
   end
 
-  it "should create only two cherries even if they were preloaded" do
-    Fruit.all(:conditions => 'species = "cherry"').size.should == 2
+  describe 'with preloaded cherry scenario' do
+    it "should have correct size after changed by second test" do
+      @cherry.average_diameter.should == 3
+      @cherry.update_attribute(:average_diameter, 1)
+      @cherry.average_diameter.should == 1
+    end
+
+    it "should have correct size" do
+      @cherry.average_diameter.should == 3
+      @cherry.update_attribute(:average_diameter, 5)
+      @cherry.average_diameter.should == 5
+    end
+
+    it "should create big cherry" do
+      @big_cherry.species.should == 'cherry'
+    end
   end
 
-  it "should contain cherries in basket if basket is loaded in test and cherries preloaded" do
-    @basket.should == [@cherry, @big_cherry]
+  describe 'hornsby_clear' do
+    before do
+      hornsby_scenario :just_apple
+    end
+
+    it "should clear scenarios when calling hornsby_clear" do
+      hornsby_clear
+      Fruit.count.should == 0
+    end
+
+    it "should clear only tables passed" do
+      Tree.create!(:name => 'oak')
+      hornsby_clear :fruits
+      Tree.count.should == 1
+      Fruit.count.should == 0
+    end
+
+    it "should mark scenarios as undone when passed :undone option" do
+      hornsby_scenario :fruit
+      hornsby_clear :undo => [:just_apple]
+      Fruit.count.should == 0
+      hornsby_scenario :fruit
+      Fruit.count.should == 1
+    end
+
+    it "should mark all scenarios as undone when passed :undone option as :all" do
+      hornsby_scenario :fruit
+      hornsby_clear :undo => :all
+      Fruit.count.should == 0
+      hornsby_scenario :fruit
+      Fruit.count.should == 2
+    end
+
+    it "should raise error when not executed scenarios passed to :undo option" do
+      lambda {
+        hornsby_clear :undo => :just_orange
+      }.should raise_error(ArgumentError)
+    end
   end
-end
 
-describe Hornsby, 'transactions' do
-  before do
-    hornsby_scenario :just_apple
+  describe 'with many apples scenario' do
+    before do
+      hornsby_scenario :many_apples, :cherry, :cherry_basket
+    end
+
+    it "should create only one apple" do
+      Fruit.all(:conditions => 'species = "apple"').size.should == 1
+    end
+
+    it "should create only two cherries even if they were preloaded" do
+      Fruit.all(:conditions => 'species = "cherry"').size.should == 2
+    end
+
+    it "should contain cherries in basket if basket is loaded in test and cherries preloaded" do
+      @basket.should == [@cherry, @big_cherry]
+    end
   end
 
-  it "should drop only inner transaction" do
-    @apple.reload.should_not be_nil
-    begin
-      ActiveRecord::Base.transaction do
-        f = Fruit.create(:species => 'orange')
-        f.reload.should_not be_nil
-        raise 'some error'
+  describe 'transactions' do
+    before do
+      hornsby_scenario :just_apple
+    end
+
+    it "should drop only inner transaction" do
+      @apple.reload.should_not be_nil
+      begin
+        ActiveRecord::Base.transaction do
+          f = Fruit.create(:species => 'orange')
+          f.reload.should_not be_nil
+          raise 'some error'
+        end
+      rescue
       end
-    rescue
+      @apple.reload.should_not be_nil
+      Fruit.find_by_species('orange').should be_nil
     end
-    @apple.reload.should_not be_nil
-    Fruit.find_by_species('orange').should be_nil
   end
-end
 
-#describe Hornsby, "with pitted namespace" do
+#describe "with pitted namespace" do
 #  before do
 #    Hornsby.build('pitted:peach').copy_ivars(self)
 #  end
-  
+
 #  it "should have @peach" do
 #    @peach.species.should == 'peach'
 #  end
 #end
+end

data/spec/spec_helper.rb

@@ -18,6 +18,7 @@ load(File.join("db", "schema.rb"))
 require 'spec/autorun'
 require '../lib/hornsby'
 require 'db/fruit'
+require 'db/tree'
 
 Spec::Runner.configure do |config|
   Hornsby.configure_rspec(config, :filename => File.join('hornsby_scenario.rb'), :scenarios => :big_cherry)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinsiliux-hornsby
 version: !ruby/object:Gem::Version 
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors: 
 - Andrius Chamentauskas
@@ -13,16 +13,6 @@ cert_chain: []
 date: 2009-05-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.0
-    version: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
   type: :runtime