number_name_string 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18389d8f60a893aae5cbc7bafcb6203bff2144d1
-  data.tar.gz: e3352b3fd2905adfb213e5153892997de7de0ae0
+  metadata.gz: 1656d761433863430d537e773c037f89a5880f7a
+  data.tar.gz: e211242393e3d38f1424052a310d46b3935f1ddc
 SHA512:
-  metadata.gz: b76e1acd8070fe2756ae0287403ff4c66ad9d4e6346a7f4af8b37f7a7171f026a8b0a19671835449bda7c2994d440e1647de7d25f20f0ecd7d50661ecc6570a9
-  data.tar.gz: ba86416c7e94971515aefd578db46c611b19070ec6397da20dca1ce5ebfe8e1424a4142359d6a9de362886863194ac1319d5eefba744427b415052acd4251122
+  metadata.gz: 12569bbb09d87e77a104c3bbd0201f0213821ca353182291adf5d8a63402741ab43762aefe94411d74600647a02c8eb92519f76d57339bf9e4f9c757a6b0ac7e
+  data.tar.gz: e0c72e14ad5ed07aad95e51664b8a0f8ef8cd1a23b33bdae4d5d83584ed3504febcb80c1f5ddfdcc5812f60decf0cbf17ef1a61ae28616473bc179499bb4bb76

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.*.sw?

data/README.md

@@ -1,6 +1,6 @@
 # NumberNameString
 
