linguistics 1.0.9 → 2.0.0

data/README

@@ -1,166 +0,0 @@
-
-= Linguistics
-
-== Authors
-
-* Michael Granger <ged@FaerieMUD.org>
-* Martin Chase <stillflame@FaerieMUD.org>
-
-
-== Requirements
-
-* Ruby >= 1.8.6
-
-
-== Optional
-
-* Ruby-WordNet (>= 0.0.5) - adds integration for the Ruby binding for the
-  WordNet� lexical refrence system.
-
-  URL: http://deveiate.org/projects/Ruby-WordNet
-
-* LinkParser (>= 1.0.5)
-
-  URL: http://deveiate.org/projects/Ruby-LinkParser
-
-
-== General Information
-
-Linguistics is a framework for building linguistic utilities for Ruby objects
-in any language. It includes a generic language-independant front end, a
-module for mapping language codes into language names, and a module which
-contains various English-language utilities.
-
-
-=== Method Interface
-
-The Linguistics module comes with a language-independant mechanism for
-extending core Ruby classes with linguistic methods.
-
-It consists of three parts: a core linguistics module which contains the
-class-extension framework for languages, a generic inflector class that serves
-as a delegator for linguistic methods on Ruby objects, and one or more
-language-specific modules which contain the actual linguistic functions.
-
-The module works by adding a single instance method for each language named
-after the language's two-letter code (or three-letter code, if no two-letter
-code is defined by ISO639) to various Ruby classes. This allows many
-language-specific methods to be added to objects without cluttering up the
-interface or risking collision between them, albeit at the cost of three or four
-more characters per method invocation.
-
-If you don't like extending core Ruby classes, the language modules should
-also allow you to use them as a function library as well.
-
-For example, the English-language module contains a #plural function which can
-be accessed via a method on a core class:
-
-  Linguistics::use( :en )
-  "goose".en.plural
-  # => "geese"
-  
-or via the Linguistics::EN::plural function directly:
-
-  include Linguistics::EN
-  plural( "goose" )
-  # => "geese"
-
-The class-extension mechanism actually uses the functional interface behind
-the scenes.
-
-A new feature with the 0.02 release: You can now omit the language-code method
-for unambiguous methods by calling Linguistics::use with the +:installProxy+
-configuration key, with the language code of the language module whose methods
-you wish to be available. For example, instead of having to call:
-
-  "goose".en.plural
-
-from the example above, you can now do this:
-
-  Lingusitics::use( :en, :installProxy => :en )
-  "goose".plural
-  # => "geese"
-
-More about how this works in the documentation for Linguistics::use.
-
-
-==== Adding Language Modules
-
-To add a new language to the framework, create a file named the same as the
-ISO639 2- or 3-letter language code for the language you're adding. It must be
-placed under lib/linguistics/ to be recognized by the linguistics module, but
-you can also just require it yourself prior to calling Linguistics::use().
-This file should define a module under Linguistics that is an all-caps version
-of the code used in the filename. Any methods you wish to be exposed to users
-should be declared as module functions (ie., using Module#module_function).
-
-You may also wish to add your module to the list of default languages by
-adding the appropriate symbol to the Linguistics::DefaultLanguages array.
-
-For example, to create a Portuguese-language module, create a file called
-'lib/linguistics/pt.rb' which contains the following:
-
-  module Linguistics
-    module PT
-      Linguistics::DefaultLanguages << :pt
-
-      module_function
-	  <language methods here>
-    end
-  end
-
-See the English language module (lib/linguistics/en.rb) for an example.
-
-
-=== English Language Module
-
-See the README.english file for a synopsis.
-
-The English-language module currently contains linguistic functions ported
-from a few excellent Perl modules:
-
-  Lingua::EN::Inflect
-  Lingua::Conjunction
-  Lingua::EN::Infinitive
-
-See the lib/linguistics/en.rb file for specific attributions.
-
-New with version 0.02: integration with the Ruby WordNet� and LinkParser
-modules (which must be installed separately).
-
-
-== To Do
-  
-* I am planning on improving the results from the infinitive functions, which
-  currently return useful results only part of the time. Investigations into
-  additional stemming functions and some other strategies are ongoing.
-
-* Martin Chase <stillflame at FaerieMUD dot org> is working on an integration
-  module for his excellent work on a Ruby interface to the CMU Link Grammar
-  (an english-sentence parser). This will make writing fairly accurate natural
-  language parsers in Ruby much easier.
-
-* Suggestions (and patches) for any of these items or additional features are
-  welcomed.
-
-
-
-== Legal
-
-This module is Open Source Software which is Copyright (c) 2003 by The
-FaerieMUD Consortium. All rights reserved.
-
-You may use, modify, and/or redistribute this software under the terms of the
-Perl Artistic License, a copy of which should have been included in this
-distribution (See the file Artistic). If it was not, a copy of it may be
-obtained from http://language.perl.com/misc/Artistic.html or
-http://www.faeriemud.org/artistic.html).
-
-THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED
-WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
-
-
- $Id$
-
-

data/README.english

@@ -1,245 +0,0 @@
-
-= English Ruby Linguistics Module - Synopsis
-
-This is an overview of the functionality currently in the English functions of
-the Ruby Linguistics module as of version 0.02:
-
-
-== Pluralization
-
-  require 'linguistics'
-  Linguistics::use( :en ) # extends Array, String, and Numeric
-
-  "box".en.plural
-  # => "boxes"
-
-  "mouse".en.plural
-  # => "mice"
-
-  "ruby".en.plural
-  # => "rubies"
-
-
-== Indefinite Articles
-
-  "book".en.a
-  # => "a book"
-
-  "article".en.a
-  # => "an article"
-
-
-== Present Participles
-
-  "runs".en.present_participle
-  # => "running"
-
-  "eats".en.present_participle
-  # => "eating"
-
-  "spies".en.present_participle
-  # => "spying"
-
-
-== Ordinal Numbers
-
-  5.en.ordinal
-  # => "5th"
-
-  2004.en.ordinal
-  # => "2004th"
-
-
-== Numbers to Words
-
-  5.en.numwords
-  # => "five"
-
-  2004.en.numwords
-  # => "two thousand and four"
-
-  2385762345876.en.numwords
-  # => "two trillion, three hundred and eighty-five billion,
-  seven hundred and sixty-two million, three hundred and
-  forty-five thousand, eight hundred and seventy-six"
-
-
-== Quantification
-
-  "cow".en.quantify( 5 )
-  # => "several cows"
-
-  "cow".en.quantify( 1005 )
-  # => "thousands of cows"
-
-  "cow".en.quantify( 20_432_123_000_000 )
-  # => "tens of trillions of cows"
-
-
-== Conjunctions
-
-  animals = %w{dog cow ox chicken goose goat cow dog rooster llama 
-  pig goat dog cat cat dog cow goat goose goose ox alpaca}
-  puts "The farm has: " + animals.en.conjunction
-
-  # => The farm has: four dogs, three cows, three geese, three goats,
-  two oxen, two cats, a chicken, a rooster, a llama, a pig, 
-  and an alpaca
-
-Note that 'goose' and 'ox' are both correctly pluralized, and the correct
-indefinite article 'an' has been used for 'alpaca'.
-
-You can also use the generalization function of the #quantify method to give
-general descriptions of object lists instead of literal counts:
-
-  allobjs = []
-  ObjectSpace::each_object {|obj| allobjs << obj.class.name}
-
-  puts "The current Ruby objectspace contains: " +
-    allobjs.en.conjunction( :generalize => true )
-
-which will print something like:
-
-  The current Ruby objectspace contains: thousands of Strings,
-  thousands of Arrays, hundreds of Hashes, hundreds of
-  Classes, many Regexps, a number of Ranges, a number of
-  Modules, several Floats, several Procs, several MatchDatas,
-  several Objects, several IOS, several Files, a Binding, a
-  NoMemoryError, a SystemStackError, a fatal, a ThreadGroup,
-  and a Thread
-
-
-== Infinitives
-
-New in version 0.02:
-
-  "leaving".en.infinitive
-  # => "leave"
-
-  "left".en.infinitive
-  # => "leave"
-
-  "leaving".en.infinitive.suffix
-  # => "ing"
-
-
-== WordNet� Integration
-
-Also new in version 0.02, if you have the Ruby-WordNet module installed, you can
-look up WordNet synsets using the Linguistics interface:
-
-  # Test to be sure the WordNet module loaded okay.
-  Linguistics::EN.has_wordnet?
-  # => true
-
-  # Fetch the default synset for the word "balance"
-  "balance".synset
-  # => #<WordNet::Synset:0x40376844 balance (noun): "a state of equilibrium"
-   (derivations: 3, antonyms: 1, hypernyms: 1, hyponyms: 3)>
-
-  # Fetch the synset for the first verb sense of "balance"
-  "balance".en.synset( :verb )
-  # => #<WordNet::Synset:0x4033f448 balance, equilibrate, equilibrize, equilibrise
-  (verb): "bring into balance or equilibrium; "She has to balance work and her
-  domestic duties"; "balance the two weights"" (derivations: 7, antonyms: 1,
-  verbGroups: 2, hypernyms: 1, hyponyms: 5)>
-
-  # Fetch the second noun sense
-  "balance".en.synset( 2, :noun )
-  # => #<WordNet::Synset:0x404ebb24 balance (noun): "a scale for weighing; depends
-  on pull of gravity" (hypernyms: 1, hyponyms: 5)>
-
-  # Fetch the second noun sense's hypernyms (more-general words, like a superclass)
-  "balance".en.synset( 2, :noun ).hypernyms
-  # => [#<WordNet::Synset:0x404e5620 scale, weighing machine (noun): "a measuring
-  instrument for weighing; shows amount of mass" (derivations: 2, hypernyms: 1,
-  hyponyms: 2)>]
-
-  # A simpler way of doing the same thing:
-  "balance".en.hypernyms( 2, :noun )
-  # => [#<WordNet::Synset:0x404e5620 scale, weighing machine (noun): "a measuring
-  instrument for weighing; shows amount of mass" (derivations: 2, hypernyms: 1,
-  hyponyms: 2)>]
-
-  # Fetch the first hypernym's hypernyms
-  "balance".en.synset( 2, :noun ).hypernyms.first.hypernyms
-  # => [#<WordNet::Synset:0x404c60b8 measuring instrument, measuring system,
-  measuring device (noun): "instrument that shows the extent or amount or quantity
-  or degree of something" (hypernyms: 1, hyponyms: 83)>]
-
-  # Find the synset to which both the second noun sense of "balance" and the
-  # default sense of "shovel" belong.
-  ("balance".en.synset( 2, :noun ) | "shovel".en.synset)
-  # => #<WordNet::Synset:0x40473da4 instrumentality, instrumentation (noun): "an
-  artifact (or system of artifacts) that is instrumental in accomplishing some
-  end" (derivations: 1, hypernyms: 1, hyponyms: 13)>
-
-  # Fetch just the words for the other kinds of "instruments"
-  "instrument".en.hyponyms.collect {|synset| synset.words}.flatten
-  # => ["analyzer", "analyser", "cautery", "cauterant", "drafting instrument",
-  "extractor", "instrument of execution", "instrument of punishment", "measuring
-  instrument", "measuring system", "measuring device", "medical instrument",
-  "navigational instrument", "optical instrument", "plotter", "scientific
-  instrument", "sonograph", "surveying instrument", "surveyor's instrument",
-  "tracer", "weapon", "arm", "weapon system", "whip"]
-
-There are many more WordNet methods supported � too many to list here. See the
-documentation for the complete list.
-
-
-== LinkParser Integration
-
-Another new feature in version 0.02 is integration with the Ruby version of the
-CMU Link Grammar Parser by Martin Chase. If you have the LinkParser module
-installed, you can create linkages from English sentences that let you query for
-parts of speech:
-
-  # Test to see whether or not the link parser is loaded.
-  Linguistics::EN.has_link_parser?
-  # => true
-
-  # Diagram the first linkage for a test sentence
-  puts "he is a big dog".sentence.linkages.first.to_s
-	  +---O*---+ 
-	  | +--Ds--+ 
-   +Ss+ |  +-A-+ 
-   |  | |  |   | 
-  he is a big dog
-
-  # Find the verb in the sentence
-  "he is a big dog".en.sentence.verb.to_s      
-  # => "is"
-
-  # Combined infinitive + LinkParser: Find the infinitive form of the verb of the
-  given sentence.
-  "he is a big dog".en.sentence.verb.infinitive
-  # => "be"
-
-  # Find the direct object of the sentence
-  "he is a big dog".en.sentence.object.to_s
-  # => "dog"
-
-  # Look at the raw LinkParser::Word for the direct object of the sentence.
-  "he is a big dog".en.sentence.object     
-  # => #<LinkParser::Word:0x403da0a0 @definition=[[{@A-}, Ds-, {@M+}, J-], [{@A-},
-  Ds-, {@M+}, Os-], [{@A-}, Ds-, {@M+}, Ss+, {@CO-}, {C-}], [{@A-}, Ds-, {@M+},
-  Ss+, R-], [{@A-}, Ds-, {@M+}, SIs-], [{@A-}, Ds-, {R+}, {Bs+}, J-], [{@A-}, Ds-,
-  {R+}, {Bs+}, Os-], [{@A-}, Ds-, {R+}, {Bs+}, Ss+, {@CO-}, {C-}], [{@A-}, Ds-,
-  {R+}, {Bs+}, Ss+, R-], [{@A-}, Ds-, {R+}, {Bs+}, SIs-]], @right=[], @suffix="",
-  @left=[#<LinkParser::Connection:0x403da028 @rword=#<LinkParser::Word:0x403da0a0
-  ...>, @lword=#<LinkParser::Word:0x403da0b4 @definition=[[Ss-, O+, {@MV+}], [Ss-,
-  B-, {@MV+}], [Ss-, P+], [Ss-, AF-], [RS-, Bs-, O+, {@MV+}], [RS-, Bs-, B-,
-  {@MV+}], [RS-, Bs-, P+], [RS-, Bs-, AF-], [{Q-}, SIs+, O+, {@MV+}], [{Q-}, SIs+,
-  B-, {@MV+}], [{Q-}, SIs+, P+], [{Q-}, SIs+, AF-]],
-  @right=[#<LinkParser::Connection:0x403da028 ...>], @suffix="", @left=[],
-  @name="is", @position=1>, @subName="*", @name="O", @length=3>], @name="dog",
-  @position=4>
-
-  # Combine WordNet + LinkParser to find the definition of the direct object of
-  # the sentence
-  "he is a big dog".en.sentence.object.gloss
-  # => "a member of the genus Canis (probably descended from the common wolf) that
-  has been domesticated by man since prehistoric times; occurs in many breeds;
-  \"the dog barked all night\""
-
-

