rhymes 0.0.2 → 0.0.3

data/Gemfile

@@ -4,3 +4,6 @@ source :rubygems
 gemspec
 
 gem 'rake'
+group :test do
+  gem 'rspec'
+end

data/README.rdoc

@@ -15,12 +15,18 @@ Before first usage download and store the dictionary. Example below assumes
 dictionary stored by default at /tmp/cmudict.0.7a. Precompiled version will be stored
 as /tmp/rhymes.dat
   
-  require 'rhymes'
-  Rhymes.rhyme('word')
+  ruby > require 'rhymes'
+  => true
+  ruby > Rhymes.rhyme('ruby')
+  => ["BOOBY", "DUBHI", "DUBY", "HRUBY", "KUBY", "LOOBY", "LUBY", "NEWBY", "RUBEY", "RUBI", "RUBIE", "SCOOBY", "TRUBEY", "TRUBY"]
 
 == Configuration
 
-  require 'rhymes'
-  Rhymes.setup(options = {:raw_dict => '/tmp/cmudict.0.7a', :compiled => '/tmp/rhymes.dat'})
+  ruby > require 'rhymes'
+  => true
+  ruby > Rhymes.setup
+  => {:raw_dict=>"/tmp/cmudict.0.7a", :compiled=>"/tmp/rhymes.dat"}
+  ruby > Rhymes.setup(:compiled=>'/new/location/file')
+  => {:raw_dict=>"/tmp/cmudict.0.7a", :compiled=>"/new/location/file"}
 
     

data/Rakefile

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/rhymes.rb

@@ -1,34 +1,32 @@
 require 'rhymes/version'
-# https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict/
-# wget https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict/cmudict.0.7a
 
 module Rhymes
   DEFAULTS = {:raw_dict => '/tmp/cmudict.0.7a', :compiled => '/tmp/rhymes.dat'}
   
   class << self
     ##
-    # Sets the raw dictionary location.
-    # default - /tmp/cmudict.0.7a
+    # Sets the raw dictionary location. Default: /tmp/cmudict.0.7a
     attr_writer :raw_dict
+    
     ##
-    # Sets the location to store/retrieve precompiled dictionary
-    # default - /tmp/rhymes.dat 
+    # Sets the location to store/retrieve precompiled dictionary. Default: /tmp/rhymes.dat 
     attr_writer :compiled
     
     ##
-    # Sets up options
+    # 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 = DEFAULTS)
-      @raw_dict = options[:raw_dict] || DEFAULTS[:raw_dict]
-      @compiled = options[:compiled] || DEFAULTS[:compiled]
+      @raw_dict = options[:raw_dict] || @raw_dict || DEFAULTS[:raw_dict]
+      @compiled = options[:compiled] || @compiled || DEFAULTS[:compiled]
+      {:raw_dict => @raw_dict, :compiled => @compiled}
     end
     
     ##
-    # Return the list of perfect and identical rhymes to provided word
+    # Return the list of perfect and identical rhymes to provided word.
     def rhyme(word)
       wup = word.upcase
-      rhymes[words[wup]] - [wup]
+      (rhymes[words[wup]] || []) - [wup]
     end
 
   private
@@ -42,14 +40,15 @@ module Rhymes
       init unless @rhymes
       @rhymes
     end
-
+    
+    
     def perfect_key(pron)
       first = pron.rindex{|snd| snd =~ /1$/} || 0
       pron[first..-1]
     end
 
     def init
-      setup unless @compiled
+      setup unless @compiled && @raw_dict
       if File.exists?(@compiled)
         @words, @rhymes = Marshal.load(File.open(@compiled, 'rb'){|f| f.read })
       elsif File.exists?(@raw_dict)
@@ -71,7 +70,9 @@ module Rhymes
           # ????
         end
       else
-        raise "File #{@data_dir + RAW} does not exist!"
+        raise "File #{@data_dir + RAW} 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
     end
   end

data/lib/rhymes/version.rb

@@ -1,3 +1,3 @@
 module Rhymes
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/rhymes.gemspec

@@ -16,4 +16,5 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
+  s.add_development_dependency 'rspec'
 end

data/spec/rhymes_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Rhymes do
+  before(:all) do
+    @sample = File.join(File.dirname(__FILE__), 'sample_raw.txt')
+    Rhymes.setup(:raw_dict => @sample)
+  end
+  
+  it 'should save provided option' do
+    Rhymes.setup(:compiled => '/tmp/sample').should == 
+      {:raw_dict => @sample, :compiled => '/tmp/sample'}
+  end
+  
+  it 'should rhyme ruby with newby and scooby' do
+    Rhymes.rhyme('ruby').should == ['NEWBY', 'SCOOBY']
+    Rhymes.rhyme('Scooby').should == ['NEWBY', 'RUBY']
+    Rhymes.rhyme('newby').should == ['RUBY', 'SCOOBY']
+  end
+
+  it 'should rhyme rube and cube' do
+    Rhymes.rhyme('RubE').should == ['CUBE']
+    Rhymes.rhyme('cUbE').should == ['RUBE']
+  end
+
+  it 'should rhyme lighter and scriptwriter' do
+    Rhymes.rhyme('LIGHTER').should == ['SCRIPTWRITER']
+    Rhymes.rhyme('SCRIPTWRITER').should == ['LIGHTER']
+  end
+  
+  it 'should rhyme monterrey and usa' do
+    Rhymes.rhyme('MONTERREY').should == ['USA']
+    Rhymes.rhyme('USA').should == ['MONTERREY']
+  end
+
+  it 'should rhyme nothing with unknown word' do
+    Rhymes.rhyme('dabadabadaba').should == []
+  end
+
+ end

data/spec/sample_raw.txt

@@ -0,0 +1,18 @@
+;;;
+;;;  NOTES  ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+;;; 
+!EXCLAMATION-POINT  EH2 K S K L AH0 M EY1 SH AH0 N P OY2 N T
+"CLOSE-QUOTE  K L OW1 Z K W OW1 T
+
+CUBE  K Y UW1 B
+LIGHTER  L AY1 T ER0
+MONTERREY  M AA2 N T ER0 EY1
+MONTERREY(1)  M AA2 N ER0 EY1
+MONTERREY(2)  M AA2 N T ER0 R EY1
+MONTERREY(3)  M AA2 N ER0 R EY1
+NEWBY  N UW1 B IY0
+RUBE  R UW1 B
+RUBY  R UW1 B IY0
+SCOOBY  S K UW1 B IY0
+SCRIPTWRITER  S K R IH1 P T R AY2 T ER0
+USA  Y UW1 EH1 S EY1

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+require 'rhymes'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter     = 'documentation'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhymes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,19 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-17 00:00:00.000000000Z
-dependencies: []
+date: 2011-10-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &82209270 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82209270
 description: Lookup perfect and identical rhymes
 email:
 - rubify@softover.com
@@ -26,6 +37,9 @@ files:
 - lib/rhymes.rb
 - lib/rhymes/version.rb
 - rhymes.gemspec
+- spec/rhymes_spec.rb
+- spec/sample_raw.txt
+- spec/spec_helper.rb
 homepage: https://github.com/kalenkov/rhymes
 licenses: []
 post_install_message: