greenbar 0.1.1

data/LICENSE

@@ -0,0 +1,47 @@
+NOTE: this is essentially the same license as Ruby has, without paragraphs
+that do not apply.
+
+
+Greenbar is copyrighted free software.
+You can redistribute it and/or modify it under the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) rename any non-standard executables so the names do not conflict
+          with standard executables, which must also be provided.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or executable
+     form, provided that you do at least ONE of the following:
+
+       a) distribute the executables and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard executables non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.
+

data/README

@@ -0,0 +1,33 @@
+= Greenbar -- Test::Unit Tools
+
+Greenbar provides aids for testing with Test::Unit.
+
+== Download
+
+Get the latest version of Greenbar at
+
+* http://greenbar.rubyforge.org/downloads.html
+
+== Installation
+
+=== Normal Installation
+
+"Standard" installation using ruby install.rb is not yet supported.
+
+=== GEM Installation
+
+Download and install Greenbar with the following.
+
+   gem install --remote greenbar
+
+== Getting Started
+Greenbar provides a framework for re-using setup and teardown code across multiple Test::Unit::TestCases.  The key
+to this is the TestSetup module.  Greenbar also provides several generally useful TestSetup mix-ins.
+
+== Online Resources
+
+
+== License
+
+:include: LICENSE
+

data/doc/examples/ClassMethodSetup_define_class_method.rb

@@ -0,0 +1,32 @@
+require 'test/unit'
+require 'rubygems'
+require_gem 'greenbar'
+
+
+class UserTest < Test::Unit::TestCase
+  include Greenbar::ClassMethodSetup
+  
+  def test_signup
+    confirmation_args=
+    define_class_method(Mailer, :deliver_confirmation) do |*args|
+      confirmation_args = args
+    end
+    user = User.new('user@test.domain')
+    user.signup()
+    assert_equal ['user@test.domain'], confirmation_args
+  end
+end
+
+class User
+  def initialize(email)
+    @email = email
+  end
+  
+  def signup
+    Mailer.deliver_confirmation(@email)
+  end
+end
+
+class Mailer
+  # assume that 'deliver_confirmation' is handled by a method_missing method
+end

data/doc/examples/ClassMethodSetup_replace_class_method.rb

@@ -0,0 +1,25 @@
+require 'test/unit'
+require 'rubygems'
+require_gem 'greenbar'
+
+class FooTest < Test::Unit::TestCase
+  include Greenbar::ClassMethodSetup
+  
+  def test_dot_files
+    files= [ '.rails', '.ruby', 'timesheet']
+    dirs = [ 'a', 'b', '.', '..', '.bash.d']
+    replace_class_method(Dir, :entries) do
+      dirs + files
+    end
+    replace_class_method(File, :directory?) do |file_name|
+      dirs.include? file_name
+    end
+    assert_equal ['.rails', '.ruby'], ConfigFinder.dotFiles('/root')
+  end
+end
+
+class ConfigFinder
+  def self.dotFiles homeDir
+    Dir.entries(homeDir).select {|file_name| !File.directory?(file_name) && file_name =~ /^\./}
+  end
+end

data/doc/examples/ClassMethodSetup_replace_new.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'rubygems'
+require_gem 'greenbar'
+
+class DataCounterTest < Test::Unit::TestCase
+  include Greenbar::ClassMethodSetup
+  
+  def test_DataCounter
+    replace_new(DataService, { ['testhost'] => MockDataService.new })
+    assert_equal 5, DataCounter.new.count('testhost')
+  end
+end
+
+class DataCounter
+  def count host
+    DataService.new(host).fetch.length
+  end
+end
+
+# assume fetch accesses a remote system, normally
+class DataService
+  def fetch
+  end
+end
+
+class MockDataService
+  def fetch
+    "x,y,z"
+  end
+end