-Converts to and from numbers and names (ie: 16.to_name == 'sixteen', 'forty.to_i == 40).
+Converts between numbers and their cardinal (ex: two) and ordinal (ex: second) names.
 
 Pure Ruby with no dependencies outside of the standard library.
 
@@ -41,7 +41,8 @@ Or, as a mixin directly on Fixnum and String classes:
 
 ```ruby
 include NumberNameString
-716.to_name                # "seven hundred sixteen"
+716.to_cardinal            # "seven hundred sixteen"
+716.to_ordinal             # "seven hundred sixteenth"
 "four thousand two".to_i   # 4002
 91346.to_comma             # "91,346"
 'five thousand'.to_comma   # "5,000"
@@ -55,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/number_name_string. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/robzr/number_name_string. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 

data/bin/test.rb

@@ -4,33 +4,50 @@ require_relative '../lib/number_name_string'
 
 include NumberNameString
 
-# Test Fixnum extension to_comma
-puts "1000.to_comma: #{1000.to_comma}"
-puts "\'1000\'.to_comma: #{'1000'.to_comma}"
-
-# Test String.to_i
-puts "'one hundered'.to_i: #{'one hundred'.to_i}"
-
-# Call as a module method
-puts "Module method ([]): #{NumberNameString[100]}"
-puts "Module method (<<): #{NumberNameString << 100}"
-
-# Instantiate and call
 nnsc = NumberNameString::Convert.new
-puts "Class method ([]): #{nnsc[100]}"
-puts "Class method (<<): #{nnsc << 100}"
 
-# Print table of test numbers
-TEST_NUMBERS = [(0..22).to_a +
-                (98..102).to_a +
-                (999998..1000001).to_a +
-                [87006200514255917]].flatten.freeze
+# Test various syntaxes
+{ '1000.to_comma' => "1,000",
+  '"1000".to_comma' => "1,000",
+  '"one hundred".to_i' => 100,
+  'NumberNameString[100]' => 'one hundred',
+  'NumberNameString["one hundred"]' => 100,
+  'nnsc[100]' => 'one hundred',
+  'nnsc["one hundred"]' => 100,
+  'nnsc["fourteen hundred"]' => 1400,
+  'nnsc["fourteen hundred ninetysix"]' => 1496,
+}.each do |statement, result|
+  eval_result = eval statement
+  unless eval_result == result
+    puts "ERROR(0): '#{statement}' == '#{eval_result}' instead of '#{result}'"
+  end
+end
+
+# Generate numbers, convert to string and back to number, compare results
+[(0..22).to_a +
+ (98..102).to_a +
+ (999998..1000001).to_a +
+ [87006200514255917]].flatten.each do |num|
+  unless num.to_comma == NumberNameString[num].to_comma
+    print "ERROR(1): "
+    printf("%s -> \"%s\" -> %s -> %s\n",
+           num.to_comma,
+           NumberNameString[num],
+           NumberNameString[num].to_i,
+           NumberNameString[num].to_comma)
+  end
+end
 
-TEST_NUMBERS.each do |num|
-  rendered = NumberNameString[num]
-  unrendered = NumberNameString[rendered]
-  printf("%-10s -> %-10s -> \"%s\"\n",
-         num.to_comma,
-         NumberNameString[unrendered],
-         rendered)
+# Compare series of strings to numbers
+{ 'zero' => 0, 
+  'six' => 6,
+  'fiftytwo' => 52,
+  'six hundred' => 600,
+  'seven hundred fortytwo' => 742,
+  'six hundred thousand' => 600000,
+  'six hundred fourteen thousand two hundred sixtytwo' => 614262
+}.each do |name, num|
+  unless num.to_name == name
+    puts "ERROR(2): \"#{name}\".to_i -> #{num} -> #{num.to_name}"
+  end
 end

data/lib/number_name_string.rb

@@ -1,13 +1,19 @@
-require_relative "number_name_string/convert"
-require_relative "number_name_string/version"
+require_relative 'number_name_string/convert'
+require_relative 'number_name_string/constants'
+require_relative 'number_name_string/lookup'
+require_relative 'number_name_string/triplet'
+require_relative 'number_name_string/version'
 
 module NumberNameString
+
   class NumberNameStringError < ArgumentError ; end
 
-  # Would be ideal if we could only add this functionality only if included
+  class NumberNameParseError < ArgumentError ; end
+
+  # Extends Fixnum class with to_comma and to_name
   class ::Fixnum
     def to_comma
-      self.to_s.to_comma
+      self.to_s.add_commas
     end
 
     def to_name
@@ -15,22 +21,28 @@ module NumberNameString
     end
   end
 
-  # Would be ideal if we could only add this functionality only if included
+  # Extends String class with to_comma and updated to_i
   class ::String
     alias_method :old_to_i, :to_i
 
     def to_comma
+      self.to_i.to_comma
+    end
+
+    def add_commas
       self.reverse.gsub(/(\d{3})(?=\d)/, '\\1,').reverse
     end
 
     def to_i
-      # TODO: verify output may be a string and this is necessary
-      result = NumberNameString[self]
-      result.is_a?(String) ? result.old_to_i : result
+      if self =~ /^\d+$/
+        old_to_i
+      else
+        NumberNameString[self]
+      end
     end
   end
 
   def self.[](num)
-    (instance ||= NumberNameString::Convert.new)[num]
+    (@instance ||= NumberNameString::Convert.new)[num]
   end
 end

data/lib/number_name_string/constants.rb

@@ -0,0 +1,39 @@
+module NumberNameString
+  # Cardinal Numbers & Scales
+  ONES = [:zero, :one, :two, :three, :four, :five, :six, :seven, :eight, 
+          :nine].freeze
+  TEENS = [:ten, :eleven, :twelve, :thirteen, :fourteen, :fifteen, :sixteen,
+           :seventeen, :eighteen, :nineteen].freeze
+  TENS = [:twenty, :thirty, :forty, :fifty, :sixty, :seventy, :eighty,
+          :ninety].freeze
+  SCALES = [nil, :thousand, :million, :billion, :trillion, :quadrillion,
+           :quintillion, :sextillion, :septillion, :octillion, :nonillion,
+           :decillion, :undecillion, :duodecillion, :tredecillion,
+           :quattuordecillion, :quindecillion, :sexdecillion, :septendecillion,
+           :octodecillion, :novemdecillion, :vigintillion]
+
+  # Ordinal Numbers & Scales
+  ORD_ONES = [:zeroth, :first, :second, :third, :fourth, :fifth, :sixth,
+              :seventh, :eighth, :ninth].freeze
+  ORD_TEENS = ([:tenth, :eleventh, :twelfth] + 
+                TEENS[3..9].map { |teen| "#{teen}th".to_sym }).freeze
+  ORD_TENS = TENS.map { |ten| ten.to_s.sub(/y$/, 'ieth').to_sym }.freeze
+  ORD_SCALES = SCALES.map { |scale| "#{scale}th".to_sym if scale }
+
+  SCALE_MAX = (SCALES.length - 1) * 3
+
+  # Common mispellings
+  MISPELLINGS = {
+    :fourty => 40,      :fourtieth => 40,
+    :fourtyone => 41,   :fourtifirst => 41,
+    :fourtytwo => 42,   :fourtisecond => 42,
+    :fourtythree => 43, :fourtithird => 43,
+    :fourtyfour => 44,  :fourtifourth => 44,
+    :fourtyfive => 45,  :fourtififth => 45,
+    :fourtysix => 46,   :fourtisixth => 46,
+    :fourtyseven => 47, :fourtiseventh => 47,
+    :fourtyeight => 48, :fourtieighth => 48,
+    :fourtynine => 49,  :fourtininth => 49,
+    :hundered => 100,   :hunderedth => 100
+  }
+end

data/lib/number_name_string/convert.rb

@@ -1,26 +1,20 @@
 module NumberNameString
+  # Handles conversion logic, takes full number (string or numeric), parses
+  # and accumulates results from lookup tables
   class Convert
-    #
-    # TODO: convert to arrays for multiple spellings
-    #  - [forty, fourty]
-    #  - [hundred, hundered]
-    #
-    ONES = %W{ #{} one two three four five six seven eight nine }
-    ONES_ZERO = %W{ zero one two three four five six seven eight nine }
-    TEENS = %w{ ten eleven twelve thirteen fourteen fifteen sixteen
-                seventeen eighteen nineteen } 
-    TENS = %W{ #{} #{} twenty thirty forty fifty sixty seventy eighty ninety }
-    SCALE = %W{ #{} thousand million billion trillion quadrillion quintillion
-      sextillion septillion octillion nonillion decillion undecillion duodecillion
-      tredecillion quattuordecillion quindecillion sexdecillion septendecillion
-      octodecillion novemdecillion vigintillion }
-    SCALE_MAX = (SCALE.length - 1) * 3
+    def initialize(num = nil)
+      @lookup = Lookup.instance
+      @num = num
+      @num_struct = Struct.new(:word, :type, :number) 
+    end
 
-    def [](arg)
+    def [](arg = @num)
       if arg.is_a? Fixnum
-        to_s arg
+        num_to_string arg
       elsif arg.is_a? String 
-        to_i arg
+        string_to_num arg
+      elsif arg.is_a? Symbol 
+        string_to_num arg.to_s
       else
         raise NumberNameStringError.new("Invalid arg type: #{arg.class.name}")
       end
@@ -28,112 +22,88 @@ module NumberNameString
 
     alias << []
 
-    def to_i(arg)
-      num = 0
-      words = arg.downcase.gsub('-', '').split(/\s+/)
-      while word = words.shift
-        accum = 0
-        # (sub_hundred | ones(false) hundred [sub_hundred] )[scale]]
-        if sub_hundred?(word)
-          if ones?(word, false) && hundred?(words[0])
-            accum += ones?(word) * 100
-            words.shift
-            word = words.shift
-          else
-            accum += sub_hundred?(word)
-          end
-          word = words.shift
-          if scale? word      
-            accum *= scale? word
-          end
+    # Converts a string to a number
+    #
+    # @param arg [String] number to convert
+    # @returns [Integer] number
+    def string_to_num(arg = @num)
+      total = 0
+      triplet = Triplet.new
+      words = num_string_to_array arg
+      marker = words.length
+      while marker > 0 
+        marker -= 1
+        word = words[marker]
+        if word.type == :number
+          triplet << word.number
+        end
+        if word.type == :scale || marker == 0
+          triplet.scale = word.number if word.type == :scale
+          total += triplet.to_i
+          triplet.reset
         end
-#        puts "accum: #{accum}"
-        num += accum
       end
-      num
+      total
     end
 
-    def to_s(num, include_zero = true)
-      case digits = num.to_s.length
-      when 1
-        include_zero ? ONES_ZERO[num] : ONES[num]
-      when 2
-        num < 20 ? TEENS[num - 10] : "#{TENS[num / 10]}#{ONES[num % 10]}"
-      when 3
-        "#{ONES[num / 100]} hundred#{space_pad(to_s(num % 100, false))}"
-      when (4..SCALE_MAX)
-        zeros = 10 ** (((digits - 1) / 3) * 3)
-        "%s%s%s" % [to_s(num / zeros, false),
-                    space_pad(SCALE[(digits - 1) / 3]),
-                    space_pad(to_s(num % zeros, false))]
-      else
-        raise NumberNameStringError.new('Number out of range')
-      end
+    # Converts a number to a string
+    #
+    # @param num [Integer] number to convert
+    # @param type [Symbol] convert to type :cardinal or :ordinal
+    # @returns [String] name of number
+    def num_to_string(num = @num, type = :cardinal)
+      name = ''
+      num_to_triplets(num).each_with_index.reverse_each do |triplet, index| 
+        name += " #{name_triplet triplet} #{SCALES[index]}" if triplet > 0
+      end 
+      name == '' ? 'zero' : name.sub(/^\s*/, '').sub(/\s*$/, '')
     end
 
     private
 
-    # ONES = %W{ #{} one two three four five six seven eight nine }
-    # ONES_ZERO = %W{ zero one two three four five six seven eight nine }
-    # TEENS = %w{ ten eleven twelve thirteen fourteen fifteen sixteen
-    #   seventeen eighteen nineteen }
-    # TENS = %W{ #{} #{} twenty thirty fourty fifty sixty seventy eighty ninety }
-    # SCALE = %W{ #{} thousand million billion trillion quadrillion quintillion
-    
-    def hundred?(word)
-      word == 'hundred' && 100
-    end
-
-    def number?(word)
-      ones?(word) || teens?(word) || tens?(word) || hundred?(word)
+    # Cleans and splits string
+    #
+    # @param arg [String] string to split & convert
+    # @returns [Array] array of symbols
+    def clean_and_split(arg)
+      arg.downcase
+        .gsub('-', '')
+        .gsub(/\band\b/, '')
+        .split(/\s+/)
+        .map { |word| word.to_sym }
     end
 
-    def ones?(word, with_zero = true)
-      if with_zero
-        ONES_ZERO.find_index word
+    # Converts a triplet (1-3 digit number) to a string
+    #
+    # @param arg [Integer] number to convert
+    # @param type [Symbol] :cardinal or :ordinal
+    # @returns [String] name of number
+    def name_triplet(num, type = :cardinal)
+      if num >= 100
+        name = "#{@lookup.cardinal(num / 100)} hundred"
+        name += " #{@lookup.cardinal(num % 100)}" unless num % 100 == 0
+        name
       else
-        ONES.find_index word
+        @lookup.cardinal num
       end
     end
 
-    def scale?(word)
-      _ = SCALE.find_index word
-      10 ** (_ * 3) if _ 
-    end
-
-    def space_pad(arg)
-      if arg.is_a?(NilClass) || arg == ''
-        ''
-      elsif arg =~ /^\s/
-        arg
+    def num_to_triplets(num = @num)
+      str = num.to_s
+      if str.length % 3 == 0
+        str
       else
-        " #{arg}"
-      end
-    end
-
-    def sub_hundred?(word)
-      ones?(word) || teens?(word) || tens?(word)
+        str.rjust((3 - str.length % 3) + str.length, '0')
+      end.scan(/\d{3}/)
+        .map(&:to_i)
+        .reverse
     end
 
-    def teens?(word)
-      _ = TEENS.find_index word
-      _ + 10 if _
-    end
-
-    def tens?(word)
-      if TENS.find_index(word)
-        TENS.find_index(word) * 10
-      elsif tens_prefix?(word)
-        prefix = tens_prefix?(word)
-        suffix = word.slice(prefix.length, 100)
-        if ones?(suffix, false)
-          TENS.find_index(prefix) * 10 + ones?(suffix, false)
-        end
+    def num_string_to_array(arg)
+      clean_and_split(arg).reverse.map do |word| 
+        number, type = @lookup.number word
+        @num_struct.new(word, type, number)
       end
     end
-
-    def tens_prefix?(word)
-      TENS.select { |prefix| prefix != "" && word =~ /^#{prefix}/ }.first
-    end
   end
 end

data/lib/number_name_string/lookup.rb

@@ -0,0 +1,90 @@
+module NumberNameString
+  # Singleton class which generates translation tables on demand
+  # Converts a single name into a number or a 0-100 into a name
+  class Lookup
+    require 'pp'
+    require 'singleton'
+    include Singleton
+
+    # Lookup cardinal number name (ex: two)
+    #
+    # @param[Fixnum] number to convert (between 0-100)
+    # @return[String] 
+    def cardinal(number)
+      lookup_cardinal[number]
+    end
+
+    # Lookup single word, return number or scale
+    # @return[Fixnum, Symbol] 
+    def number(name)
+      if _ = lookup_name[name]
+        [_, :number]
+      elsif _ = lookup_scale[name]
+        [_, :scale]
+      else
+        raise NumberNameParseError.new("Parse error on: #{name}")
+      end
+    end
+
+    # Lookup ordinal number name (ex: second)
+    #
+    # @param[Fixnum] number to convert (between 0-100)
+    # @return[String] 
+    def ordinal(number)
+      lookup_ordinal[number]
+    end
+
+    private
+
+    def generate_cardinal_table
+      ONES + TEENS + TENS.map do |prefix|
+        [prefix] + ONES[1..9].map { |suffix| "#{prefix}#{suffix}".to_sym }
+      end.flatten
+    end
+
+    def generate_name_table
+      table = {}
+      (ONES + TEENS).each.with_index { |name, number| table[name] = number }
+      TENS.each.with_index do |prefix, number|
+        number = (number + 2) * 10
+        table[prefix] = number 
+        ONES[1..9].each do |suffix|
+          number += 1
+          table["#{prefix}#{suffix}".to_sym] = number
+        end
+      end
+      table.merge({ :hundred => 100}).merge MISPELLINGS
+    end
+
+    def generate_ordinal_table
+      ORD_ONES + ORD_TEENS + TENS.map do |prefix|
+        [prefix] + ORD_ONES[1..9].map { |suffix| "#{prefix}#{suffix}".to_sym }
+      end.flatten
+    end
+
+    def generate_scale_table
+      table = {}
+      SCALES.each.with_index do |scale, index|
+        size = 10 ** (index * 3)
+        table[scale] = size if scale
+      end
+      table
+    end
+
+    def lookup_cardinal
+      @lookup_cardinal ||= generate_cardinal_table
+    end
+
+    def lookup_name
+      @lookup_name ||= generate_name_table
+    end
+
+    def lookup_ordinal
+      @lookup_ordinal ||= generate_ordinal_table
+    end
+
+    def lookup_scale
+      @lookup_scale ||= generate_scale_table
+    end
+  end
+end

data/lib/number_name_string/triplet.rb

@@ -0,0 +1,27 @@
+module NumberNameString
+  # Accumulates and totals a 3 digit number (with an optional scale)
+  # Used internally only.
+  class Triplet
+    attr_accessor :hundreds, :tens, :scale
+
+    def initialize(num = 0)
+      reset num
+    end
+
+    def <<(num)
+      @hundreds = @tens if @tens > 0
+      @tens = num % 100
+    end
+
+    def to_i
+      (@hundreds * 100 + @tens) * @scale 
+    end
+
+    def reset(num = 0)
+      @hundreds = 0
+      @tens = num
+      @scale = 1
+    end
+  end
+end
+

data/lib/number_name_string/version.rb

@@ -1,3 +1,3 @@
 module NumberNameString
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: number_name_string
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Rob Zwissler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 'Converts to and from numbers and names (ie: 16.to_name == ''sixteen'',
@@ -60,9 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -72,7 +72,10 @@ files:
 - bin/setup
 - bin/test.rb
 - lib/number_name_string.rb
+- lib/number_name_string/constants.rb
 - lib/number_name_string/convert.rb
+- lib/number_name_string/lookup.rb
+- lib/number_name_string/triplet.rb
 - lib/number_name_string/version.rb
 - number_name_string.gemspec
 homepage: https://github.com/robzr/number_name_string
@@ -85,17 +88,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: 'Converts to and from numbers and names (ie: 16.to_name == ''sixteen'')'