greenbar 0.1.1

data/lib/greenbar/DateSetup.rb

@@ -0,0 +1,62 @@
+#: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'
+require 'greenbar/ClassMethodSetup'
+require 'date'
+
+class Date; end
+#:startdoc:
+#
+# ===Purpose
+#
+# To control time at the date level.  DateSetup lets you
+# control what day Date.today thinks it is.  
+#
+# ===Usage
+#  
+# 1. Include Greenbar::DateSetup in your test case.
+# 2. Use Date.today= to define the date you want to be 'today'
+#
+# You may change 'today' as often as you want. 
+#
+# ===Example
+#
+#   :include: doc/examples/DateSetup.rb
+#
+# ===Additional definitions
+#   Date.today=(date)
+# 
+# sets the Date to returned as 'today' for Date.today
+# Must be called before Date.today if DateSetup is being used.
+#
+
+module Greenbar::DateSetup
+  include Greenbar::TestSetup
+  include Greenbar::ClassMethodSetup
+  
+  def setup_mixin #:nodoc:
+    replace_class_method(Date, :today) {
+      raise "Must use Date.today= when using DateSetup." unless defined? @today
+      @today
+    }
+
+    def Date.today=(date)  #:nodoc:
+        @today = date
+    end
+  end
+    
+  def teardown_mixin #:nodoc:
+    class << Date
+      remove_method :today=
+    end
+  end
+    
+end

data/lib/greenbar/EnvSetup.rb

@@ -0,0 +1,51 @@
+#: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'
+
+# :startdoc:
+#
+# ===Purpose
+#
+# Save and restore The Environment (ENV) automatically.  If you've got a 
+# piece of code that depends on environment variables, then you'll want
+# this to do good unit testing.  The variable needs to be set to make 
+# sure the test passes, but you want to restore everything to a consistent
+# state when the test ends.
+#
+# ===Usage
+#  
+# * Include Greenbar::EnvSetup in your test case.
+# * Define any ENV settings you need.
+#
+# You may now modify the ENV freely, confident that it will be restored to
+# it's starting configuration.
+#
+# ===Example
+#
+# Let's say you've got an application, and it needs to know find it's 
+# configuration file.  To do this, you want it to look in the directory
+# specified in the environment variable APP_HOME.  
+#
+#   :include: doc/examples/EnvSetup.rb
+#
+module Greenbar::EnvSetup
+  
+  include Greenbar::TestSetup
+
+  def setup_mixin #:nodoc:
+    @env_mixin_backup = ENV.to_hash
+    ENV.clear
+  end
+    
+  def teardown_mixin #:nodoc:
+    ENV.replace @env_mixin_backup
+  end
+end

data/lib/greenbar/RailsSetup.rb

@@ -0,0 +1,57 @@
+#:stopdoc:
+# Copyright 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/
+if defined? RAILS_ROOT
+  require 'test/unit/testcase'
+#:startdoc:
+  module Greenbar
+#
+# ===Purpose 
+# 
+# Make RubyOnRails compatible with Greenbar::TestSetup
+#
+# Unfortunately, RubyOnRails wants to replace TestCase setup/teardown methods, just like
+# Greenbar::TestSetup.  And it does it in a 'very selfish' way.
+# This module makes it possible to use RubyOnRails fixtures and any Greenbar TestSetup
+# in the same test case.    
+#
+# ===Usage
+#
+# * Simply add the following line to the end of your 'test_helper.rb' file
+# 
+#   require_gem 'greenbar'
+#
+# That's it.  Do that, and then you can freely include the various TestSetups
+#
+    module RailsSetup
+      include Greenbar::TestSetup
+      def setup_mixin #:nodoc:
+        setup_with_fixtures
+      end
+      
+      def teardown_mixin#:nodoc:
+        teardown_with_fixtures
+      end
+    end
+  
+  end  
+#:stopdoc:
+  
+  class Test::Unit::TestCase; end
+  
+  class << Test::Unit::TestCase
+    alias_method :rails_fixtures,  :fixtures
+  end
+    
+  module Test::Unit
+    def TestCase.fixtures *args
+      include Greenbar::RailsSetup
+      rails_fixtures(*args)
+    end
+  end
+#:startdoc:
+end

data/lib/greenbar/RandSetup.rb

