numbers_in_words 0.1.1 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a69b94b2d308dbf461d439c03e57ab585f6bd14760fbe01fbfb72ab7c87bf49
+  data.tar.gz: e8eaf38c1c28fa6b6d6c055ad2e73a0a446f418f984314682c5cc22eda6a64a3
+SHA512:
+  metadata.gz: a62e3d4ee01401dc3fd9ed1a694722fc4033954ea4c3e4ffc0f321f2c11777b91b465407873a80477986ef4c91d6bbc1aaa64dd6b0d9ab35ff45435d687b09a4
+  data.tar.gz: f068adee24754761e40e8b969fd432f478ec6c0d921e686594a33c29d06c4384644b2cb9a18a82c385e225e090c0a3db2fb379154d5885ced72523efb9f1776c

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

@@ -0,0 +1,7 @@
+*.swp
+*.swo
+*.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

@@ -0,0 +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/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,47 @@
+[![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'
+```
+
+Usage
+=========
+
+```ruby
+require 'numbers_in_words'
+
+NumbersInWords.in_words(112)
+#=> one hundred and twelve
+
+NumbersInWords.in_numbers("one googol")
+#=>10000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
+
+NumbersInWords.in_numbers("Seventy million, five-hundred and fifty six thousand point eight nine three")
+#=> 70556000.893
+
+NumbersInWords.in_numbers("nineteen sixty five")
+#=> 1965
+```
+
+
+Monkey patch version
+
+```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
+```

data/Rakefile

@@ -1,44 +1,3 @@
-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
+# 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,7 +1,58 @@
-require 'rubygems'
+# frozen_string_literal: true
 
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__)))
+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'
 
-require 'numbers'
-require 'words'
+module NumbersInWords
+  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
+    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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module NumbersInWords
+  module NumericExtension
+    def in_words(fraction: false)
+      NumbersInWords::ToWord.new(self).in_words(fraction: fraction)
+    end
+  end
+
+  module StringExtension
+    def in_numbers(only_compress: false)
+      NumbersInWords::ToNumber.new(self, only_compress).call
+    end
+  end
+end
+
+class String
+  include NumbersInWords::StringExtension
+end
+
+class Numeric
+  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