laurynasl-hornsby 0.0.1

data/README

@@ -0,0 +1,98 @@
+Hornsby
+=======
+A Scenario Builder without the fixture pain.
+
+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 http://rails-oceania.googlecode.com/svn/lachiecox/hornsby
+
+Or piston:
+
+piston import http://rails-oceania.googlecode.com/svn/lachiecox/hornsby vendor/plugins/hornsby
+
+Add the following to spec_helper.rb
+
+# by default this loads scenarios from RAILS_ROOT/spec/hornsby_scenarios.rb
+Hornsby.load
+
+Spec::Runner.configure do |config|
+  ...
+  
+  config.include(HornsbySpecHelper)
+end
+
+
+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
+
+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
+====
+* Make transactional for speed.
+* Add scenario namespaces for better organisation.
+* Detect scenario cycles.
+
+Credits
+=======
+Lachie Cox <lachie@smartbomb.com.au>
+
+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,179 @@
+#require File.dirname(__FILE__) + '/detect_framework'
+require 'yaml'
+
+if defined?(Merb::Plugins)
+  Merb::Plugins.add_rakefiles "hornsby" / "tasks"
+end
+
+class Hornsby
+  @@record_name_fields = %w( name title username login )
+  @@delete_sql = "DELETE FROM %s"
+  
+  cattr_reader :scenarios
+  cattr_accessor :tables_to_delete
+  cattr_accessor :orm
+  @@scenarios = {}
+  
+  def self.build(names, receiver_context)
+    delete_tables
+
+    context = Module.new
+    ivars = context.instance_variables
+    @@completed_scenarios = []
+
+    names.each do |name|
+      scenario = @@scenarios[name.to_sym] or raise "scenario #{name} not found"
+      scenario.build(context)
+    end
+
+    context_ivars = context.instance_variables - ivars
+    context_ivars.each do |iv|
+      receiver_context.instance_variable_set(iv, context.instance_variable_get(iv))
+    end
+  end
+  
+  def self.[](name)
+  end
+  
+  #def self.load(scenarios_file=nil)
+  def self.load
+    return unless @@scenarios.empty?
+
+    root = RAILS_ROOT rescue Merb.root.to_s
+    
+    if File.exists?('.hornsby')
+      config = YAML.load(IO.read('.hornsby'))
+      scenarios_file = config['filename']
+      @@orm = config['orm'].to_sym if config['orm']
+      @@tables_to_delete = config['tables_to_delete'].collect {|t| t.to_sym} if config['tables_to_delete']
+    else
+      #scenarios_file ||= root+'/spec/hornsby_scenarios.rb'
+      File.open('.hornsby', 'w') do |f|
+        f.write "orm: sequel\n"
+        f.write "filename: hornsby_scenarios.rb\n"
+        f.write "tables_to_delete: []\n"
+      end
+      puts "generated Hornsby configuration file at .hornsby"
+
+      if File.exists?('hornsby_scenarios.rb')
+        puts "looks like file hornsby_scenarios.rb exists"
+      else
+        File.open('hornsby_scenarios.rb', 'w') do |f|
+          f.write "# for more information, see http://github.com/laurynasl/hornsby/wikis/usage\n"
+          f.write "scenario :sample do\n"
+          f.write "  \#@sample = SomeModel.create :name => \"Me\"\n"
+          f.write "end\n"
+        end
+        puts "created sample scenarios file at hornsby_scenarios.rb"
+      end
+      exit
+    end
+
+    
+    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(context)
+    #say "Building scenario `#{@scenario}'"
+    
+    build_parent_scenarios(context)
+    build_scenario(context)
+    
+    self
+  end
+  
+  def build_scenario(context)
+    return if @@completed_scenarios.include?(@scenario)
+    surface_errors { context.module_eval(&@block) }
+    @@completed_scenarios << @scenario
+  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
+    if @@orm == :activerecord
+      tables.each { |t| ActiveRecord::Base.connection.delete(@@delete_sql % t)  }
+    elsif @@orm == :datamapper
+      DataMapper::Resource.descendants.each do |klass|
+        #klass.auto_migrate!
+        klass.all.destroy!
+      end
+    elsif @@orm == :sequel
+      tables = (Sequel::Model.db.tables - [:schema_info])
+      tables = (@@tables_to_delete||[]) + (tables - (@@tables_to_delete||[]))
+      tables.each do |t|
+        Sequel::Model.db << (@@delete_sql % t)
+      end
+    else
+      raise "Hornsby.orm must be set to either :activerecord, :datamapper or :sequel"
+    end
+  end
+
+  def self.tables
+    ActiveRecord::Base.connection.tables - skip_tables
+  end
+
+  def self.skip_tables
+    %w( schema_info )
+  end
+end
+
+
+module HornsbySpecHelper
+  def hornsby_scenario(*names)
+    Hornsby.build(names, self)
+  end
+end
+Hornsby.orm = :activerecord

