rhymes 0.1.0 → 1.0.0

data/README.rdoc

@@ -1,34 +1,23 @@
+{<img src="https://codeclimate.com/github/kalenkov/rhymes.png" />}[https://codeclimate.com/github/kalenkov/rhymes]
 = Rhymes
-Rhymes looks up perfect and identical rhymes using the Carnegie Mellon 
-Pronouncing Dictionary, or any other pronounciation dictionary with 
-compatible format.
-
-Dictionary can be downloaded from https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict/
-(latest version - https://cmusphinx.svn.sourceforge.net/svnroot/cmusphinx/trunk/cmudict/cmudict.0.7a)
+Rhymes looks up perfect and identical rhymes using precompiled version of the Carnegie Mellon 
+Pronouncing Dictionary.
 
 == Installation
 
   gem install rhymes
 
 == Usage
-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
   
   ruby > require 'rhymes'
   => true
   ruby > Rhymes.rhyme('ruby')
   => ["BOOBY", "DUBHI", "DUBY", "HRUBY", "KUBY", "LOOBY", "LUBY", "NEWBY", "RUBEY", "RUBI", "RUBIE", "SCOOBY", "TRUBEY", "TRUBY"]
 
-== Configuration
+Class method will load dictionary on each call. Use instance method to front-load the expense
 
   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"}
-  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
+  ruby > rhymes = Rhymes.new; rhymes.rhyme('ruby')
+  => ["BOOBY", "DUBHI", "DUBY", "HRUBY", "KUBY", "LOOBY", "LUBY", "NEWBY", "RUBEY", "RUBI", "RUBIE", "SCOOBY", "TRUBEY", "TRUBY"]
+

data/data/cmudict_LICENSE

@@ -0,0 +1,33 @@
+Copyright (C) 1993-2008 Carnegie Mellon University. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+   The contents of this file are deemed to be source code.
+
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in
+   the documentation and/or other materials provided with the
+   distribution.
+
+This work was supported in part by funding from the Defense Advanced
+Research Projects Agency, the Office of Naval Research and the National
+Science Foundation of the United States of America, and by member
+companies of the Carnegie Mellon Sphinx Speech Consortium. We acknowledge
+the contributions of many volunteers to the expansion and improvement of
+this dictionary.
+
+THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND
+ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
+NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/rhymes.rb

@@ -1,88 +1,31 @@
 require 'rhymes/version'
 
-module Rhymes
-  # generic error
-  class RhymesError < RuntimeError; end
+class Rhymes
   # 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.
-    #   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 (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
-      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
-      @words 
-    end
-
-    def rhymes
-      init unless @rhymes
-      @rhymes
-    end
-    
-    
-    def perfect_key(pron)
-      first = pron.rindex{|snd| snd =~ /1$/} || 0
-      pron[first..-1]
-    end
-
-    def init
-      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
-      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
+  class UnknownWord < RuntimeError; end
+
+  ##
+  # Class method (slow, reads data on each call)
+  # Returns the list of perfect and identical rhymes to provided word (in upper case)
+  # raises
+  #   Rhymes::UnknownWord       - word does not exist in the dictionary
+  def self.rhyme(word)
+    Rhymes.new.rhyme(word)
+  end
+  
+  def initialize
+    @words, @rhymes = Marshal.load(File.open(File.expand_path('../data/rhymes.dat', File.dirname(__FILE__)), 'rb'){|f| f.read })
+  end
 
+  ##
+  # Instance method. Use to front-load the expense of reading data file
+  # Returns the list of perfect and identical rhymes to provided word (in upper case)
+  # raises
+  #   Rhymes::UnknownWord       - word does not exist in the dictionary
+  def rhyme(word)
+    wup = word.upcase
+    key = @words[wup]
+    raise UnknownWord unless key
+    @rhymes[key] - [wup]
   end
 end

data/lib/rhymes/version.rb

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

data/rhymes.gemspec

@@ -11,8 +11,6 @@ Gem::Specification.new do |s|
   s.summary     = %q{Lookup perfect and identical rhymes}
   s.description = %q{Lookup perfect and identical rhymes}
 
-  s.rubyforge_project = "rhymes"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]

data/spec/rhymes_spec.rb

@@ -1,41 +1,17 @@
 require 'spec_helper'
 
 describe Rhymes do
-  before do
-    @sample = File.join(File.dirname(__FILE__), 'sample_raw.txt')
-    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'}
-  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']
-    Rhymes.rhyme('newby').should == ['RUBY', 'SCOOBY']
-  end
-
-  it 'should rhyme rube and cube' do
-    Rhymes.rhyme('RubE').should == ['CUBE']
-    Rhymes.rhyme('cUbE').should == ['RUBE']
+    Rhymes.rhyme('ruby').should include('NEWBY', 'SCOOBY')
+    rhymes = Rhymes.new
+    rhymes.rhyme('Scooby').should include('NEWBY', 'RUBY')
+    rhymes.rhyme('newby').should include('RUBY', 'SCOOBY')
   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']
+  it 'should rhyme case-insensitive' do
+    rhymes = Rhymes.new
+    rhymes.rhyme('RubE').should include('CUBE')
+    rhymes.rhyme('cUbE').should include('RUBE')
   end
 
   it 'should raise with unknown word' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rhymes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -39,6 +39,8 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- data/cmudict_LICENSE
+- data/rhymes.dat
 - lib/rhymes.rb
 - lib/rhymes/version.rb
 - rhymes.gemspec
@@ -64,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: rhymes
+rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3