Linguistics 1.0.3

data/tests/lingtestcase.rb

@@ -0,0 +1,239 @@
+#!/usr/bin/ruby
+# 
+# This is an abstract test case class for building Test::Unit unit tests for the
+# Linguistics module. It consolidates most of the maintenance work that must be
+# done to build a test file by adjusting the $LOAD_PATH appropriately, as well
+# as adding some other useful methods that make building and maintaining the
+# tests much easier (IMHO). See the docs for Test::Unit for more info on the
+# particulars of unit testing.
+# 
+# == Synopsis
+# 
+#	# Allow the unit test to be run from the base dir, or from tests/ or
+#	# similar:
+#	begin
+#		require 'tests/lingtestcase'
+#	rescue
+#		require '../lingtestcase'
+#	end
+#
+#	class MySomethingTest < Linguistics::TestCase
+#		def setup
+#			super()
+#			@foo = 'bar'
+#		end
+#
+#		def test_00_something
+#			obj = nil
+#			assert_nothing_raised { obj = MySomething::new }
+#			assert_instance_of MySomething, obj
+#			assert_respond_to :myMethod, obj
+#		end
+#	end
+# 
+# == Rcsid
+# 
+# $Id: lingtestcase.rb 78 2005-07-13 19:58:43Z ged $
+# 
+# == Authors
+# 
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+#:include: COPYRIGHT
+#
+#---
+#
+# Please see the file COPYRIGHT in the 'docs' directory for licensing details.
+#
+
+begin
+	basedir = File::dirname( File::dirname(__FILE__) )
+	unless $LOAD_PATH.include?( "#{basedir}/lib" )
+		$LOAD_PATH.unshift "#{basedir}/lib"
+	end
+end
+
+require "test/unit"
+
+require "linguistics"
+
+
+module Linguistics
+
+	### The abstract base class for Linguistics test cases.
+	class TestCase < Test::Unit::TestCase
+
+		@methodCounter = 0
+		@setupBlocks = []
+		@teardownBlocks = []
+		class << self
+			attr_accessor :methodCounter, :setupBlocks, :teardownBlocks
+		end
+
+
+		### Inheritance callback -- adds @setupBlocks and @teardownBlocks ivars
+		### and accessors to the inheriting class.
+		def self::inherited( klass )
+			klass.module_eval {
+				@setupBlocks = []
+				@teardownBlocks = []
+
+				class << self
+					attr_accessor :setupBlocks, :teardownBlocks
+				end
+			}
+			klass.methodCounter = 0
+		end
+		
+
+
+		### Output the specified <tt>msgs</tt> joined together to
+		### <tt>STDERR</tt> if <tt>$DEBUG</tt> is set.
+		def self::debugMsg( *msgs )
+			return unless $DEBUG
+			self.message "DEBUG>>> %s" % msgs.join('')
+		end
+
+		### Output the specified <tt>msgs</tt> joined together to
+		### <tt>STDOUT</tt>.
+		def self::message( *msgs )
+			$stderr.puts msgs.join('')
+			$stderr.flush
+		end
+
+
+		### Add a setup block for the current testcase
+		def self::addSetupBlock( &block )
+			self.methodCounter += 1
+			newMethodName = "setup_#{self.methodCounter}".intern
+			define_method( newMethodName, &block )
+			self.setupBlocks.push newMethodName
+		end
+			
+		### Add a teardown block for the current testcase
+		def self::addTeardownBlock( &block )
+			self.methodCounter += 1
+			newMethodName = "teardown_#{self.methodCounter}".intern
+			define_method( newMethodName, &block )
+			self.teardownBlocks.unshift newMethodName
+		end
+			
+
+		#############################################################
+		###	I N S T A N C E   M E T H O D S
+		#############################################################
+
+		### A dummy test method to allow this Test::Unit::TestCase to be
+		### subclassed without complaining about the lack of tests.
+		def test_0_dummy
+		end
+
+
+		### Forward-compatibility method for namechange in Test::Unit
+		def setup( *args )
+			self.class.setupBlocks.each {|sblock|
+				debugMsg "Calling setup block method #{sblock}"
+				self.send( sblock )
+			}
+			super( *args )
+		end
+		alias_method :set_up, :setup
+
+
+		### Forward-compatibility method for namechange in Test::Unit
+		def teardown( *args )
+			super( *args )
+			self.class.teardownBlocks.each {|tblock|
+				debugMsg "Calling teardown block method #{tblock}"
+				self.send( tblock )
+			}
+		end
+		alias_method :tear_down, :teardown
+
+
+		### Instance alias for the like-named class method.
+		def message( *msgs )
+			self.class.message( *msgs )
+		end
+
+
+		### Instance alias for the like-named class method
+		def debugMsg( *msgs )
+			self.class.debugMsg( *msgs )
+		end
+
+
+		### Output a separator line made up of <tt>length</tt> of the specified
+		### <tt>char</tt>.
+		def writeLine( length=75, char="-" )
+			$stderr.puts "\r" + (char * length )
+		end
+
+
+		### Output a header for delimiting tests
+		def printTestHeader( desc )
+			return unless $VERBOSE || $DEBUG
+			message ">>> %s <<<" % desc
+		end
+
+
+		### Try to force garbage collection to start.
+		def collectGarbage
+			a = []
+			1000.times { a << {} }
+			a = nil
+			GC.start
+		end
+
+
+		### Output the name of the test as it's running if in verbose mode.
+		def run( result )
+			$stderr.puts self.name if $VERBOSE || $DEBUG
+			super
+		end
+
+
+		#############################################################
+		###	E X T R A   A S S E R T I O N S
+		#############################################################
+
+		### Negative of assert_respond_to
+		def assert_not_respond_to( obj, meth )
+			msg = "%s expected NOT to respond to '%s'" %
+				[ obj.inspect, meth ]
+			assert_block( msg ) {
+				!obj.respond_to?( meth )
+			}
+		end
+
+
+		### Assert that the instance variable specified by +sym+ of an +object+
+		### is equal to the specified +value+. The '@' at the beginning of the
+		### +sym+ will be prepended if not present.
+		def assert_ivar_equal( value, object, sym )
+			sym = "@#{sym}".intern unless /^@/ =~ sym.to_s
+			msg = "Instance variable '%s'\n\tof <%s>\n\texpected to be <%s>\n" %
+				[ sym, object.inspect, value.inspect ]
+			msg += "\tbut was: <%s>" % object.instance_variable_get(sym)
+			assert_block( msg ) {
+				value == object.instance_variable_get(sym)
+			}
+		end
+
+
+		### Assert that the specified +object+ has an instance variable which
+		### matches the specified +sym+. The '@' at the beginning of the +sym+
+		### will be prepended if not present.
+		def assert_has_ivar( sym, object )
+			sym = "@#{sym}" unless /^@/ =~ sym.to_s
+			msg = "Object <%s> expected to have an instance variable <%s>" %
+				[ object.inspect, sym ]
+			assert_block( msg ) {
+				object.instance_variables.include?( sym.to_s )
+			}
+		end
+
+	end # class TestCase
+
+end # module Linguistics
+

