num_words 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d205d24368e2f8f01249971360cd573497c2892cea31840289831937af26f0
-  data.tar.gz: 5597dd4bc9baf0217b5bca0111dc2e214cae69838de05635ba53849ba72c017c
+  metadata.gz: 24463f1da6ace2a42347b2e4bd275527a02510175087ebc98eaf3011ea56f4ff
+  data.tar.gz: e61dc04d74d11bde0825d575a5240b96790d1a156ad8048813449adf1e267e05
 SHA512:
-  metadata.gz: e4ff68ce798397ccea435a92976665940d8fe23a869a4dc34332318f81caf6ec81f3c85153349c52bc40bd52999fd557f709fff04c60e8c434aa3e7d4ce2661d
-  data.tar.gz: f5cf56ac330f7de0d23ead06d6989e40ad461a85484adb044ad20c65fd493cc01f25aeb3df00bfbe2700955292844378615b43764849b3ae57c996b8a10bf111
+  metadata.gz: 9decb67c34898169365951b2c04c79449c0024ea83263ed30a8d0412ce1f6f2ac62a6423e380c9492cd87afce0841085e3f4e06900b9141a87427d4043fc8a04
+  data.tar.gz: 2f5fe30029e8c3ed6915c0ace3f913d3ed3ea0f47ac119f200b1a8dc4b410e0575317f5011275bc40c466e1593af21732c918829b02bfa1a47cd5ac3f0709704

data/README.md

@@ -1,36 +1,32 @@
 # NumWords
 
-TODO: Delete this and the text below, and describe your gem
+**NumWords** is a Ruby gem that converts numbers into words in multiple numbering systems, including US, European, UK, French, and Indian. It supports both integer and decimal numbers and is useful for invoices, financial documents, or any application that requires converting numeric values into readable text.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/num_words`. To experiment with that code, run `bin/console` for an interactive prompt.
+---
 
-## Installation
-
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
+## Features
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+- Convert integers and decimals to words.
+- Supports multiple country numbering systems:
+  - **US / American** – `thousand, million, billion`
+  - **European** – `thousand, million, milliard, billion`
+  - **UK** – `thousand, million, billion`
+  - **France** – `mille, million, milliard`
+  - **India** – `thousand, lakh, crore`
+- Easy to integrate into Ruby or Rails applications.
+- Supports numbers up to `duovigintillion` (10^69) in the American system.
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-```
-
-## Usage
-
-TODO: Write usage instructions here
+---
 
