words 0.3.0 → 0.3.1

data/README.markdown

@@ -4,6 +4,9 @@
 
 Words implements a fast interface to [Wordnet®](http://wordnet.princeton.edu) which provides both a pure ruby and an FFI powered backend over the same easy-to-use API. The FFI backend makes use of [Tokyo Cabinet](http://1978th.net/tokyocabinet/) and the FFI interface, [rufus-tokyo](http://github.com/jmettraux/rufus-tokyo), to provide cross ruby distribution compatability and blistering speed. The pure ruby interface operates on a special ruby optimised index along with the basic dictionary files provided by WordNet®. I have attempted to provide ease of use in the form of a simple yet powerful api and installation is a sintch!
 
+* Version 0.2 Introduced Pure Ruby Backend
+* Version 0.3 Introduced Evocation Support (see examples & below) as developed by the [Wordnet® Evocation Project](http://wordnet.cs.princeton.edu/downloads/evocation/release-0.4/README.TXT) 
+
 ## Pre-Installation ##
 
 First ensure you have a copy of the wordnet data files. This is generally available from your Linux/OSX package manager:
@@ -55,13 +58,16 @@ Then your ready to rock and roll. :)
 
 To build the wordnet dataset (or index for pure) file yourself, from the original wordnet files, you can use the bundled "build_wordnet" command
 
-	build_wordnet -h # this will give you the usage information
+	build_wordnet -h # this will give you the usage information & additional options/features
 	
 	# this would attempt to build the tokyo backend data locating the original wordnet files through a search...
 	sudo build_wordnet -v --build-tokyo
 	
 	# this would attempt to build the pure backend index locating the original wordnet files through a search...
 	sudo build_wordnet -v --build-pure
+	
+	# this would attempt to build the tokyo backend index as above but also builds the evocations information into the dataset
+	sudo build_wordnet -v --build-pure --build-evocations
 
 ## Usage ##
 
@@ -107,6 +113,9 @@ Heres a few little examples of using words within your programs.
     sense.derivationally_related_forms.first.destination_word # => "bat"
     sense.derivationally_related_forms.first.destination # => the synset of v01413191
     
+    data.find("broadcast").senses.first.evocations # => sense relevant evocations
+    data.find("broadcast").senses.first.evocations[1] # => the evocation at index 1
+    
 These and more examples are available from within the examples.rb file!        
 
 ## Note on Patches/Pull Requests ##

data/Rakefile

@@ -11,7 +11,6 @@ begin
     gem.homepage = "http://github.com/roja/words"
     gem.authors = ["Roja Buck"]
     gem.add_dependency "trollop", ">= 1.15"
-    gem.add_dependency 'rufus-tokyo', '>= 1.0.5'
     gem.executables = [ "build_wordnet" ]
     gem.default_executable = "build_wordnet"
     gem.rubyforge_project = 'words'

data/VERSION

@@ -1 +1 @@
-0.3.0
+0.3.1

data/bin/build_wordnet

@@ -6,7 +6,6 @@ require 'pathname'
 # gem includes
 require 'rubygems'
 require 'trollop'
-require 'rufus-tokyo'
 require 'zlib'
 require 'net/http'
 
@@ -33,6 +32,8 @@ end
 Trollop::die :build_tokyo, "You need to specify whether tokyo dataset or pure ruby index building is required" if !opts[:build_tokyo] && !opts[:build_pure]
 puts "Verbose mode enabled" if (VERBOSE = opts[:verbose])
 
+require 'rufus-tokyo' if opts[:build_tokyo]
+
 gem_path = Pathname.new "#{File.dirname(__FILE__)}/.."
 abort "Ensure you run the command using sudo or as a Superuser / Administrator" unless gem_path.writable?
 data_path = gem_path + "data/"

data/lib/words.rb

@@ -4,7 +4,7 @@ require 'set'
 
 # gem includes
 require 'rubygems'
-require 'rufus-tokyo'
+require 'rufus-tokyo' if Gem.available?('rufus-tokyo')
 
 module Words
   
@@ -21,6 +21,7 @@ module Words
       
       if @data_path.exist?
         if @connection_type == :tokyo
+          raise "Coulden't find the rufus-tokyo gem. Please ensure it's installed." unless Gem.available?('rufus-tokyo')
           @connection = Rufus::Tokyo::Table.new(@data_path.to_s, :mode => 'r')
           @connected = true
         elsif @connection_type == :pure
@@ -384,6 +385,8 @@ module Words
       @to_s
     end
     
+    alias word lemma
+    
   end
   
   class Homographs

data/words.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{words}
-  s.version = "0.3.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roja Buck"]
-  s.date = %q{2010-01-17}
+  s.date = %q{2010-01-18}
   s.default_executable = %q{build_wordnet}
   s.description = %q{Words, with both pure ruby & tokyo-cabinate backends, implements a fast interface to Wordnet® over the same easy-to-use API. The FFI backend makes use of Tokyo Cabinet and the FFI interface, rufus-tokyo, to provide cross ruby distribution compatability and blistering speed. The pure ruby interface operates on a special ruby optimised index along with the basic dictionary files provided by WordNet®. I have attempted to provide ease of use in the form of a simple yet powerful api and installation is a sintch!}
   s.email = %q{roja@arbia.co.uk}
@@ -48,14 +48,11 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<trollop>, [">= 1.15"])
-      s.add_runtime_dependency(%q<rufus-tokyo>, [">= 1.0.5"])
     else
       s.add_dependency(%q<trollop>, [">= 1.15"])
-      s.add_dependency(%q<rufus-tokyo>, [">= 1.0.5"])
     end
   else
     s.add_dependency(%q<trollop>, [">= 1.15"])
-    s.add_dependency(%q<rufus-tokyo>, [">= 1.0.5"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: words
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Roja Buck
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-17 00:00:00 +00:00
+date: 2010-01-18 00:00:00 +00:00
 default_executable: build_wordnet
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -22,16 +22,6 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "1.15"
     version: 
-- !ruby/object:Gem::Dependency 
-  name: rufus-tokyo
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.0.5
-    version: 
 description: "Words, with both pure ruby & tokyo-cabinate backends, implements a fast interface to Wordnet\xC2\xAE over the same easy-to-use API. The FFI backend makes use of Tokyo Cabinet and the FFI interface, rufus-tokyo, to provide cross ruby distribution compatability and blistering speed. The pure ruby interface operates on a special ruby optimised index along with the basic dictionary files provided by WordNet\xC2\xAE. I have attempted to provide ease of use in the form of a simple yet powerful api and installation is a sintch!"
 email: roja@arbia.co.uk
 executables: