rhymes 0.0.4 → 0.1.0

data/.gitignore

@@ -3,3 +3,4 @@
 .rvmrc
 Gemfile.lock
 pkg/*
+.idea

data/README.rdoc

@@ -26,7 +26,9 @@ as /tmp/rhymes.dat
   => true
   ruby > Rhymes.setup
   => {:raw_dict=>"/tmp/cmudict.0.7a", :compiled=>"/tmp/rhymes.dat"}
-  ruby > Rhymes.setup(:compiled=>'/new/location/file')
+  ruby > Rhymes.setup(:compiled => '/new/location/file')
   => {:raw_dict=>"/tmp/cmudict.0.7a", :compiled=>"/new/location/file"}
-
+  ruby > Rhymes.setup{|c| c.raw_dict = '/new/raw/dict'}
+   => {:raw_dict=>"/new/raw/dict", :compiled=>"/new/location/file"}
     
+Note that after the first successful call to Rhymes.rhyme all data is in memory and setup does not affect anything

data/Rakefile

@@ -1,3 +1,5 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/rhymes.rb

@@ -1,25 +1,41 @@
 require 'rhymes/version'
 
 module Rhymes
-  @@options = {:raw_dict => '/tmp/cmudict.0.7a', :compiled => '/tmp/rhymes.dat'}
-  
+  # generic error
+  class RhymesError < RuntimeError; end
+  # word does not exist in the dictionary
+  class UnknownWord < RhymesError; end
+  # dictionary file cannot be found at expected location
+  class DictionaryMissing < RhymesError; end
+
   class << self
     ##
     # Sets up options.
     # - :raw_dict - location of raw dictionary file. Default: /tmp/cmudict.0.7a
-    # - :compiled - location to store/retrieve precompiled dictionary. Default: /tmp/rhymes.dat
-    def setup(options)
-      @@options.merge!(options)
+    # - :compiled - location to store/retrieve precompiled dictionary. Default: /tmp/rhymes.dat.
+    #   Providing location to store precompiled dictionary speeds up consequent loads
+    def setup(opts = {})
+      opts.each{ |k, v| options[k]  = v }
+      yield options if block_given?
+      Hash[options.each_pair.to_a]
     end
     
     ##
-    # Return the list of perfect and identical rhymes to provided word.
+    # Return the list of perfect and identical rhymes to provided word (in upper case)
+    # raises
+    #   Rhymes::UnknownWord       - word does not exist in the dictionary
+    #   Rhymes::DictionaryMissing - dictionary file cannot be found at expected location
     def rhyme(word)
       wup = word.upcase
-      (rhymes[words[wup]] || []) - [wup]
+      key = words[wup]
+      raise UnknownWord unless key
+      rhymes[key] - [wup]
     end
 
   private
+    def options
+      @options ||= Struct.new(:raw_dict, :compiled).new('/tmp/cmudict.0.7a', '/tmp/rhymes.dat')
+    end
 
     def words
       init unless @words
@@ -38,31 +54,35 @@ module Rhymes
     end
 
     def init
-      if File.exists?(@@options[:compiled])
-        @words, @rhymes = Marshal.load(File.open(@@options[:compiled], 'rb'){|f| f.read })
-      elsif File.exists?(@@options[:raw_dict])
-        @words, @rhymes = {}, {}
-        File.open(@@options[:raw_dict]) do |f| 
-          while l = f.gets do
-            next if l =~ /^[^A-Z]/ 
-            word, *pron = l.strip.split(' ')
-            next if word.empty? || word =~ /\d/ 
-            pron.map!{|snd| snd.sub(/2/, '1')}
-            key = perfect_key(pron)
-            @words[word] = key 
-            (@rhymes[key] ||= []) << word
-          end
-        end
-        begin
-          File.open(@@options[:compiled], 'wb'){|f| f.write(Marshal.dump([@words, @rhymes]))}
-        rescue
-          # ????
+      return if load_compiled
+      unless File.exists?(options.raw_dict)
+        msg = %W[File #{options.raw_dict} does not exist. You can download the latest dictionary
+              from https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict and provide
+              file location with Rhymes.setup(:raw_dict => file_full_path) (/tmp/cmudict.0.7a by default)] * ' '
+        raise DictionaryMissing.new(msg)
+      end
+      load_dictionary
+    end
+
+    def load_dictionary
+      @words, @rhymes = {}, {}
+      File.open(options[:raw_dict]) do |f|
+        while l = f.gets do
+          next if l =~ /^[^A-Z]/
+          word, *pron = l.strip.split(' ')
+          next if word.empty? || word =~ /\d/
+          pron.map!{|snd| snd.sub(/2/, '1')}
+          key = perfect_key(pron)
+          @words[word] = key
+          (@rhymes[key] ||= []) << word
         end
-      else
-        raise "File #{@@options[:raw_dict]} does not exist. You can download latest dictionary " +
-              "from https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict and provide "
-              "file location with Rhymes.setup(:raw_dict => file_full_path) (/tmp/cmudict.0.7a by default)"
       end
+      File.open(options.compiled, 'wb'){|f| f.write(Marshal.dump([@words, @rhymes]))} rescue nil
+    end
+
+    def load_compiled
+        @words, @rhymes = Marshal.load(File.open(options.compiled, 'rb'){|f| f.read }) if File.exists?(options.compiled)
     end
+
   end
 end

data/lib/rhymes/version.rb

@@ -1,3 +1,3 @@
 module Rhymes
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/spec/rhymes_spec.rb

@@ -1,16 +1,22 @@
 require 'spec_helper'
 
 describe Rhymes do
-  before(:all) do
+  before do
     @sample = File.join(File.dirname(__FILE__), 'sample_raw.txt')
-    Rhymes.setup(:raw_dict => @sample)
+    Rhymes.setup(:raw_dict => @sample, :compiled => '')
   end
   
   it 'should save provided option' do
-    Rhymes.setup(:compiled => '/tmp/sample').should == 
-      {:raw_dict => @sample, :compiled => '/tmp/sample'}
+    Rhymes.setup(:compiled => '/tmp/sample').should == {:raw_dict => @sample, :compiled => '/tmp/sample'}
   end
-  
+
+  it 'should save block config' do
+    Rhymes.setup do |config|
+      config.raw_dict = 'foo'
+      config.compiled = 'bar'
+    end.should == {:raw_dict => 'foo', :compiled => 'bar'}
+  end
+
   it 'should rhyme ruby with newby and scooby' do
     Rhymes.rhyme('ruby').should == ['NEWBY', 'SCOOBY']
     Rhymes.rhyme('Scooby').should == ['NEWBY', 'RUBY']
@@ -32,8 +38,8 @@ describe Rhymes do
     Rhymes.rhyme('USA').should == ['MONTERREY']
   end
 
-  it 'should rhyme nothing with unknown word' do
-    Rhymes.rhyme('dabadabadaba').should == []
+  it 'should raise with unknown word' do
+    expect {Rhymes.rhyme('dabadabadaba')}.to raise_error(Rhymes::UnknownWord)
   end
 
- end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhymes
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-17 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &79065380 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *79065380
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Lookup perfect and identical rhymes
 email:
 - rubify@softover.com
@@ -60,8 +65,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rhymes
-rubygems_version: 1.8.15
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Lookup perfect and identical rhymes
-test_files: []
+test_files:
+- spec/rhymes_spec.rb
+- spec/sample_raw.txt
+- spec/spec_helper.rb