rwordnet 0.1.0 → 0.1.1

data/README.markdown

@@ -15,10 +15,11 @@ rwordnet* ) at the expense of some performance. Use at your own risk, etc.
 
 ## Installation ##
 
-One of the chief benefits of rwordnet over Ruby-WordNet is how easy it is to install;
+One of the chief benefits of rwordnet over Ruby-WordNet is how easy it is to install:
 
-    gem sources -a http://gems.github.com # Add github to your rubygems sources
-    sudo gem install doches-rwordnet      # Install rwordnet
+    gem install gemcutter  # These two steps are only necessary if you haven't
+    gem tumble             # yet installed the gemcutter tools
+    gem install rwordnet
     
 That's it! rwordnet comes bundled with the WordNet database which it uses by default, 
 so there's absolutely nothing else to download, install, or configure.
@@ -30,15 +31,22 @@ set the path to WordNet's database files before using the library (see examples
 The other benefit of rwordnet over Ruby-WordNet is that it's so much easier (IMHO) to
 use. 
 
-As a quick example, consider finding all of the glosses for a given word:
+As a quick example, consider finding all of the noun glosses for a given word:
 
     require 'rubygems'
     require 'wordnet'
     
-    index = WordNet::NounIndex.new
+    index = WordNet::NounIndex.instance
     lemma = index.find("fruit")
     lemma.synsets.each { |synset| puts synset.gloss }
 
+...or all of the glosses, period:
+
+    lemmas = WordNet::WordNetDB.find("fruit")
+    synsets = lemmas.map { |lemma| lemma.synsets }
+    words = synsets.flatten
+    words.each { |word| puts word.gloss }
+
 Have your own WordNet database that you've marked up with extra attributes and whatnot?
 No problem:
 
@@ -47,5 +55,5 @@ No problem:
     
     include WordNet
     WordNetDB.path = "/path/to/WordNet-3.0"
-    lemma = WordNetDB.find("fruit")
-    ...
+    lemmas = WordNetDB.find("fruit")
+    ...

data/lib/wordnet/index.rb

@@ -1,6 +1,8 @@
+require 'singleton'
 module WordNet
 
 # Index is a WordNet lexicon. Note that Index is the base class; you probably want to be using the NounIndex, VerbIndex, etc. classes instead.
+# Note that Indices are Singletons -- get an Index object by calling <POS>Index.instance, not <POS>Index.new.
 class Index
   # Create a new index for the given part of speech. +pos+ can be one of +noun+, +verb+, +adj+, or +adv+.
   def initialize(pos)
@@ -11,9 +13,7 @@ class Index
   # Find a lemma for a given word. Returns a Lemma which can then be used to access the synsets for the word.
   def find(lemma_str)
     # Look for the lemma in the part of the DB already read...
-    @db.each_key do |word|
-      return @db[word] if word == lemma_str
-    end
+    return @db[lemma_str] if @db.include?(lemma_str)
     
     # If we didn't find it, read in some more from the DB. Some optimisation is possible here. TODO.
     index = WordNetDB.open(File.join(WordNetDB.path,"dict","index.#{@pos}"))
@@ -30,33 +30,42 @@ class Index
       index.close
     end
     
+    # If we *still* didn't find it, return nil. It must not be in the database...
     return nil
   end
 end
 
-# An Index of nouns.
+# An Index of nouns. Create a NounIndex by calling `NounIndex.instance`
 class NounIndex < Index
+  include Singleton
+  
   def initialize
     super("noun")
   end
 end
 
-# An Index of verbs.
+# An Index of verbs. Create a VerbIndex by calling `VerbIndex.instance`
 class VerbIndex < Index
+  include Singleton
+
   def initialize
     super("verb")
   end
 end
 
-# An Index of adjectives.
+# An Index of adjectives. Create an AdjectiveIndex by `AdjectiveIndex.instance`
 class AdjectiveIndex < Index
+  include Singleton
+
   def initialize
     super("adj")
   end
 end
 
-# An Index of adverbs.
+# An Index of adverbs. Create an AdverbIndex by `AdverbIndex.instance`
 class AdverbIndex < Index
+  include Singleton
+
   def initialize
     super("adv")
   end

data/lib/wordnet/wordnetdb.rb

@@ -20,7 +20,7 @@ class WordNetDB
   def WordNetDB.find(word)
     lemmas = []
     [NounIndex, VerbIndex, AdjectiveIndex, AdverbIndex].each do |index|
-      lemmas.push index.new.find(word)
+      lemmas.push index.instance.find(word)
     end
     return lemmas.flatten.reject { |x| x.nil? }
   end

data/test/unit/index_test.rb

@@ -4,7 +4,7 @@ class TestIndex < Test::Unit::TestCase
   @@index = nil
   
   def setup
-    @@index = WordNet::NounIndex.new if @@index.nil?
+    @@index = WordNet::NounIndex.instance if @@index.nil?
   end
   
   test 'find a lemma by string' do

data/test/unit/synset_test.rb

@@ -5,7 +5,7 @@ class TestSynset < Test::Unit::TestCase
 
   def setup
     if @@synsets.nil?
-      index = WordNet::NounIndex.new
+      index = WordNet::NounIndex.instance
       lemma = index.find("fruit")
       @@synsets = lemma.get_synsets
     end

data/test/unit/wordnetdb_test.rb

@@ -4,12 +4,11 @@ class TestWordNetDB < Test::Unit::TestCase
   include WordNet
   
   test 'set and read path' do
-    WordNetDB.path = WordNetPath
-    assert_equal WordNetPath,WordNetDB.path
+    WordNetDB.path = "WordNetPath"
+    assert_equal "WordNetPath",WordNetDB.path
   end
   
   test 'find a word' do
-    WordNetDB.path = WordNetPath
     lemmas = WordNetDB.find("fruit")
     assert_equal 2,lemmas.size
   end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rwordnet
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Trevor Fountain
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-18 00:00:00 +01:00
+date: 2010-09-03 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -60,21 +66,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A pure Ruby interface to the WordNet database