numbers_in_words 0.0.7 → 0.0.9

data/Manifest

@@ -1,11 +1,14 @@
 Manifest
+README
 Rakefile
 examples/display_numbers_in_words.rb
 index_cyclo.html
+init.rb
+lib/numbers.rb
 lib/numbers_in_words.rb
 lib/numbers_in_words.rb_cyclo.html
-lib/words_in_numbers.rb
+lib/words.rb
 lib/words_in_numbers.rb_cyclo.html
-numbers_in_words.rb
+numbers_in_words.gemspec
 spec/numbers_in_words_spec.rb
 spec/words_in_numbers_spec.rb

data/README

@@ -0,0 +1,70 @@
+Installation
+============
+
+
+gem install numbers_in_words
+
+or 
+
+sudo gem install numbers_in_words
+
+
+
+The file numbers_to_words defines a module NumbersToWords which is included in Fixnum and Bignum.
+The in_words method can then be used on any Fixnum or Bignum object.
+
+E.g.
+	>require 'numbers_in_words'
+	>112.in_words
+	#=> one hundred and twelve
+
+To try it out the program display_numbers_to_words.rb expects two integer parameters to define a
+range. It then prints out all numbers in words included in this range.
+
+e.g.
+
+	>ruby display_numbers_to_words.rb 1 11
+	one
+	two
+	three
+	four
+	five
+	six
+	seven 
+	eight
+	nine
+	ten
+	eleven
+
+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:
+
+	> 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
+
+I also created a method group_words takes a block and a size parameter 
+This method which could be used by different languages.
+(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:
+	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
+

data/Rakefile

@@ -1,8 +1,9 @@
 require 'rubygems'
 require 'rake'
 require 'echoe'
-Echoe.new('numbers_in_words','0.0.7') do |e|
-  e.description = ""
+Echoe.new('numbers_in_words','0.0.9') 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\".in_numbers #=> 75"
   e.url = "http://rubygems.org/gems/numbers_in_words"
   e.author = "Mark Burns"
   e.email = "markthedeveloper@googlemail.com"

data/lib/numbers.rb

@@ -0,0 +1,208 @@
+require 'rubygems'
+require 'active_support'
+module NumbersInWords
+
+  #handle exceptions to normal numbers
+  EXCEPTIONS = {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"}
+
+  DIGITS= %w[zero one two three four five six seven eight nine]
+  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"
+  }
+  LENGTH_OF_GOOGOL = 101 #length of the string i.e. one with 100 zeros
+
+  def initialize
+    power = 9
+    POWERS_OF_TEN_NAMES.each do |name|
+      POWERS_OF_TEN[power]=name
+      power += 3
+    end
+  end
+
+  #returns a hash with powers of ten and their multipliers
+  def powers_of_ten 
+    i = self.to_i
+    digits=i.to_s.split ""
+    #turn back into integers
+    digits.map! { |x| x.to_i} 
+
+    digits.reverse!
+    #create a hash where the key is the
+    #power of ten and the value is the multipler
+    power = 0
+    return digits.inject({}) do |result,digit|
+      result[power]=digit unless digit==0
+      power+=1
+      result
+    end
+  end
+
+  def groups_of size
+    i=self.to_i
+    #split into groups this gives us 1234567 => 123 456 7
+    #so we need to reverse first
+    #in stages
+    #i.e. 1234567 => 7654321     
+    groups = i.to_s.reverse
+    #7654321 => 765 432 1
+    groups = groups.split("").in_groups_of(size)
+    #765 432 1 => 1 432 765
+    groups.reverse!
+    #1 432 765 => 1 234 567
+    groups.map! {|group| group.reverse}
+
+    #turn back into integers
+    groups.map! {|group|  group.join("").to_i }
+    groups.reverse! # put in ascending order of power of ten
+
+    #output hash where key is the power of ten
+    #and value if the multiplier
+    power = 0
+    return groups.inject({}) do |output, digits|
+      output[power]=digits
+      power+=size
+      output
+    end
+
+  end
+
+  def group_words size, language="English"
+    #1000 and over Numbers are split into groups of three
+    number = self.to_i
+    groups = number.groups_of(size)
+    powers = groups.keys.sort.reverse #put in descending order
+    powers.each do |power|
+      name = POWERS_OF_TEN[power] if language=="English"
+      digits = groups[power]
+      yield power, name, digits
+    end
+
+  end
+
+  def english_group group_size
+    number = self.to_i
+    output = ""
+    number.group_words(group_size) 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_english
+        output << prefix + name unless power == 0
+      end
+    end
+    return output
+  end
+
+  def split_googols
+    number = self.to_i
+    output = ""
+    googols = number.to_s[0..(-LENGTH_OF_GOOGOL)].to_i
+    remainder = number.to_s[1-LENGTH_OF_GOOGOL .. -1].to_i
+    output << " " + googols.in_words + " googol" 
+    if remainder > 0
+      prefix = " "
+      prefix << "and " if remainder < 100
+      output << prefix + remainder.in_english
+    end
+    return output
+  end
+
+  def in_googols
+
+    number = self.to_i
+    output = ""
+    output << " " + number.to_s[0..0].to_i.in_english + " googol"
+    remainder = number.to_s[1..-1].to_i
+    prefix = " "
+    prefix << "and " if remainder < 100
+    output << prefix + remainder.in_english if remainder > 0
+
+    return output
+  end
+
+  def in_english
+    number = self.to_i # make a copy
+    #handle negative numbers
+    if number < 0
+      return "minus " + (-number).in_english
+    end
+    #handle 0-10
+    return DIGITS[number] if number < 10
+    return EXCEPTIONS[number] if EXCEPTIONS[number]
+
+    output = ""
+    length = number.to_s.length
+    if length == 2 #20-99
+      tens = (number/10).round*10 #write the tens
+      # e.g. eighty
+      output << EXCEPTIONS[tens]
+      #write the digits
+      digit= number - tens
+      output << " " + digit.in_english unless digit==0
+    elsif length == 3
+      #e.g. 113 splits into "one hundred" and "thirteen"
+      output << number.english_group(2)
+    elsif length < LENGTH_OF_GOOGOL #more than one hundred less than one googol
+      output << number.english_group(3)
+    elsif length == LENGTH_OF_GOOGOL 
+      output << number.in_googols
+    elsif length > LENGTH_OF_GOOGOL #one googol and larger
+      output << number.split_googols
+    end
+
+    return output.strip
+  end
+
+  def in_words language="English"
+    case language
+    when "English" #allow for I18n
+      in_english
+    end
+  end
+end
+
+class Fixnum
+  include NumbersInWords
+end
+
+class Bignum
+  include NumbersInWords
+end

data/lib/numbers_in_words.rb

@@ -1,208 +1,8 @@
 require 'rubygems'
-require 'active_support'
-module NumbersInWords
 
-  #handle exceptions to normal numbers
-  EXCEPTIONS = {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"}
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__)))
 
