numbers_in_words 0.1.1 → 0.2.0

data/.gitignore

@@ -0,0 +1,5 @@
+*.swp
+*.swo
+*.html
+tmp
+pkg/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in numbers_in_words.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    numbers_in_words (0.2.0)
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.10)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    columnize (0.3.6)
+    debugger (1.2.3)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.5)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.6)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debugger
+  numbers_in_words!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Mark Burns
+
+MIT License
+
+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/README.md

@@ -0,0 +1,97 @@
+Installation
+============
+
+```
+gem 'numbers_in_words'
+
+require 'numbers_in_words'
+require 'numbers_in_words/duck_punch' #see why later
+```
+
+This project was created for a test for a job interview. I haven't really used
+it myself, but I saw it mentioned somewhere so I thought I'd tidy it up a bit.
+
+I'm going to hopefully preempt some support queries by predicting this will happen:
+
+You've got one of:
+
+```
+NoMethodError: undefined method `in_words' for 123:Fixnum
+NoMethodError: undefined method `in_numbers' for "123":String
+```
+
+Here's why
+==========
+
+Previous versions of this gem duckpunched Fixnum and String with a whole bunch
+of methods. This gem will now only add methods if you specifically tell it to
+with:
+
+```
+require 'numbers_in_words'
+require 'numbers_in_words/duck_punch'
+```
+
+Plus it now only adds a single `#in_words` method to `Numeric` and an `#in_numbers`
+method to `String` instead of a whole bunch of them.
+
+Usage
+=========
+
+```ruby
+require 'numbers_in_words'
+require 'numbers_in_words/duck_punch'
+112.in_words
+#=> one hundred and twelve
+
+"one googol".in_numbers
+#=>10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+
+"Seventy million, five-hundred and fifty six thousand point eight nine three".in_numbers
+#=> 70556000.893
+```
+
+---------------
+
+Whilst creating this project I realized that in English:
+
+* Numbers are grouped in groups of threes
+* Numbers less than 1,000 are grouped by hundreds and then by tens
+* There are specific rules for when we put an "and" in between numbers
+
+It makes sense to manage the numbers by these groups, so
+I created a method groups_of which will split any integer into
+groups of a certain size. It returns a hash with the power of ten
+as the key and the multiplier as the value. E.g:
+
+```ruby
+31245.groups_of(3)
+#=> {0=>245,3=>31} #i.e. 31 thousands, and 245 ones
+
+245.group_of(2)
+#=> {0=>45,2=>2}    #i.e. 2 hundreds, and 45 ones
+```
+
+(In Japanese numbers are grouped in groups of 4, so it makes sense to try and
+separate the language related stuff from the number grouping related stuff)
+
+Example of usage:
+
+```ruby
+245.group_words(2,"English") do |power, name, digits|
+  puts "#{digits}*10^#{power} #{digits} #{name}s"
+end
+
+
+2  * 10^2 =  2 hundreds
+45 * 10^0 = 45 ones
+
+ ```
+
+Future plans
+============
+
+* Handle complex numbers
+* Option for outputting punctuation
+* Reject invalid numbers
+* Support for other languages

data/Rakefile

@@ -1,44 +1 @@
-require 'rubygems'
-require 'rake'
-require 'echoe'
-require 'metric_fu'
-
-Echoe.new('numbers_in_words','0.1.1') do |e|
-  e.description = "#in_words method for integers and #in_numbers for strings"
-  e.summary = "Example: 123.in_words #=> \"one hundred and twenty three\", \"seventy-five point eight\".in_numbers #=> 75.8"
-  e.url = "http://rubygems.org/gems/numbers_in_words"
-  e.author = "Mark Burns"
-  e.email = "markthedeveloper@gmail.com"
-  e.ignore_pattern = ["tmp/*",".git/*"]
-  e.dependencies = ['active_support']
-end
-
-
-MetricFu::Configuration.run do |config|
-  #define which metrics you want to use
-  config.metrics  = [:churn, :saikuro, :stats, :flog, :flay, :reek, :roodi, :rcov]
-  config.graphs   = [:flog, :flay, :reek, :roodi, :rcov]
-  config.flay     = { :dirs_to_flay => ['lib'],    :minimum_score => 100  }
-  config.flog     = { :dirs_to_flog => [ 'lib']  }
-  config.reek     = { :dirs_to_reek => ['lib']  }
-  config.roodi    = { :dirs_to_roodi => ['lib'] }
-  config.saikuro  = { :output_directory => 'scratch_directory/saikuro',
-                      :input_directory => ['lib'],
-                      :cyclo => "",
-                      :filter_cyclo => "0",
-                      :warn_cyclo => "5",
-                      :error_cyclo => "7",
-                      :formater => "text"} #this needs to be set to "text"
-  config.churn    = { :start_date => "1 year ago", :minimum_churn_count => 10}
-  config.rcov     = { :environment => 'test',
-                      :test_files => ['spec/**/*_spec.rb'],
-                      :rcov_opts => ["--sort coverage",
-                                     "--no-html",
-                                     "--text-coverage",
-                                     "--no-color",
-                                     "--profile",
-                                     "--rails",
-                                     "--exclude /gems/,/Library/,spec"]}
-  config.graph_engine = :bluff
-end
-
+require "bundler/gem_tasks"

data/lib/numbers_in_words.rb

@@ -1,7 +1,24 @@
-require 'rubygems'
+require 'active_support/core_ext/array'
 
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__)))
+require "numbers_in_words/version"
+require 'numbers_in_words/language_writer'
 
-require 'numbers'
-require 'words'
+require 'numbers_in_words/english/constants'
+require 'numbers_in_words/english/language_writer_english'
+
+require 'numbers_in_words/number_group'
+require 'numbers_in_words/number_parser'
+require 'numbers_in_words/to_number'
+require 'numbers_in_words/to_word'
+
+module NumbersInWords
+  LENGTH_OF_GOOGOL = 101 #length of the string i.e. one with 100 zeros
+
+  class << self
+    attr_writer :language
+    def language
+      @language ||= "English"
+    end
+  end
+end
 

data/lib/numbers_in_words/duck_punch.rb

@@ -0,0 +1,19 @@
+module NumbersInWords
+  def in_words language=NumbersInWords.language
+    NumbersInWords::ToWord.new(self, language).in_words
+  end
+end
+
+module WordsInNumbers
+  def in_numbers language=NumbersInWords.language
+    NumbersInWords::ToNumber.new(self, language).in_numbers
+  end
+end
+
+class String
+  include WordsInNumbers
+end
+
+class Numeric
+  include NumbersInWords
+end

data/lib/numbers_in_words/english/constants.rb

@@ -0,0 +1,93 @@
+module NumbersInWords
+  module English
+    def self.exceptions
+      {
+        0 => "zero",
+        1 => "one",
+        2 => "two",
+        3 => "three",
+        4 => "four",
+        5 => "five",
+        6 => "six",
+        7 => "seven",
+        8 => "eight",
+        9 => "nine",
+
+        10 => "ten",
+        11 => "eleven",
+        12 => "twelve",
+
+        13 => "thirteen",
+        14 => "fourteen",
+        15 => "fifteen",
+        16 => "sixteen" ,
+        17 => "seventeen",
+        18 => "eighteen",
+        19 => "nineteen",
+
+        20 => "twenty",
+        30 => "thirty",
+        40 => "forty",
+        50 => "fifty",
+        60 => "sixty",
+        70 => "seventy",
+        80 => "eighty",
+        90 => "ninety"
+      }
+    end
+
+    def self.swap_keys hsh
+      hsh.inject({}){|h,(k,v)| h[v]=k; h}
+    end
+
+    def self.powers_of_ten
+      {
+        0   => "one",
+        1   => "ten",
+        2   => "hundred",
+        3   => "thousand",
+        6   => "million",
+        9   => "billion",
+        12  => "trillion",
+        15  => "quadrillion",
+        18  => "quintillion",
+        21  => "sextillion",
+        24  => "septillion",
+        27  => "octillion",
+        30  => "nonillion",
+        33  => "decillion",
+        36  => "undecillion",
+        39  => "duodecillion",
+        42  => "tredecillion",
+        45  => "quattuordecillion",
+        48  => "quindecillion",
+        51  => "sexdecillion",
+        54  => "septendecillion",
+        57  => "octodecillion",
+        60  => "novemdecillion",
+        63  => "vigintillion",
+        66  => "unvigintillion",
+        69  => "duovigintillion",
+        72  => "trevigintillion",
+        75  => "quattuorvigintillion",
+        78  => "quinvigintillion",
+        81  => "sexvigintillion",
+        84  => "septenvigintillion",
+        87  => "octovigintillion",
+        90  => "novemvigintillion",
+        93  => "trigintillion",
+        96  => "untrigintillion",
+        99  => "duotrigintillion",
+        100 => "googol"
+      }
+    end
+
+    def self.exceptions_to_i
+      swap_keys exceptions
+    end
+
+    def self.powers_of_ten_to_i
+      swap_keys powers_of_ten
+    end
+  end
+end

data/lib/numbers_in_words/english/language_writer_english.rb

@@ -0,0 +1,107 @@
+module NumbersInWords
+  module English
+    class LanguageWriterEnglish < LanguageWriter
+      delegate :to_i, to: :that
+
+      def initialize that
+        super that
+        @language = "English"
+      end
+
+      def negative
+        "minus " + (-@that).in_words
+      end
+
+      def in_words
+        v = handle_exception
+        return v if v
+
+        in_decimals = decimals
+        return in_decimals if in_decimals
+
+        number = to_i
+
+        return negative() if number < 0
+
+        length = number.to_s.length
+        output = ""
+
+        if length == 2 #20-99
+          tens = (number/10).round*10 #write the tens
+
+          output << exceptions[tens] # e.g. eighty
+
+          digit = number - tens       #write the digits
+
+          output << " " + digit.in_words unless digit==0
+        else
+          output << write() #longer numbers
+        end
+
+        output.strip
+
+      end
+
+      def handle_exception
+        exceptions[@that] if @that.is_a?(Integer) and exceptions[@that]
+      end
+
+
+      def write
+        length = @that.to_s.length
+        output =
+          if length == 3
+            #e.g. 113 splits into "one hundred" and "thirteen"
+            write_groups(2)
+
+            #more than one hundred less than one googol
+          elsif length < LENGTH_OF_GOOGOL
+            write_groups(3)
+
+          elsif length >= LENGTH_OF_GOOGOL
+            write_googols
+          end
+        output.strip
+      end
+
+      def decimals
+        int, decimals = NumberGroup.new(@that).split_decimals
+        if int
+          out = int.in_words + " point "
+          decimals.each do |decimal|
+            out << decimal.to_i.in_words + " "
+          end
+          out.strip
+        end
+      end
+
+      private
+      def write_googols
+        googols, remainder = NumberGroup.new(@that).split_googols
+        output = ""
+        output << " " + googols.in_words + " googol"
+        if remainder > 0
+          prefix = " "
+          prefix << "and " if remainder < 100
+          output << prefix + remainder.in_words
+        end
+        output
+      end
+
+      def write_groups group
+        #e.g. 113 splits into "one hundred" and "thirteen"
+        output = ""
+        group_words(group) do |power, name, digits|
+          if digits > 0
+            prefix = " "
+            #no and between thousands and hundreds
+            prefix << "and " if power == 0  and digits < 100
+            output << prefix + digits.in_words
+            output << prefix + name unless power == 0
+          end
+        end
+        output
+      end
+    end
+  end
+end