skip_database 0.1.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.1.0. initial version

data/Manifest

@@ -0,0 +1,8 @@
+CHANGELOG
+Manifest
+README
+Rakefile
+lib/active_support/test_case.rb
+lib/skip_database.rb
+lib/skip_database/runner.rb
+lib/test/unit/unit.rb

data/README

@@ -0,0 +1,90 @@
+SkipDatabase
+============
+
+Adds functionality to Test::Unit tests descending from ActiveSupport::TestCase to toggle database execution within a single test suite.
+
+Installation
+------------
+
+gem install skip_database
+
+Usage
+-----
+
+In order to toggle database skipping, run tests with the --skip-database command-line option.
+
+Within test classes descending from ActiveSupport::TestCase, commands executed within the skip_database block are only executed
+when the skip-database option is set. Commands within the with_database block are only executed for tests run with database execution.
+
+SkipDatabase uses "UnitRecord":http://github.com/dan-manges/unit-record to raise exceptions when database statements are executed. By default, ActiveRecord::Base is disconnected with the options :stub_associations set to true and :strategy set to :raise.
+
+Immediately after ActiveRecord::Base is disconnected, SkipDatabase requires any files found in test/skip_database/ under the Rails root directory.
+
+Example
+-------
+
+class UserTest < ActiveSupport::TestCase
+
+  def test_user_name_must_be_unique
+  
+    user = User.new(:first => "Elwin", :last => "Ransom")
+    
+    # this block won't be executed unless we're skipping the database
+    skip_database do
+      User.expects(:create!).with(:first => user.first, :last => user.last)
+      user.expects(:save).returns false
+      user.errors.add(:name, "must be unique")
+    end
+    
+    User.create!(:first => "Elwin", :last => "Ransom")
+    assert !user.save
+    
+    assert_equal user.errors.on(:name), "must be unique"
+  end
+
+  # Do not run the following tests when skipping database execution
+  with_database do
+  
+    def test_complex_methods
+      Company.build_by_factory(:users => 3, :admin => 1)
+      
+      users = User.find_by_sql <<-SQL
+                                  select * from users
+                                  join permissions on permissions.user_id = users.id
+                                  join companies on companies.id = users.company_id
+                                  where permissions.role = 'user' and companies.active is true
+                                SQL
+      
+      admins = User.find_by_sql <<-SQL
+                                  select * from users
+                                  join permissions on permissions.user_id = users.id
+                                  join companies on companies.id = users.company_id
+                                  where permissions.role = 'admin' and companies.active is true
+                                SQL
+      
+      assert_equal 2, users.size
+      assert_equal 1, admins.size
+    end
+  
+  end
+
+end
+
+$ ruby test/unit/user_test.rb --skip-database
+Loaded suite test/unit/user_test
+Started
+.
+Finished in 0.01123 seconds.
+
+1 tests, 4 assertions, 0 failures, 0 errors
+
+$ ruby test/unit/user_test.rb
+Loaded suite test/unit/user_test
+Started
+..
+Finished in 0.31526 seconds.
+
+2 tests, 4 assertions, 0 failures, 0 errors
+
+
+Copyright (c) 2010 Mike Bradford <mbradford@mumboe.com>, released under the MIT license 

data/Rakefile

