test_extensions 0.1.1 → 0.1.3

data/Readme

@@ -1,9 +1,8 @@
-= QualitySmith Test Extensions
+= Test Extensions
 
-[<b>Home page</b>:]        soon: http://test-extensions.rubyforge.org/
+[<b>Home page</b>:]        http://test-extensions.rubyforge.org/
 [<b>Project site</b>:]     http://rubyforge.org/projects/test-extensions
 [<b>Gem install</b>:]      <tt>gem install test_extensions</tt>
-[<b>Wiki</b>:]             http://wiki.qualitysmith.com/
 [<b>Author</b>:]           Tyler Rick, and others
 [<b>Copyright</b>:]        2007 QualitySmith, Inc.
 [<b>License</b>:]          {GNU General Public License}[http://www.gnu.org/copyleft/gpl.html]
@@ -28,7 +27,7 @@ After:
 
 link:include/assert_equal_with_difference_highlighting-there_he_is.png
 
-See http://qualitysmithext.rubyforge.org/classes/Test/Unit/Assertions.html#M000082 for full details.
+See http://quality-ext.rubyforge.org/classes/Test/Unit/Assertions.html#M000082 for full details.
 
 === Useful assertion methods
 
@@ -38,7 +37,7 @@ See http://qualitysmithext.rubyforge.org/classes/Test/Unit/Assertions.html#M0000
   	assert_match Regexp.loose_join('key phrase 1', 'key phrase 2'), "Some really long string that you want to make sure contains both key phrase 1 and key phrase 2, in that order, but you don't care too much about the stuff in between, and you don't really want to hand-craft the regular expression or worry about escaping things like '.'s and '*'s yourself."
 * <b><tt>assert_changed</tt></b>: assert that a variable changed state during the course of the block (not really useful)
 
-See the individual method documentation for each method for details. These methods are currently part of http://qualitysmithext.rubyforge.org/.
+See the individual method documentation for each method for details. These methods are currently part of http://quality-ext.rubyforge.org.
 
 Rails-specific:
 * assert_user_error
@@ -48,6 +47,10 @@ Rails-specific:
 * <b><tt>capture_output</tt></b> -- captures the standard output/error from the method under test (rather than letting it print to the screen) so that you can make assertions about it.
 * <b><tt>simulate_input</tt></b> -- if your application is expecting some kind of user input on stdin, this method can be used to simulate the input, so that your test is completely automated and self-contained.
 
+=== FreshTestCaseCreator
+
+...
+
 == Installation
 
   sudo gem install test_extensions --include-dependencies
@@ -65,7 +68,7 @@ Then just throw this in your <tt>test_helper.rb</tt>:
 Gems:
 * colored
 * facets
-* qualitysmith_extensions
+* quality_extensions
 
 == Problems, questions, comments, or contributions?
 

data/lib/test_extensions.rb

@@ -1,13 +1,18 @@
 require 'test/unit'
+
 require 'rubygems'
 
 gem 'facets'
 require 'facets/core/kernel/require_local'
+
 require_local 'test_extensions/test_colorizer'
+require_local 'test_extensions/runnable'
+require_local 'test_extensions/remove_constants_when_test_suite_finished'
+require_local 'test_extensions/fresh_test_environment_creator'
 
-gem 'qualitysmith_extensions'
-require 'qualitysmith_extensions/regexp/join'
-require 'qualitysmith_extensions/kernel/capture_output.rb'
-require 'qualitysmith_extensions/kernel/simulate_input.rb'
+gem 'quality_extensions'
+require 'quality_extensions/regexp/join'
+require 'quality_extensions/kernel/capture_output.rb'
+require 'quality_extensions/kernel/simulate_input.rb'
 
-require 'qualitysmith_extensions/test/all'
+require 'quality_extensions/test/all'

data/lib/test_extensions/fresh_test_environment_creator.rb

@@ -0,0 +1,204 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   GPL
+# Developer notes::
+# Changes::
+#++
+
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+require 'rubygems'
+require 'facets/core/kernel/require_local'
+require 'facets/core/kernel/load_local'
+require 'facets/core/kernel/with'
+require 'quality_extensions/module/remove_const'
+require 'quality_extensions/module/create'
+require 'quality_extensions/object/ignore_access'
+
+# useful if you want to try multiple different configurations of the same class
+# and make sure that they all are compatabible in some way (document in your common tests)
+# creates a clean slate by removing constants...
+# Lets you cleanly *document* both all the *commonalities* and all the *differences* between two different behaviors (caused by two different configurations)
+#
+# Example:
+#   # Common setup
+#   test_environment_creator = FreshTestEnvironmentCreator.new(:classes_to_remove => [MyModel]) do
+#     def setup
+#       @object = ClassWithSomeConfiguration.new
+#     end
+#     def test_common_stuff
+#       # These tests should hold true whether we're acting acts_one_way *or* acts_another_way
+#       ...
+#     end
+#   end
+#
+#   # The setup for TestWhenActingOneWay
+#   class MyModel < ActiveRecord::Base
+#     acts_one_way
+#   end
+#   # The TestWhenActingOneWay TestCase itself
+#   test_environment_creator.create(:TestWhenActingOneWay) do
+#     def test_1
+#       ...
+#     end
+#   end.run!
+#
+#   # The setup for TestWhenActingAnotherWay
+#   class MyModel < ActiveRecord::Base
+#     acts_another_way
+#   end
+#   # The TestWhenActingAnotherWay TestCase itself
+#   test_environment_creator.create(:TestWhenActingAnotherWay) do
+#     def test_1
+#       ...
+#     end
+#   end.run!
+#
+class FreshTestEnvironmentCreator
+  def initialize(options = {}, &common_tests)
+    @classes_to_remove = options[:classes_to_remove] || []
+    @common_tests = Module.create(:CommonTests, &common_tests) if block_given?
+  end
+  def create(test_case_name, &contents_of_class)
+    returning test_case_class = Class.create(test_case_name, :superclass => Test::Unit::TestCase, &contents_of_class) do
+      test_case_class.send :include, @common_tests if @common_tests
+      test_case_class.ignore_access.class_variable_set(:@@classes_to_remove, @classes_to_remove)
+    end
+  end
+end
+
+class Test::Unit::TestCase
+  def self.run!
+    Test::Unit::UI::Console::TestRunner.run(self)
+
+    self.ignore_access.class_variable_get(:@@classes_to_remove).each do |class_to_reload|
+      class_to_reload.remove_const! rescue nil
+    end if self.ignore_access.class_variables.include?('@@classes_to_remove')
+  end
+end
+
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'facets/core/integer/multiple'
+
+#---------------------------------------------------------------------------------------------------------------------------------
+# You don't need FreshTestEnvironmentCreator if all you want is some tests / setup common to multiple test cases...
+# It provides that as a feature, but that's easy to do by simply creating a module containing your common test code...
+
+module CommonTestsAndSetup
+  def setup
+    puts 'Common setup'
+  end
+  def test_common_1
+    puts 'test_common_1'
+  end
+end
+
+class Test1 < Test::Unit::TestCase
+  include CommonTestsAndSetup
+  def setup
+    super
+    puts 'Special setup for Test1'
+  end
+  def test_1
+    puts 'test_1'
+  end
+end
+Test1.run!
+
+class Test2 < Test::Unit::TestCase
+  include CommonTestsAndSetup
+  def test_1
+    puts 'test_2'
+  end
+end
+Test2.run!
+
+puts '---------------------------------------------------------------------------------------------------------------------------------'
+#---------------------------------------------------------------------------------------------------------------------------------
+# Beginning of actual tests for FreshTestEnvironmentCreator.
+
+class BaseClass
+  def abstract?; true; end
+  def do_the_stuff_we_always_do; "We did the stuff that we're always supposed to do."; end
+  def gather_user_input;         "Some really unintuitive default user interface for gather input from the user."; end
+  def do_computations;           "Computing... " + (1..10).to_a.join(',') + ',done'; end
+  def behave!
+    gather_user_input +
+    do_the_stuff_we_always_do +
+    do_computations
+  end
+
+  # Configuration macros, which do any number of unknown things to the class which might be hard to undo if you wanted to create
+  # that class again with the same name but with a different configuration... In other words, lets assume that these macros
+  # do all kind of nasty things to the class, which would necessitate us doing a remove_const and redefining the class again
+  # from scratch if we wanted to be guaranteed of having a clean slate...
+  def self.behave_efficiently
+    define_method :do_computations do
+      "Computing... " + (1..10).select(&:even?).join(',') + ',done'
+    end
+  end
+  def self.behave_intelligently
+    define_method :gather_user_input do
+      "Read your mind and intelligently predict what you're trying to accomplish."
+    end
+  end
+end
+
+test_environment_creator = FreshTestEnvironmentCreator.new(:classes_to_remove => [ClassWithSomeConfiguration]) do
+  def setup
+    @object = ClassWithSomeConfiguration.new
+  end
+  def test_common_stuff
+    puts 'Testing common stuff'
+    assert_match Regexp.union("We did the stuff"), @object.behave!
+    assert_match /We did the stuff that we're always supposed to do./, @object.behave!
+    #' (To fix syntax highlighting in vim)
+  end
+end
+
+#---------------------------------------------------------------------------------------------------------------------------------
+
+class ClassWithSomeConfiguration < BaseClass
+  behave_efficiently
+end
+
+test_environment_creator.create(:TestOfEfficiency) do
+  def test_1
+    puts "Testing behave_efficiently"
+    assert_match Regexp.union("unintuitive default user interface"), @object.behave!
+    assert_match Regexp.union("2,4,6,8,10,done"), @object.behave!
+  end
+end.run!
+
+#---------------------------------------------------------------------------------------------------------------------------------
+
+class ClassWithSomeConfiguration < BaseClass
+  behave_intelligently
+end
+
+test_environment_creator.create(:TestOfIntelligence) do
+  def setup
+    puts "(A bit of setup specific to this test case...)"
+    super
+  end
+  def test_1
+    puts "Testing behave_intelligently"
+    assert_match Regexp.union("intelligently predict"), @object.behave!
+    assert_match Regexp.union("1,2,3,4,5,6,7,8,9,10,done"), @object.behave!
+  end
+end.run!
+
+
+=end
+

data/lib/test_extensions/register_additional_observers.rb

@@ -0,0 +1,76 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   GPL
+# Developer notes::
+# Changes::
+#++
+
+require 'test/unit/ui/console/testrunner'
+
+require 'rubygems'
+require 'quality_extensions/module/alias_method_chain'
+
+class Test::Unit::UI::TestRunnerMediator
+  # Test::Unit uses listeners to notify the UI of test progress, failures, etc. That's great, if you're writing a new UI.
+  # But unfortunately, it doesn't provide an easy way (that I could find) to add your *own* listeners (for things *other* than the UI).
+  # The only place that I see add_listener used anywhere in Test::Unit is in the UI classes (ui/*/testrunner.rb).
+  #
+  # So how does one hook into Test::Unit to register/add a listener for things *without* writing a new UI? (Let's assume we're
+  # perfectly happy with the Test::Unit::UI::Console UI...)
+  #
+  # They've provided some nice "events" ("channels"?) -- like TestCase::STARTED, TestCase::FINISHED, TestResult::FAULT -- but
+  # how do I register with Test::Unit that *I* want to be notified of those events too?
+  #
+  # Also, add_listener is an instance method -- how do you get inside of TestCase/TestRunnerMediator so that you *have* an instance?
+  #
+  # I wanted to add my *own* listener callback. So that's why I wrote this monkey patch... (If there's an easier way, let me know...)
+  #
+  # * Test::Unit::TestCase::FINISHED -- Seems to be called not when the entire TestCase has finished running (as the name would suggest) but after every test *method* in the TestCase...?
+  # * Test::Unit::UI::TestRunnerMediator::FINISHED -- When all the tests for a whole suite have finished
+
+  def self.register_additional_observers(&block)
+    @@additional_observers_procs ||= []
+    @@additional_observers_procs.push block
+  end
+  def run_suite_with_additional_observers
+    @@additional_observers_procs.each do |proc|
+      proc.call(self)
+    end if defined?(@@additional_observers_procs)
+    run_suite_without_additional_observers
+  end
+  alias_method_chain :run_suite, :additional_observers
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+require 'rubygems'
+require 'facets/core/kernel/require_local'
+require_local 'runnable'
+
+Test::Unit::UI::TestRunnerMediator.register_additional_observers do |mediator|
+  mediator.add_listener(Test::Unit::TestCase::FINISHED) do |*args|
+    puts "FINISHED!"
+    p args
+  end
+end
+
+
+class Test1 < Test::Unit::TestCase
+  def test_1
+  end
+  def test_2
+  end
+end
+Test1.run!
+
+=end
+
+

data/lib/test_extensions/remove_constants_when_test_suite_finished.rb

@@ -0,0 +1,70 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   GPL
+# Developer notes::
+# Changes::
+#++
+
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+require 'rubygems'
+require 'facets/core/kernel/require_local'
+require 'quality_extensions/module/remove_const'
+require 'quality_extensions/object/ignore_access'
+require 'quality_extensions/module/alias_method_chain'
+
+require_local 'runnable'
+
+class Test::Unit::TestCase
+
+  def self.run_with_remove_constants_when_test_suite_finished!
+    run_without_remove_constants_when_test_suite_finished!
+
+    self.ignore_access.class_variable_get(:@@classes_to_remove).each do |class_to_reload|
+      #puts "removing #{class_to_reload}"
+      class_to_reload.remove_const! rescue nil
+    end if self.ignore_access.class_variables.include?('@@classes_to_remove')
+  end
+
+  class << self
+    alias_method_chain :run!, :remove_constants_when_test_suite_finished
+  end
+end
+
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class Foo
+  def method1; end
+end
+
+class Test1 < Test::Unit::TestCase
+  def test_1
+    assert_nothing_raised { Foo.new.method1 }
+  end
+end
+Test1.ignore_access.class_variable_set(:@@classes_to_remove, [Foo])
+Test1.run!
+
+class Foo
+end
+
+class Test2 < Test::Unit::TestCase
+  def test_1
+    assert_raise(NoMethodError) { Foo.new.method1 }
+  end
+end
+Test2.run!
+
+=end
+

data/lib/test_extensions/runnable.rb

@@ -0,0 +1,41 @@
+#--
+# Author::    Tyler Rick
+# Copyright:: Copyright (c) 2007 QualitySmith, Inc.
+# License::   GPL
+# Developer notes::
+# Changes::
+#++
+
+require 'test/unit'
+require 'test/unit/ui/console/testrunner'
+
+require 'rubygems'
+require 'quality_extensions/module/remove_const'
+require 'quality_extensions/module/create'
+require 'quality_extensions/object/ignore_access'
+
+class Test::Unit::TestCase
+  # Just a (much conciser) wrapper for Test::Unit::UI::Console::TestRunner.run(NameOfTestCase)
+  def self.run!
+    Test::Unit::UI::Console::TestRunner.run(self)
+  end
+end
+
+
+#  _____         _
+# |_   _|__  ___| |_
+#   | |/ _ \/ __| __|
+#   | |  __/\__ \ |_
+#   |_|\___||___/\__|
+#
+=begin test
+require 'test/unit'
+
+class Test1 < Test::Unit::TestCase
+  def test_1
+  end
+end
+Test1.run!
+
+=end
+

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.2
+rubygems_version: 0.9.4
 specification_version: 1
 name: test_extensions
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
-date: 2007-05-01 00:00:00 -07:00
+  version: 0.1.3
+date: 2007-10-09 00:00:00 -07:00
 summary: A collection of user-contributed enhancements and new methods for Test::Unit
 require_paths: 
 - lib
@@ -31,6 +31,10 @@ authors:
 files: 
 - lib/test_extensions.rb
 - lib/test_extensions/test_colorizer.rb
+- lib/test_extensions/remove_constants_when_test_suite_finished.rb
+- lib/test_extensions/register_additional_observers.rb
+- lib/test_extensions/fresh_test_environment_creator.rb
+- lib/test_extensions/runnable.rb
 - Readme
 test_files: []
 
@@ -68,7 +72,7 @@ dependencies:
         version: 0.0.0
     version: 
 - !ruby/object:Gem::Dependency 
-  name: qualitysmith_extensions
+  name: quality_extensions
   version_requirement: 
   version_requirements: !ruby/object:Gem::Version::Requirement 
     requirements: