softprops-nuwords 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 softprops
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/Manifest

@@ -0,0 +1,8 @@
+lib/nuwords.rb
+LICENSE
+Rakefile
+README.rdoc
+test/nuwords_test.rb
+test/test_helper.rb
+VERSION
+Manifest

data/README.rdoc

@@ -0,0 +1,9 @@
+= nuwords
+
+Numeric words 
+  
+    42.in_words #=> "fourty-two"
+
+== Copyright
+
+Copyright (c) 2009 softprops. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,66 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "nuwords"
+    gem.summary = %Q{numeric words}
+    gem.email = "d.tangren@gmail.com"
+    gem.homepage = "http://github.com/softprops/nuwords"
+    gem.authors = ["softprops"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "nuwords #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'echoe'
+Echoe.new('nuwords','0.1.0') do |g|
+  g.description     = 'convert numbers to words'
+  g.url             = 'http://github.com/softprops/nuwords'
+  g.author          = 'softprops'
+  g.email           = 'd.tangren@gmail.com'
+  g.ignore_pattern  = ['tmp/*','script/*']
+  g.development_dependencies =[]
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/nuwords.rb

@@ -0,0 +1,146 @@
+#
+# A Simple library for converting numeric values into words. Supports values
+# up to #MAX (999,999,999,999,999). I could support more but it's not really that useful at
+# that point. I draw the line at 
+# 'nine hundred ninety-nine trillion nine hundred ninety-nine billion nine hundred ninety-nine million 
+#  nine hundred ninety-nine thousand nine hundred ninety-nine'!
+# simple usage:
+#   0.in_words # => 'zero'
+#   1234013.in_words    # => 'one million two hundred thirty-four thousand thirteen'
+#
+# custom language usage:
+#   3.in_words :in => 'Mandarin'  # => 'san'
+#
+# custom translator usage:
+#   142.in_words :translator => CustomTranslator  # => result of CustomTranslator.translate(142)
+#
+# @author softprops
+#
+module Nuwords
+  # the maxiumum supported number
+  MAX = 999_999_999_999_999
+  
+  # Translates a numeric value to words
+  # This method takes an optional hash of options which include
+  # :translator => The class responsible for translation behavior
+  # :in         => The language Dictionary that the number should be translated into
+  #                If the Dictionary for the language cannot be found an UnsupportedLanguageException will be raised
+  def in_words(opts = {})
+    translator = opts.delete(:translator) || Translator.new
+    raise InvalidTranslatorException unless translator.respond_to?(:translate)
+    translator.translate(self, opts)
+  end
+  
+  alias_method :to_w, :in_words
+  
+  protected
+  
+  class InvalidTranslatorException < Exception; end
+  class NumberNotSupportedException < Exception; end
+  
+  # Responsible for translating a given number into
+  # words. To extend override #parse with your impl
+  class Translator
+    
+    # The interface for performing actual translation
+    def translate(number, opts = {})
+      @dictionary = dictionary_for(opts[:in] || 'En')
+      @dashed = opts[:dashed].nil? ? true : opts[:dashed] 
+      parse(number, false)
+    end
+    
+    protected 
+    
+    # Handles the core logic of interpreting
+    # the given number in words
+    # The language is dependent on the Dictionary provided with the 
+    #:in option which defaults to En (English)
+    def parse(number, ignore_zero = true)
+      word = ''
+      case number
+      when 0
+        word << @dictionary.zero! if !ignore_zero
+      when 1..9
+        word << @dictionary.ones![number - 1]
+      when 11..19
+        word << @dictionary.teens![(number - 10) - 1]
+      when 10 || 20..99
+        word << @dictionary.tens![(number / 10) - 1] if(number/10 > 0) 
+        word << (@dashed ? '-' : '') << parse(number % 10)  if(number % 10 > 0)
+      when 100..999
+        word << parse(number/100) << " #{@dictionary.bigs![0]} "  if (number/100 > 0) 
+        word << parse(number%100)                                 if (number%100 > 0)
+      when 1_000..999_999
+        word << parse((number/1000)) << " #{@dictionary.bigs![1]} "   if (number/1_000>0)
+        word << parse(number%1000)                                    if (number%1_000>0)
+      when 1_000_000..999_999_999
+        word << parse(number/1_000_000) << " #{@dictionary.bigs![2]} "   if(number/1_000_000>0)
+        word << parse(number%1_000_000)                                  if(number%1_000_000>0)
+      when 1_000_000_000..999_999_999_999
+        word << parse(number/1_000_000_000) << " #{@dictionary.bigs![3]} " if(number/1_000_000_000>0)
+        word << parse(number%1_000_000_000)                                if(number%1_000_000_000>0)
+      when 1_000_000_000_000..999_999_999_999_999
+        word << parse(number/1_000_000_000_000) <<" #{@dictionary.bigs![4]} " if(number/1_000_000_000_000>0)
+        word << parse(number%1_000_000_000_000)                              if(number%1_000_000_000_000>0)
+      else
+        raise NumberNotSupportedException.new("Number #{number} not supported")
+      end
+      word.strip
+    end
+    
+    private
+    
+    # Fetchs the Library of words for the given
+    # language
+    def dictionary_for(lang)
+      Dictionaries.find(lang.to_s)
+    end
+  end
+    
+  # =Language Dictionaries
+  # to use your own, include Numords::Dictionaries::Dictionary
+  # in a class that defines class methods #zero, #ones, #teens, #tens, #bigs
+  # and invoke via 1.in_words(:in => CustomLanguage)
+  module Dictionaries
+    
+    class UnsupportedLanguageException < Exception; end
+    
+    class << self
+      # look up a dictionary for a given lan
+      def find(lang)
+        return Dictionaries.const_get(lang) if lang.kind_of?(String)
+        lang
+        rescue Exception => e; raise UnsupportedLanguageException.new("#{e} - unsupported language #{lang}")
+      end
+    end
+    
+    # Base behavior of Dictionary. Defines the definition
+    # of accessor methods for %w( zero ones teens tens bigs )
+    module Dictionary
+      def self.included(klass)
+        %w( zero ones teens tens bigs ).each do |classification|
+          klass.class_eval %Q{
+            def self.#{classification}(values)
+              @@#{classification}=values
+            end
+            
+            def self.#{classification}!
+              @@#{classification}
+            end
+          }
+        end
+      end
+    end # end Dictionary
+    
+    # English library (default)
+    class En 
+      include Dictionary
+      zero 'zero'
+      ones  %w( one two three four five six seven eight nine )
+      teens %w( eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen )
+      tens  %w( ten twenty thirty fourty fifty sixty seventy eighty ninety )
+      bigs  %w( hundred thousand million billion trillion )  
+    end # end En
+  end # end Dictionaries
+end
+Numeric.send :include, Nuwords # include in Numeric class for use

data/nuwords.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{nuwords}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["softprops"]
+  s.date = %q{2009-05-17}
+  s.description = %q{convert numbers to words}
+  s.email = %q{d.tangren@gmail.com}
+  s.extra_rdoc_files = ["lib/nuwords.rb", "LICENSE", "README.rdoc"]
+  s.files = ["lib/nuwords.rb", "LICENSE", "Rakefile", "README.rdoc", "test/nuwords_test.rb", "test/test_helper.rb", "VERSION", "Manifest", "nuwords.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/softprops/nuwords}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Nuwords", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{nuwords}
+  s.rubygems_version = %q{1.3.2}
+  s.summary = %q{convert numbers to words}
+  s.test_files = ["test/nuwords_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/nuwords_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+# English library (default)
+class AnotherLanguage 
+  include Nuwords::Dictionaries::Dictionary
+  zero  'zero'
+  ones  %w( blah meh nom si wu liu chi ba nine )
+  teens %w( eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen )
+  tens  %w( bacon twenty thirty fourty fifty sixty seventy eighty ninety )
+  bigs  %w( hundred thousand million billion trillion )  
+end
+
+class NuwordsTest < Test::Unit::TestCase
+  
+  context "the library" do
+    should "provide the maxiumum supported value" do
+      assert true, Nuwords.const_defined?(:MAX)
+    end
+    context "when given a bogus translator" do
+      should "raise a InvalidTranslatorException" do
+        assert_raise Nuwords::InvalidTranslatorException do
+          1.in_words(:translator => Hash)
+        end
+      end
+    end
+  end
+  
+  context "a numberic value" do
+    context "less than one" do
+      should "translate to zero" do
+        assert_equal "zero", 0.in_words
+      end
+    end
+    
+    context "that is greater than ten and less than on hundred" do
+      should "be delimited by a dash if not devisible evenly by ten" do
+        assert_equal "twenty-five", 25.in_words 
+      end
+      
+      context "when requested not to have dashes" do
+        should "not be delimited by a dash if not devisible evenly by ten" do
+          assert_equal "twentyfive", 25.in_words(:dashed => false)
+        end
+      end
+    end
+    
+    context "that is translated to a custom language" do
+      should "translate numeric values accordingly" do
+        assert_equal 'bacon', 10.in_words(:in => AnotherLanguage)
+      end
+    end
+    
+    context "that is translated to a bogus language" do
+      should "raise an UnsupportedLanguageException" do
+        assert_raise Nuwords::Dictionaries::UnsupportedLanguageException do
+          10.in_words(:in => "asdf")
+        end
+      end
+    end
+    
+    context "that is less or equal to 999,999,999,999,999" do
+      should "not raise a NumberNotSupportedException" do
+        assert_nothing_raised do
+          # 0.upto(999_999_999_999_999) works but takes a good while to run
+          (999_999_999_999_999 - 1).in_words
+          999_999_999_999_999.in_words
+        end
+      end
+    end
+    
+    context "that is greater than 999,999,999,999,999" do
+      should "raise a NumberNotSupportedException" do
+        assert_raise Nuwords::NumberNotSupportedException do
+          999_999_999_999_999.next.in_words
+        end
+      end
+    end
+    
+    should "respond to aliased method #to_w" do
+      assert true, 1.respond_to?(:to_w)
+    end
+    
+    should "return the same value when #to_w is called as with #in_words" do
+      assert_equal 1.to_w, 1.in_words
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'nuwords'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: softprops-nuwords
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- softprops
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-17 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: convert numbers to words
+email: d.tangren@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/nuwords.rb
+- LICENSE
+- README.rdoc
+files: 
+- lib/nuwords.rb
+- LICENSE
+- Rakefile
+- README.rdoc
+- test/nuwords_test.rb
+- test/test_helper.rb
+- VERSION
+- Manifest
+- nuwords.gemspec
+has_rdoc: true
+homepage: http://github.com/softprops/nuwords
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Nuwords
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: nuwords
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: convert numbers to words
+test_files: 
+- test/nuwords_test.rb
+- test/test_helper.rb