data/doc/examples/DateSetup.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require_gem 'greenbar'
+
+require 'test/unit'
+
+class DateDueCalculatorTest < Test::Unit::TestCase
+  include Greenbar::DateSetup
+  
+  def test_calculate_date_due
+    Date.today = Date.civil(2006, 4, 15)
+    calculator = DateDueCalculator.new
+    assert_equal Date.civil(2006, 4, 22), calculator.calculate_due_date(Movie.new(:standard))
+    assert_equal Date.civil(2006, 4, 19), calculator.calculate_due_date(Movie.new(:hotflick))
+  end
+end
+
+class Movie
+  def initialize group
+    @group = group
+  end
+  
+  def checkout_duration
+    return 4 if @group == :hotflick 
+    return 7
+  end
+end
+
+class DateDueCalculator
+  def calculate_due_date movie
+    Date.today + movie.checkout_duration
+  end
+end

data/doc/examples/EnvSetup.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require_gem 'greenbar'
+
+require 'test/unit'
+
+class HomeFinderTest < Test::Unit::TestCase
+  include Greenbar::EnvSetup
+  
+  def setup
+    @finder = HomeFinder.new
+  end
+  
+  def test_find_home
+    ENV['APP_HOME'] = '/usr/lib/app'
+    
+    assert_equal '/usr/lib/app', @finder.find_home
+  end
+  
+  def test_find_home_default
+    assert_equal '/usr/local/lib/app', @finder.find_home
+  end
+end
+
+class HomeFinder
+  def find_home
+    ENV['APP_HOME'] || '/usr/local/lib/app'
+  end
+end

data/doc/examples/RandSetup.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require_gem 'greenbar'
+
+require 'test/unit'
+
+class DieTest < Test::Unit::TestCase
+  include Greenbar::RandSetup
+  
+  def test_roll_one_die
+    seed_rand_sequence 6, [5, 1, 3, 2]
+    die = Die.new
+    assert_equal 5, die.roll(6)
+    assert_equal 1, die.roll(6)
+    assert_equal 3, die.roll(6)
+    assert_equal 2, die.roll(6)
+    assert_equal 5, die.roll(6)
+  end
+end
+
+class Die
+  def roll size
+    rand(size)
+  end
+end

data/doc/examples/TestSetup.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require_gem 'greenbar'
+
+require 'test/unit'
+
+module BarSetup
+  include Greenbar::TestSetup
+  def setup_mixin
+    @original_bar = $bar
+  end
+  
+  def teardown_mixin
+    $bar = @original_bar
+  end
+end
+
+class Foo
+  def bar
+    $bar
+  end
+end
+
+class FooTest < Test::Unit::TestCase
+  include BarSetup
+  
+  def setup
+    $bar = 'xyzzy'
+  end
+  
+  def test_foo
+    assert_equal 'xyzzy', Foo.new.bar
+  end
+end

data/doc/examples/TimeSetup.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+require_gem 'greenbar'
+
+require 'test/unit'
+
+class WebServiceTest < Test::Unit::TestCase
+  include Greenbar::TimeSetup
+  
+  def test_expires
+    Time.now = Time.local(2006, 4, 16, 15, 23)
+    response = WebService.new.handle_request
+    assert_equal Time.local(2006, 4, 16, 16, 23), response.expires_at
+  end
+end
+
+class Response
+  def initialize expires_at
+    @expires_at = expires_at
+  end
+  attr_reader :expires_at
+end
+
+class WebService
+  def handle_request
+    Response.new Time.now + 60 * 60
+  end
+end

data/lib/greenbar.rb

@@ -0,0 +1,17 @@
+module Greenbar
+  private
+  def self.lazyLoad symbol
+    autoload symbol, 'greenbar/' + symbol.to_s
+  end
+  lazyLoad :TestSetup
+  lazyLoad :EnvSetup
+  lazyLoad :RandSetup
+  lazyLoad :TimeSetup
+  lazyLoad :ClassMethodSetup
+  lazyLoad :DateSetup
+
+end
+
+# :stopdoc:
+# this rails-related hack doesn't fit normal usage
+require 'greenbar/RailsSetup'

data/lib/greenbar/ClassMethodSetup.rb