@@ -0,0 +1,13 @@
+require "rubygems"
+require "rake"
+require "echoe"
+
+Echoe.new("skip_database", "0.1.0") do |p|
+  p.description   = "Database skipping unility for Test::Unit and ActiveSupport::TestCase"
+  p.author        = "Mike Bradford"
+  p.email         = "mbradford@mumboe.com"
+  p.url           = "http://development.mumboe.com/"
+  p.development_dependencies = ["rails","active_record","active_support","unit_record"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/lib/active_support/test_case.rb

@@ -0,0 +1,35 @@
+module ActiveSupport
+  class TestCase
+
+    class << self
+      # the block will be called only if database execution is skipped
+      def skip_database(&block)
+        block.bind(self).call if SkipDatabase::Runner.skipping_database
+      end
+
+      # the block will not be called if database execution is skipped
+      def with_database(&block)
+        block.bind(self).call unless SkipDatabase::Runner.skipping_database
+      end
+      
+      def skipping_database?
+        SkipDatabase::Runner.skipping_database
+      end
+    end
+
+    def skipping_database?
+      SkipDatabase::Runner.skipping_database
+    end
+
+    # the block will be called only if database execution is skipped
+    def skip_database(&block)
+      block.bind(self).call if SkipDatabase::Runner.skipping_database
+    end
+
+    # the block will not be called if database execution is skipped
+    def with_database(&block)
+      block.bind(self).call unless SkipDatabase::Runner.skipping_database
+    end
+  
+  end
+end

data/lib/skip_database.rb

@@ -0,0 +1,11 @@
+require File.join File.dirname(__FILE__), "test/unit/unit"
+require File.join File.dirname(__FILE__), "skip_database/runner"
+require File.join File.dirname(__FILE__), "active_support/test_case"
+
+OptionParser.new do |opts|
+  opts.on("-s", "--skip-database") do |e|
+    SkipDatabase::Runner.skipping_database = true
+  end
+end.parse! [ARGV.delete("-s") || ARGV.delete("--skip-database")]
+
+at_exit { exit SkipDatabase::Runner.run unless $! || Test::Unit.run? }

data/lib/skip_database/runner.rb

@@ -0,0 +1,23 @@
+module SkipDatabase
+  class Runner < Test::Unit::AutoRunner
+    class << self
+      attr_accessor :skipping_database
+      
+      # run the test suite, disconnecting the database and requiring any files in test/skip_database if skip-database option set
+      def run(force_standalone=false, default_dir=nil, argv=ARGV, &block)
+        if self.skipping_database == true
+          require "unit_record"
+          ActiveRecord::Base.disconnect! :stub_associations => true, :strategy => :raise
+          dir = Rails.root.join("test/skip_database")
+          Dir["#{dir}/*"].each { |file| require "#{dir}/#{File.basename(file, File.extname(file))}" }
+        end
+        r = new(force_standalone || standalone?, &block)
+        r.base = default_dir
+        # adding this option here so that it will show up on the help menu
+        r.options.on("-s", "--skip-database", "Raise an exception when database calls are executed") {}
+        r.process_args(argv)
+        r.run
+      end
+    end  
+  end
+end

data/lib/test/unit/unit.rb

@@ -0,0 +1,15 @@
+# redifining this file to remove the original at_exit block
+require 'test/unit/testcase'
+require 'test/unit/autorunner'
+
+module Test # :nodoc:
+  module Unit
+    def self.run=(flag)
+      @run = flag
+    end
+
+    def self.run?
+      @run ||= false
+    end
+  end
+end

data/skip_database.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{skip_database}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mike Bradford"]
+  s.date = %q{2010-02-16}
+  s.description = %q{Database skipping unility for Test::Unit and ActiveSupport::TestCase}
+  s.email = %q{mbradford@mumboe.com}
+  s.extra_rdoc_files = ["CHANGELOG", "README", "lib/active_support/test_case.rb", "lib/skip_database.rb", "lib/skip_database/runner.rb", "lib/test/unit/unit.rb"]
+  s.files = ["CHANGELOG", "Manifest", "README", "Rakefile", "lib/active_support/test_case.rb", "lib/skip_database.rb", "lib/skip_database/runner.rb", "lib/test/unit/unit.rb", "skip_database.gemspec"]
+  s.homepage = %q{http://development.mumboe.com/}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Skip_database", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{skip_database}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Database skipping unility for Test::Unit and ActiveSupport::TestCase}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rails>, [">= 0"])
+      s.add_development_dependency(%q<active_record>, [">= 0"])
+      s.add_development_dependency(%q<active_support>, [">= 0"])
+      s.add_development_dependency(%q<unit_record>, [">= 0"])
+    else
+      s.add_dependency(%q<rails>, [">= 0"])
+      s.add_dependency(%q<active_record>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+      s.add_dependency(%q<unit_record>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rails>, [">= 0"])
+    s.add_dependency(%q<active_record>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+    s.add_dependency(%q<unit_record>, [">= 0"])
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: skip_database
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mike Bradford
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: active_record
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: unit_record
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Database skipping unility for Test::Unit and ActiveSupport::TestCase
+email: mbradford@mumboe.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README
+- lib/active_support/test_case.rb
+- lib/skip_database.rb
+- lib/skip_database/runner.rb
+- lib/test/unit/unit.rb
+files: 
+- CHANGELOG
+- Manifest
+- README
+- Rakefile
+- lib/active_support/test_case.rb
+- lib/skip_database.rb
+- lib/skip_database/runner.rb
+- lib/test/unit/unit.rb
+- skip_database.gemspec
+has_rdoc: true
+homepage: http://development.mumboe.com/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Skip_database
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: skip_database
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Database skipping unility for Test::Unit and ActiveSupport::TestCase
+test_files: []
+