wordnet 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 27d43321cb1c8ba285945387a8eedd6bd25f5647
-  data.tar.gz: 6b7f5d9abef4970f46a98bc06f621ef2de26744d
+SHA256:
+  metadata.gz: 6a3f4db4815bfad5f10d2c684bb66466414b27c5fdb186a53579ca71d2c279f9
+  data.tar.gz: 939d0eb8a138ef9802105829d31ee2078a3dce010186a1606d7456aef6292f7f
 SHA512:
-  metadata.gz: 6dac34d56a4eea80abe63377c08e8f68e1d149e40e230757bb05213f3bd45d88b0238eb4f3cb04d46e0ef2a016bb9229e8a22e6240c94295e19e32fed023ec31
-  data.tar.gz: 7b93069a12a31970a977afcf2ecf8a12113f103d56818c99c417c83f5f7f2c3f4d1f93e0ffd268d73f81d0910c760de20c5d923ab06d214d00e320bf391c80f5
+  metadata.gz: 8ef75970224d87c5946815902d168d344fed6321598218d0eec4a6a972ab5d6b3e0cd52e68e8808debd63d9e71ab1044576f31d479628d23fa71028e875c16db
+  data.tar.gz: 5dc4fb6d4e93470f9d778727cb6d6a045aa42ae02fbc08b99197b69d09356b02af4868d65eede1af56b64a0ac0409032c6443951ce82a1d835bacde5bbbbbd10

data/History.md

@@ -0,0 +1,33 @@
+# Release History for wordnet
+
+---
+
+## v1.2.0 [2023-05-10] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Update for Ruby 3
+- Improve API docs
+
+
+## v1.1.0 [2017-09-26] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Update to WordNet 3.1 (from SQLUNet 5.2.0), Sequel 5.0.
+- Made fetching Synset by ordinal deterministic
+- Documentation updates/fixes
+
+
+## v1.0.1 [2016-09-18] Michael Granger <ged@FaerieMUD.org>
+
+- Finish up and fix WordNet::Sense
+- Add Wordnet::Synset#wordlist
+- Documentation fixes, fixes for newer Ruby versions
+
+
+## v1.0.0 [2012-08-22] Michael Granger <ged@FaerieMUD.org>
+
+Converted to use Sequel and wnsql.
+
+

data/README.md

