sinsiliux-hornsby 0.1.0

data/README.rdoc

@@ -0,0 +1,104 @@
+= Hornsby
+
+A Scenario Builder without the fixture pain.
+
+== Usage
+
+Scenarios look like:
+
+    scenario :apple do
+      @apple = Fruit.create! :species => 'apple'
+    end
+
+    scenario :orange do
+      @orange = Fruit.create! :species => 'orange'
+    end
+
+    scenario :fruitbowl => [:apple,:orange] do
+      @fruitbowl = FruitBowl.create! :fruit => [@apple,@orange]
+    end
+
+    scenario :kitchen => :fruitbowl do
+      @kitchen = Kitchen.create! :fruitbowl => @fruitbowl
+    end
+
+...and you use them in specs like:
+
+    describe Fruit, "@apple" do
+      before do
+        hornsby_scenario :apple
+      end
+  
+      it "should be an apple" do
+        @apple.species.should == 'apple'
+      end
+    end
+
+    describe FruitBowl, "with and apple and an orange" do
+      before do
+        hornsby_scenario :fruitbowl
+      end
+
+      it "should have 2 fruits" do
+        @fruitbowl.should have(2).fruit
+      end
+    end
+
+== Setup
+
+Install the plugin:
+
+    ./script/plugin install git://github.com/lachie/hornsby.git
+
+Add the following to spec_helper.rb
+
+    # by default this loads scenarios from RAILS_ROOT/spec/hornsby_scenarios.rb
+    Spec::Runner.configure do |config|
+      ...
+  
+      Hornsby.configure_rspec(config, :filename => 'scenarios.rb', :scenarios => :preloaded_scenario)
+    end
+
+configure_rspec supports two parameters:
+* filename - file with hornsby scenarios
+* scenarios - list of hornsby scenarios that should be preloaded (available in all tests, never reloaded so they're much faster)
+
+
+== Advanced Usage
+
+Its just ruby, right? So go nuts:
+
+    1.upto(9) do |i|
+      scenario("user_#{i}") do
+        user = User.create! :name => "user#{i}"
+        instance_variable_set("@user_#{i}",user)
+      end
+    end
+
+== Transactions
+
+Hornsby scenarios is transactional, meaning that after every test transaction is dropped and database is reset to
+starting point. Starting point is empty database + any scenarios that you specify in configure_rspec.
+
+== Rake
+
+If you'd like simply to load your scenarios into a database, use the rake task like so:
+
+    $ rake hornsby:scenario RAILS_ENV=test SCENARIO=fruitbowl
+
+== TODO
+
+* Add scenario namespaces for better organisation.
+* Detect scenario cycles.
+
+== Credits
+
+Lachie Cox <lachie@smartbomb.com.au>
+
+Andrius Chamentauskas <sinsiliux@gmail.com>
+
+The code is based on Err's code found in this post: http://errtheblog.com/post/7708
+
+== License
+
+MIT, see LICENCE

data/lib/hornsby.rb

@@ -0,0 +1,167 @@
+class Hornsby
+  @@record_name_fields = %w( name title username login )
+  @@delete_sql = "DELETE FROM %s"
+  
+  def self.framework_root
+    if const_defined?(:RAILS_ROOT)
+      puts "rails root"
+      RAILS_ROOT
+    elsif const_defined?(:Merb)
+      puts "merb"
+      Merb.root
+    elsif const_defined?('Rails')
+      Rails.root
+    end
+  end
+  
+  cattr_reader :scenarios
+  @@scenarios = {}
+  cattr_reader :global_scenarios
+  # @@namespaces = {}
+
+  def self.configure_rspec(config, options = {})
+    load(options[:filename])
+
+    @@global_scenarios = Hornsby.build(options[:scenarios]) if options[:scenarios]
+
+    config.include(HornsbySpecHelper)
+
+    config.before do
+      @@global_scenarios.each {|s| s.copy_ivars(self)} if @@global_scenarios
+      ActiveRecord::Base.connection.increment_open_transactions
+      ActiveRecord::Base.connection.transaction_joinable = false
+      ActiveRecord::Base.connection.begin_db_transaction
+    end
+
+    config.after do
+      ActiveRecord::Base.connection.rollback_db_transaction
+      ActiveRecord::Base.connection.decrement_open_transactions
+    end
+  end
+  
+  def self.build(*names)
+    scenarios = names.map {|name| @@scenarios[name.to_sym] or raise "scenario #{name} not found"}
+    
+    scenarios.each {|s| s.build}
+  end
+  
+  def self.[](name)
+  end
+  
+  def self.load(scenarios_file=nil)
+    delete_tables
+    return unless @@scenarios.empty?
+
+    scenarios_file ||= framework_root + '/spec/hornsby_scenarios.rb'
+    self.module_eval File.read(scenarios_file)
+  end
+  
+  def self.scenario(scenario,&block)
+    self.new(scenario, &block)
+  end
+  
+  def self.namespace(name,&block)
+  end
+  
+  def self.reset!
+    @@scenarios = {}
+  end
+  
+  def initialize(scenario, &block)
+    case scenario
+    when Hash
+      parents = scenario.values.first
+      @parents = Array === parents ? parents : [parents]
+      scenario = scenario.keys.first
+    when Symbol, String
+      @parents = []
+    else 
+      raise "I don't know how to build `#{scenario.inspect}'"
+    end
+    
+    @scenario = scenario.to_sym
+    @block    = block
+    
+    @@scenarios[@scenario] = self
+  end
+  
+  def say(*messages)
+    puts messages.map { |message| "=> #{message}" }
+  end
+
+  def build
+    #say "Building scenario `#{@scenario}'"
+    @context = context = Module.new
+    
+    # TODO move this elsewhere
+    context.module_eval do
+      def self.method_missing(meth_id,*args,&block)
+        begin
+          rec = meth_id.to_s.classify.constantize.send(:create!, *args)
+          yield(rec) if block_given?
+        rescue
+          super
+        end
+      end
+    end
+    
+    ivars = context.instance_variables
+    
+    build_parent_scenarios(context)
+    build_scenario(context)
+    
+    @context_ivars = context.instance_variables - ivars
+    
+    self
+  end
+  
+  def build_scenario(context)
+    surface_errors { context.module_eval(&@block) }
+  end
+  
+  def build_parent_scenarios(context)
+    @parents.each do |p|
+      parent = self.class.scenarios[p] or raise "parent scenario [#{p}] not found!"
+
+      parent.build_parent_scenarios(context)
+      parent.build_scenario(context)
+    end
+  end
+
+  
+  def surface_errors
+    yield
+  rescue Object => error
+    puts 
+    say "There was an error building scenario `#{@scenario}'", error.inspect
+    puts 
+    puts error.backtrace
+    puts 
+    raise error
+  end
+  
+  def self.delete_tables
+    tables.each { |t| ActiveRecord::Base.connection.delete(@@delete_sql % t)  }
+  end
+
+  def self.tables
+    ActiveRecord::Base.connection.tables - skip_tables
+  end
+
+  def self.skip_tables
+    %w( schema_info )
+  end
+  
+  def copy_ivars(to)
+    @context_ivars.each do |iv|
+      to.instance_variable_set(iv, @context.instance_variable_get(iv))
+    end
+  end
+end
+
+
+module HornsbySpecHelper
+  def hornsby_scenario(*names)
+    Hornsby.build(*names).each {|s| s.copy_ivars(self)}
+  end
+end

data/spec/hornsby_spec.rb

@@ -0,0 +1,103 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class Fruit < ActiveRecord::Base
+end
+
+Hornsby.scenario(:just_apple) do
+  @apple = Fruit.create! :species => 'apple'
+end
+
+Hornsby.scenario(:bananas_and_apples => :just_apple) do
+  @banana = Fruit.create! :species => 'banana'
+end
+
+Hornsby.scenario(:just_orange) do
+  @orange = Fruit.create! :species => 'orange'
+end
+
+Hornsby.scenario(:fruit => [:just_apple,:just_orange]) do
+  @fruit = [@orange,@apple]
+end
+
+Hornsby.scenario(:bananas_and_apples_and_oranges => [:bananas_and_apples,:just_orange]) do
+  @fruit = [@orange,@apple,@banana]
+end
+
+
+# Hornsby.namespace(:pitted_fruit) do
+#   scenario(:peach) do
+#     @peach = Fruit.create! :species => 'peach'
+#   end
+#   
+#   scenario(:nectarine) do
+#     @nectarine = Fruit.create! :species => 'nectarine'
+#   end
+# end
+
+describe Hornsby, "with just_apple scenario" do
+  before do
+    Hornsby.build(:just_apple).each {|s| s.copy_ivars(self)}
+  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, "with bananas_and_apples scenario" do
+  before do
+    Hornsby.build(:bananas_and_apples).each {|s| s.copy_ivars(self)}
+  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
+
+describe Hornsby, "with fruit scenario" do
+  before do
+    Hornsby.build(:fruit).each {|s| s.copy_ivars(self)}
+  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
+
+#describe Hornsby, "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

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+plugin_spec_dir = File.dirname(__FILE__)
+
+ActiveRecord::Base.logger = Logger.new(plugin_spec_dir + "/debug.log")
+
+databases = YAML::load(IO.read(plugin_spec_dir + "/db/database.yml"))
+
+db_info = databases[ENV["DB"] || "sqlite3"]
+
+FileUtils::rm(RAILS_ROOT+"/"+db_info[:dbfile])
+
+ActiveRecord::Base.establish_connection(db_info)
+
+load(File.join(plugin_spec_dir, "db", "schema.rb"))
+

data/tasks/hornsby_tasks.rake

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__)+'/../lib/hornsby'
+
+namespace :hornsby do
+
+  desc "Load the scenario named in the env var SCENARIO"
+  task :scenario => :environment do
+    raise "set SCENARIO to define which scenario to load" unless ENV['SCENARIO']
+    ::Hornsby.load
+    ::Hornsby.build(ENV['SCENARIO'])
+  end
+  
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: sinsiliux-hornsby
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Andrius Chamentauskas
+- Lachie Cox
+autorequire: 
+bindir: bin
+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
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: 
+email: sinsiliux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/hornsby.rb
+- tasks/hornsby_tasks.rake
+- README.rdoc
+has_rdoc: false
+homepage: http://github.com/sinsiliux/hornsby
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Fixtures replacement
+test_files: 
+- spec/spec_helper.rb
+- spec/hornsby_spec.rb