rwordnet 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af20be262ff83829299dfcaab7bdaf6daca77d9e
-  data.tar.gz: 5fdf6de52538acc9e2e6c6cd59af7f8055aa1361
+  metadata.gz: 9518288f71b4a82f57e48e62f1adb0842c799857
+  data.tar.gz: f56b54be645baaaff6b855745cbc122ef8e4a035
 SHA512:
-  metadata.gz: 9f232d93029c8f200e6ba54af4461df6a4430e7ecc1189510cee59447303a350bb47f6deab13ad9b3cb7d6730b52d514b73377f673f1d81c03b4997d2a6ababe
-  data.tar.gz: d374907bacd015be0274bb8f8219d1803bc884b9c852f99c83441ca303e7fe2ac4687be7341462e6bb5fb54657f09c91d4cf64edc746ee27c8577ce2286a2942
+  metadata.gz: c6c0e42b463a29d85a1ece1a3eb68d1c9924dd011e1bc1c9f4058478d1e330fc78219bc5ed76ea68313a1b4944862905aa6809dace2d77b843c6295056e5e69b
+  data.tar.gz: c04cbcc3ead95d96d4c98c4427e3b7bdfaaa2c8f1c799877475009977bd8ebb5f54e2104f1642d9144b369476b48276d7abb20c7e8d14c9457b58a2e5036acd4

data/README.markdown

@@ -1,5 +1,6 @@
 # A pure Ruby interface to WordNet #
 