-## Development
+## Installation
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+### Using RubyGems
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After releasing your gem to [RubyGems.org](https://rubygems.org), install it with:
 
-## Contributing
+```bash
+# Using Bundler
+bundle add gem 'num_words'
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/num_words.
-# num_words
+# Or install manually
+gem install num_words

data/lib/num_words/converter.rb

@@ -0,0 +1,129 @@
+# lib/num_words/converter.rb
+# frozen_string_literal: true
+
+module NumWords
+  ONES = %w[zero one two three four five six seven eight nine ten eleven twelve thirteen fourteen fifteen sixteen seventeen eighteen nineteen].freeze
+  TENS = %w[zero ten twenty thirty forty fifty sixty seventy eighty ninety].freeze
+
+  AM_EXPONENTS = {
+    3 => 'thousand', 6 => 'million', 9 => 'billion', 12 => 'trillion',
+    15 => 'quadrillion', 18 => 'quintillion', 21 => 'sexillion', 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'
+  }.freeze
+
+  EU_EXPONENTS = {
+    3 => 'thousand', 6 => 'million', 9 => 'milliard', 12 => 'billion',
+    15 => 'billiard', 18 => 'trillion', 21 => 'trilliard', 24 => 'quadrillion',
+    27 => 'quadrilliard', 30 => 'quintillion', 33 => 'quintilliard', 36 => 'sextillion',
+    39 => 'sextilliard', 42 => 'septillion', 45 => 'septilliard', 48 => 'octillion',
+    51 => 'octilliard', 54 => 'noventillion', 57 => 'noventilliard', 60 => 'decillion',
+    63 => 'decilliard', 66 => 'undecillion', 69 => 'undecilliard'
+  }.freeze
+
+  UK_EXPONENTS = {
+    3 => 'thousand', 6 => 'million', 12 => 'billion', 15 => 'billiard',
+    18 => 'trillion', 21 => 'trilliard', 24 => 'quadrillion'
+  }.freeze
+
+  FR_EXPONENTS = {
+    3 => 'mille', 6 => 'million', 9 => 'milliard', 12 => 'billion',
+    15 => 'billiard', 18 => 'trillion', 21 => 'trilliard'
+  }.freeze
+
+  INDIAN_UNITS = ['', 'thousand', 'lakh', 'crore'].freeze
+
+  COUNTRY_EXPONENTS = {
+    us: AM_EXPONENTS,
+    eu: EU_EXPONENTS,
+    uk: UK_EXPONENTS,
+    fr: FR_EXPONENTS,
+    in: INDIAN_UNITS
+  }.freeze
+
+  class << self
+    def to_words(number, country: :us, include_and: true)
+      return to_words_indian(number) if country == :in
+
+      val = number.to_i.abs
+      return 'zero' if val.zero?
+
+      exp_hash = COUNTRY_EXPONENTS[country] || AM_EXPONENTS
+      to_words_generic(val, exp_hash, include_and)
+    end
+
+    def to_words_indian(num)
+      integer_part, decimal_part = num.to_s.split('.')
+      integer_words = indian_units_to_words(integer_part.to_i)
+      return integer_words if decimal_part.nil? || decimal_part.to_i.zero?
+
+      decimal_words = decimal_part.chars.map { |d| sub_thousand_to_words(d.to_i) }.join(' ')
+      "#{integer_words} and #{decimal_words}"
+    end
+
+    private
+
+    def to_words_generic(val, exp_hash, include_and)
+      chunks = []
+      while val.positive?
+        chunks << val % 1000
+        val /= 1000
+      end
+
+      result = []
+      chunks.each_with_index do |chunk, index|
+        next if chunk.zero?
+        words = hundreds_to_words(chunk, include_and && index.zero?)
+        result.unshift("#{words} #{exp_hash[index * 3]}".strip)
+      end
+      result.join(' ').strip
+    end
+
+    def hundreds_to_words(val, include_and = false)
+      return '' if val.zero?
+
+      words = []
+      if val >= 100
+        words << "#{ONES[val / 100]} hundred"
+        val %= 100
+        words << 'and' if val.positive? && include_and
+      end
+
+      words << TENS[val / 10] if val >= 20
+      val %= 10 if val >= 20
+      words << ONES[val] if val.positive?
+      words.join(' ').strip
+    end
+
+    def indian_units_to_words(num)
+      num = num.to_i
+      return 'zero' if num.zero?
+      words = []
+      unit_index = 0
+
+      loop do
+        break if num.zero?
+
+        num, remainder = unit_index.zero? ? num.divmod(1000) : num.divmod(100)
+        words.unshift("#{sub_thousand_to_words(remainder)} #{INDIAN_UNITS[unit_index]}".strip) if remainder.positive?
+        unit_index += 1
+      end
+
+      words.join(' ').strip
+    end
+
+    def sub_thousand_to_words(num)
+      num = num.to_i
+      return ONES[num] if num < 20
+      return "#{ONES[num / 100]} hundred" if num >= 100 && (num % 100).zero?
+
+      if num < 100
+        "#{TENS[num / 10]} #{ONES[num % 10]}".strip
+      else
+        "#{ONES[num / 100]} hundred and #{sub_thousand_to_words(num % 100)}"
+      end
+    end
+  end
+end

data/lib/num_words/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module NumWords
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/num_words.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "num_words/version"
+require_relative "num_words/converter"
 
 module NumWords
   class Error < StandardError; end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: num_words
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - mrmalvi
@@ -22,7 +22,10 @@ files:
 - Rakefile
 - exe/num_words
 - lib/num_words.rb
+- lib/num_words/converter.rb
 - lib/num_words/version.rb
+- num_words-0.1.0.gem
+- num_words-0.2.0.gem
 - sig/num_words.rbs
 homepage: https://github.com/mrmalvi/num_words
 licenses: []
@@ -37,7 +40,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="