@@ -0,0 +1,133 @@
+#:stopdoc:
+# Copyright 2005, 2006 Enttek, Inc, All Rights Reserved
+# Copyright 2005, 2006 Kiel Hodges, All Rights Reserved
+# Copyright 2005, 2006 David Corbin <dcorbin@users.sourceforge.net>, All Rights Reserved
+#
+# This software may be copied and used only in accordance with the
+# terms provided in the include LICENSE file.  If no such file is included
+# then please contact the authors of the Greenbar project at 
+# http://rubyforge.org/projects/greenbar/
+#
+require 'greenbar/TestSetup'
+
+class Module
+  public :define_method
+
+  def metaclass
+    class << self
+      return self
+    end
+  end
+  
+  def alias_class_method new_name, old_name
+    metaclass.instance_eval {
+      alias_method new_name, old_name
+    }
+  end
+  
+  def remove_class_method method_name
+    metaclass.instance_eval {
+      remove_method method_name
+    }
+  end  
+end
+#:startdoc:
+#
+# ===Purpose
+#
+# Sometimes it is very convenient to replace (or even provide)
+# an alternative implementation of a method in class A to aid
+# in testing class B.  ClassMethodSetup allows you to do this
+# easily, and restores the original method implementation on
+# completion.
+#
+# ===Usage
+#  
+# 1. Include Greenbar::ClassMethodSetup in your test case.
+# 2. Use replace_class_method, define_class_method, or replace_new
+# as needed.
+#
+# You may change 'today' as often as you want. 
+#
+# ===Examples
+# 
+# ====for define_class_method
+#
+#  :include: doc/examples/ClassMethodSetup_define_class_method.rb
+#
+# ====for replace_class_method
+#
+#  :include: doc/examples/ClassMethodSetup_replace_class_method.rb
+#
+# ====for replace_new
+#
+#  :include: doc/examples/ClassMethodSetup_replace_new.rb
+#
+#
+module Greenbar::ClassMethodSetup
+  include Greenbar::TestSetup
+
+  def setup_mixin #:nodoc:
+    @class_methods_to_restore = []
+    @class_methods_to_remove  = []
+  end
+    
+  def teardown_mixin #:nodoc:
+    @class_methods_to_restore.each {|target_class, method_name|
+      target_class.alias_class_method method_name, name_of_copied_method(method_name)
+    }
+
+    @class_methods_to_remove.each {|target_class, method_name|
+      target_class.remove_class_method method_name
+    }
+  end
+  
+  # Replaces a class method _method_name_ on class _target_class_.  The implementation
+  # will be the _block_, and may take any number of arguments.  The original method
+  # will be restored automatically.  The primary purpose for this method is when you 
+  # need to provide a mock implementation of some class_method.
+  #
+  def replace_class_method target_class, method_name, &block
+    @class_methods_to_restore << [target_class, method_name]
+    target_class.alias_class_method name_of_copied_method(method_name), method_name
+    target_class.metaclass.define_method method_name, &block
+  end
+  
+  # Defines a new class method _method_name_ on class _target_class_.  The implementation
+  # will be the _block_, and may take any number of arguments.  The method
+  # will be destroyed automatically at the end of the test.
+  # The primary purpose for this method is when you 
+  # need to provide a mock implementation of a method that is usually handled by
+  # method_missing implementation
+  #
+  def define_class_method target_class, method_name, &block
+    @class_methods_to_remove << [target_class, method_name]
+    target_class.metaclass.define_method method_name, &block
+  end
+  
+  # Replaces the new method on class _target_class_.  
+  #
+  # In the canonical form, _results_ should will respond to to_hash.
+  # The hash is keyed by arrays that match the expected arguments to the new method.
+  # the hash value is the object to return for that set of arguments.
+  #
+  # If _results_ does not respond to to_hash, is is assumed to be the desired
+  # return value for a no-argument call to new.
+  #
+  def replace_new target_class, results
+    argument_instance_map = results.respond_to?(:to_hash) ? results.to_hash : { [] => results } 
+
+    replace_class_method(target_class, :new) {|*args| 
+      return argument_instance_map[args] if argument_instance_map.has_key? args
+      raise "No instance has been set to return from #{target_class}.new for #{args.inspect}."
+    }
+  end
+
+  
+  private 
+  
+  def name_of_copied_method(method_name)
+    'original_' + method_name.to_s
+  end
+  
+end