-  DIGITS= %w[zero one two three four five six seven eight nine]
-  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"
-  }
-  LENGTH_OF_GOOGOL = 101 #length of the string i.e. one with 100 zeros
+require 'numbers'
+require 'words'
 
-  def initialize
-    power = 9
-    POWERS_OF_TEN_NAMES.each do |name|
-      POWERS_OF_TEN[power]=name
-      power += 3
-    end
-  end
 
-  #returns a hash with powers of ten and their multipliers
-  def powers_of_ten 
-    i = self.to_i
-    digits=i.to_s.split ""
-    #turn back into integers
-    digits.map! { |x| x.to_i} 
-
-    digits.reverse!
-    #create a hash where the key is the
-    #power of ten and the value is the multipler
-    power = 0
-    return digits.inject({}) do |result,digit|
-      result[power]=digit unless digit==0
-      power+=1
-      result
-    end
-  end
-
-  def groups_of size
-    i=self.to_i
-    #split into groups this gives us 1234567 => 123 456 7
-    #so we need to reverse first
-    #in stages
-    #i.e. 1234567 => 7654321     
-    groups = i.to_s.reverse
-    #7654321 => 765 432 1
-    groups = groups.split("").in_groups_of(size)
-    #765 432 1 => 1 432 765
-    groups.reverse!
-    #1 432 765 => 1 234 567
-    groups.map! {|group| group.reverse}
-
-    #turn back into integers
-    groups.map! {|group|  group.join("").to_i }
-    groups.reverse! # put in ascending order of power of ten
-
-    #output hash where key is the power of ten
-    #and value if the multiplier
-    power = 0
-    return groups.inject({}) do |output, digits|
-      output[power]=digits
-      power+=size
-      output
-    end
-
-  end
-
-  def group_words size, language="English"
-    #1000 and over Numbers are split into groups of three
-    number = self.to_i
-    groups = number.groups_of(size)
-    powers = groups.keys.sort.reverse #put in descending order
-    powers.each do |power|
-      name = POWERS_OF_TEN[power] if language=="English"
-      digits = groups[power]
-      yield power, name, digits
-    end
-
-  end
-
-  def english_group group_size
-    number = self.to_i
-    output = ""
-    number.group_words(group_size) 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_english
-        output << prefix + name unless power == 0
-      end
-    end
-    return output
-  end
-
-  def split_googols
-    number = self.to_i
-    output = ""
-    googols = number.to_s[0..(-LENGTH_OF_GOOGOL)].to_i
-    remainder = number.to_s[1-LENGTH_OF_GOOGOL .. -1].to_i
-    output << " " + googols.in_words + " googol" 
-    if remainder > 0
-      prefix = " "
-      prefix << "and " if remainder < 100
-      output << prefix + remainder.in_english
-    end
-    return output
-  end
-
-  def in_googols
-
-    number = self.to_i
-    output = ""
-    output << " " + number.to_s[0..0].to_i.in_english + " googol"
-    remainder = number.to_s[1..-1].to_i
-    prefix = " "
-    prefix << "and " if remainder < 100
-    output << prefix + remainder.in_english if remainder > 0
-
-    return output
-  end
-
-  def in_english
-    number = self.to_i # make a copy
-    #handle negative numbers
-    if number < 0
-      return "minus " + (-number).in_english
-    end
-    #handle 0-10
-    return DIGITS[number] if number < 10
-    return EXCEPTIONS[number] if EXCEPTIONS[number]
-
-    output = ""
-    length = number.to_s.length
-    if length == 2 #20-99
-      tens = (number/10).round*10 #write the tens
-      # e.g. eighty
-      output << EXCEPTIONS[tens]
-      #write the digits
-      digit= number - tens
-      output << " " + digit.in_english unless digit==0
-    elsif length == 3
-      #e.g. 113 splits into "one hundred" and "thirteen"
-      output << number.english_group(2)
-    elsif length < LENGTH_OF_GOOGOL #more than one hundred less than one googol
-      output << number.english_group(3)
-    elsif length == LENGTH_OF_GOOGOL 
-      output << number.in_googols
-    elsif length > LENGTH_OF_GOOGOL #one googol and larger
-      output << number.split_googols
-    end
-
-    return output.strip
-  end
-
-  def in_words language="English"
-    case language
-    when "English" #allow for I18n
-      in_english
-    end
-  end
-end
-
-class Fixnum
-  include NumbersInWords
-end
-
-class Bignum
-  include NumbersInWords
-end

