wordfor 0.0.2 → 0.1.0

data/LICENSE.txt

@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,24 +1,72 @@
 # Wordfor
 
-TODO: Write a gem description
+A simple command line thesaurus based on the
+[WordNet](http://wordnet.princeton.edu/) database. It can help you get other
+**word**s **for** things, which can be particularly useful if your dayjob
+requires frequent naming of things.
+
+To "bulk up" the results, I'm using a traversal of the input word's [hyponyms
+and hypernyms](http://en.wikipedia.org/wiki/Hyponymy). Sometimes these look a
+lot like synonyms, sometimes they get a little weird.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install the gem by running:
+
+    $ gem install wordfor
 
-    gem 'wordfor'
+This gem requires Ruby 1.9.2 or higher.
 
-And then execute:
+## Usage
 
-    $ bundle
+the command:
 
-Or install it yourself as:
+    $ wordfor list
 
-    $ gem install wordfor
+prints:
 
-## Usage
+    noun:
+      synonyms:
+        inclination, lean, leaning, tilt, listing
+      hyponyms:
+        agenda, agendum, order of business, order of the day, order book, order paper,
+        a-list, bibliography, bill, bill of entry, bill of goods, bill of fare,
+        card, carte, carte du jour, menu, a la carte, prix fixe, table d'hote,
+        playbill, black book, blacklist, shitlist, calendar, docket, calorie chart,
+        canon, catalog, catalogue, discography, library catalog, library catalogue,
+        card catalog, card catalogue, parts catalog, parts catalogue, seed catalog,
+        seed catalogue, character set, alphabet, armenian, armenian alphabet, latin
+        alphabet, roman alphabet, hebraic alphabet, hebrew alphabet, hebrew script,
+        greek alphabet, cyrillic, cyrillic alphabet, arabic alphabet, phonetic
+        alphabet, sound alphabet, visible speech, finger alphabet, manual alphabet,
+        alphanumeric characters, alphanumerics, checklist, class list, honours list,
+        codex, contents, table of contents, corrigenda, credits, criminal record,
+        record, directory, subdirectory, distribution list, enumeration, numbering, faq,
+        free list, grocery list, shopping list, hit list, hit parade, index,
+        concordance, key, key word, key, inventory, stock list, parts inventory,
+        mailing list, flag, masthead, computer menu, menu, drop-down menu, cascading
+        menu, hierarchical menu, submenu, necrology, play list, playlist, portfolio,
+        posting, price list, push-down list, push-down stack, stack, queue, push-down
+        queue, roll, roster, batting order, card, lineup, death-roll, muster roll,
+        church roll, rota, waiting list, schedule, network programming, timetable,
+        timetable, shopping list, grocery list, short list, shortlist, sick list,
+        slate, ticket, standing, wish list
+      hypernyms:
+        position, spatial relation, relation, abstract entity, abstraction, entity,
+        database, info, information, content, message, subject matter, substance,
+        communication
+    verb:
+      synonyms:
+        name, number, heel, lean
+      hyponyms:
+        itemise, itemize, inventory, stock-take, take stock, empanel, impanel, index,
+        cross-index, blacklist, post
+      hypernyms:
+        enumerate, itemise, itemize, recite, identify, name, denote, refer, intend, mean,
+        signify, stand for, angle, lean, slant, tilt, tip, bend, flex, change form,
+        change shape, deform, change, move, register, enter, put down, record,
+        preserve, save, hold on, keep, have, have got, hold
 
-TODO: Write usage instructions here
 
 ## Contributing
 

data/bin/wordfor

@@ -19,8 +19,8 @@ use this program.
 
 EOS
 
-  opts.on('-v', '--verbose', 'more noisy') do |v|
-    options[:verbose] = v
+  opts.on('-v', '--version', 'show version and quit') do |v|
+    options[:version] = v
   end
 
   opts.on('-d', '--debug', 'debugging output') do |d|
@@ -28,6 +28,11 @@ EOS
   end
 end.parse!
 
+if options[:version]
+  puts "wordfor #{ Wordfor::VERSION } #{ Wordfor::VERSION_DATE }"
+  exit 0
+end
+
 word = ARGV[0]
 
 if word.nil?
@@ -37,33 +42,28 @@ else
   word = word.strip
 end
 
-if Wordfor::Setup.run_setup?
-  Wordfor::Setup.new($stdin, $stdout).run
-end
-
-result = Wordfor::Lookup.new( Wordfor::Configuration.api_key ).lookup(word)
+result = Wordfor::Lookup.new.lookup(word)
 
 if options[:debug]
   puts result.inspect
   puts result.keys.inspect
 end
 
+def display_word_relationship(words, relationship)
+  if words[relationship]
+    word_list = words[relationship].join(", ")
+    puts "  #{ relationship }:"
+    puts '    ' + Wordfor::Plaintext.wrapped_text(word_list, :indent => '    ')
+  end
+end
+
 result.each_pair do |(part_of_speech, words)|
   if words
     puts "#{ part_of_speech }:"
 
-    if words['syn']
-      word_list = words['syn'].join(", ")
-
-      puts "  synonyms:"
-      puts '    ' + Wordfor::Plaintext.wrapped_text(word_list, :indent => '    ')
-    end
-
-    if words['ant']
-      word_list = words['ant'].join(", ")
-
-      puts "  antonyms:"
-      puts '    ' + Wordfor::Plaintext.wrapped_text(word_list, :indent => '    ')
-    end
+    display_word_relationship words, :synonyms
+    display_word_relationship words, :hyponyms
+    display_word_relationship words, :hypernyms
+    display_word_relationship words, :antonyms
   end
 end

data/lib/wordfor.rb

@@ -1,11 +1,8 @@
-require 'httparty'
-
 require 'wordfor/core_ext/array'
 require 'wordfor/core_ext/dir'
 
 require 'wordfor/version'
 require 'wordfor/configuration'
-require 'wordfor/setup'
 require 'wordfor/plaintext'
 require 'wordfor/lookup'
 

data/lib/wordfor/lookup.rb

@@ -1,17 +1,73 @@
-require 'httparty'
+require 'wordnet'
 
-# http://words.bighugelabs.com/api/2/API_KEY/word/json
+# WordNet!
 module Wordfor
   class Lookup
-    include HTTParty
-    base_uri 'words.bighugelabs.com'
+    def initialize
+      @lexicon = WordNet::Lexicon.new
 
-    def initialize(api_key)
-      @api_key = api_key
     end
 
+    # Based on example code:
+    #
+    # lex = WordNet::Lexicon.new
+    # lex.lookup_synsets('time').map {|o|
+    #   o.traverse(:hyponyms).with_index.map {|ss, i|
+    #     [ss.part_of_speech.to_sym, ss.words.map(&:lemma)]
+    #   }
+    # }.reject {|l| l.size == 0}
+
     def lookup(word)
-      self.class.get("/api/2/#{ @api_key }/#{ word }/json")
+      @input_word = word
+      @visited = {}
+      @pos_map = {}
+
+      origins = @lexicon.lookup_synsets word
+
+      origins.each {|o|
+        break if visited?(o)
+        add_synset_to_map o, :synonyms
+
+        o.traverse(:hyponyms).with_index.each {|ss|
+          break if visited?(ss)
+          add_synset_to_map ss, :hyponyms
+        }
+
+        o.traverse(:hypernyms).with_index.each {|ss|
+          break if visited?(ss)
+          add_synset_to_map ss, :hypernyms
+        }
+
+        o.traverse(:antonyms).with_index.each {|ss|
+          break if visited?(ss)
+          add_synset_to_map ss, :antonyms
+        }
+      }
+
+      @pos_map
+    end
+
+    private
+
+    def visited? ss
+      if @visited[ss.synsetid]
+        true
+      else
+        @visited[ss.synsetid] = ss
+        false
+      end
+    end
+
+    def filter list, word
+      list.reject {|w| w == word}
+    end
+
+    def add_synset_to_map synset, relation
+      pos = synset.part_of_speech.to_sym
+
+      @pos_map[pos] ||= {}
+      @pos_map[pos][relation] ||= []
+      @pos_map[pos][relation].concat filter(synset.words.map(&:lemma), @input_word)
     end
   end
 end

data/lib/wordfor/version.rb

@@ -1,3 +1,4 @@
 module Wordfor
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
+  VERSION_DATE = "2013-01-23"
 end

data/wordfor.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.add_dependency('httparty', '~> 0.9.0')
-  gem.add_dependency('json', '~> 1.7.5')
+  gem.add_dependency 'wordnet'
+  gem.add_dependency 'wordnet-defaultdb'
+
+  gem.required_ruby_version = '>= 1.9.2'
 end

metadata

@@ -1,65 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: wordfor
-version: !ruby/object:Gem::Version 
-  hash: 27
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 2
-  version: 0.0.2
 platform: ruby
-authors: 
+authors:
 - Adam Bachman
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-01-10 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: httparty
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wordnet
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 59
-        segments: 
-        - 0
-        - 9
-        - 0
-        version: 0.9.0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wordnet-defaultdb
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 7
-        - 5
-        version: 1.7.5
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Find synonyms and antonyms from the command line.
-email: 
+email:
 - adam.bachman@gmail.com
-executables: 
+executables:
 - wordfor
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - LICENSE.txt
@@ -72,42 +63,30 @@ files:
 - lib/wordfor/core_ext/dir.rb
 - lib/wordfor/lookup.rb
 - lib/wordfor/plaintext.rb
-- lib/wordfor/setup.rb
 - lib/wordfor/version.rb
 - wordfor.gemspec
-has_rdoc: true
 homepage: http://github.com/abachman/wordfor
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A thesaurus for your command line.
 test_files: []
-

data/lib/wordfor/setup.rb

@@ -1,23 +0,0 @@
-module Wordfor
-  class Setup
-    def self.run_setup?
-      !File.exists?(Wordfor::Configuration.config_file)
-    end
-
-    def initialize(stdin, stdout)
-      @stdin = stdin
-      @stdout = stdout
-      @settings = {}
-    end
-
-    def run
-      File.open(Wordfor::Configuration.config_file, "w") do |file|
-        @stdout.puts "~/.wordfor.yml not found. Running setup"
-        @stdout.puts "http://words.bighugelabs.com/ API key?"
-        @settings["api_key"] = @stdin.gets.chomp
-        file.write @settings.to_yaml
-      end
-    end
-  end
-end
-