linkparser 1.0.4 → 1.1.0

data/lib/linkparser.rb

@@ -1,38 +1,28 @@
 #!/usr/bin/ruby
 
-require 'linkparser_ext'
-
-
-#  The LinkParser top-level namespace.
-#  
-#  == Authors
-#  
-#  * Michael Granger <ged@FaerieMUD.org>
-#  * Martin Chase <stillflame@FaerieMUD.org>
-#  
-#  == Version
-# 
-#   $Id: linkparser.rb 53 2009-06-03 12:52:13Z deveiant $
+# The LinkParser top-level namespace.
 #  
-#  == License
-# 
-#  :include: LICENSE
-#--
+# @author Michael Granger <ged@FaerieMUD.org>
+# @author Martin Chase <stillflame@FaerieMUD.org>
 #  
-#  See the LICENSE file for copyright/licensing information.
 module LinkParser
 
+	# Release version
+	VERSION = '1.1.0'
+
+	# Load the correct version if it's a Windows binary gem
+	if RUBY_PLATFORM =~/(mswin|mingw)/i
+		major_minor = RUBY_VERSION[ /^(\d+\.\d+)/ ] or
+			raise "Oops, can't extract the major/minor version from #{RUBY_VERSION.dump}"
+		require "#{major_minor}/linkparser_ext"
+	else
+		require 'linkparser_ext'
+	end
+
+	require 'linkparser/mixins'
 	require 'linkparser/sentence'
 	require 'linkparser/linkage'
 
-	# Release version
-	VERSION = '1.0.4'
-
-	# SVN Revision
-	SVNRev = %q$Rev: 53 $
-
-	# SVN Id
-	SVNId = %q$Id: linkparser.rb 53 2009-06-03 12:52:13Z deveiant $
 
 end # class LinkParser
 

data/lib/linkparser/linkage.rb

@@ -1,4 +1,8 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+
+require 'linkparser'
+require 'linkparser/mixins'
+
 # 
 # Additional high-level functionality for LinkParser::Sentence objects.
 # 
@@ -10,44 +14,41 @@
 # 
 # * Michael Granger <ged@FaerieMUD.org>
 # 
-# == License
-#
-# Copyright (c) 2007, 2008 The FaerieMUD Consortium
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-# 
 # == Version
 #
-#  $Id: linkage.rb 48 2008-12-19 18:30:33Z deveiant $
+#  $Id: linkage.rb,v a5e7d9e3cf5c 2010/11/25 00:50:55 ged $
 # 
+# == License
+#
+# :include: LICENSE
+#--
+#  
+# See the LICENSE file for copyright/licensing information.
+class LinkParser::Linkage
+	extend LinkParser::DeprecationUtilities
 
-require 'linkparser'
+	require 'linkparser_ext'
 
+	###
+	### Deprecated API
+	### These methods are going to be removed in a future version. 
+	###
 
-### Additional high-level functionality for LinkParser::Sentence objects.
-class LinkParser::Linkage
+	### Returns +true+ if the linkage has more than one sublinkage (i.e., the 
+	### sentence has a conjunction).
+	def has_conjunction?
+		return self.num_sublinkages > 1
+	end
+	deprecated_method :has_conjunction?
 
-	# SVN Revision
-	SVNRev = %q$Rev: 48 $
+	# These are all defined in the extension
+	deprecated_method :num_sublinkages
+	deprecated_method :current_sublinkage=
+	deprecated_method :current_sublinkage
+	deprecated_method :compute_union
+
+	### End deprecated stuff
 