@@ -1 +1,140 @@
-The README is in RDoc format, which Bitbucket/Github doesn't support; [see the source](https://bitbucket.org/ged/ruby-wordnet/src/3db62d5ed69878e8e7c36795d3379291db0402d6/README.rdoc?at=default).
+# Ruby-WordNet
+
+home
+: https://hg.sr.ht/~ged/ruby-wordnet
+
+code
+: https://hg.sr.ht/~ged/ruby-wordnet/browse
+
+docs
+: http://deveiate.org/code/wordnet
+
+github
+: https://github.com/ged/ruby-wordnet
+
+
+## Description
+
+This library is a Ruby interface to WordNet®[https://wordnet.princeton.edu/].
+WordNet® is an online lexical reference system whose design is inspired by
+current psycholinguistic theories of human lexical memory. English nouns,
+verbs, adjectives and adverbs are organized into synonym sets, each
+representing one underlying lexical concept. Different relations link the
+synonym sets.
+
+This library uses SqlUNET[http://sqlunet.sourceforge.net/], which is a
+conversion of the WordNet (along with a number of other linguistic databases)
+lexicon flatfiles into a relational database format. You can either install the
+[wordnet-defaultdb](https://rubygems.org/gems/wordnet-defaultdb) gem, which
+packages up the SQLite3 version of SqlUNet, or install your own and point the
+lexicon at it by passing [Sequel connection
+parameters](http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html)
+to the constructor.
+
+## Usage
+
+There are three major parts to this library:
+
+WordNet::Lexicon
+: the interface to the dictionary, used to connect to the
+database and look up Words and Synsets.
+
+WordNet::Word
+: the English word entries in the Lexicon that are mapped
+to Synsets via one or more Senses.
+
+WordNet::Synset
+: the main artifact of WordNet: a "synonym set". These
+: are connected to one or more Words through a Sense,
+and are connected to each other via SemanticLinks.
+
+The other object classes exist mostly as a way of representing relationships
+between the main three:
+
+WordNet::Sense
+: represents a link between one or more Words and
+one or more Synsets for one meaning of the word.
+
+WordNet::SemanticLink
+: represents a link between Synsets
+
+WordNet::LexicalLink
+: represents a link between Words in Synsets
+
+WordNet::Morph
+: an interface to a lookup table of irregular word
+forms mapped to their base form (lemma)
+
+
+The last class (WordNet::Model) is the abstract superclass for all the others,
+and inherits most of its functionality from Sequel::Model, the ORM layer
+of the Sequel toolkit. It's mostly just a container for the database
+connection, with some convenience methods to allow the database connection
+to be deferred until runtime instead of when the library loads.
+
+The library also comes with the beginnings of support for the SUMO-WordNet
+mapping:
+
+WordNet::SumoTerm
+: [Suggested Upper Merged Ontology](http://www.ontologyportal.org/) terms,
+with associations back to related Synsets.
+
+As mentioned above, SqlUNet has done an amazing job of linking up a number of
+other useful linguistic lexicons via WordNet synsets. I plan on adding support
+for at minimum VerbNet, FrameNet, and PropBank.
+
+
+## Requirements
+
+* Ruby >= 3.0
+* Sequel >= 5.0
+
+
+## Contributing
+
+You can check out the current development source with Mercurial via its
+[project page](https://hg.sr.ht/~ged/ruby-wordnet). Or if you prefer
+Git, via [its Github mirror](https://github.com/ged/ruby-wordnet).
+
+After checking out the source, run:
+
+    $ gem install -Ng
+    $ rake setup
+
+This will do any necessary development environment set up.
+
+
+## Authors
+
+* Michael Granger <ged@FaerieMUD.org>
+
+
+## License
+
+Copyright (c) 2002-2023, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+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.

data/lib/wordnet/constants.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 

data/lib/wordnet/lexicallink.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/synset' unless defined?( WordNet::Synset )

data/lib/wordnet/lexicon.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'pathname'
 require 'loggability'
@@ -224,11 +223,13 @@ class WordNet::Lexicon
 	### #lookup_synsets instead.
 	###
 	### The +word+ can be one of:
-	### [Integer]
+	###
+	### [+Integer+]
 	###   Looks up the corresponding Word or Synset by ID. This assumes that all Synset IDs are
 	###   all 9 digits or greater, which is true as of WordNet 3.1. Any additional +args+ are
 	###   ignored.
-	### [Symbol, String]
+	###
+	### [+Symbol+, +String+]
 	###   Look up a Word by its gloss using #lookup_synsets, passing any additional +args+,
 	###   and return the first one that is found.
 	def []( word, *args )
@@ -250,13 +251,13 @@ class WordNet::Lexicon
 	###
 	### The *args* can contain:
 	###
-	### [Integer, Range]
+	### [+Integer+, +Range+]
 	###   The sense/s of the Word (1-indexed) to use when searching for Synsets. If not specified,
 	###   all senses of the +word+ are used.
-	### [Regexp]
+	### [+Regexp+]
 	###   The Word's Synsets are filtered by definition using an RLIKE filter. Note that not all
 	###   databases (including the default one, sqlite3) support RLIKE.
-	### [Symbol, String]
+	### [+Symbol+, +String+]
 	###   If it matches one of either a lexical domain (e.g., "verb.motion") or a part of
 	###   speech (e.g., "adjective", :noun, :v), the resulting Synsets are filtered by that
 	###   criteria.

data/lib/wordnet/model.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'loggability'
 require 'sequel'
@@ -37,7 +36,6 @@ module WordNet
 
 
 		### Reset the database connection that all model objects will use.
-		### @param [Sequel::Database] newdb  the new database object.
 		def self::db=( newdb )
 			Loggability.with_level( :fatal ) do
 				super

data/lib/wordnet/morph.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/model'
@@ -22,6 +21,15 @@ class WordNet::Morph < WordNet::Model( :morphs )
 
 	set_primary_key :morphid
 
+
+	##
+	# :method: morphid
+	# The Integer ID of the morph
+
+	##
+	# :method: morph
+	# The text of the morph
+
 	#                 Table "public.morphmaps"
 	#  Column  |     Type     |           Modifiers
 	# ---------+--------------+-------------------------------
@@ -35,6 +43,9 @@ class WordNet::Morph < WordNet::Model( :morphs )
 	# Foreign-key constraints:
 	#     "fk_morphmaps_morphid" FOREIGN KEY (morphid) REFERENCES morphs(morphid)
 	#     "fk_morphmaps_wordid" FOREIGN KEY (wordid) REFERENCES words(wordid)
+
+	##
+	# The WordNet::Word entries associated with this Morph
 	many_to_many :words,
 		join_table: :morphmaps,
 		right_key: :wordid,

data/lib/wordnet/semanticlink.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/constants'
@@ -12,11 +11,19 @@ class WordNet::SemanticLink < WordNet::Model( :semlinks )
 
 	set_primary_key [:synset1id, :synset2id, :linkid]
 
+	##
+	# :method: linkid
+	# The ID of this semlink
+
+	##
+	# The "origin" WordNet::Synset associated with this SemanticLink
 	many_to_one :origin,
 		class: 'WordNet::Synset',
 		key: :synset1id,
 		primary_key: :synsetid
 
+	##
+	# The "target" WordNet::Synset associated with this SemanticLink
 	one_to_one :target,
 		class: 'WordNet::Synset',
 		key: :synsetid,

data/lib/wordnet/sense.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/model'
@@ -10,6 +9,50 @@ class WordNet::Sense < WordNet::Model( :senses )
 
 	set_primary_key :senseid
 
+	#                              Table "wn.senses"
+	#    Column    |          Type          | Collation | Nullable |   Default
+	# -------------+------------------------+-----------+----------+-------------
+	#  wordid      | bigint                 |           | not null | '0'::bigint
+	#  casedwordid | bigint                 |           |          |
+	#  synsetid    | bigint                 |           | not null | '0'::bigint
+	#  senseid     | bigint                 |           |          |
+	#  sensenum    | bigint                 |           | not null | '0'::bigint
+	#  lexid       | bigint                 |           | not null | '0'::bigint
+	#  tagcount    | bigint                 |           |          |
+	#  sensekey    | character varying(100) |           |          |
+	# Indexes:
+	#     "idx_192341_primary" PRIMARY KEY, btree (wordid, synsetid)
+	#     "k_senses_lexid" btree (lexid)
+	#     "k_senses_synsetid" btree (synsetid)
+	#     "k_senses_wordid" btree (wordid)
+	#     "unq_senses_senseid" UNIQUE, btree (senseid)
+	#     "unq_senses_sensekey" UNIQUE, btree (sensekey)
+	# Foreign-key constraints:
+	#     "senses_synsetid_fkey" FOREIGN KEY (synsetid) REFERENCES synsets(synsetid)
+	#     "senses_wordid_fkey" FOREIGN KEY (wordid) REFERENCES words(wordid)
+	#
+
+	##
+	# :method: wordid
+	# The integer ID of the WordNet::Word this Sense is linked to
+
+	##
+	# :method: synsetid
+	# The integer ID Of the WordNet::Synset this Sense is linked to.
+
+	##
+	# :method: senseid
+	# The unique integer ID of the Sense.
+
+	##
+	# :method: sensenum
+	# The index of this Sense in relation to its Synset
+
+	##
+	# :method: sensekey
+	# The raw sense key as it appeared in the sources
+
+
 	##
 	# The Synset this is a Sense for
 	many_to_one :synset, key: :synsetid

data/lib/wordnet/sumoterm.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/model'

data/lib/wordnet/synset.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/constants'
@@ -353,7 +352,7 @@ class WordNet::Synset < WordNet::Model( :synsets )
 	### Return the table of part-of-speech types, keyed by letter identifier.
 	def self::postype_table
 		@postype_table ||= self.db[:postypes].inject({}) do |hash, row|
-			hash[ row[:pos].untaint.to_sym ] = row[:posname]
+			hash[ row[:pos].to_sym ] = row[:posname]
 			hash
 		end
 	end

data/lib/wordnet/word.rb

@@ -1,5 +1,4 @@
 # -*- ruby -*-
-#encoding: utf-8
 
 require 'wordnet' unless defined?( WordNet )
 require 'wordnet/model'

data/lib/wordnet.rb

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-#encoding: utf-8
 
 require 'loggability'
 require 'sequel'
@@ -15,7 +14,7 @@ module WordNet
 
 
 	# Release version
-	VERSION = '1.1.0'
+	VERSION = '1.2.0'
 
 	# VCS revision
 	REVISION = %q$Revision: $

data/spec/helpers.rb

@@ -1,9 +1,14 @@
 # -*- ruby -*-
-#encoding: utf-8
-# coding: utf-8
 
 # SimpleCov test coverage reporting; enable this using the :coverage rake task
-require 'simplecov' if ENV['COVERAGE']
+if ENV['COVERAGE']
+	require 'simplecov'
+	SimpleCov.start do
+		add_filter 'spec/'
+		enable_coverage :branch
+	end
+end
+
 
 $LOAD_PATH.unshift( 'wordnet-defaultdb/lib' )
 
@@ -29,8 +34,15 @@ RSpec.configure do |config|
 	config.example_status_persistence_file_path = "spec/.state"
 
 	if Gem::Specification.find_all_by_name( 'pg' ).any?
-		$dburi = 'postgres:/wordnet31'
-	else
+		begin
+			dburi = 'postgres:/sqlunet50'
+			Sequel.connect( dburi )
+			$dburi = dburi
+		rescue
+		end
+	end
+
+	if ! $dburi
 		config.filter_run_excluding( :requires_pg )
 		unless (( $dburi = WordNet::Lexicon.default_db_uri ))
 			config.filter_run_excluding( :requires_database )