data/tests/use.tests.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/ruby -w
+#
+# Unit test for the 'use' function of the Linguistics module.
+# $Id: use.tests.rb 78 2005-07-13 19:58:43Z ged $
+#
+# Copyright (c) 2003 The FaerieMUD Consortium.
+# 
+
+unless defined? Linguistics::TestCase
+	testsdir = File::dirname( File::expand_path( __FILE__ ) )
+	$LOAD_PATH.unshift testsdir unless $LOAD_PATH.include?( testsdir )
+
+	require 'lingtestcase'
+end
+
+
+### This test suite tests the language-installation function of the Linguistics
+### module.
+module Linguistics
+class UseTestCase < Linguistics::TestCase
+
+	LanguageCodes = [ :en, :EN, 'en', 'EN', 'En', 'eN' ]
+	BogusLanguageCodes = [ :zz, :ry, :qi ]
+	MissingLanguageCodes = [ :ja, :fr, :es ]
+
+	TestArray = %w{stone stick hammer stone lantern}
+	TestString = "banner"
+	TestNumber = 5
+
+	def test_00_UseEnglish
+		printTestHeader "Linguistics: Use <language>"
+
+		# Test the only (currently) valid codes
+		LanguageCodes.each do |code|
+			assert_nothing_raised {
+				Linguistics::use( code )
+			}
+		end
+
+		# Test bogus codes
+		BogusLanguageCodes.each do |code|
+			assert_raises( RuntimeError ) {
+				Linguistics::use( code )
+			}
+		end
+
+		# Test valid, but missing languages (might fail for implementors of new
+		# languages).
+		MissingLanguageCodes.each do |code|
+			assert_raises( LoadError ) {
+				Linguistics::use( code )
+			}
+		end
+
+	end
+
+
+	def test_10_InflectorMethod
+		printTestHeader "Linguistics: Inflector method (core classes)"
+		rval = nil
+
+		# This shouldn't be necessary, but it's here for completeness
+		Linguistics::use( :en )
+
+		[ TestArray, TestString, TestNumber ].each do |obj|
+			debugMsg "obj.class.instance_variables = %s" %
+				obj.class.instance_variables.inspect
+
+			assert_respond_to obj, :en
+			assert_nothing_raised {
+				rval = obj.en
+			}
+			assert_kind_of Linguistics::LanguageProxyClass, rval
+		end
+	end
+
+
+	def test_20_SpecifyClasses
+		printTestHeader "Linguistics: Extend specific classes"
+		
+		assert_nothing_raised( "One class, not in an array" ) {
+			Linguistics::use( :en, :classes => Symbol )
+		}
+		assert_respond_to :foo, :en
+
+		assert_nothing_raised( "One class, in an array" ) {
+			Linguistics::use( :en, :classes => [IO] )
+		}
+		assert_respond_to $stderr, :en
+
+		assert_nothing_raised( "Two classes, in an Array" ) {
+			Linguistics::use( :en, :classes => [Class, Range] )
+		}
+		assert_respond_to Array, :en
+		assert_respond_to( (1..5), :en )
+	end
+
+end
+end