sinsiliux-hornsby 0.3.0 → 0.4.0

data/README.rdoc

@@ -57,6 +57,21 @@ can pass :undo option with list of scenarios to mark as not executed or :all if
     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)
 
+Hornsby searches for scenario files in this particular order in Rails (Merb) root:
+* hornsby_scenarios.rb
+* hornsby_scenarios/*.rb
+* hornsby_scenario.rb
+* hornsby_scenario/*.rb
+* spec/hornsby_scenarios.rb
+* spec/hornsby_scenarios/*.rb
+* spec/hornsby_scenario.rb
+* spec/hornsby_scenario/*.rb
+* test/hornsby_scenarios.rb
+* test/hornsby_scenarios/*.rb
+* test/hornsby_scenario.rb
+* test/hornsby_scenario/*.rb
+You can pass :root option to override framework root and :filename option to pass custom filename pattern 
+
 == 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):
@@ -72,6 +87,12 @@ Lastly you could use it as plugin:
 
     ruby script/plugin install git://github.com/sinsiliux/hornsby.git
 
+Hornsby scenarios is activated by calling enable_hornsby. For specifics on how to call that in your testing framework see a little lower.
+enable_hornsby supports these parameters:
+* root - custom framework root if automatic detection fails for some reason (eg. not rails/merb project)
+* filename - custom files pattern with hornsby scenarios
+* scenarios - list of hornsby scenarios that should be preloaded (available in all tests, never reloaded so they're much faster)
+
 === RSpec
 
 Add the following to spec_helper.rb
@@ -79,32 +100,19 @@ Add the following to spec_helper.rb
     Spec::Runner.configure do |config|
       ...
   
-      Hornsby.configure_rspec(config, :filename => 'scenarios.rb', :scenarios => :preloaded_scenario)
+      config.enable_hornsby :filename => 'scenarios.rb', :scenarios => :preloaded_scenario
     end
 
-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
+      enable_hornsby
     end
 
-Hornsby.load supports same options as configure_rspec.
-
 == Advanced Usage
 
 Its just ruby, right? So go nuts:
@@ -130,6 +138,8 @@ If you'd like simply to load your scenarios into a database, use the rake task l
 == TODO
 
 * Add scenario namespaces for better organisation.
+* Add ability to revert one scenario.
+* Add preloading scenarios for whole block of tests.
 
 == Credits
 
@@ -141,4 +151,4 @@ The code is based on Err's code found in this post: http://errtheblog.com/post/7
 
 == License
 
-MIT, see LICENCE
+MIT, see LICENCE

data/lib/hornsby/context.rb

@@ -0,0 +1,15 @@
+class Hornsby
+  module Context
+    def self.execute(&block)
+      module_eval(&block) if block
+    end
+
+    def self.copy_ivars(to, reload = false)
+      instance_variables.each do |iv|
+        v = instance_variable_get(iv)
+        v.reload if reload and v.respond_to?(:reload)
+        to.instance_variable_set(iv, v)
+      end
+    end
+  end
+end

data/lib/hornsby/errors.rb

@@ -0,0 +1,11 @@
+class Hornsby
+  class ScenarioNotFoundError < NameError
+    def initialize(*args)
+      @scenarios = args
+    end
+
+    def to_s
+      "Scenario(s) not found '#{@scenarios.join(',')}'"
+    end
+  end
+end

data/lib/hornsby/helper.rb

@@ -0,0 +1,25 @@
+class Hornsby
+  module Helper
+    def hornsby_scenario(*names)
+      Hornsby.build(*names)
+      Hornsby.copy_ivars(self)
+    end
+
+    alias :hornsby_scenarios :hornsby_scenario 
+
+    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
+end

data/lib/hornsby/rspec_extensions.rb

@@ -0,0 +1,17 @@
+module Spec
+  module Runner
+    class Configuration
+      def enable_hornsby(options = {})
+        Hornsby.load(options)
+
+        include(Hornsby::Helper)
+        before do
+          Hornsby.setup(self)
+        end
+        after do
+          Hornsby.teardown
+        end
+      end
+    end
+  end
+end

data/lib/hornsby/test_unit_extensions.rb

@@ -0,0 +1,17 @@
+module Test
+  module Unit
+    class TestCase
+      def run_with_hornsby(result, &progress_block)
+        Hornsby.setup(self)
+        run_without_hornsby(result, &progress_block)
+        Hornsby.teardown
+      end
+
+      def self.enable_hornsby(options = {})
+        include Hornsby::Helper
+        Hornsby.load(options)
+        alias_method_chain :run, :hornsby
+      end
+    end
+  end
+end

data/lib/hornsby.rb

@@ -1,11 +1,19 @@
-require File.join(File.dirname(__FILE__), 'hornsby_context')
+require File.join(File.dirname(__FILE__), 'hornsby/context')
+require File.join(File.dirname(__FILE__), 'hornsby/helper')
+require File.join(File.dirname(__FILE__), 'hornsby/errors')
+if defined? Spec
+  require File.join(File.dirname(__FILE__), 'hornsby/rspec_extensions')
+else
+  require File.join(File.dirname(__FILE__), 'hornsby/test_unit_extensions')
+end
 
 class Hornsby
-  @@delete_sql = "DELETE FROM %s"
+  SCENARIO_FILES = [nil, 'spec', 'test'].product(['hornsby_scenarios', 'hornsby_scenario']).map do |path|
+    path = File.join(*path.compact)
+    ["#{path}.rb", File.join(path, "*.rb")]
+  end.flatten
 
-  def self.framework_root
-    RAILS_ROOT rescue Rails.root rescue Merb.root rescue ''
-  end
+  @@delete_sql = "DELETE FROM %s"
 
   cattr_reader :scenarios
   cattr_accessor :executed_scenarios
@@ -14,31 +22,15 @@ class Hornsby
   @@executed_scenarios = Set.new
   @@global_executed_scenarios = []
 
-  @@global_context = HornsbyContext
+  @@global_context = Hornsby::Context
   @@context = nil
 
-  def self.configure_rspec(config, options = {})
-    load(options)
-
-    config.include(HornsbyHelper)
-    config.before do
-      Hornsby.setup(self)
-    end
-    config.after do
-      Hornsby.teardown
-    end
+  def self.framework_root
+    @@framework_root ||= RAILS_ROOT rescue Rails.root rescue Merb.root rescue nil
   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
+  def self.configure_rspec(config, options = {})
+    raise '### This is deprecated! Please use config.enable_hornsby instead of Hornsby.configure_rspec(config)'
   end
 
   def self.setup(current_context)
@@ -56,26 +48,37 @@ class Hornsby
   end
 
   def self.build(*names)
-    scenarios = names.map {|name| @@scenarios[name.to_sym] or raise "scenario #{name} not found"}
+    scenarios = names.map {|name| @@scenarios[name.to_sym] or raise ScenarioNotFoundError, name}
 
     scenarios.each {|s| s.build}
   end
 
-  def self.[](name)
-  end
-
   def self.load(options = {})
     return unless @@scenarios.empty?
 
     delete_tables
-    scenarios_file = options[:filename] || File.join(framework_root, 'spec', 'hornsby_scenarios.rb')
-    self.module_eval File.read(scenarios_file)
+    @@framework_root = options[:root] if options[:root]
+    load_scenarios_files(options[:filename] || SCENARIO_FILES)
 
     @@context = @@global_context
     @@global_scenarios = Hornsby.build(options[:scenarios]) if options[:scenarios]
     @@global_executed_scenarios = @@executed_scenarios.to_a
   end
 
+  def self.load_scenarios_files(*patterns)
+    patterns.flatten!
+    patterns.collect! {|pattern| File.join(framework_root, pattern)} if framework_root
+    
+    patterns.each do |pattern|
+      unless (files = Dir.glob(pattern)).empty?
+        files.each{|f| self.module_eval File.read(f)}
+        return
+      end
+    end
+    
+    raise "Scenarios file not found! Put scenarios in #{patterns.join(' or ')} or pass custom filename with :filename option"
+  end
+
   def self.scenario(scenario, &block)
     self.new(scenario, &block)
   end
@@ -100,21 +103,21 @@ class Hornsby
   attr_reader :scenario
 
   def initialize(scenario, &block)
-    case scenario
+    @scenario, @parents = parse_name(scenario)
+    @block = block
+
+    @@scenarios[@scenario] = self
+  end
+
+  def parse_name(name)
+    case name
       when Hash
-        parents = scenario.values.first
-        @parents = Array === parents ? parents : [parents]
-        scenario = scenario.keys.first
+        return name.keys.first.to_sym, [name.values.first].flatten.map{|sc| parse_name(sc).first}
       when Symbol, String
-        @parents = []
+        return name.to_sym, []
       else
-        raise "I don't know how to build `#{scenario.inspect}'"
-    end
-
-    @scenario = scenario.to_sym
-    @block    = block
-
-    @@scenarios[@scenario] = self
+        raise TypeError, "Pass scenarios names as strings or symbols only, cannot build scenario '#{name.inspect}'"
+    end  
   end
 
   def say(*messages)
@@ -134,7 +137,7 @@ class Hornsby
 
   def build_parent_scenarios(context)
     @parents.each do |p|
-      parent = self.class.scenarios[p] or raise "parent scenario [#{p}] not found!"
+      parent = @@scenarios[p] or raise ScenarioNotFoundError, p
 
       parent.build_parent_scenarios(context)
       parent.build_scenario(context)
@@ -145,33 +148,10 @@ class Hornsby
     yield
   rescue StandardError => error
     puts
-    say "There was an error building scenario `#{@scenario}'", error.inspect
+    say "There was an error building scenario '#{@scenario}'", error.inspect
     puts
     puts error.backtrace
     puts
     raise error
   end
-end
-
-
-module HornsbyHelper
-  def hornsby_scenario(*names)
-    Hornsby.build(*names)
-    Hornsby.copy_ivars(self)
-  end
-
-  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
+end

data/spec/hornsby_scenario.rb

@@ -32,6 +32,9 @@ scenario(:cherry_basket => [:big_cherry, :cherry]) do
   @basket = [@cherry, @big_cherry]
 end
 
+
+scenario :parent_not_existing => :not_existing
+
 # Hornsby.namespace(:pitted_fruit) do
 #   scenario(:peach) do
 #     @peach = Fruit.create! :species => 'peach'

data/spec/hornsby_spec.rb

@@ -155,6 +155,26 @@ describe Hornsby do
     end
   end
 
+  describe 'errors' do
+    it 'should raise ScenarioNotFoundError when scenario could not be found' do
+      lambda {
+        hornsby_scenario :not_existing
+      }.should raise_error(Hornsby::ScenarioNotFoundError, "Scenario(s) not found 'not_existing'")
+    end
+    
+    it 'should raise ScenarioNotFoundError when scenario parent could not be found' do
+      lambda {
+        hornsby_scenario :parent_not_existing
+      }.should raise_error(Hornsby::ScenarioNotFoundError, "Scenario(s) not found 'not_existing'")
+    end
+
+    it 'should raise TypeError when scenario name is not symbol or string' do
+      lambda {
+        Hornsby.new(1)
+      }.should raise_error(TypeError, "Pass scenarios names as strings or symbols only, cannot build scenario '1'")
+    end
+  end
+
 #describe "with pitted namespace" do
 #  before do
 #    Hornsby.build('pitted:peach').copy_ivars(self)

data/spec/spec_helper.rb

@@ -21,5 +21,5 @@ require 'db/fruit'
 require 'db/tree'
 
 Spec::Runner.configure do |config|
-  Hornsby.configure_rspec(config, :filename => File.join('hornsby_scenario.rb'), :scenarios => :big_cherry)
+  Hornsby.configure_rspec(config, :root => File.join(spec_dir, '..'), :scenarios => :big_cherry)
 end

data/test/hornsby_test.rb

@@ -0,0 +1,188 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'shoulda'
+
+class HornsbyTest < ActiveSupport::TestCase
+  context "with just_apple scenario" do
+    setup do
+      hornsby_scenario :just_apple
+    end
+
+    should "create @apple" do
+      assert(!(@apple.nil?))
+    end
+
+    should "create Fruit @apple" do
+      assert(@apple.instance_of?(Fruit))
+    end
+
+    should "not create @banana" do
+      assert(@banana.nil?)
+    end
+
+    should "have correct species" do
+      assert(@apple.species == 'apple')
+    end
+  end
+
+  context "with bananas_and_apples scenario" do
+    setup do
+      hornsby_scenario :bananas_and_apples
+    end
+
+    should "have correct @apple species" do
+      assert(@apple.species == 'apple')
+    end
+
+    should "have correct @banana species" do
+      assert(@banana.species == 'banana')
+    end
+  end
+
+  context "with fruit scenario" do
+    setup do
+      hornsby_scenario :fruit
+    end
+
+    should "have 2 fruits" do
+      assert(@fruit.size == 2)
+    end
+
+    should "have an @apple" do
+      assert(@apple.species == 'apple')
+    end
+
+    should "have an @orange" do
+      assert(@orange.species == 'orange')
+    end
+
+    should "have no @banana" do
+      assert(@banana.nil?)
+    end
+  end
+
+  context 'with preloaded cherry scenario' do
+    should "have correct size after changed by second test" do
+      assert(@cherry.average_diameter == 3)
+      @cherry.update_attribute(:average_diameter, 1)
+      assert(@cherry.average_diameter == 1)
+    end
+
+    should "have correct size" do
+      assert(@cherry.average_diameter == 3)
+      @cherry.update_attribute(:average_diameter, 5)
+      assert(@cherry.average_diameter == 5)
+    end
+
+    should "create big cherry" do
+      assert(@big_cherry.species == 'cherry')
+    end
+  end
+
+  context 'hornsby_clear' do
+    setup do
+      hornsby_scenario :just_apple
+    end
+
+    should "clear scenarios when calling hornsby_clear" do
+      hornsby_clear
+      assert(Fruit.count == 0)
+    end
+
+    should "clear only tables passed" do
+      Tree.create!(:name => 'oak')
+      hornsby_clear :fruits
+      assert(Tree.count == 1)
+      assert(Fruit.count == 0)
+    end
+
+    should "mark scenarios as undone when passed :undone option" do
+      hornsby_scenario :fruit
+      hornsby_clear :undo => [:just_apple]
+      assert(Fruit.count == 0)
+      hornsby_scenario :fruit
+      assert(Fruit.count == 1)
+    end
+
+    should "mark all scenarios as undone when passed :undone option as :all" do
+      hornsby_scenario :fruit
+      hornsby_clear :undo => :all
+      assert(Fruit.count == 0)
+      hornsby_scenario :fruit
+      assert(Fruit.count == 2)
+    end
+
+    should "raise error when not executed scenarios passed to :undo option" do
+      assert_raise(ArgumentError) do
+        hornsby_clear :undo => :just_orange
+      end
+    end
+  end
+
+  context 'with many apples scenario' do
+    setup do
+      hornsby_scenario :many_apples, :cherry, :cherry_basket
+    end
+
+    should "create only one apple" do
+      assert(Fruit.all(:conditions => 'species = "apple"').size == 1)
+    end
+
+    should "create only two cherries even if they were preloaded" do
+      assert(Fruit.all(:conditions => 'species = "cherry"').size == 2)
+    end
+
+    should "contain cherries in basket if basket is loaded in test and cherries preloaded" do
+      assert(@basket == [@cherry, @big_cherry])
+    end
+  end
+
+  context 'transactions' do
+    setup do
+      hornsby_scenario :just_apple
+    end
+
+    should "drop only inner transaction" do
+      assert(!(@apple.reload.nil?))
+      begin
+        ActiveRecord::Base.transaction do
+          f = Fruit.create(:species => 'orange')
+          assert(!(f.reload.nil?))
+          raise 'some error'
+        end
+      rescue
+      end
+      assert(!(@apple.reload.nil?))
+      assert(Fruit.find_by_species('orange').nil?)
+    end
+  end
+
+  context 'errors' do
+    should 'raise ScenarioNotFoundError when scenario could not be found' do
+      assert_raise(Hornsby::ScenarioNotFoundError, "Scenario(s) not found 'not_existing'") do
+        hornsby_scenario :not_existing
+      end
+    end
+    
+    should 'raise ScenarioNotFoundError when scenario parent could not be found' do
+      assert_raise(Hornsby::ScenarioNotFoundError, "Scenario(s) not found 'not_existing'") do
+        hornsby_scenario :parent_not_existing
+      end
+    end
+
+    should 'raise TypeError when scenario name is not symbol or string' do
+      assert_raise(TypeError, "Pass scenarios names as strings or symbols only, cannot build scenario '1'") do
+        Hornsby.new(1)
+      end
+    end
+  end
+
+#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/test/test_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'fileutils'
+require 'activerecord'
+require 'test/unit'
+require 'active_record/test_case'
+begin
+  require 'mysqlplus'
+rescue LoadError
+end
+
+spec_dir = File.join(File.dirname(__FILE__), '..', 'spec')
+
+ActiveRecord::Base.logger = Logger.new("debug.log")
+
+databases = YAML::load(IO.read(spec_dir + "/db/database.yml"))
+db_info = databases[ENV["DB"] || "test"]
+ActiveRecord::Base.establish_connection(db_info)
+load(File.join(spec_dir, "db", "schema.rb"))
+
+require spec_dir + '/../lib/hornsby'
+require spec_dir + '/db/fruit'
+require spec_dir + '/db/tree'
+
+class ActiveSupport::TestCase
+  enable_hornsby :root => File.join(File.dirname(__FILE__), '..'), :scenarios => :big_cherry
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sinsiliux-hornsby
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Andrius Chamentauskas
@@ -33,7 +33,11 @@ extra_rdoc_files: []
 
 files: 
 - lib/hornsby.rb
-- lib/hornsby_context.rb
+- lib/hornsby/context.rb
+- lib/hornsby/helper.rb
+- lib/hornsby/errors.rb
+- lib/hornsby/rspec_extensions.rb
+- lib/hornsby/test_unit_extensions.rb
 - lib/tasks/hornsby_tasks.rake
 - README.rdoc
 - LICENSE
@@ -71,3 +75,5 @@ test_files:
 - spec/db/fruit.rb
 - spec/db/database.yml.example
 - spec/db/schema.rb
+- test/test_helper.rb
+- test/hornsby_test.rb

data/lib/hornsby_context.rb

@@ -1,13 +0,0 @@
-module HornsbyContext
-  def self.execute(&block)
-    module_eval(&block) if block
-  end
-
-  def self.copy_ivars(to, reload = false)
-    instance_variables.each do |iv|
-      v = instance_variable_get(iv)
-      v.reload if reload and v.respond_to?(:reload)
-      to.instance_variable_set(iv, v)
-    end
-  end
-end