@@ -0,0 +1,82 @@
+#: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'
+#TODO - use ClassMethodSetup?
+
+#:startdoc:#
+#===Purpose
+#
+# Provides a way to control random numbers generated from Kernel#rand
+#
+#===Usage
+#  
+# * Include Greenbar::RandSetup in your test case.
+# * Seed sequences for each 'max' used in the code under test.  Use seed_rand_sequence
+#
+# Kernel#rand is called to generate random numbers, and it takes a single argument, 'max'
+# If you're picking a random color from a collection of eight, you might seay
+#   color = COLORS[rand(8)]
+# Unfortunately, if you're really getting random numbers back, it's very difficult
+# to write a test.  So, you might add this call to your test case.
+#   seed_rand_sequence 8, [2, 4]
+# If you call it a third time, it will return 2 again, as the sequence is repeated automatically.
+#
+#===Example
+#
+#
+#   :include: doc/examples/RandSetup.rb
+#
+#===Additional definitions
+#   Kernel#seed_rand_sequence=(max, sequence)
+# 
+# Initializes a re-usable sequence for calls to Kernel#rand with max.
+# The first element of the array is returned on the first call to rand(max),
+# and the sequence is rotated, appending this return to the end.
+#
+
+module Greenbar::RandSetup
+
+  #:stopdoc:  
+  include Greenbar::TestSetup
+
+  def setup_mixin
+    Kernel.class_eval do
+      
+      alias :rand_saved_by_RandSetup :rand
+      
+      def rand(max=0)
+        @@rand_sequences ||= {}
+        raise "Must use seed_rand_sequence(#{max}) before using rand(#{max})." unless @@rand_sequences.has_key? max
+        @@rand_sequences[max] << @@rand_sequences[max].shift
+        @@rand_sequences[max][-1]
+      end
+      
+      def seed_rand_sequence(max, sequence)
+        array = sequence.to_a
+        raise "Must provide a non-empty sequence." if array.empty?
+        @@rand_sequences ||= {}
+        @@rand_sequences[max] = array
+      end
+      
+    end
+      
+  end
+    
+  def teardown_mixin
+    Kernel.class_eval do
+      alias :rand :rand_saved_by_RandSetup
+      remove_method :rand_saved_by_RandSetup
+      remove_method :seed_rand_sequence
+      @@rand_sequences = nil
+    end
+  end
+  #:startdoc:#
+end

data/lib/greenbar/TestSetup.rb

@@ -0,0 +1,105 @@
+#: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/
+
+module Greenbar
+#:startdoc:
+#
+# === Purpose
+#
+# Provides a way to aggregate reusable setup and teardown methods in a test case, that
+# are called automatically, just like the setup and teardown methods that are directly
+# in a test case.
+#
+# === Usage
+#  
+# * Create a new module, and mix-in Greenbar::TestSetup.
+# * Define methods setup_mixin and teardown_mixin to do whatever you need.
+# * Include your module in your test case.
+#
+# It is not necessary to call any methods.  The mere act of including the module
+# will cause it to be hooked in correctly.
+#
+# You may include as many TestSetup-based modules as you like in your test cases, and 
+# it all works.
+#
+# === Example
+#
+# The following code shows an example where you might want to control
+# the state of a global variable, but only for the duration of a particular 
+# test case.  Note: we all know global data is evil, *and* a bad programming
+# practice but it makes for a convenient example.
+#
+#   :include: doc/examples/TestSetup.rb
+#
+  module Greenbar::TestSetup
+    def setup #:nodoc:
+      setup_mixins
+    end
+      
+    def teardown #:nodoc:
+      teardown_mixins
+    end
+      
+    def setup_mixins #:nodoc:
+      self.class.included_test_mixins.reverse_each {|testSetup| testSetup.call_instance_method :setup_mixin,  self}
+    end
+      
+    def teardown_mixins #:nodoc:
+      self.class.included_test_mixins.each {|testSetup| testSetup.call_instance_method :teardown_mixin, self}
+    end
+      
+    def self.included(fixtureModule) #:nodoc:
+      fixtureModule.extend SetupModuleExtension
+    end
+  
+    module SetupModuleExtension #:nodoc:
+      
+      def included(aClass)
+        aClass.extend TestCaseClassExtension
+      end
+    
+      def call_instance_method(symbol, testCase)
+        method = instance_method(symbol).bind(testCase)
+        method.call
+      end
+      
+    end
+    
+    module TestCaseClassExtension #:nodoc:
+      
+      def method_added(symbol)
+        case symbol
+        when :setup
+          unless method_defined?(:setup_without_mixins)
+            alias_method :setup_without_mixins, :setup
+            define_method :setup do
+              send :setup_mixins
+              send :setup_without_mixins
+            end
+          end
+        when :teardown
+          unless method_defined?(:teardown_without_mixins)
+            alias_method :teardown_without_mixins, :teardown
+            define_method :teardown do
+              send :teardown_without_mixins
+              send :teardown_mixins
+            end
+          end
+        end
+      end
+    
+      def included_test_mixins
+        ancestors.find_all {|aModule| aModule != self && aModule < Greenbar::TestSetup}
+      end
+      
+    end
+    
+  end
+end 

data/lib/greenbar/TimeSetup.rb

