integer_to_english 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c689cf8ada32860cd7b4ec850835856d0272fe10
+  data.tar.gz: e4a79c1507318e2247b302d25ee34295bdcb6dbd
+SHA512:
+  metadata.gz: a54891c18fdd5c016e8f7f4bb6e19387b9e0f5c80172862bce550c41a20af2f13df117d57ebb051bd2527003d133d0d95f20f3a573c1754f41eaf05b4a71012a
+  data.tar.gz: 6b0ba8e1ae0323fd5fd2e4255a5c35d3070062a57157b25b90aa95d11e28b7bb8abe66849b0d41a1bd1c241c64a4d15e9bbfc720ed21e5f7692c0c4bf4cb327d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in integer_to_english.gemspec
+gemspec
+
+group :development do
+  gem 'minitest-reporters'
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Viktor Vad
+
+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,66 @@
+# IntegerToEnglish
+
+The ```Integer``` class is pimped up with the ```to_english``` method.
+
+Regarding the names of numbers above million, the "short scale" will be used as it is used increasingly in British English too.
+English grammar source used: http://en.wikipedia.org/wiki/English-language_numerals
+
+**Limitation**: The highest number it can convert is less then 1 quintillion (10^18)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'integer_to_english'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install integer_to_english
+
+## Usage
+
+```ruby
+7.to_english
+'seven'
+```
+
+```ruby
+42to_english
+'forty-two'
+```
+
+```ruby
+2001.to_english
+'two thousand and one'
+```
+
+```ruby
+1999.to_english
+'nineteen hundred and ninety-nine'
+```
+
+US vs UK (UK is default, if you think otherwise, "fork it!")
+
+```ruby
+999_000.to_english
+'nine hundred and ninety-nine thousand'
+```
+
+```ruby
+999_000.to_english :us
+'nine hundred ninety-nine thousand'
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/vadviktor/integer_to_english/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+end
+
+task :default => :test
+

data/integer_to_english.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+require 'pathname'
+require Pathname.new(__dir__) + 'lib/integer_to_english/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'integer_to_english'
+  spec.version       = IntegerToEnglish::VERSION
+  spec.authors       = ['Viktor Vad']
+  spec.email         = ['vad.viktor@gmail.com']
+  spec.summary       = %q{Integer.to_english}
+  spec.description   = %q{The Integer class is pimped up with the to_english method.}
+  spec.homepage      = 'https://github.com/vadviktor/integer_to_english'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest'
+end

data/lib/integer_to_english.rb

@@ -0,0 +1,145 @@
+require 'pathname'
+require Pathname.new(__dir__) + 'integer_to_english/version'
+
+module IntegerToEnglish
+
+  # @params [Symbol] format
+  def to_english(format = :gb)
+    Converter.new.to_text self, format
+  end
+
+  class Converter
+
+    def initialize
+      @singles   = ['', 'one', 'two', 'three', 'four', 'five', 'six', 'seven', 'eight', 'nine']
+      @tens      = ['', 'ten', 'twenty', 'thirty', 'forty', 'fifty', 'sixty', 'seventy', 'eighty', 'ninety']
+      @ten_frags = ['', 'eleven', 'twelve', 'thirteen', 'fourteen', 'fifteen', 'sixteen', 'seventeen', 'eighteen', 'nineteen']
+      @scale     = ['', 'thousand', 'million', 'billion', 'trillion', 'quadrillion'] # can be extended further
+    end
+
+    # Version can be :gb or :uk for British or :us for USA
+    # "and" word will be used accordingly
+    #
+    # @param number [String|Integer]
+    # @param version [Symbol]
+    # @return [String]
+    def to_text(number, version = :gb)
+      unless number.is_a?(String) || number.is_a?(Integer)
+        raise ArgumentError.new 'Only Integer or String (that converts to integer) can be parsed'
+      end
+
+      version = version.to_sym if version.is_a? String
+      unless [:uk, :gb, :us].include? version
+        raise ArgumentError.new 'Only :uk, :gb or :us versions can be generated'
+      end
+
+      number = number.to_s if number.is_a? Integer
+      number.strip!
+
+      # strip prefix
+      number[0] = '' if number[0] == '+' or number[0] == '-'
+
+      # 0
+      return 'zero' if number.length == 1 and number == '0'
+
+      # 1..999
+      return get_hundreds number, version if number.length < 4
+
+      # 999 <
+      i             = 0
+      portions      = []
+      portion_block = []
+      number.reverse!
+
+      number.each_char do |c|
+        portion_block.push c
+        i += 1
+
+        if i % 3 == 0
+          block_clone = portion_block.clone
+          portions.push block_clone
+          portion_block.clear
+          i = 0
+        end
+      end
+
+      portions.push portion_block unless portion_block.empty?
+      portions.reverse!
+
+      final_number = ''
+      i            = portions.length - 1
+      portions.each do |p|
+        p.reverse!
+        p_in_text    = get_hundreds(p.join.to_i.to_s, version)
+        final_number += p_in_text
+        final_number += ' ' + @scale[i] + ' ' if p_in_text != ''
+        i            -= 1
+      end
+      final_number.strip!
+    end
+
+    private
+
+    # @param number [String]
+    # @return [String]
+    def get_hundreds number, version
+      two = get_2_decimals number
+      return two unless two.nil?
+      get_3_decimals number, version
+    end
+
+    # @param number [String]
+    # @return [String|Nil]
+    def get_2_decimals number
+      # 0
+      return '' if number.length == 1 and number == '0'
+
+      # 1..9 / 01..09
+      if (number.length == 1 and number != '0') or
+          (number.length == 2 and number[0] == '0' and number[1] != '0')
+        return @singles[number.to_i]
+      end
+
+      # tens
+      if number.length == 2 and number[0] != '0' and number[1] == '0'
+        return @tens[number[0].to_i]
+      end
+
+      # 11..19
+      if number.length == 2 and number[0] == '1' and number[1].to_i > 0
+        return @ten_frags[number[1].to_i]
+      end
+
+      # 21..99
+      if number.length == 2 and number[0].to_i > 1 and number[1].to_i >= 1
+        return @tens[number[0].to_i] + '-' + @singles[number[1].to_i]
+      end
+
+      nil
+    end
+
+    # @param number [String|Array]
+    # @return [String|Nil]
+    def get_3_decimals number, version
+      # hundreds
+      if number.length == 3 and number[0] != '0'
+        final_number = @singles[number[0].to_i] + ' hundred'
+
+        if number[1] != '0' or number[2] != '0'
+          final_number += version == :gb ? ' and ' : ' '
+          final_number += get_2_decimals(number[1..2])
+        end
+
+        return final_number
+      end
+
+      nil
+    end
+
+  end
+
+end
+
+class Integer
+  include IntegerToEnglish
+end

data/lib/integer_to_english/version.rb

@@ -0,0 +1,3 @@
+module IntegerToEnglish
+  VERSION = '1.0.0'
+end

data/test/minitest_helper.rb

@@ -0,0 +1,11 @@
+require 'pathname'
+require Pathname.new(__dir__).parent + 'lib/integer_to_english'
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+
+if ENV['MINITEST_REPORTER'] == 'RUBYMINE'
+  Minitest::Reporters.use! Minitest::Reporters::RubyMineReporter.new
+else
+  Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new
+end

data/test/test_integer_to_english.rb

@@ -0,0 +1,125 @@
+require 'pathname'
+require Pathname.new(__dir__) + 'minitest_helper'
+
+class TestIntegerToEnglish < MiniTest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::IntegerToEnglish::VERSION
+  end
+
+  def test_integer_augmented
+    assert 0.respond_to?(:to_english), 'Integer has not been taught to speak English'
+  end
+
+  def test_should_convert_0_to_9
+    assert_equal 'zero', 0.to_english
+    assert_equal 'one', 1.to_english
+    assert_equal 'two', 2.to_english
+    assert_equal 'three', 3.to_english
+    assert_equal 'four', 4.to_english
+    assert_equal 'five', 5.to_english
+    assert_equal 'six', 6.to_english
+    assert_equal 'seven', 7.to_english
+    assert_equal 'eight', 8.to_english
+    assert_equal 'nine', 9.to_english
+  end
+
+  def test_should_convert_10s
+    assert_equal 'ten', 10.to_english
+    assert_equal 'twenty', 20.to_english
+    assert_equal 'thirty', 30.to_english
+    assert_equal 'forty', 40.to_english
+    assert_equal 'fifty', 50.to_english
+    assert_equal 'sixty', 60.to_english
+    assert_equal 'seventy', 70.to_english
+    assert_equal 'eighty', 80.to_english
+    assert_equal 'ninety', 90.to_english
+  end
+
+  def test_should_convert_11_to_19
+    assert_equal 'eleven', 11.to_english
+    assert_equal 'twelve', 12.to_english
+    assert_equal 'thirteen', 13.to_english
+    assert_equal 'fourteen', 14.to_english
+    assert_equal 'fifteen', 15.to_english
+    assert_equal 'sixteen', 16.to_english
+    assert_equal 'seventeen', 17.to_english
+    assert_equal 'eighteen', 18.to_english
+    assert_equal 'nineteen', 19.to_english
+  end
+
+  def test_should_convert_21_to_99
+    assert_equal 'twenty-one', 21.to_english
+    assert_equal 'forty-two', 42.to_english
+    assert_equal 'sixty-five', 65.to_english
+    assert_equal 'ninety-nine', 99.to_english
+  end
+
+  def test_should_deal_with_prefix
+    assert_equal 'sixty-five', +65.to_english
+    assert_equal 'sixty-five', -65.to_english
+  end
+
+  def test_should_convert_100s
+    assert_equal 'one hundred', 100.to_english
+    assert_equal 'two hundred', 200.to_english
+    assert_equal 'nine hundred', 900.to_english
+  end
+
+  def test_should_convert_hundreds_in_usa
+    assert_equal 'two hundred seventy-three', 273.to_english(:us)
+    assert_equal 'five hundred six', 506.to_english(:us)
+    assert_equal 'four hundred fifty-three', 453.to_english('us')
+  end
+
+  def test_should_convert_hundreds_in_british
+    assert_equal 'two hundred and seventy-three', 273.to_english
+    assert_equal 'five hundred and six', 506.to_english
+  end
+
+  def test_should_convert_1000s
+    assert_equal 'one thousand', 1000.to_english
+    assert_equal 'two thousand', 2000.to_english
+    assert_equal 'nine thousand', 9000.to_english
+  end
+
+  def test_should_convert_millions
+    assert_equal 'one million', 1000000.to_english
+    assert_equal 'two million', 2000000.to_english
+    assert_equal 'nine million', 9000000.to_english
+  end
+
+  def test_should_convert_billions
+    assert_equal 'one billion', 1000000000.to_english
+    assert_equal 'two billion', 2000000000.to_english
+    assert_equal 'nine billion', 9000000000.to_english
+  end
+
+  def test_should_convert_trillions
+    assert_equal 'one trillion', 1000000000000.to_english
+    assert_equal 'two trillion', 2000000000000.to_english
+    assert_equal 'nine trillion', 9000000000000.to_english
+  end
+
+  def test_should_convert_quadrillions
+    assert_equal 'one quadrillion', 1000000000000000.to_english
+    assert_equal 'two quadrillion', 2000000000000000.to_english
+    assert_equal 'nine quadrillion', 9000000000000000.to_english
+  end
+
+  # TODO more tricky and complex numbers
+
+  #list of random numbers, should be listing tricky ones
+  def test_should_convert_any_numbers_it_could
+    assert_equal 'forty-three thousand four hundred and two', 43402.to_english
+    assert_equal 'three hundred thirty thousand four hundred two', 330402.to_english(:us)
+    assert_equal(
+        'six hundred twenty-three quadrillion seven hundred seventy-seven trillion four million three thousand four hundred two',
+        623777000004003402.to_english(:us)
+    )
+    assert_equal(
+        'six hundred and twenty-three quadrillion seven hundred and seventy-seven trillion four million three thousand four hundred and two',
+        623777000004003402.to_english(:gb)
+    )
+
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: integer_to_english
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Viktor Vad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The Integer class is pimped up with the to_english method.
+email:
+- vad.viktor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- integer_to_english.gemspec
+- lib/integer_to_english.rb
+- lib/integer_to_english/version.rb
+- test/minitest_helper.rb
+- test/test_integer_to_english.rb
+homepage: https://github.com/vadviktor/integer_to_english
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Integer.to_english
+test_files:
+- test/minitest_helper.rb
+- test/test_integer_to_english.rb