numbers_in_words 0.2.0 → 0.5.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 71344514fae412865a50ec69a9b58335ac9249aadf29bd5145a8455f503473b0
+  data.tar.gz: 128abd6b5546902d819c11b9105d573a564e6e1679c84bbeb8910bb6f28c03f8
+SHA512:
+  metadata.gz: 2cb8730bc67b4be3a3aba9a63e4198c1a2e11e9664879d9f859fc4cf11b26743671abb97d180d411cd6a2dfaa6309afadf9f2d61a584c6ef2d5b05ecbbbfab16
+  data.tar.gz: 1c50db96276a5a9a9211bdb460c1f9e686fb35436a180d0aaf8de34961061cfd400421680a227558642b124d9be88eaa9f5a67ff3dfbbf65e4ba8ebfed5293d1

data/.codeclimate.yml

@@ -0,0 +1,14 @@
+---
+engines:
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- spec/**/*
+- .codeclimate.yml
+- .rubocop.yml

data/.gitignore

@@ -3,3 +3,5 @@
 *.html
 tmp
 pkg/
+Gemfile.lock
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,58 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/Documentation:
+  Enabled: false
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,15 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=9a548b48c1c0804d8fb9083ae8e9693a5d5197eb86e8cf1b63a89d18f33e0464
+sudo: false
+language: ruby
+rvm:
+ - "2.6.6"
+ - "2.7.1"
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script: ./bin/spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+gem 'byebug'
+gem 'simplecov', '< 0.18.0', require: false, group: :test
 # Specify your gem's dependencies in numbers_in_words.gemspec
 gemspec

data/Gemfile.lock

@@ -1,39 +1,63 @@
 PATH
   remote: .
   specs:
-    numbers_in_words (0.2.0)
-      activesupport
+    numbers_in_words (0.5.1)
 
 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)
