linguistics 1.0.8

data/rake/testing.rb

@@ -0,0 +1,187 @@
+# 
+# Rake tasklib for testing tasks
+
+# 
+# Authors:
+# * Michael Granger <ged@FaerieMUD.org>
+# 
+
+unless defined?( COVERAGE_MINIMUM )
+	if ENV['COVVERAGE_MINIMUM']
+		COVERAGE_MINIMUM = Float( ENV['COVERAGE_MINIMUM'] )
+	else
+		COVERAGE_MINIMUM = 85.0 
+	end
+end
+SPEC_FILES       = [] unless defined?( SPEC_FILES )
+TEST_FILES       = [] unless defined?( TEST_FILES )
+
+COMMON_SPEC_OPTS = ['-Du'] unless defined?( COMMON_SPEC_OPTS )
+
+COVERAGE_TARGETDIR = BASEDIR + 'coverage' unless defined?( COVERAGE_TARGETDIR )
+RCOV_EXCLUDES      = 'spec,tests,/Library/Ruby,/var/lib,/usr/local/lib' unless
+	defined?( RCOV_EXCLUDES )
+
+
+desc "Run all defined tests"
+task :test do
+	unless SPEC_FILES.empty?
+		log "Running specs"
+		Rake::Task['spec:quiet'].invoke
+	end
+
+	unless TEST_FILES.empty?
+		log "Running unit tests"
+		Rake::Task[:unittests].invoke 
+	end
+end
+
+
+### RSpec specifications
+begin
+	gem 'rspec', '>= 1.1.3'
+
+	require 'spec'
+	require 'spec/rake/spectask'
+
+	### Task: spec
+	desc "Run specs"
+	task :spec => 'spec:doc'
+
+	namespace :spec do
+		desc "Run rspec every time there's a change to one of the files"
+		task :autotest do
+			require 'autotest/rspec'
+
+			autotester = Autotest::Rspec.new
+			autotester.run
+		end
+
+		desc "Generate regular color 'doc' spec output"
+		Spec::Rake::SpecTask.new( :doc ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 's', '-c']
+		end
+
+		desc "Generate spec output with profiling"
+		Spec::Rake::SpecTask.new( :profile ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'o']
+		end
+
+		desc "Generate quiet non-colored plain-text output"
+		Spec::Rake::SpecTask.new( :quiet ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'p']
+		end
+
+		desc "Generate HTML output"
+		Spec::Rake::SpecTask.new( :html ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = COMMON_SPEC_OPTS + ['-f', 'h']
+		end
+
+	end
+rescue LoadError => err
+	task :no_rspec do
+		$stderr.puts "Specification tasks not defined: %s" % [ err.message ]
+	end
+
+	task :spec => :no_rspec
+	namespace :spec do
+		task :autotest => :no_rspec
+		task :doc => :no_rspec
+		task :profile => :no_rspec
+		task :quiet => :no_rspec
+		task :html => :no_rspec
+	end
+end
+
+
+### Test::Unit tests
+begin
+	require 'rake/testtask'
+
+	Rake::TestTask.new( :unittests ) do |task|
+		task.libs += [LIBDIR]
+		task.test_files = TEST_FILES
+		task.verbose = true
+	end
+
+rescue LoadError => err
+	task :no_test do
+		$stderr.puts "Test tasks not defined: %s" % [ err.message ]
+	end
+
+	task :unittests => :no_rspec
+end
+
+
+### RCov (via RSpec) tasks
+begin
+	gem 'rcov'
+	gem 'rspec', '>= 1.1.3'
+
+	require 'spec'
+	require 'rcov'
+
+	### Task: coverage (via RCov)
+	desc "Build test coverage reports"
+	unless SPEC_FILES.empty?
+		Spec::Rake::SpecTask.new( :coverage ) do |task|
+			task.spec_files = SPEC_FILES
+			task.libs += [LIBDIR]
+			task.spec_opts = ['-f', 'p', '-b']
+			task.rcov_opts = RCOV_OPTS
+			task.rcov = true
+		end
+	end
+
+
+	### Task: rcov
+	task :rcov => :coverage
+
+	### Other coverage tasks
+	namespace :coverage do
+		desc "Generate a detailed text coverage report"
+		Spec::Rake::SpecTask.new( :text ) do |task|
+			task.spec_files = SPEC_FILES
+			task.rcov_opts = RCOV_OPTS + ['--text-report']
+			task.rcov = true
+		end
+
+		desc "Show differences in coverage from last run"
+		Spec::Rake::SpecTask.new( :diff ) do |task|
+			task.spec_files = SPEC_FILES
+			task.spec_opts = ['-f', 'p', '-b']
+			task.rcov_opts = RCOV_OPTS - ['--save'] + ['--text-coverage-diff']
+			task.rcov = true
+		end
+
+		desc "Run RCov in 'spec-only' mode to check coverage from specs"
+		Spec::Rake::SpecTask.new( :speconly ) do |task|
+			task.spec_files = SPEC_FILES
+			task.rcov_opts = ['--exclude', RCOV_EXCLUDES, '--text-report', '--save']
+			task.rcov = true
+		end
+	end
+
+	CLOBBER.include( COVERAGE_TARGETDIR )
+
+rescue LoadError => err
+	task :no_rcov do
+		$stderr.puts "Coverage tasks not defined: RSpec+RCov tasklib not available: %s" %
+		[ err.message ]
+	end
+
+	task :coverage => :no_rcov
+	task :clobber_coverage
+	task :rcov => :no_rcov
+	namespace :coverage do
+		task :text => :no_rcov
+		task :diff => :no_rcov
+	end
+	task :verify => :no_rcov
+end
+
+

data/rake/verifytask.rb

@@ -0,0 +1,64 @@
+#####################################################################
+###	S U B V E R S I O N   T A S K S   A N D   H E L P E R S
+#####################################################################
+
+require 'rake/tasklib'
+
+#
+# Work around the inexplicable behaviour of the original RDoc::VerifyTask, which 
+# errors if your coverage isn't *exactly* the threshold.
+# 
+
+# A task that can verify that the RCov coverage doesn't
+# drop below a certain threshold. It should be run after
+# running Spec::Rake::SpecTask.
+class VerifyTask < Rake::TaskLib
+	
+	COVERAGE_PERCENTAGE_PATTERN = 
+		%r{<tt class='coverage_code'>(\d+\.\d+)%</tt>}
+	
+	# Name of the task. Defaults to :verify_rcov
+	attr_accessor :name
+
+	# Path to the index.html file generated by RCov, which
+	# is the file containing the total coverage.
+	# Defaults to 'coverage/index.html'
+	attr_accessor :index_html
+
+	# Whether or not to output details. Defaults to true.
+	attr_accessor :verbose
+
+	# The threshold value (in percent) for coverage. If the 
+	# actual coverage is not equal to this value, the task will raise an 
+	# exception. 
+	attr_accessor :threshold
+
+	def initialize( name=:verify )
+		@name = name
+		@index_html = 'coverage/index.html'
+		@verbose = true
+		yield self if block_given?
+		raise "Threshold must be set" if @threshold.nil?
+		define
+	end
+
+	def define
+		desc "Verify that rcov coverage is at least #{threshold}%"
+
+		task @name do
+			total_coverage = nil
+			if match = File.read( index_html ).match( COVERAGE_PERCENTAGE_PATTERN )
+				total_coverage = Float( match[1] )
+			else
+				raise "Couldn't find the coverage percentage in #{index_html}"
+			end
+
+			puts "Coverage: #{total_coverage}% (threshold: #{threshold}%)" if verbose
+			if total_coverage < threshold
+				raise "Coverage must be at least #{threshold}% but was #{total_coverage}%"
+			end
+		end
+	end
+end
+
+# vim: set nosta noet ts=4 sw=4:

data/rake/win32.rb

@@ -0,0 +1,190 @@
+# 
+# Win32-specific tasks (cross-compiling, etc.)
+# 
+# Thanks to some people that understand this stuff better than me for
+# posting helpful blog posts. This stuff is an amalgam of stuff they did:
+# 
+# * Mauricio Fernandez
+#   http://eigenclass.org/hiki/cross+compiling+rcovrt
+# 
+# * Jeremy Hinegardner
+#   http://www.copiousfreetime.org/articles/2008/10/12/building-gems-for-windows.html
+# 
+# * Aaron Patterson
+#   http://tenderlovemaking.com/2008/11/21/cross-compiling-ruby-gems-for-win32/
+
+require 'rubygems'
+require 'rake'
+require 'pathname'
+require 'rubygems/platform'
+require 'rbconfig'
+require 'uri'
+require 'net/ftp'
+
+HOMEDIR        = Pathname( '~' ).expand_path
+RUBYVERSION    = '1.8.6-p287'
+RUBYVERSION_MAJORMINOR = RUBYVERSION[/^\d+\.\d+/]
+
+RUBY_DL_BASE   = "ftp://ftp.ruby-lang.org/pub/ruby/#{RUBYVERSION_MAJORMINOR}/"
+RUBY_DL_URI    = URI( RUBY_DL_BASE + "ruby-#{RUBYVERSION}.tar.gz" )
+
+XCOMPILER_DIR  = HOMEDIR + '.ruby_mingw32'
+
+XCOMPILER_DL   = XCOMPILER_DIR + "ruby-#{RUBYVERSION}.tar.gz"
+XCOMPILER_SRC  = XCOMPILER_DIR + "ruby-#{RUBYVERSION}"
+
+XCOMPILER_BIN  = XCOMPILER_DIR + 'bin'
+XCOMPILER_LIB  = XCOMPILER_DIR + 'lib'
+XCOMPILER_RUBY = XCOMPILER_BIN + 'ruby.exe'
+
+XCOMPILER_LOAD_PATH = XCOMPILER_LIB + "ruby/#{RUBYVERSION_MAJORMINOR}/i386-mingw32"
+
+TAR_OPTS = { :compression => :gzip }
+
+WIN32_GEMSPEC = GEMSPEC.dup
+WIN32_GEMSPEC.files += FileList[ EXTDIR + '**.{dll,so}' ]
+WIN32_GEMSPEC.platform = Gem::Platform.new( 'i386-mingw32' )
+WIN32_GEMSPEC.extensions = []
+
+
+CONFIGURE_CMD = %W[
+	env
+		ac_cv_func_getpgrp_void=no
+		ac_cv_func_setpgrp_void=yes
+		rb_cv_negative_time_t=no
+		ac_cv_func_memcmp_working=yes
+		rb_cv_binary_elf=no
+    ./configure
+	    --host=i386-mingw32
+	    --target=i386-mingw32
+	    --build=#{Config::CONFIG['build']}
+	    --prefix=#{XCOMPILER_DIR}
+]
+
+### Archive::Tar::Reader#extract (as of 0.9.0) is broken w.r.t.
+### permissions, so we have to do this ourselves.
+def untar( tarfile, targetdir )
+	targetdir = Pathname( targetdir )
+	raise "No such directory: #{targetdir}" unless targetdir.directory?
+
+	reader = Archive::Tar::Reader.new( tarfile.to_s, TAR_OPTS )
+
+	mkdir_p( targetdir )
+	reader.each( true ) do |header, body|
+		path = targetdir + header[:path]
+		# trace "Header is: %p" % [ header ]
+
+		case header[:type]
+		when :file
+			trace "  #{path}"
+			path.open( File::WRONLY|File::EXCL|File::CREAT|File::TRUNC, header[:mode] ) do |fio|
+				bytesize = header[:size]
+				fio.write( body[0,bytesize] )
+			end
+
+		when :directory
+			trace "  #{path}"
+			path.mkpath
+
+		when :link
+			linktarget = targetdir + header[:dest]
+			trace "  #{path} => #{linktarget}"
+			path.make_link( linktarget.to_s )
+
+		when :symlink
+			linktarget = targetdir + header[:dest]
+			trace "  #{path} -> #{linktarget}" 
+			path.make_symlink( linktarget )
+		end
+	end
+
+end
+
+
+begin
+	require 'archive/tar'
+
+	namespace :win32 do
+		directory XCOMPILER_DIR.to_s
+
+		file XCOMPILER_DL => XCOMPILER_DIR do
+			# openuri can't handle this -- passive ftp required?
+			# run 'wget', '-O', XCOMPILER_DL, RUBY_DL_URI
+			log "Downloading ruby distro from %s" % [ RUBY_DL_URI ]
+			ftp = Net::FTP.new( RUBY_DL_URI.host )
+			ftp.login
+			ftp.getbinaryfile( RUBY_DL_URI.path, XCOMPILER_DL, 4096 )
+			ftp.close
+		end
+
+		directory XCOMPILER_SRC.to_s
+		task XCOMPILER_SRC => [ XCOMPILER_DIR, XCOMPILER_DL ] do
+			if XCOMPILER_SRC.exist?
+				trace "Rake fails. #{XCOMPILER_SRC} already exists."
+			else
+				untar( XCOMPILER_DL, XCOMPILER_DIR )
+			end
+		end
+
+		file XCOMPILER_RUBY => XCOMPILER_SRC do
+			Dir.chdir( XCOMPILER_SRC ) do
+				unless File.exist?( 'Makefile.in.orig' )
+					File.open( 'Makefile.in.new', IO::CREAT|IO::WRONLY|IO::EXCL ) do |ofh|
+						IO.readlines( 'Makefile.in' ).each do |line|
+							next if line.include?( 0.chr )
+							trace "  copying line: %p" % [ line ]
+							line.sub!( /ALT_SEPARATOR = ".*?"/, "ALT_SEPARATOR = 92.chr" )
+							ofh.write( line )
+						end
+					end
+
+					mv 'Makefile.in', 'Makefile.in.orig'
+					mv 'Makefile.in.new', 'Makefile.in'
+				end
+
+				run *CONFIGURE_CMD
+				run 'make', 'ruby'
+				run 'make', 'rubyw.exe'
+				run 'make', 'install'
+			end
+		end
+
+		file XCOMPILER_LOAD_PATH => XCOMPILER_RUBY
+
+		desc "Cross-compile the library for Win32 systems, installing a cross-" +
+		     "compiled Ruby if necessary"
+		task :build => [ EXTDIR, XCOMPILER_LOAD_PATH.to_s ] do
+			in_subdirectory( EXTDIR ) do
+				ruby "-I#{XCOMPILER_LOAD_PATH}", 'extconf.rb'
+				sh 'make'
+			end
+		end
+
+		desc "Build a binary gem for win32 systems"
+		task :gem => ['win32:build', PKGDIR.to_s] + WIN32_GEMSPEC.files do
+			when_writing( "Creating win32 GEM" ) do
+				pkgname = WIN32_GEMSPEC.file_name
+				builder = Gem::Builder.new( WIN32_GEMSPEC )
+				builder.build
+				mv pkgname, PKGDIR + pkgname, :verbose => $trace
+			end
+		end
+	end
+
+rescue LoadError => err
+	trace "Couldn't load the win32 tasks: %s: %s" % [ err.class.name, err.message ]
+
+	task :no_win32_build do
+		abort "No win32 build: %s: %s" % [ err.class.name, err.message ]
+	end
+
+	namespace :win32 do
+		desc "Build a binary Gem for Win32 systems, installing a cross " +
+		     "compiled Ruby if necessary"
+		task :gem => :no_win32_build
+		task :build => :no_win32_build
+	end
+
+end
+
+

data/spec/linguistics/en_spec.rb

@@ -0,0 +1,215 @@
+#!/usr/bin/env spec -cfs
+
+BEGIN {
+	require 'pathname'
+	basedir = Pathname.new( __FILE__ ).dirname.parent.parent
+
+	libdir = basedir + "lib"
+
+	$LOAD_PATH.unshift( libdir ) unless $LOAD_PATH.include?( libdir )
+}
+
+begin
+	require 'spec/runner'
+	require 'linguistics'
+	require 'linguistics/en'
+rescue LoadError
+	unless Object.const_defined?( :Gem )
+		require 'rubygems'
+		retry
+	end
+	raise
+end
+
+
+describe Linguistics::EN do
+
+	before( :all ) do
+		Linguistics::use( :en )
+		include Linguistics::EN
+	end
+
+
+	describe "conjunctions with an Array of a single element" do
+
+		before( :each ) do
+			@array = ['cat']
+		end
+
+		it "results in a phrase with indefinite article" do
+			@array.en.conjunction.should == "a cat"
+		end
+		
+	end
+
+
+	describe "conjunction with an Array of two different words" do
+
+		before( :each ) do
+			@array = ['cat', 'dog']
+		end
+
+		it "results in a phrase joined with 'and' with default options" do
+			@array.en.conjunction.should == "a cat and a dog"
+		end
+		
+		it "results in a phrase joined with 'plus' if 'plus' is set as the conjunctive" do
+			@array.en.conjunction(:conjunctive => 'plus').should == "a cat plus a dog"
+		end
+		
+		it "results in a phrase joined with a space if an empty string is set as the conjunctive" do
+			@array.en.conjunction(:conjunctive => '').should == "a cat a dog"
+		end
+		
+	end
+
+
+	describe "conjunction with an Array of two words that differ only in case" do
+
+		before( :each ) do
+			@array = ['cat', 'Cat']
+		end
+
+		it "combines them into their downcased equivalents with default options" do
+			@array.en.conjunction.should == "two cats"
+		end
+		
+		it "lists them separately if :combine is set to false" do
+			@array.en.conjunction(:combine => false).should == "a cat and a Cat"
+		end
+		
+		it "doesn't combine them if :casefold is turned off" do
+			@array.en.conjunction(:casefold => false).should == "a cat and a Cat"
+		end
+		
+		it "combines and lists them with a non-specific count if :generalize is set" do
+			@array.en.conjunction(:generalize => true).should == "several cats"
+		end
+		
+	end
+
+
+	describe "conjunction with an Array of many (more than two) words of varying cases" do
+
+		before( :each ) do
+			@array = %w{cat dog fox dog chicken chicken Fox chicken goose Dog goose}
+		end
+
+		it "combines them into their downcased equivalents and lists them in order of amount " +
+		   "with default options" do
+			@array.en.conjunction.should == 
+				'three dogs, three chickens, two foxes, two geese, and a cat'
+		end
+		
+		it "lists them separately if :combine is set to false" do
+			@array.en.conjunction(:combine => false).should == 
+				'a cat, a dog, a fox, a dog, a chicken, a chicken, a Fox, a '\
+				'chicken, a goose, a Dog, and a goose'
+		end
+		
+		it "doesn't combine the differently-cased ones if :casefold is turned off" do
+			@array.en.conjunction(:casefold => false).should == 
+				'three chickens, two dogs, two geese, a cat, a fox, a Fox, '\
+				'and a Dog'
+		end
+		
+		it "combines and lists them with a non-specific count if :generalize is set" do
+			@array.en.conjunction(:generalize => true).should == 
+				'several dogs, several chickens, several foxes, several '\
+				'geese, and a cat'
+		end
+		
+	end
+	
+
+	describe "conjunction with an object-transform block" do
+
+		it "doesn't still have #6: #conjunction doesn't invoke supplied block under some conditions"
+		before( :each ) do
+			# Create a new class, as we need to guarantee that this will be the
+			# first #conjunction call to it.
+			@collection = Class::new {
+				include Enumerable, Linguistics
+				def initialize( *ary )
+					@ary = ary.flatten
+				end
+
+				# Delegate #each to the contained Array
+				def each( &block )
+					@ary.each( &block )
+				end
+			}
+
+			@obj = @collection.new( 'foo', 'bar', 'baz', 'tree', 'node', 'sonogram' )
+		end
+
+		it "uses supplied block for object transform on first invocation" do
+			@obj.en.conjunction {|word| "%s-letter word" % word.length.en.numwords }.should ==
+				"three three-letter words, two four-letter words, and an eight-letter word"
+		end
+	end
+
+
+
+	def test_conjunction_should_use_supplied_block_for_object_transform
+		rval = nil
+
+		assert_nothing_raised do
+			rval = Items.en.conjunction {|word| "%s-word" % word[0,1]}
+		end
+
+		assert_equal "three c-words and a b-word", rval
+	end
+
+
+	def test_conjunction_should_use_supplied_block_for_object_transform_through_autoproxy
+		rval = nil
+
+		assert_nothing_raised do
+			rval = Items.conjunction {|word| "%s-word" % word[0,1]}
+		end
+
+		assert_equal "three c-words and a b-word", rval
+	end
+
+	def test_conjunction_with_penultimate_separator_turned_off_should_not_use_one
+		rval = nil
+		
+		assert_nothing_raised do
+			rval = Items.en.conjunction( :penultimate => false )
+		end
+		
+		assert_equal "a cow, a chicken, a blancmange and a cyclist", rval
+	end
+
+	def test_three_item_conjunction_should_honor_penultimate_setting
+		rval = nil
+		
+		assert_nothing_raised do
+			rval = %w{duck cow dog}.en.conjunction( :penultimate => false )
+		end
+		
+		assert_equal "a duck, a cow and a dog", rval
+	end
+
+	def test_conjunction_uses_alt_separator_if_phrases_include_the_primary_one
+		rval = nil
+		scene_items = [
+			"desk with stamps, paper, and envelopes on it",
+			"basket containing milk, eggs, and broccoli",
+			"chair",
+			"wooden chest",
+			"hat rack",
+		]
+		
+		assert_nothing_raised do
+			rval = scene_items.conjunction
+		end
+		
+		assert_equal "a desk with stamps, paper, and envelopes on it; " +
+			"a basket containing milk, eggs, and broccoli; " +
+			"a chair; a wooden chest; and a hat rack", rval
+	end
+
+end
+