@@ -0,0 +1,66 @@
+#: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'
+require 'greenbar/ClassMethodSetup'
+
+class Time; end
+#:startdoc:
+#
+# ===Purpose
+#
+# To control time.  What could be more useful than that?  TimeSetup lets you
+# control what time Time.new thinks it is.  
+#
+# ===Usage
+#  
+# 1. Include Greenbar::TimeSetup in your test case.
+# 2. Use Time.now= to define the time you want to be 'now'
+#
+# You may change 'now' as often as you want. 
+#
+# ===Example
+#
+#   :include: doc/examples/TimeSetup.rb
+#
+# ===Additional definitions
+#   Time.now=(time)
+# 
+# sets the Time to returned as 'now' for Time.new and Time.now
+# Must be called before Time.new or Time.now if TimeSetup is being used.
+#
+module Greenbar::TimeSetup
+  #:stopdoc:
+  include Greenbar::TestSetup 
+  include Greenbar::ClassMethodSetup 
+  #:startdoc:
+  
+  def setup_mixin #:nodoc:
+    replace_class_method(Time, :now) {
+      raise "Must use Time.now= when using TimeSetup." unless @now
+      @now
+    }
+
+    replace_class_method(Time, :new) {
+      Time.now
+    }
+
+    def Time.now=(time) #:nodoc:
+        @now = time
+    end
+  end
+    
+  def teardown_mixin #:nodoc:
+    class << Time
+      remove_method :now=
+    end
+  end
+    
+end

data/rakefile.rb

@@ -0,0 +1,102 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+GREENBAR_VERSION = '0.1.1' 
+WEB_BUILD="web/build"
+
+desc "Default Task"
+task :default => :unitTest
+
+desc "Build website"
+task :build_web => [:clean_web_build, :rdoc] do
+	builder = WebBuilder.new(WEB_BUILD, 'web')
+	builder.generate_pages
+	builder.build_page "#{Dir.pwd}/LICENSE", "license.html"
+
+	dest = "#{WEB_BUILD}/documentation"
+	mkdir_p dest
+	cp_r 'html/.', dest
+end
+
+task :clean_web_build do
+	rm_rf WEB_BUILD
+	rm_rf 'html'
+	mkdir_p WEB_BUILD
+end
+
+
+desc "Run unit tests"
+Rake::TestTask.new(:unitTest) {|unitTest|
+  unitTest.test_files = FileList['test/allTests.rb']
+  unitTest.warning = false
+  unitTest.verbose = true
+}
+
+desc "Run examples"
+Rake::TestTask.new(:examples) {|unitTest|
+  unitTest.test_files = FileList['doc/examples/**.rb']
+  unitTest.libs << 'lib'
+  unitTest.warning = false
+  unitTest.verbose = true
+}
+
+rdoc = Rake::RDocTask.new("rdoc") {|rdoc|
+  rdoc.rdoc_dir = 'html'
+  rdoc.template = 'jamis'
+  rdoc.title    = "Greenbar -- Test::Unit Tools"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.main = 'README'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('lib/**/*.rb', 'doc/**/*.rdoc')
+}
+
+FILES_TO_PACKAGE = FileList[
+  'lib/**/*.rb',
+  'test/**/*.rb', 
+  'doc/**/*.rb', 
+  '[A-Z]*',
+  'rakefile.rb',
+]
+
+if ! defined?(Gem)
+  puts "Package Target requires RubyGEMs"
+else
+  gemSpec = Gem::Specification.new {|spec|
+    
+    spec.name = 'greenbar'
+    spec.version = GREENBAR_VERSION
+    spec.summary = "Test::Unit tools."
+    spec.description = <<-EOF
+      Greenbar is a collection of aids for testing with Test::Unit' <<
+    EOF
+    spec.authors = "David Corbin, Kiel Hodges"
+    spec.homepage = "http://greenbar.rubyforge.org"
+    spec.rubyforge_project = "greenbar"
+
+    spec.files = FILES_TO_PACKAGE.to_a
+    spec.test_file = 'test/allTests.rb'
+
+    spec.require_path  = 'lib'
+    spec.autorequire   = 'greenbar.rb'
+
+    spec.has_rdoc = true
+    spec.extra_rdoc_files = rdoc.rdoc_files.reject {|filename| filename =~ /\.rb$/ }.to_a << 'README'
+    spec.rdoc_options <<
+      '--title' <<  'Greenbar - Aids for Testing with Test::Unit' <<
+      '--main' << 'README' <<
+      '--line-numbers' << '--inline-source'
+
+#    spec.signing_key = 'gem-private_key.pem'
+#    spec.cert_chain  = ['gem-public_cert.pem']
+  }
+
+  Rake::GemPackageTask.new(gemSpec) {|package|
+    package.need_tar = true
+  }
+end
+
+