data/lib/hornsby/tasks.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__)+'/../hornsby'
+
+env = []
+if defined?(Merb)
+  env = :merb_env
+elsif defined?(Rails)
+  env = :environment
+end
+
+namespace :hornsby do
+
+  desc "Load the scenario named in the env var SCENARIO"
+  task :scenario => env do
+    raise "set SCENARIO to define which scenario to load" unless ENV['SCENARIO']
+    ::Hornsby.load#(ENV['FILENAME'])
+    #::Hornsby.orm = ENV['ORM'].to_sym if ENV['ORM']
+    ::Hornsby.build(ENV['SCENARIO'].split(','), self)
+  end
+  
+end

data/lib/laurynasl-hornsby.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/hornsby.rb'

data/spec/hornsby_spec.rb

@@ -0,0 +1,130 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../lib/hornsby'
+
+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.scenario(:bananas_and_more_apples => [:just_apple, :bananas_and_apples]) do
+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).copy_ivars(self)
+    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, "with bananas_and_apples scenario" do
+  before do
+    #Hornsby.build(:bananas_and_apples).copy_ivars(self)
+    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
+
+describe Hornsby, "with fruit scenario" do
+  before do
+    #Hornsby.build(:fruit).copy_ivars(self)
+    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 have an @orange" do
+    @orange.species.should == 'orange'
+  end
+  
+  it "should have no @banana" do
+    @banana.should be_nil
+  end
+end
+
+describe Hornsby, "don't repeat completed scenario" do
+  before do
+    #Hornsby.build(:bananas_and_more_apples).copy_ivars(self)
+    hornsby_scenario :bananas_and_more_apples
+  end
+
+  it "should create only one apple" do
+    Fruit.find_all_by_species('apple').size.should == 1
+  end
+end
+
+describe Hornsby, "run multiple scenarios" do
+
+  it "should create both apple and orange" do
+    hornsby_scenario :just_apple, :just_orange
+    @apple.should_not be_nil
+    @orange.should_not 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,32 @@
+require 'rubygems'
+require 'fileutils'
+require File.dirname(__FILE__) + '/../lib/detect_framework'
+
+
+if FRAMEWORK == :rails
+  #ORM = :activerecord
+
+  require File.dirname(__FILE__) + '/../../../../spec/spec_helper'
+
+
+elsif FRAMEWORK == :merb
+  #ORM = :datamapper # just assumption for now...
+
+  require File.dirname(__FILE__) + '/../../../spec/spec_helper'
+  require 'activerecord'
+end
+
+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"]
+puts db_info.inspect
+
+#FileUtils::rm(RAILS_ROOT+"/"+db_info[:dbfile])
+
+ActiveRecord::Base.establish_connection(db_info)
+
+load(File.join(plugin_spec_dir, "db", "schema.rb"))

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: laurynasl-hornsby
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Laurynas Liutkus
+autorequire: name
+bindir: bin
+cert_chain: []
+
+date: 2008-08-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
+description: 
+email: laurynasl@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/hornsby.rb
+- lib/laurynasl-hornsby.rb
+- lib/hornsby/tasks.rb
+- README
+has_rdoc: true
+homepage: http://github.com/laurynasl/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: Totally different fixtures replacement
+test_files: 
+- spec/spec_helper.rb
+- spec/hornsby_spec.rb