+[![Gem Version](https://badge.fury.io/rb/rwordnet.svg)](http://badge.fury.io/rb/rwordnet)
 [![Build Status](https://travis-ci.org/doches/rwordnet.png)](https://travis-ci.org/doches/rwordnet)
 [![Documentation Status](https://inch-ci.org/github/doches/rwordnet.svg?branch=master)](https://inch-ci.org/github/doches/rwordnet)
 [![Code Climate](https://codeclimate.com/github/doches/rwordnet/badges/gpa.svg)](https://codeclimate.com/github/doches/rwordnet)
@@ -26,6 +27,10 @@ since it converts the WordNet database into a BerkelyDB file for quicker access.
 writing rwordnet, I've focused more on usability and ease of installation ( *gem install
 rwordnet* ) at the expense of some performance. Use at your own risk, etc.
 
+| Note |
+| --- |
+| `2.0.0` changed how you require rwordnet from `require 'wordnet'` to `require 'rwordnet'` (note the extra `r`!).  |
+
 ## Installation ##
 
 One of the chief benefits of rwordnet over Ruby-WordNet is how easy it is to install:
@@ -45,7 +50,7 @@ use.
 As an example, consider finding all of the noun glosses for a given word:
 
 ```Ruby
-require 'wordnet'
+require 'rwordnet'
 
 lemma = WordNet::Lemma.find("fruit", :noun)
 lemma.synsets.each { |synset| puts synset.gloss }
@@ -64,9 +69,8 @@ Have your own WordNet database that you've marked up with extra attributes and w
 No problem:
 
 ```Ruby
-require 'wordnet'
+require 'rwordnet'
 
 WordNet::DB.path = "/path/to/WordNet-3.0"
 lemmas = WordNet::Lemma.find_all("fruit")
-...
 ```

data/examples/benchmark.rb

@@ -1,5 +1,5 @@
 require 'benchmark'
-require 'wordnet'
+require 'rwordnet'
 
 initial = Benchmark.realtime do
   WordNet::Lemma.find(ARGV[0] || raise("Usage: ruby benchmark.rb noun"), :noun)

data/examples/dictionary.rb

@@ -1,5 +1,5 @@
 # Use WordNet as a command-line dictionary.
-require 'wordnet'
+require 'rwordnet'
 
 if ARGV.size != 1
   puts "Usage: ruby dictionary.rb word"

data/examples/full_hypernym.rb

@@ -1,4 +1,4 @@
-require 'wordnet'
+require 'rwordnet'
 
 # Find the word 'dog'
 lemma = WordNet::Lemma.find("dog", :noun)

data/examples/morphy.rb

@@ -1,4 +1,4 @@
-require 'wordnet'
+require 'rwordnet'
 
 puts 'dogs'
 puts '--------------'

data/examples/synset_find.rb

@@ -1,4 +1,4 @@
-require 'wordnet'
+require 'rwordnet'
 
 puts 'hiking'
 WordNet::Synset.find_all('hiking').each{|d| puts d}

data/lib/rwordnet.rb

@@ -0,0 +1,5 @@
+require 'rwordnet/pointer'
+require 'rwordnet/db'
+require 'rwordnet/lemma'
+require 'rwordnet/pointers'
+require 'rwordnet/synset'

data/lib/{wordnet → rwordnet}/db.rb

@@ -1,5 +1,3 @@
-require 'stringio'
-
 module WordNet
   # Represents the WordNet database, and provides some basic interaction.
   class DB
@@ -9,7 +7,6 @@ module WordNet
     class << self; attr_accessor :cached end
     @raw_wordnet = {}
 
-
     class << self
       # To use your own WordNet installation (rather than the one bundled with rwordnet:
       # Returns the path to the WordNet installation currently in use. Defaults to the bundled version of WordNet.

data/lib/{wordnet → rwordnet}/lemma.rb

@@ -2,6 +2,7 @@ module WordNet
   # Represents a single word in the WordNet lexicon, which can be used to look up a set of synsets.
   class Lemma
     SPACE = ' '
+    POS_SHORTHAND = {:v => :verb, :n => :noun, :a => :adj, :r => :adv}
 
     # The word this lemma represents
     attr_accessor :word
@@ -58,8 +59,13 @@ module WordNet
         end
       end
 
-      # Find a lemma for a given word and pos
+      # Find a lemma for a given word and pos. Valid parts of speech are:
+      # 'adj', 'adv', 'noun', 'verb'. Additionally, you can use the shorthand
+      # forms of each of these ('a', 'r', 'n', 'v')/
       def find(word, pos)
+        # Map shorthand POS to full forms
+        pos = POS_SHORTHAND[pos] || pos
+
         cache = @@cache[pos] ||= build_cache(pos)
         if found = cache[word]
           Lemma.new(*found)

data/lib/{wordnet → rwordnet}/synset.rb

@@ -1,19 +1,19 @@
 module WordNet
   SYNSET_TYPES = {"n" => "noun", "v" => "verb", "a" => "adj", "r" => "adv"}
+  MORPHOLOGICAL_SUBSTITUTIONS = {
+      'noun' => [['s', ''], ['ses', 's'], ['ves', 'f'], ['xes', 'x'],
+             ['zes', 'z'], ['ches', 'ch'], ['shes', 'sh'],
+             ['men', 'man'], ['ies', 'y']],
+      'verb' => [['s', ''], ['ies', 'y'], ['es', 'e'], ['es', ''],
+             ['ed', 'e'], ['ed', ''], ['ing', 'e'], ['ing', '']],
+      'adj' => [['er', ''], ['est', ''], ['er', 'e'], ['est', 'e']],
+      'adv' => []}
 
   # Represents a synset (or group of synonymous words) in WordNet. Synsets are related to each other by various (and numerous!)
   # relationships, including Hypernym (x is a hypernym of y <=> x is a parent of y) and Hyponym (x is a child of y)
   class Synset
     @morphy_path = File.expand_path("../../../morphy/", __FILE__)
     @exception_map = {}
-    @morphological_substitutions = {
-        'noun' => [['s', ''], ['ses', 's'], ['ves', 'f'], ['xes', 'x'],
-               ['zes', 'z'], ['ches', 'ch'], ['shes', 'sh'],
-               ['men', 'man'], ['ies', 'y']],
-        'verb' => [['s', ''], ['ies', 'y'], ['es', 'e'], ['es', ''],
-               ['ed', 'e'], ['ed', ''], ['ing', 'e'], ['ing', '']],
-        'adj' => [['er', ''], ['est', ''], ['er', 'e'], ['est', 'e']],
-        'adv' => []}
 
     # Get the offset, in bytes, at which this synset's information is stored in WordNet's internal DB.
     # You almost certainly don't care about this.
@@ -83,7 +83,7 @@ module WordNet
     # Ported from python NLTK
     # Load all synsets with a given lemma and part of speech tag.
     # If no pos is specified, all synsets for all parts of speech
-    # will be loaded. 
+    # will be loaded.
     # If lang is specified, all the synsets associated with the lemma name
     # of that language will be returned.
     def self.find(word, pos)
@@ -107,7 +107,7 @@ module WordNet
     end
 
     def self._apply_rules(forms, pos)
-        substitutions = @morphological_substitutions[pos]
+        substitutions = MORPHOLOGICAL_SUBSTITUTIONS[pos]
         out = []
         forms.each do |form|
             substitutions.each do |old, new|
@@ -188,7 +188,7 @@ module WordNet
         map! { |pointer| Synset.new(@synset_type, pointer.offset) }
     end
 
-    # Get the Synset of this sense's antonym
+    # Get the Synsets of this sense's antonym
     def antonyms
       relation(ANTONYM)
     end
@@ -198,7 +198,8 @@ module WordNet
       relation(HYPERNYM)[0]
     end
 
-    # Get the parent synset (higher-level category, i.e. fruit -> reproductive_structure).
+    # Get the parent synset (higher-level category, i.e. fruit -> reproductive_structure)
+    # as an array.
     def hypernyms
       relation(HYPERNYM)
     end

data/lib/rwordnet/version.rb

@@ -0,0 +1,3 @@
+module WordNet
+  VERSION = "2.0.0"
+end

data/test/test_helper.rb

@@ -21,7 +21,7 @@ require "bundler/setup"
 require "maxitest/autorun"
 
 $LOAD_PATH.unshift Bundler.root.join("lib")
-require "wordnet"
+require "rwordnet"
 
 Minitest::Test.class_eval do
   def with_db_path(path)

data/test/unit/synset_test.rb

@@ -73,4 +73,11 @@ describe WordNet::Synset do
     animal =  WordNet::Lemma.find("animal", :noun).synsets[0]
     assert_equal animal.expanded_hypernyms_depth[1], 6
   end
+
+  it 'understands short forms in lemma lookups' do
+    animal =  WordNet::Lemma.find("animal", :noun).synsets[0]
+    shortform =  WordNet::Lemma.find("animal", :n).synsets[0]
+
+    assert_equal animal.to_s, shortform.to_s
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rwordnet
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Trevor Fountain
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-18 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: trevor@texasexpat.net
@@ -37,13 +37,13 @@ files:
 - examples/full_hypernym.rb
 - examples/morphy.rb
 - examples/synset_find.rb
-- lib/wordnet.rb
-- lib/wordnet/db.rb
-- lib/wordnet/lemma.rb
-- lib/wordnet/pointer.rb
-- lib/wordnet/pointers.rb
-- lib/wordnet/synset.rb
-- lib/wordnet/version.rb
+- lib/rwordnet.rb
+- lib/rwordnet/db.rb
+- lib/rwordnet/lemma.rb
+- lib/rwordnet/pointer.rb
+- lib/rwordnet/pointers.rb
+- lib/rwordnet/synset.rb
+- lib/rwordnet/version.rb
 - morphy/exceptions/adj.exc
 - morphy/exceptions/adv.exc
 - morphy/exceptions/noun.exc
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A pure Ruby interface to the WordNet database

data/lib/wordnet.rb

@@ -1,5 +0,0 @@
-require 'wordnet/pointer'
-require 'wordnet/db'
-require 'wordnet/lemma'
-require 'wordnet/pointers'
-require 'wordnet/synset'

data/lib/wordnet/version.rb

@@ -1,3 +0,0 @@
-module WordNet
-  VERSION = "1.1.0"
-end