-	# SVN Id
-	SVNId = %q$Id: linkage.rb 48 2008-12-19 18:30:33Z deveiant $
 
 	# Descriptions of the linkage types, keyed by linkage symbol
 	LINK_TYPES = {
@@ -161,7 +162,8 @@ class LinkParser::Linkage
 
 	# Link struct (:lword, :rword, :length, :label, :llabel, :rlabel, :desc)
 	Link = Struct.new( "LinkParserLink", :lword, :rword, :length, :label, :llabel, :rlabel, :desc )
-	
+
+
 
 	######
 	public
@@ -169,10 +171,9 @@ class LinkParser::Linkage
 
 	### Return a human-readable representation of the Sentence object.
 	def inspect
-		return %{#<%s:0x%x: sublinkage %d: [%d links]>} % [
+		return %{#<%s:0x%x: [%d links]>} % [
 			self.class.name,
 			self.object_id / 2,
-			self.current_sublinkage,
 			self.num_links
 		]
 	end
@@ -180,7 +181,7 @@ class LinkParser::Linkage
 
 	### Return the +index+th link.
 	def link( index )
-		Link.new( 
+		Link.new(
 			self.words[ self.link_lword(index) ],
 			self.words[ self.link_rword(index) ],
 			self.link_length(index),
@@ -190,25 +191,38 @@ class LinkParser::Linkage
 			LINK_TYPES[ self.link_label(index).gsub(/[^A-Z]+/, '').to_sym ]
 		)
 	end
-	
+
 
 	### Return the Array of words in the sentence as tokenized by the
 	### parser.
 	def links
-		( 0...self.link_count ).collect do |i|
+		return ( 0...self.link_count ).collect do |i|
 			self.link( i )
 		end
 	end
 
 
+	### Return an Array of parsed (well, just split on whitespace for now) disjunct strings 
+	### for the linkage.
+	def disjuncts
+		return self.disjunct_strings.collect do |dstr|
+			if dstr.nil?
+				nil
+			else
+				dstr.split
+			end
+		end
+	end
+
+
 	### Return the verb word from the linkage.
 	def verb
 		if link = self.links.find {|link| link.llabel =~ /^(O([DFNTX]?)|P|BI|K|LI|MV|Q)[a-z\*]*/ }
 			# $deferr.puts "Picking %s: LL of %p is %s" % [ link.lword, link, link.llabel ]
-			return link.lword.sub( /\.v$/, '' )
+			return link.lword.sub( /\.v(-d)?$/, '' )
 		elsif link = self.links.find {|link| link.rlabel =~ /^(SI|S|AF)[a-z\*]*/ }
 			# $deferr.puts "Picking %s: RL of %p is %s" % [ link.rword, link, link.rlabel ]
-			return link.rword.sub( /\.v$/, '' )
+			return link.rword.sub( /\.v(-d)?$/, '' )
 		else
 			return nil
 		end
@@ -218,14 +232,26 @@ class LinkParser::Linkage
 	### Return the subject from the linkage.
 	def subject
 		link = self.links.find {|link| link.llabel[0] == ?S } or return nil
-		return link.lword.sub( /\.[np]$/, '' )
+		return link.lword.sub( /\.[np](?:-\w)?$/, '' )
 	end
-	
+
 
 	### Return the object from the linkage.
 	def object
 		link = self.links.find {|link| link.rlabel[0] == ?O } or return nil
-		return link.rword.sub( /\.[np]$/, '' )
+		return link.rword.sub( /\.[np](?:-\w)?$/, '' )
+	end
+
+
+	### Return an Array of all the nouns in the linkage.
+	def nouns
+		nouns = []
+		self.links.each do |link|
+			nouns << $1 if link.lword =~ /^(.*)\.n(?:-\w)?$/
+			nouns << $1 if link.rword =~ /^(.*)\.n(?:-\w)?$/
+		end
+
+		return nouns.uniq
 	end
 
 
@@ -235,14 +261,6 @@ class LinkParser::Linkage
 		return self.links.find {|link| link.label == 'Wi' && link.rword =~ /\.v$/ } ?
 			true : false
 	end
-	
-	
-	### Returns +true+ if the linkage has more than one sublinkage (i.e., the 
-	### sentence has a conjunction).
-	def has_conjunction?
-		return self.num_sublinkages > 1
-	end
-	
 
 end # class Sentence
 

data/lib/linkparser/mixins.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+
+module LinkParser
+
+	### Functions for marking methods as deprecated.
+	module DeprecationUtilities
+
+		# Hash of which warnings have already been output
+		$lp_deprecation_warnings = {}
+
+		### Make a wrapper for a deprecated method. The wrapper will print a deprecation warning
+		### to STDERR, and then call the method with the same name prefixed with an underscore.
+		### @param [Symbol, #to_sym] name  the name of the method to deprecate.
+		def deprecated_method( *names )
+			names.each do |name|
+				method_body = lambda do |*args|
+					source = caller( 1 ).first
+					if $lp_deprecation_warnings.key?( source )
+						$lp_deprecation_warnings[ source ] += 1
+					else
+						$lp_deprecation_warnings[ source ] = 1
+						warn "Use of deprecated method %p from %s." % [ name, source ]
+					end
+
+					return self.method( "_#{name}" ).call( *args )
+				end
+
+				# Install the wrapper after aliasing away the old method
+				alias_method( "_#{name}", name )
+				remove_method( name )
+				define_method( name, &method_body )
+			end
+		end
+
+	end # module DeprecationUtilities
+
+end # module LinkParser

data/lib/linkparser/sentence.rb

@@ -1,4 +1,7 @@
 #!/usr/bin/ruby
+
+require 'linkparser'
+
 # 
 # A Sentence is the API's representation of an input string, tokenized
 # and interpreted according to a specific Dictionary. After a Sentence
@@ -9,46 +12,18 @@
 # 
 # * Michael Granger <ged@FaerieMUD.org>
 # 
-# == License
-#
-# Copyright (c) 2007, 2008 The FaerieMUD Consortium
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-# 
 # == Version
 #
-#  $Id: sentence.rb 53 2009-06-03 12:52:13Z deveiant $
+#  $Id$
 # 
-
-require 'linkparser'
-
-
+# == License
+# 
+#  :include: LICENSE
+#--
+#  
+# See the LICENSE file for copyright/licensing information.
 class LinkParser::Sentence
 
-	# SVN Revision
-	SVNRev = %q$Rev: 53 $
-
-	# SVN Id
-	SVNId = %q$Id: sentence.rb 53 2009-06-03 12:52:13Z deveiant $
-
-
-
 	######
 	public
 	######
@@ -78,8 +53,8 @@ class LinkParser::Sentence
 	def to_s
 		return self.words.join(" ")
 	end
-	
-	
+
+
 	#########
 	protected
 	#########
@@ -88,7 +63,7 @@ class LinkParser::Sentence
 	def singleton_class
 		class << self; self; end
 	end
-	
+
 
 	### Proxy method -- auto-delegate calls to the first linkage.
 	def method_missing( sym, *args )
@@ -99,10 +74,10 @@ class LinkParser::Sentence
 			LinkParser::Linkage.instance_methods.include?( sym )
 
 		linkage = self.linkages.first or raise LinkParser::Error, "sentence has no linkages"
-		
+
 		meth = linkage.method( sym )
 		self.singleton_class.send( :define_method, sym, &meth )
-		
+
 		meth.call( *args )
 	rescue => err
 		raise err, err.message, err.backtrace[ 0..-2 ]

data/rake/dependencies.rb

@@ -1,6 +1,6 @@
 # 
 # Dependency-checking and Installation Rake Tasks
-# $Id: dependencies.rb 43 2008-09-05 18:19:16Z deveiant $
+
 # 
 
 require 'rubygems/dependency_installer'

data/rake/documentation.rb

@@ -0,0 +1,123 @@
+# 
+# Documentation Rake tasks
+# 
+
+require 'rake/clean'
+
+
+# Append docs/lib to the load path if it exists for documentation
+# helpers.
+DOCSLIB = DOCSDIR + 'lib'
+$LOAD_PATH.unshift( DOCSLIB.to_s ) if DOCSLIB.exist?
+
+# Make relative string paths of all the stuff we need to generate docs for
+DOCFILES = Rake::FileList[ LIB_FILES + EXT_FILES + GEMSPEC.extra_rdoc_files ]
+
+# Documentation coverage constants
+COVERAGE_DIR    = BASEDIR + 'coverage'
+COVERAGE_REPORT = COVERAGE_DIR + 'documentation.txt'
+
+
+# Prefer YARD, fallback to RDoc
+begin
+	require 'yard'
+	require 'yard/rake/yardoc_task'
+
+	# Undo the lazy-assed monkeypatch yard/globals.rb installs and
+	# re-install them as mixins as they should have been from the
+	# start
+	# <metamonkeypatch>
+	class Object
+		remove_method :log
+		remove_method :P
+	end
+
+	module YardGlobals
+		def P(namespace, name = nil)
+			namespace, name = nil, namespace if name.nil?
+			YARD::Registry.resolve(namespace, name, false, true)
+		end
+
+		def log
+			YARD::Logger.instance
+		end
+	end
+
+	class YARD::CLI::Base; include YardGlobals; end
+	class YARD::CLI::Command; include YardGlobals; end
+	class YARD::Parser::SourceParser; extend YardGlobals; include YardGlobals; end
+	class YARD::Parser::CParser; include YardGlobals; end
+	class YARD::CodeObjects::Base; include YardGlobals; end
+	class YARD::Handlers::Base; include YardGlobals; end
+	class YARD::Handlers::Processor; include YardGlobals; end
+	class YARD::Serializers::Base; include YardGlobals; end
+	class YARD::RegistryStore; include YardGlobals; end
+	class YARD::Docstring; include YardGlobals; end
+	module YARD::Templates::Helpers::ModuleHelper; include YardGlobals; end
+	module YARD::Templates::Helpers::HtmlHelper; include YardGlobals; end
+
+	if vvec(RUBY_VERSION) >= vvec("1.9.1")
+		# Monkeypatched to allow more than two '#' characters at the beginning
+		# of the comment line.
+		# Patched from yard-0.5.8
+		require 'yard/parser/ruby/ruby_parser'
+		class YARD::Parser::Ruby::RipperParser < Ripper
+			def on_comment(comment)
+				visit_ns_token(:comment, comment)
+				case comment
+				when /\A# @group\s+(.+)\s*\Z/
+					@groups.unshift [lineno, $1]
+					return
+				when /\A# @endgroup\s*\Z/
+					@groups.unshift [lineno, nil]
+					return
+				end
+
+				comment = comment.gsub(/^\#+\s{0,1}/, '').chomp
+				append_comment = @comments[lineno - 1]
+
+				if append_comment && @comments_last_column == column
+					@comments.delete(lineno - 1)
+					comment = append_comment + "\n" + comment
+				end
+
+				@comments[lineno] = comment
+				@comments_last_column = column
+			end
+		end # class YARD::Parser::Ruby::RipperParser
+	end
+
+	# </metamonkeypatch>
+
+	YARD_OPTIONS = [] unless defined?( YARD_OPTIONS )
+
+	yardoctask = YARD::Rake::YardocTask.new( :apidocs ) do |task|
+		task.files   = DOCFILES
+		task.options = YARD_OPTIONS
+		task.options << '--debug' << '--verbose' if $trace
+	end
+	yardoctask.before = lambda {
+		trace "Calling yardoc like:",
+			"  yardoc %s" % [ quotelist(yardoctask.options + yardoctask.files).join(' ') ]
+	}
+
+	YARDOC_CACHE = BASEDIR + '.yardoc'
+	CLOBBER.include( YARDOC_CACHE.to_s )
+
+rescue LoadError
+	require 'rdoc/task'
+
+	desc "Build API documentation in #{API_DOCSDIR}"
+	RDoc::Task.new( :apidocs ) do |task|
+		task.main     = "README"
+		task.rdoc_files.include( DOCFILES )
+		task.rdoc_dir = API_DOCSDIR.to_s
+		task.options  = RDOC_OPTIONS
+	end
+end
+
+# Need the DOCFILES to exist to build the API docs
+task :apidocs => DOCFILES
+
+CLEAN.include( API_DOCSDIR.to_s )
+