+    ast (2.4.1)
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    json (2.3.1)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    regexp_parser (1.7.1)
+    rexml (3.2.4)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.88.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.1.0, < 1.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.1.0)
+      parser (>= 2.7.0.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  debugger
+  byebug
   numbers_in_words!
-  rspec
+  rspec (~> 3.4.0)
+  rubocop
+  simplecov (< 0.18.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -1,42 +1,37 @@
+[![Build Status](http://img.shields.io/travis/markburns/numbers_in_words.svg)](https://travis-ci.org/markburns/numbers_in_words)
+[![Maintainability](https://api.codeclimate.com/v1/badges/a51210488896b798af20/maintainability)](https://codeclimate.com/github/markburns/numbers_in_words/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/a51210488896b798af20/test_coverage)](https://codeclimate.com/github/markburns/numbers_in_words/test_coverage)
+[![Gem Version](http://img.shields.io/gem/v/numbers_in_words.svg)](https://rubygems.org/gems/numbers_in_words)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://markburns.mit-license.org)
+
 Installation
 ============
 
-```
+```ruby
 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:
+Usage
+=========
 
-You've got one of:
+```ruby
+require 'numbers_in_words'
 
-```
-NoMethodError: undefined method `in_words' for 123:Fixnum
-NoMethodError: undefined method `in_numbers' for "123":String
-```
+NumbersInWords.in_words(112)
+#=> one hundred and twelve
 
-Here's why
-==========
+NumbersInWords.in_numbers("one googol")
+#=>10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
 
-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:
+NumbersInWords.in_numbers("Seventy million, five-hundred and fifty six thousand point eight nine three")
+#=> 70556000.893
 
-```
-require 'numbers_in_words'
-require 'numbers_in_words/duck_punch'
+NumbersInWords.in_numbers("nineteen sixty five")
+#=> 1965
 ```
 
-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
-=========
+Monkey patch version
 
 ```ruby
 require 'numbers_in_words'
@@ -50,48 +45,3 @@ require 'numbers_in_words/duck_punch'
 "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 +1,3 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/bin/spec

@@ -0,0 +1,2 @@
+bundle exec rspec spec/non_monkey_patch_spec.rb
+bundle exec rspec spec

data/lib/numbers_in_words.rb

@@ -1,24 +1,58 @@
-require 'active_support/core_ext/array'
+# frozen_string_literal: true
 
-require "numbers_in_words/version"
-require 'numbers_in_words/language_writer'
-
-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/version'
+require 'numbers_in_words/exceptional_numbers'
+require 'numbers_in_words/parsing/number_parser'
 require 'numbers_in_words/to_word'
+require 'numbers_in_words/parsing/to_number'
 
 module NumbersInWords
-  LENGTH_OF_GOOGOL = 101 #length of the string i.e. one with 100 zeros
+  LENGTH_OF_GOOGOL      = 101 # length of the string i.e. one with 100 zeros
+  Error                 = ::Class.new(::StandardError)
+  AmbiguousParsingError = ::Class.new(Error)
+  DivideByZeroError     = ::Class.new(Error)
+  InvalidNumber         = ::Class.new(Error)
 
   class << self
-    attr_writer :language
-    def language
-      @language ||= "English"
+    extend Forwardable
+    def_delegators :exceptional_numbers, :fraction
+
+    def in_words(num, fraction: false)
+      ToWord.new(num).in_words(fraction: fraction)
+    end
+
+    def in_numbers(words, only_compress: false)
+      ToNumber.new(words, only_compress).call
+    end
+
+    def exceptional_numbers
+      @exceptional_numbers ||= ExceptionalNumbers.new
+    end
+
+    def lookup(number)
+      exceptional_numbers.lookup(number)
+    end
+
+    def exceptional_number(text)
+      exceptional_numbers_to_i[text]
+    end
+
+    def power_of_ten(text)
+      powers_of_ten_to_i[text]
+    end
+
+    private
+
+    def exceptional_numbers_to_i
+      @exceptional_numbers_to_i ||= swap_keys exceptional_numbers.to_h
+    end
+
+    def powers_of_ten_to_i
+      @powers_of_ten_to_i ||= swap_keys POWERS_OF_TEN
+    end
+
+    def swap_keys(hash)
+      hash.each_with_object({}) { |(k, v), h| h[v] = k }
     end
   end
 end
-

data/lib/numbers_in_words/duck_punch.rb

@@ -1,19 +1,23 @@
+# frozen_string_literal: true
+
 module NumbersInWords
-  def in_words language=NumbersInWords.language
-    NumbersInWords::ToWord.new(self, language).in_words
+  module NumericExtension
+    def in_words(fraction: false)
+      NumbersInWords::ToWord.new(self).in_words(fraction: fraction)
+    end
   end
-end
 
-module WordsInNumbers
-  def in_numbers language=NumbersInWords.language
-    NumbersInWords::ToNumber.new(self, language).in_numbers
+  module StringExtension
+    def in_numbers(only_compress: false)
+      NumbersInWords::ToNumber.new(self, only_compress).call
+    end
   end
 end
 
 class String
-  include WordsInNumbers
+  include NumbersInWords::StringExtension
 end
 
 class Numeric
-  include NumbersInWords
+  include NumbersInWords::NumericExtension
 end

data/lib/numbers_in_words/exceptional_numbers.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+
+require_relative 'fraction'
+require_relative 'powers_of_ten'
+
+module NumbersInWords
+  class ExceptionalNumbers
+    extend Forwardable
+
+    DEFINITIONS = {
+      0 => { number: 'zero', ordinal: 'zeroth' },
+      1 => { number: 'one', ordinal: 'first' },
+      2 => { number: 'two', ordinal: 'second', fraction: { singular: 'half', plural: 'halves' } },
+      3 => { number: 'three', ordinal: 'third' },
+      4 => { number: 'four', ordinal: 'fourth', fraction: { singular: 'quarter', plural: 'quarters' } },
+      5 => { number: 'five', ordinal: 'fifth' },
+      6 => { number: 'six' },
+      7 => { number: 'seven' },
+      8 => { number: 'eight', ordinal: 'eighth' },
+      9 => { number: 'nine', ordinal: 'ninth' },
+      10 => { number: 'ten' },
+      11 => { number: 'eleven' },
+      12 => { number: 'twelve', ordinal: 'twelfth' },
+      13 => { number: 'thirteen' },
+      14 => { number: 'fourteen' },
+      15 => { number: 'fifteen' },
+      16 => { number: 'sixteen' },
+      17 => { number: 'seventeen' },
+      18 => { number: 'eighteen' },
+      19 => { number: 'nineteen' },
+      20 => { number: 'twenty', ordinal: 'twentieth' },
+      30 => { number: 'thirty', ordinal: 'thirtieth' },
+      40 => { number: 'forty', ordinal: 'fortieth' },
+      50 => { number: 'fifty', ordinal: 'fiftieth' },
+      60 => { number: 'sixty', ordinal: 'sixtieth' },
+      70 => { number: 'seventy', ordinal: 'seventieth' },
+      80 => { number: 'eighty', ordinal: 'eightieth' },
+      90 => { number: 'ninety', ordinal: 'ninetieth' }
+    }.freeze
+
+    def fraction_names
+      @fraction_names ||= determine_fraction_names
+    end
+
+    def lookup_fraction(words)
+      fraction_lookup[words]
+    end
+
+    def fraction_lookup
+      @fraction_lookup ||= generate_fraction_lookup
+    end
+
+    def lookup(number)
+      to_h[number]
+    end
+
+    def fraction(denominator: nil, numerator: nil, word: nil)
+      raise unless denominator || word
+
+      numerator ||= 1
+
+      denominator ||= NumbersInWords.in_numbers(word)
+
+      Fraction.new(denominator: denominator, numerator: numerator, attributes: DEFINITIONS[denominator])
+    end
+
+    def to_h
+      @to_h ||= DEFINITIONS.transform_values do |h|
+        h[:number]
+      end
+    end
+
+    private
+
+    def generate_fraction_lookup
+      named_fractions.each_with_object({}) do |f, result|
+        f.lookup_keys.each do |k|
+          key = k.split(' ').last
+          result[key] = 1.0 / f.denominator.to_f
+        end
+      end
+    end
+
+    def named_fractions
+      @named_fractions ||= numbers.flat_map do |n|
+        [
+          Fraction.new(denominator: n, numerator: 1),
+          Fraction.new(denominator: n, numerator: 2)
+        ]
+      end
+    end
+
+    def numbers
+      (2..100).to_a + powers_of_ten_skipping_googolplex.map { |p| 10**p }
+    end
+
+    def powers_of_ten_skipping_googolplex
+      POWERS_OF_TEN.keys[0..-2]
+    end
+
+    def determine_fraction_names
+      names = named_fractions.map(&:in_words)
+
+      words = names.map(&:split).map(&:last)
+      words += strip_punctuation(words)
+      words.uniq
+    end
+
+    def strip_punctuation(words)
+      words.map { |w| w.gsub(/^a-z/, ' ') }
+    end
+  end
+end