data/numbers_in_words.gemspec

@@ -2,21 +2,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{numbers_in_words}
-  s.version = "0.0.7"
+  s.version = "0.0.9"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mark Burns"]
   s.date = %q{2010-04-06}
-  s.description = %q{}
+  s.description = %q{#in_words method for integers and #in_numbers for strings}
   s.email = %q{markthedeveloper@googlemail.com}
-  s.extra_rdoc_files = ["lib/numbers_in_words.rb", "lib/numbers_in_words.rb_cyclo.html", "lib/words_in_numbers.rb", "lib/words_in_numbers.rb_cyclo.html"]
-  s.files = ["Manifest", "Rakefile", "examples/display_numbers_in_words.rb", "index_cyclo.html", "lib/numbers_in_words.rb", "lib/numbers_in_words.rb_cyclo.html", "lib/words_in_numbers.rb", "lib/words_in_numbers.rb_cyclo.html", "numbers_in_words.rb", "spec/numbers_in_words_spec.rb", "spec/words_in_numbers_spec.rb", "numbers_in_words.gemspec"]
+  s.extra_rdoc_files = ["README", "lib/numbers.rb", "lib/numbers_in_words.rb", "lib/numbers_in_words.rb_cyclo.html", "lib/words.rb", "lib/words_in_numbers.rb_cyclo.html"]
+  s.files = ["Manifest", "README", "Rakefile", "examples/display_numbers_in_words.rb", "index_cyclo.html", "init.rb", "lib/numbers.rb", "lib/numbers_in_words.rb", "lib/numbers_in_words.rb_cyclo.html", "lib/words.rb", "lib/words_in_numbers.rb_cyclo.html", "numbers_in_words.gemspec", "spec/numbers_in_words_spec.rb", "spec/words_in_numbers_spec.rb"]
   s.homepage = %q{http://rubygems.org/gems/numbers_in_words}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Numbers_in_words"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Numbers_in_words", "--main", "README"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{numbers_in_words}
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{}
+  s.summary = %q{Example: 123.in_words #=> "one hundred and twenty three", "seventy-five".in_numbers #=> 75}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 9
+  version: 0.0.9
 platform: ruby
 authors: 
 - Mark Burns
@@ -29,30 +29,34 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-description: ""
+description: "#in_words method for integers and #in_numbers for strings"
 email: markthedeveloper@googlemail.com
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
+- README
+- lib/numbers.rb
 - lib/numbers_in_words.rb
 - lib/numbers_in_words.rb_cyclo.html
-- lib/words_in_numbers.rb
+- lib/words.rb
 - lib/words_in_numbers.rb_cyclo.html
 files: 
 - Manifest
+- README
 - Rakefile
 - examples/display_numbers_in_words.rb
 - index_cyclo.html
+- init.rb
+- lib/numbers.rb
 - lib/numbers_in_words.rb
 - lib/numbers_in_words.rb_cyclo.html
-- lib/words_in_numbers.rb
+- lib/words.rb
 - lib/words_in_numbers.rb_cyclo.html
-- numbers_in_words.rb
+- numbers_in_words.gemspec
 - spec/numbers_in_words_spec.rb
 - spec/words_in_numbers_spec.rb
-- numbers_in_words.gemspec
 has_rdoc: true
 homepage: http://rubygems.org/gems/numbers_in_words
 licenses: []
@@ -63,6 +67,8 @@ rdoc_options:
 - --inline-source
 - --title
 - Numbers_in_words
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -86,6 +92,6 @@ rubyforge_project: numbers_in_words
 rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
-summary: ""
+summary: "Example: 123.in_words #=> \"one hundred and twenty three\", \"seventy-five\".in_numbers #=> 75"
 test_files: []