data/rake/191_compat.rb

@@ -1,26 +0,0 @@
-# 1.9.1 fixes
-
-
-# Make Pathname compatible with 1.8.7 Pathname.
-unless Pathname.instance_methods.include?( :=~ )
-	class Pathname
-		def self::glob( *args ) # :yield: p
-			args = args.collect {|p| p.to_s }
-			if block_given?
-				Dir.glob(*args) {|f| yield self.new(f) }
-			else
-				Dir.glob(*args).map {|f| self.new(f) }
-			end
-		end
-
-		def =~( other )
-			self.to_s =~ other
-		end
-
-		def to_str
-			self.to_s
-		end
-	end
-end
-
-

data/rake/dependencies.rb

@@ -1,76 +0,0 @@
-# 
-# Dependency-checking and Installation Rake Tasks
-
-# 
-
-require 'rubygems/dependency_installer'
-require 'rubygems/source_index'
-require 'rubygems/requirement'
-require 'rubygems/doc_manager'
-
-### Install the specified +gems+ if they aren't already installed.
-def install_gems( gems )
-	
-	defaults = Gem::DependencyInstaller::DEFAULT_OPTIONS.merge({
-		:generate_rdoc     => true,
-		:generate_ri       => true,
-		:install_dir       => Gem.dir,
-		:format_executable => false,
-		:test              => false,
-		:version           => Gem::Requirement.default,
-	  })
-    
-	# Check for root
-	if Process.euid != 0
-		$stderr.puts "This probably won't work, as you aren't root, but I'll try anyway"
-	end
-
-	gemindex = Gem::SourceIndex.from_installed_gems
-
-	gems.each do |gemname, reqstring|
-		requirement = Gem::Requirement.new( reqstring )
-		trace "requirement is: %p" % [ requirement ]
-		
-		trace "Searching for an installed #{gemname}..."
-		specs = gemindex.find_name( gemname )
-		trace "...found %d specs: %s" %
-			[ specs.length, specs.collect {|s| "%s %s" % [s.name, s.version] }.join(', ') ]
-		
-		if spec = specs.find {|spec| requirement.satisfied_by?(spec.version) }
-			log "Version %s of %s is already installed (needs %s); skipping..." % 
-				[ spec.version, spec.name, requirement ]
-			next
-		end
-
-		rgv = Gem::Version.new( Gem::RubyGemsVersion )
-		installer = nil
-		
-		log "Trying to install #{gemname.inspect} #{requirement}..."
-		if rgv >= Gem::Version.new( '1.1.1' )
-			installer = Gem::DependencyInstaller.new
-			installer.install( gemname, requirement )
-		else
-			installer = Gem::DependencyInstaller.new( gemname )
-			installer.install
-		end
-
-		installer.installed_gems.each do |spec|
-			log "Installed: %s" % [ spec.full_name ]
-		end
-
-	end
-end
-
-
-### Task: install runtime dependencies
-desc "Install runtime dependencies as gems"
-task :install_dependencies do
-	install_gems( DEPENDENCIES )
-end
-
-### Task: install gems for development tasks
-desc "Install development dependencies as gems"
-task :install_dev_dependencies do
-	install_gems( DEVELOPMENT_DEPENDENCIES )
-end
-