linkparser 1.1.3 → 2.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0fdb3ebc1f449d0bcbdf3b4a1c69b0b417abd68642ac64d9df62cc2ccf330ba5
+  data.tar.gz: 1ea9b2c22a7a3212ca9fdae2e2640344e73f06331c451289bcac1fbe7c283940
+SHA512:
+  metadata.gz: c8484674e2df9d3eee3844db974a28d06b4030b6609418b6b1d54641ec0e67099632955c6ebd9276bbf23353a66cbf082472791a4764834160f70a04cd8b8f20
+  data.tar.gz: ed5d589f141897ec1b703f3f0d30628f418e1eca728f6d5d60b9e034ae5ed85956ac1897e33ed77692a8756bdc66965fbb6a8e2525818b9c00eafcbeddc4f9e6

data/History.md

@@ -1,17 +1,82 @@
-## 1.1.1 [2010-12-30] Michael Granger <ged@FaerieMUD.org>
+# Release History for linkparser
+
+---
+
+## v2.2.0 [2020-12-24] Michael Granger <ged@faeriemud.org>
+
+Enhancements:
+
+- Updated for Ruby 2.7
+- Add support for fetching the link-grammar config.
+- Updated for link-grammar 5.8.0.
+
+
+## v2.1.0 [2018-01-10] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Update for the latest link-grammar (5.4.3)
+
+Bugfixes:
+
+- Fix LinkParser.link_grammar_version
+- Eliminate weird calls to rb_funcall with explicit null pointers (Ruby 2.5)
+- Eliminate use of deprecated Fixnum constant (Ruby 2.5)
+- Add a workaround and minimal test case for diagrams with very small widths
+
+
+## v2.0.0 [2015-03-02] Michael Granger <ged@FaerieMUD.org>
+
+Updated for the latest Ruby and link-grammar.
+
+NOTE: This release breaks the API of previous releases. In the 5.x
+release of the upstream library (link-grammar) a bunch of
+long-deprecated functions were removed, so it was no longer possible
+to maintain backward-compatibility.
+
+The 1.x version of LinkParser should continue to work fine for
+pre-5.x versions of link-grammar, and it will continue to be
+maintained for the forseeable future.
+
+
+## v1.1.4 [2012-01-31] Michael Granger <ged@FaerieMUD.org>
+
+- Packaging fixes, dependency update
+
+
+## v1.1.3 [2011-05-16] Michael Granger <ged@FaerieMUD.org>
+
+- Use a relative path for path constants (Alessandro Berardi), update
+  deps
+
+
+## v1.1.2 [2011-05-12] Michael Granger <ged@FaerieMUD.org>
+
+- Fixes package configuration options concatenation bug (see
+  http://goo.gl/G49Y8) (Alessandro Berardi <berardialessandro@gmail.com>)
+- De-Yard, build cleanup, added gem-testers support
+- Removed unnecessary (and non-existant on Ruby < 1.9) include.
+- Fixing some shadowed variables for 1.9.2.
+- Avoid circular requires.
+
+
+## v1.1.1 [2010-12-30] Michael Granger <ged@FaerieMUD.org>
 
 * Updated for link-grammar 4.7.1.
 * Fixed some specs that were doing nothing, using old RSpec syntax, etc.
 * Converted to Hoe.
 
 
-## 1.1.0 [2010-11-30] Michael Granger <ged@FaerieMUD.org>
+## v1.1.0 [2010-11-30] Michael Granger <ged@FaerieMUD.org>
 
 * Updated to support link-grammar 4.7.0. Note that this breaks compatibility with
-  earlier versions, as the model for sentences with conjunctions has changed 
+  earlier versions, as the model for sentences with conjunctions has changed
   significantly.
 * Use pkgconfig if available.
 * Various memory-management and 1.9.2 fixes.
 
 
+## v1.0.6 [2009-10-16] Michael Granger <ged@FaerieMUD.org>
+
+[TODO]
 

data/README.md

@@ -1,56 +1,67 @@
 # linkparser
 
-* http://deveiate.org/projects/Ruby-LinkParser
+home
+: https://hg.sr.ht/~ged/linkparser
+
+code
+: https://hg.sr.ht/~ged/linkparser/browse
+
+docs
+: http://deveiate.org/code/linkparser
+
+github
+: http://github.com/ged/linkparser
+
+
 
 ## Description
 
-This module is a Ruby binding for [the Abiword version][abiword] of CMU's 
-[Link Grammar][link-grammar], a syntactic parser of English. 
+This module is a Ruby binding for
+[the Abiword version](http://www.abisource.com/projects/link-grammar/) of CMU's
+[Link Grammar](http://www.link.cs.cmu.edu/link/), a syntactic parser of English.
 
 
 ### Example Usage
 
-	require 'linkparser'
-	
-	dict = LinkParser::Dictionary.new( :screen_width => 100 )
-	sent = dict.parse( "People use Ruby for all kinds of nifty things." )
-	# => #<LinkParser::Sentence:0xcf8eb "LEFT-WALL people use Ruby for all kinds
-	#      of nifty things . RIGHT-WALL"/2 linkages/0 nulls>
-	
-	sent.subject        # => "people"
-	sent.verb           # => "use"
-	sent.object         # => "Ruby"
-	
-	puts sent.constituent_tree_string
-	# =>
-	# (S (NP People)
-	#    (VP use
-	#        (NP Ruby)
-	#        (PP for
-	#            (NP (NP all kinds)
-	#                (PP of
-	#                    (NP nifty things)))))
-	#    .)
-	
-	puts sent.diagram
-	# =>
-	#     +-------------------------------Xp------------------------------+
-	#     |                +----MVp---+----Jp----+     +------Jp-----+    |
-	#     +----Wd---+--Sp--+--Os-+    |    +-Dmc-+--Mp-+    +----A---+    |
-	#     |         |      |     |    |    |     |     |    |        |    |
-	# LEFT-WALL people.p use.v Ruby for.p all kinds.n of nifty.a things.n . 
+    dict = LinkParser::Dictionary.new
+    => #<LinkParser::Dictionary:0x007fc56b480d18 @options={}>
+
+    sent = dict.parse( "People use Ruby for all kinds of nifty things." )
+    => #<LinkParser::Sentence:0x1ff15b42eeda
+          "LEFT-WALL people.p use.v Ruby.f for.p all.a kinds.n of nifty.a things.n . RIGHT-WALL"/
+          15 linkages/0 nulls>
+
+    sent.subject
+    => "people"
+
+    sent.verb
+    => "use"
+
+    sent.object
+    => "Ruby"
+
+    puts sent.diagram( max_width: 200 )
+    
+        +---------------------------------Xp--------------------------------+
+        |                             +---------------Jp---------------+    |
+        |                             |            +--------Dmc--------+    |
+        +------>WV------>+-----MVp----+            |     +------Jd-----+    |
+        +----Wd---+--Sp--+--Os--+     |     +-Dmcn-+-OFd-+    +----A---+    +--RW--+
+        |         |      |      |     |     |      |     |    |        |    |      |
+    LEFT-WALL people.p use.v Ruby.f for.p all.a kinds.n of nifty.a things.n . RIGHT-WALL
 
 
 ## Installation
 
-First, download and install the latest version of the link-grammar 
-library from [Abiword's site][abiword-dl].
+First, download and install the latest version of the link-grammar
+library from
+[Abiword's site](http://www.abisource.com/projects/link-grammar/#download).
 
 Then install the gem:
 
     gem install linkparser
 
-You may need to specify the path to the link-grammar library if you 
+You may need to specify the path to the link-grammar library if you
 installed it somewhere that your linker doesn't look by default:
 
     gem install linkparser -- --with-link-grammar=/usr/local
@@ -58,20 +69,34 @@ installed it somewhere that your linker doesn't look by default:
 
 ## Contributing
 
-You can check out the current development source [with Mercurial][hg-repo],
-or if you prefer Git, via [its Github mirror][github-mirror].
+You can check out the current development source
+[with Mercurial](https://hg.sr.ht/~ged/linkparser),
+or if you prefer Git, via
+[its Github mirror](http://github.com/ged/linkparser).
 
 After checking out the source, run:
 
-	$ rake newb
+    $ gen install -Ng
+    $ rake setup
+
+This will install any missing dependencies and do any neceesary developer setup.
+
+
+## Author(s)
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the API documentation.
+- Michael Granger <ged@faeriemud.org>
 
 
 ## License
 
-Copyright (c) 2006-2011, The FaerieMUD Consortium
+This gem uses the link-grammar library, which is licensed under the
+LGPL v2.1 license:
+
+https://www.gnu.org/licenses/lgpl-2.1.html
+
+The gem itself is licensed under the BSD license:
+
+Copyright (c) 2006-2020, The FaerieMUD Consortium
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
@@ -99,9 +124,3 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
-
-[abiword]:http://www.abisource.com/projects/link-grammar/
-[link-grammar]:http://www.link.cs.cmu.edu/link/ "Link Grammar"
-[abiword-dl]:http://www.abisource.com/projects/link-grammar/#download
-[hg-repo]:http://repo.deveiate.org/LinkParser
-[github-mirror]:http://github.com/ged/linkparser

data/ext/{dictionary.c → linkparser_ext/dictionary.c}

@@ -1,11 +1,11 @@
 /*
  *  dict.c - Ruby LinkParser - Dictionary Class
- *  $Id: dictionary.c,v 21df914cedb1 2010/10/12 15:45:26 ged $
- *  
+ *  $Id$
+ *
  *  Authors:
  *    * Michael Granger <ged@FaerieMUD.org>
- *  
- *  Please see the LICENSE file at the top of the distribution for licensing 
+ *
+ *  Please see the LICENSE file at the top of the distribution for licensing
  *  information.
  */
 
@@ -21,12 +21,13 @@
  * Allocation function
  */
 static struct rlink_dictionary *
-rlink_dictionary_alloc() {
+rlink_dictionary_alloc()
+{
 	struct rlink_dictionary *ptr = ALLOC( struct rlink_dictionary );
 
 	ptr->dict	= NULL;
 
-	debugMsg(( "Initialized an rlink_dictionary <%p>", ptr ));
+	rlink_log( "debug", "Initialized an rlink_dictionary <%p>", ptr );
 	return ptr;
 }
 
@@ -35,9 +36,9 @@ rlink_dictionary_alloc() {
  * Free function
  */
 static void
-rlink_dict_gc_free( struct rlink_dictionary *ptr ) {
+rlink_dict_gc_free( struct rlink_dictionary *ptr )
+{
 	if ( ptr ) {
-		debugMsg(( "Freeing Dictionary <%p>", ptr ));
 		if ( ptr->dict )
 			dictionary_delete( ptr->dict );
 
@@ -45,8 +46,6 @@ rlink_dict_gc_free( struct rlink_dictionary *ptr ) {
 
 		xfree( ptr );
 		ptr = NULL;
-	} else {
-		debugMsg(( "Not freeing already freed Dictionary." ));
 	}
 }
 
@@ -55,7 +54,8 @@ rlink_dict_gc_free( struct rlink_dictionary *ptr ) {
  * Object validity checker. Returns the data pointer.
  */
 static struct rlink_dictionary *
-check_dict( VALUE self ) {
+check_dict( VALUE self )
+{
 	Check_Type( self, T_DATA );
 
     if ( !IsDictionary(self) ) {
@@ -71,7 +71,8 @@ check_dict( VALUE self ) {
  * Fetch the data pointer and check it for sanity.
  */
 static struct rlink_dictionary *
-get_dict( VALUE self ) {
+get_dict( VALUE self )
+{
 	struct rlink_dictionary *ptr = check_dict( self );
 
 	if ( !ptr )
@@ -81,11 +82,12 @@ get_dict( VALUE self ) {
 }
 
 
-/* 
+/*
  * Get the Dictionary behind the LinkParser::Dictionary +object+ specified.
  */
 struct rlink_dictionary *
-rlink_get_dict( VALUE obj ) {
+rlink_get_dict( VALUE obj )
+{
 	return get_dict( obj );
 }
 
@@ -103,8 +105,9 @@ rlink_get_dict( VALUE obj ) {
  *  Allocate a new LinkParser::Dictionary object.
  */
 static VALUE
-rlink_dict_s_alloc( VALUE klass ) {
-	debugMsg(( "Wrapping an uninitialized Dictionary pointer." ));
+rlink_dict_s_alloc( VALUE klass )
+{
+	rlink_log( "debug", "Wrapping an uninitialized Dictionary pointer." );
 	return Data_Wrap_Struct( klass, 0, rlink_dict_gc_free, 0 );
 }
 
@@ -114,7 +117,9 @@ rlink_dict_s_alloc( VALUE klass ) {
  * can be useful for testing and stuff.
  */
 static Dictionary
-rlink_make_oldstyle_dict( VALUE dict_file, VALUE pp_file, VALUE cons_file, VALUE affix_file ) {
+rlink_make_oldstyle_dict( VALUE dict_file, VALUE pp_file, VALUE cons_file, VALUE affix_file )
+{
+#ifdef HAVE_DICTIONARY_CREATE
 	SafeStringValue( dict_file  );
 	SafeStringValue( pp_file    );
 	SafeStringValue( cons_file  );
@@ -126,6 +131,11 @@ rlink_make_oldstyle_dict( VALUE dict_file, VALUE pp_file, VALUE cons_file, VALUE
 		StringValuePtr(cons_file ),
 		StringValuePtr(affix_file)
 	);
+#else
+	rb_raise( rb_eNotImpError,
+		"Old-style dictionary creation isn't supported by the installed version of link-grammar." );
+    UNREACHABLE;
+#endif
 }
 
 
@@ -134,44 +144,45 @@ rlink_make_oldstyle_dict( VALUE dict_file, VALUE pp_file, VALUE cons_file, VALUE
  *      LinkParser::Dictionary.new( *args )                        -> dict
  *
  * Create a new LinkParser::Dictionary.
- * 
+ *
  * The preferred way to set up the dictionary is to call it with no
  * arguments, which will look for a dictionary with the same language
  * as the current environment. Alternatively, a fixed language can be
  * specified by specifying an ISO639 language code, for example,
  * <tt>LinkParser::Dictionary.new( :en )</tt>.
- * 
+ *
  * Explicit dictionary file names can be also specified, like so:
- *     
+ *
  *     Dictionary.new( dict_file,
  *                     post_process_file,
  *                     constituent_knowledge_file,
  *                     affix_file )
- *     
- * This mode of dictionary construction is not recommended for new 
- * development, and is intended for advanced users only. To create the 
- * dictionary, the Dictionary looks in the current directory and the data 
+ *
+ * This mode of dictionary construction is not recommended for new
+ * development, and is intended for advanced users only. To create the
+ * dictionary, the Dictionary looks in the current directory and the data
  * directory for the files +dict_file+, +post_process_file+,
  * +constituent_knowledge_file+, and +affix_file+. The last three entries
  * may be omitted. If +dict_file+ is a fully specified path name, then
  * the other file names, which need not be fully specified, will be
  * prefixed by the directory specified by +dict_file+.
- * 
+ *
  * In any case, a Hash of options can be specified which will be used
  * as default ParseOption attributes for any sentences created from
  * it.
  *
  *  Examples:
  *      dict = LinkParser::Dictionary.new
- *      
+ *
  *      dict = LinkParser::Dictionary.new( :de )
- *      
+ *
  *      dict = LinkParser::Dictionary.new( '/var/data/custom_dicts/4.2.dict' )
- *      
- * 
+ *
+ *
  */
 static VALUE
-rlink_dict_initialize( int argc, VALUE *argv, VALUE self ) {
+rlink_dict_initialize( int argc, VALUE *argv, VALUE self )
+{
 	if ( !check_dict(self) ) {
 		int i = 0;
 		struct rlink_dictionary *ptr = NULL;
@@ -183,24 +194,24 @@ rlink_dict_initialize( int argc, VALUE *argv, VALUE self ) {
 		switch( i = rb_scan_args(argc, argv, "05", &arg1, &arg2, &arg3, &arg4, &arg5) ) {
 		  /* Dictionary.new */
 		  case 0:
-			debugMsg(( "No arguments" ));
+			rlink_log_obj( self, "debug", "No arguments" );
 			break;
 
 		  /* Dictionary.new( lang )*/
 		  /* Dictionary.new( opthash )*/
 		  case 1:
 			if( TYPE(arg1) == T_HASH ) {
-				debugMsg(( "One arg: options hash."));
+				rlink_log_obj( self, "debug", "One arg: options hash." );
 				opthash = arg1;
 			} else {
-				debugMsg(( "One arg: language" ));
+				rlink_log_obj( self, "debug", "One arg: language" );
 				lang = arg1;
 			}
 			break;
 
 		  /* Dictionary.new( lang, opthash ) */
 		  case 2:
-			debugMsg(( "Two args: language and options hash."));
+			rlink_log_obj( self, "debug", "Two args: language and options hash." );
 			lang = arg1;
 			opthash = arg2;
 			break;
@@ -209,7 +220,7 @@ rlink_dict_initialize( int argc, VALUE *argv, VALUE self ) {
 		  /* Dictionary.new( dict, pp, cons, affix, opthash ) */
 		  case 4:
 		  case 5:
-			debugMsg(( "Four or five args: old-style explicit dict files." ));
+			rlink_log_obj( self, "debug", "Four or five args: old-style explicit dict files." );
 			dict = rlink_make_oldstyle_dict( arg1, arg2, arg3, arg4 );
 			opthash = arg5;
 			break;
@@ -234,14 +245,17 @@ rlink_dict_initialize( int argc, VALUE *argv, VALUE self ) {
 		   creating it */
 		if ( !dict ) rlink_raise_lp_error();
 
-		debugMsg(( "Created dictionary %p", dict ));
+		rlink_log_obj( self, "debug", "Created dictionary %p", dict );
 		DATA_PTR( self ) = ptr = rlink_dictionary_alloc();
 
 		ptr->dict = dict;
 
 		/* If they passed in an options hash, save it for later. */
-		if ( RTEST(opthash) ) rb_iv_set( self, "@options", opthash );
-		else rb_iv_set( self, "@options", rb_hash_new() );
+		if ( RTEST(opthash) ) {
+			rb_iv_set( self, "@options", opthash );
+		} else {
+			rb_iv_set( self, "@options", rb_hash_new() );
+		}
 	}
 
 	else {
@@ -252,37 +266,18 @@ rlink_dict_initialize( int argc, VALUE *argv, VALUE self ) {
 }
 
 
-/*
- *  call-seq:
- *     dictionary.max_cost   -> fixnum
- *
- *  Returns the maximum cost (number of brackets []) that is placed on any
- *  connector in the dictionary. This is useful for designing a parsing
- *  algorithm that progresses in stages, first trying the cheap connectors.
- */
-static VALUE
-rlink_get_max_cost( VALUE self ) {
-	struct rlink_dictionary *ptr = get_dict( self );
-
-	int cost = dictionary_get_max_cost( ptr->dict );
-
-	debugMsg(( "Max cost is: %d", cost ));
-
-	return INT2NUM( cost );
-}
-
-
 /*
  *  call-seq:
  *     dictionary.parse( string )            -> sentence
  *     dictionary.parse( string, options )   -> sentence
  *
- *  Parse the specified sentence +string+ with the dictionary and return a 
+ *  Parse the specified sentence +string+ with the dictionary and return a
  *  LinkParser::Sentence. If you specify an +options+ hash, its values will override
  *  those of the Dictionary's for the resulting Sentence.
  */
 static VALUE
-rlink_parse( int argc, VALUE *argv, VALUE self ) {
+rlink_parse( int argc, VALUE *argv, VALUE self )
+{
 	VALUE input_string, options, sentence;
 	VALUE args[2];
 	int i;
@@ -296,7 +291,7 @@ rlink_parse( int argc, VALUE *argv, VALUE self ) {
 
 	/* Now call #parse on it */
 	if ( i == 1 )
-		rb_funcall( sentence, rb_intern("parse"), 0, 0 );
+		rb_funcall( sentence, rb_intern("parse"), 0 );
 	else
 		rb_funcall( sentence, rb_intern("parse"), 1, options );
 
@@ -307,26 +302,26 @@ rlink_parse( int argc, VALUE *argv, VALUE self ) {
 
 
 
-/* 
+/*
  *  Document-class: LinkParser::Dictionary
- *  
+ *
  *  A Dictionary is the programmer's handle on the set of word definitions that defines the
  *  grammar. A user creates a Dictionary from a grammar file and post-process knowledge
  *  file, and then creates all other objects through it.
  */
 void
-rlink_init_dict() {
+rlink_init_dict()
+{
 #ifdef FOR_RDOC
 	rlink_mLinkParser = rb_define_module( "LinkParser" );
 #endif
 
 	rlink_cDictionary = rb_define_class_under( rlink_mLinkParser, "Dictionary",
-	 	rb_cObject );
+		rb_cObject );
 
 	rb_define_alloc_func( rlink_cDictionary, rlink_dict_s_alloc );
 	rb_define_method( rlink_cDictionary, "initialize", rlink_dict_initialize, -1 );
 
-	rb_define_method( rlink_cDictionary, "max_cost", rlink_get_max_cost, 0 );
 	rb_define_method( rlink_cDictionary, "parse", rlink_parse, -1 );
 
 	/* The LinkParser::ParseOptions object for the Dictionary */