number_humanizer 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '097ea7f57eb7163f62075393544113f2da8b3f7c446096a8a6981c60f3ce8266'
-  data.tar.gz: c714c21473683be8c1c89e2edfc1efb1bc739ba691668d83906cfae8df3569a4
+  metadata.gz: 1945b1dea89c43d38dec1285471f801ea99e7012d2e906f5c5ee8c2c79ef9408
+  data.tar.gz: 54d390fa1d89b7a1fd1941ff73e51518036c6ad7b8eac415bf0aa14fa306e723
 SHA512:
-  metadata.gz: b71e359fcc6fe0653d170bc9cd15f6f8102044954a93e19ebdf1e36c0553d8dbaebe1714c2cac0028e48805faa81e72711c87e9885298800d0cf0470ceb187d6
-  data.tar.gz: 041112bb61cf75822b0917938dae7e8272da73859b36ff84cba41c0da6f6d31bba5822dddab13904e8a33914e300595b2427e6e2c12b6dcc3b5b40a76af75e05
+  metadata.gz: dc4d5cc8c66aabc6f3bc882183c0af137d301028fa78cc400433f836a19783ac84bc5027ee094b0bd8fa776652294064206b663c209f71f3bd29b8e691b8ad6a
+  data.tar.gz: 96955a95f3f5373c52c20a0393a1a6ec6a0fab6def578f2b8179e930f0f09ae65999515bb0e96e5a1c879d4dbd0b01a7cc93d78897a44607f07881ef7d3c481e

data/CHANGELOG.md

@@ -1,2 +1,13 @@
+## [0.1.0] - 2022-05-28
+  - Release the gem with basic functionalities
+
+
 ## [0.1.1] - 2022-06-03
   - Bug fixes and specs added
+
+
+## [0.2.0] - 2022-06-04
+  - Enhance and refactor languages structure to support multiple languages.
+  - Add English language humanizer and its specs.
+  - Setup configurations structure and basic configs.
+  - Fix issues.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    number_humanizer (0.1.0)
+    number_humanizer (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,6 +1,6 @@
-# NumberHumanizer
+# Number Humanizer
 
-A ruby gem to convert numbers into Arabic words. It has been designed to support multiple languages and currently support only Arabic language.
+A ruby gem to convert numbers into words. It has been designed to support multiple languages and currently support only Arabic and English languages.
 
 ## Installation
 
@@ -53,6 +53,53 @@ NumberHumanizer::Manager.new(1500, currency: 'ريال').call.result
 
 Note that sub currency is also supported but not fully functional so if you need to use it then you can pass amount and sub amount separately to the service and you need to combine.
 
+## Configurations
+You have to way for setting configurations in number humanizer gem:
+- Set configurations globally: this will be used in all conversions. You can add the following snippet in initializers folder or any file that is loaded automatically. Note that this configuration can be changed at any time by calling this code.
+
+```ruby
+# initializers/number_humanizer.rb
+require 'number_humanizer'
+
+NumberHumanizer.setup do |config|
+  # default language is arabic
+  config.language = :arabic
+
+  # currency is not set by default and you can set from here
+  config.currency = 'ريال'
+
+  # all upcoming configs will be placed here
+end
+```
+
+- Pass configuratoins instantly whether when using service object or monkey patched methods so that global configurations will be ignored
+
+```ruby
+require 'number_humanizer'
+
+NumberHumanizer::Manager.new(1500, language: :arabic, currency: 'ريال').call.result
+#=> "ألف و خمسة مائة ريال"
+
+1500.to_word(language: :arabic, currency: 'ريال')
+#=> "ألف و خمسة مائة ريال"
+```
+
+## Supported Languages
+Initially, gem was supporting Arabic language only but now English language is supported too. Here are the details needed for each language:
+
+- **Arabic Language**
+
+  This is the default one and you don't need to specify it but if you set other language and want to have arabic word for given number then you can pass it to the service or as args in `to_word` monkey patched method as explained in configurations section.
+
+  *Note that accepted values are: `arabic` and `ar`*.
+
+- **English Language**
+
+  Like arabic language, english language can be configured globally or instantly as described in configuration section. Here you just need to set `language` config.
+
+  *Note that accepted values are: `english` and `en`*.
+
+
 ## Development
 
 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.

data/lib/number_humanizer/configuration.rb

@@ -0,0 +1,32 @@
+module NumberHumanizer
+  class Configuration < Module
+    def initialize(**attributes)
+      attributes.each do |name, default|
+        define_reader(name, default)
+        define_writer(name)
+      end
+    end
+
+    private
+
+    def define_reader(name, default)
+      variable = :"@#{name}"
+
+      define_method(name) do
+        if instance_variable_defined?(variable)
+          instance_variable_get(variable)
+        else
+          default
+        end
+      end
+    end
+
+    def define_writer(name)
+      variable = :"@#{name}"
+
+      define_method("#{name}=") do |value|
+        instance_variable_set(variable, value)
+      end
+    end
+  end
+end

data/lib/number_humanizer/languages/arabic.rb

@@ -22,7 +22,7 @@ module NumberHumanizer::Languages
       19 => 'تيفليون',
       20 => 'تيفليار',
       21 => 'ديشليون',
-      22 => 'ديشلي',
+      22 => 'ديشلي'
     }.freeze
 
     NUMBERS_DICTIONARY = {
@@ -59,87 +59,8 @@ module NumberHumanizer::Languages
       2000 => 'ألفان'
     }.freeze
 
-    private
-
-    attr_reader :processed_real_part, :processed_fraction_part
-
-    def process_result
-      @processed_real_part = process_real_part
-      @processed_fraction_part = process_fraction_part
-      final_result = [
-        [processed_real_part, currency].compact.join(' '),
-      ]
-      final_result << [processed_fraction_part, sub_currency].compact.join(' ') if processed_fraction_part.present?
-      final_result.compact.join(decimal_point_connector).insert(0, process_minus)
-    end
-
-    def and_connector; " و "; end
-    def decimal_point_connector; " فاصل "; end
-    def minus_word; "سالب "; end
-    def unit(unit_key); UNITS_DICTIONARY[unit_key]; end
-    def word_lookup(segment); NUMBERS_DICTIONARY[segment]; end
-
-    def process_minus
-      return minus_word if number.negative?
-      ''
-    end
-
-    def process_real_part
-      number_word = word_lookup(real_part)
-      return number_word if number_word.present?
-      process_number(real_part)
-    end
-
-    def process_fraction_part
-      return if fraction_part.nil? || fraction_part.zero?
-      fraction_part
-      # process_number(fraction_part)
-    end
-
-    def process_number(number)
-      segments = get_number_segments(number)
-      segments_size = segments.size
-      "#{segments.map!.with_index { |segment, i| process_segment(segment, unit_key: segments_size - i) }.compact.reject{ |sw| sw == '' }.join(and_connector)}"
-    end
-
-    def get_number_segments(number)
-      return [0] if number.zero?
-      segments = []
-      while(number != 0)
-        segments.insert(0, number % 1000)
-        number /= 1000
-      end
-      segments
-    end
-
-    def process_segment(segment, unit_key:)
-      word = "#{segment_to_word(segment, unit_key)}"
-      word << " #{unit(unit_key)}" if unit_key != 1 && segment > 0
-      word.squish!
-    end
-
-    def segment_to_word(segment, unit_key)
-      return '' if segment.zero? || (segment == 1 && unit_key != 1)
-      return word_lookup(segment) if word_lookup(segment).present?
-      return process_words_for_tens(segment) if segment < 100
-      return process_words_for_hundreds(segment) if segment < 1000
-    end
-
-    def process_words_for_tens(segment)
-      return word_lookup(segment) if word_lookup(segment).present?
-      "#{word_lookup(segment % 10)}#{segment / 10 == 1 ? ' ' : and_connector}#{word_lookup(segment / 10 * 10)}"
-    end
-
-    def process_words_for_hundreds(segment)
-      word = "#{process_hundred_part(segment)}"
-      word << "#{and_connector}#{process_words_for_tens(segment % 100)}" if segment % 100 > 0
-      word
-    end
-
-    def process_hundred_part(segment)
-      hundred_digit = segment / 100
-      return '' if hundred_digit.zero?
-      (1..2).cover?(hundred_digit) ? word_lookup(hundred_digit * 100) : "#{word_lookup(hundred_digit)} #{word_lookup(100)}"
-    end
+    AND_CONNECTOR = " و ".freeze
+    DECIMAL_POINT_CONNECTOR = " فاصل ".freeze
+    MINUS_WORD = "سالب ".freeze
   end
 end

data/lib/number_humanizer/languages/base.rb

@@ -5,8 +5,8 @@ module NumberHumanizer::Languages
     def initialize(number, **args)
       @number = number
       @real_part, @fraction_part = exctract_real_and_fraction_parts
-      @currency = args[:currency]
-      @sub_currency = args[:sub_currency]
+      @currency = args[:currency] || NumberHumanizer.currency
+      @sub_currency = args[:sub_currency] || NumberHumanizer.sub_currency
     end
 
     def call
@@ -16,10 +16,90 @@ module NumberHumanizer::Languages
 
     private
 
-    attr_reader :number, :real_part, :fraction_part, :currency, :sub_currency
+    attr_reader :number, :real_part, :fraction_part, :currency, :sub_currency,
+                :processed_real_part, :processed_fraction_part
 
     def exctract_real_and_fraction_parts
       number.abs.to_s.split('.').map(&:to_i)
     end
+
+    def process_result
+      @processed_real_part = process_real_part
+      @processed_fraction_part = process_fraction_part
+      final_result = [
+        [processed_real_part, currency].compact.join(' '),
+      ]
+      final_result << [processed_fraction_part, sub_currency].compact.join(' ') if processed_fraction_part.present?
+      final_result.compact.join(decimal_point_connector).insert(0, process_minus)
+    end
+
+    def unit(unit_key); self.class::UNITS_DICTIONARY[unit_key]; end
+    def word_lookup(segment); self.class::NUMBERS_DICTIONARY[segment]; end
+    def and_connector; self.class::AND_CONNECTOR; end
+    def decimal_point_connector; self.class::DECIMAL_POINT_CONNECTOR; end
+    def minus_word; self.class::Minus_word; end
+
+    def process_minus
+      return minus_word if number.negative?
+      ''
+    end
+
+    def process_real_part
+      number_word = word_lookup(real_part)
+      return number_word if number_word.present?
+      process_number(real_part)
+    end
+
+    def process_fraction_part
+      return if fraction_part.nil? || fraction_part.zero?
+      fraction_part
+      # process_number(fraction_part)
+    end
+
+    def process_number(number)
+      segments = get_number_segments(number)
+      segments_size = segments.size
+      "#{segments.map!.with_index { |segment, i| process_segment(segment, unit_key: segments_size - i) }.compact.reject{ |sw| sw == '' }.join(and_connector)}"
+    end
+
+    def get_number_segments(number)
+      return [0] if number.zero?
+      segments = []
+      while(number != 0)
+        segments.insert(0, number % 1000)
+        number /= 1000
+      end
+      segments
+    end
+
+    def process_segment(segment, unit_key:)
+      word = "#{segment_to_word(segment, unit_key)}"
+      word << " #{unit(unit_key)}" if unit_key != 1 && segment > 0
+      word.squish!
+    end
+
+    def segment_to_word(segment, unit_key)
+      return '' if segment.zero? || (segment == 1 && unit_key != 1)
+      return word_lookup(segment) if word_lookup(segment).present?
+      return process_words_for_tens(segment) if segment < 100
+      return process_words_for_hundreds(segment) if segment < 1000
+    end
+
+    def process_words_for_tens(segment)
+      return word_lookup(segment) if word_lookup(segment).present?
+      "#{word_lookup(segment % 10)}#{segment / 10 == 1 ? ' ' : and_connector}#{word_lookup(segment / 10 * 10)}"
+    end
+
+    def process_words_for_hundreds(segment)
+      word = "#{process_hundred_part(segment)}"
+      word << "#{and_connector}#{process_words_for_tens(segment % 100)}" if segment % 100 > 0
+      word
+    end
+
+    def process_hundred_part(segment)
+      hundred_digit = segment / 100
+      return '' if hundred_digit.zero?
+      (1..2).cover?(hundred_digit) ? word_lookup(hundred_digit * 100) : "#{word_lookup(hundred_digit)} #{word_lookup(100)}"
+    end
   end
 end

data/lib/number_humanizer/languages/english.rb

@@ -0,0 +1,84 @@
+module NumberHumanizer::Languages
+  class English < Base
+    UNITS_DICTIONARY = {
+      1 => '',
+      2 => 'thousand',
+      3 => 'million',
+      4 => 'billion',
+      5 => 'trillion',
+      6 => 'quadrillion',
+      7 => 'quintillion',
+      8 => 'sextillion',
+      9 => 'septillion',
+      10 => 'octillion',
+      11 => 'nonillion',
+      12 => 'decillion',
+      13 => 'undecillion',
+      14 => 'duodecillion',
+      15 => 'tredecillion',
+      16 => 'quattuordecillion',
+      17 => 'quindecillion',
+      18 => 'sexdecillion',
+      19 => 'septemdecillion',
+      20 => 'octodecillion',
+      21 => 'novemdecillion',
+      22 => 'vigintillion'
+    }.freeze
+
+    NUMBERS_DICTIONARY = {
+      0   => 'zero',
+      1   => 'one',
+      2   => 'two',
+      3   => 'three',
+      4   => 'four',
+      5   => 'five',
+      6   => 'six',
+      7   => 'seven',
+      8   => 'eight',
+      9   => 'nine',
+      10  => 'ten',
+      11  => 'eleven',
+      12  => 'twelve',
+      13  => 'thirteen',
+      14  => 'fourteen',
+      15  => 'fifteen',
+      16  => 'sixteen',
+      17  => 'seventeen',
+      18  => 'eighteen',
+      19  => 'nineteen',
+      20  => 'twenty',
+      30  => 'thirty',
+      40  => 'forty',
+      50  => 'fifty',
+      60  => 'sixty',
+      70  => 'seventy',
+      80  => 'eighty',
+      90  => 'ninety',
+      100 => 'hundred',
+      200 => 'two hundred'
+    }.freeze
+
+    AND_CONNECTOR = " and ".freeze
+    DECIMAL_POINT_CONNECTOR = " point ".freeze
+    MINUS_WORD = "minus ".freeze
+
+    private
+
+    def process_words_for_hundreds(segment)
+      word = "#{process_hundred_part(segment)}"
+      word << "#{and_connector}#{process_words_for_tens(segment % 100)}" if segment % 100 > 0
+      word
+    end
+
+    def process_words_for_tens(segment)
+      return word_lookup(segment) if word_lookup(segment).present?
+      "#{word_lookup(segment / 10 * 10)} #{word_lookup(segment % 10)}"
+    end
+
+    def process_hundred_part(segment)
+      hundred_digit = segment / 100
+      return '' if hundred_digit.zero?
+      (1..2).cover?(hundred_digit) ? word_lookup(hundred_digit * 100) : "#{word_lookup(hundred_digit)} #{word_lookup(100)}"
+    end
+  end
+end

data/lib/number_humanizer/monkey_patchers.rb

@@ -1,7 +1,9 @@
 module NumberHumanizer
   module StringExtensions
     def squish!
-      self.strip.gsub(/s+/, ' ')
+      self.strip!
+      self.gsub!(/\s+/, ' ')
+      self
     end
 
     def blank?

data/lib/number_humanizer/version.rb

@@ -1,3 +1,3 @@
 module NumberHumanizer
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/number_humanizer.rb

@@ -1,15 +1,30 @@
 require "number_humanizer/version"
 require "number_humanizer/monkey_patchers"
+require "number_humanizer/configuration"
 require "number_humanizer/languages/base"
 require "number_humanizer/languages/arabic"
+require "number_humanizer/languages/english"
 
 module NumberHumanizer
+  extend NumberHumanizer::Configuration.new(
+    language: :arabic,
+    currency: nil,
+    sub_currency: nil
+  )
+
+  def self.setup
+    yield self
+  end
+
+  class LanguageNotSupportedError < StandardError
+  end
+
   class Manager
     attr_reader :result, :number, :language, :args
 
-    def initialize(number, language: :arabic, **args)
+    def initialize(number, **args)
       @number = number
-      @language = language
+      @language = args[:language] || NumberHumanizer.language
       @args = args
     end
 
@@ -20,12 +35,12 @@ module NumberHumanizer
 
     private
 
-
     def language_service_class
       @language_service_class ||= \
-        case language
+        case language.downcase.to_sym
         when :arabic, :ar then NumberHumanizer::Languages::Arabic
-        else raise(StandardError, 'Language not supported')
+        when :english, :en then NumberHumanizer::Languages::English
+        else raise(LanguageNotSupportedError, "Language specified (#{language}) not supported")
         end
     end
   end

data/number_humanizer.gemspec

@@ -8,14 +8,14 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ahmed Ba Haggag"]
   spec.email         = ["ahmedbahaggag@gmail.com"]
 
-  spec.summary       = %q{Number to word humanizer for Arabic Language}
-  spec.description   = %q{Number to word humanizer for Arabic Language}
+  spec.summary       = %q{Number to word humanizer for Arabic and English Language}
+  spec.description   = %q{Number to word humanizer for Arabic and English Language}
   spec.homepage      = "https://github.com/abahaggag/number_humanizer"
   spec.license       = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: number_humanizer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ahmed Ba Haggag
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-03 00:00:00.000000000 Z
+date: 2022-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,7 +72,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Number to word humanizer for Arabic Language
+description: Number to word humanizer for Arabic and English Language
 email:
 - ahmedbahaggag@gmail.com
 executables: []
@@ -92,8 +92,10 @@ files:
 - bin/console
 - bin/setup
 - lib/number_humanizer.rb
+- lib/number_humanizer/configuration.rb
 - lib/number_humanizer/languages/arabic.rb
 - lib/number_humanizer/languages/base.rb
+- lib/number_humanizer/languages/english.rb
 - lib/number_humanizer/monkey_patchers.rb
 - lib/number_humanizer/version.rb
 - number_humanizer.gemspec
@@ -103,7 +105,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/abahaggag/number_humanizer
   source_code_uri: https://github.com/abahaggag/number_humanizer
-  changelog_uri: https://github.com/abahaggag/number_humanizer
+  changelog_uri: https://github.com/abahaggag/number_humanizer/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -122,5 +124,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: Number to word humanizer for Arabic Language
+summary: Number to word humanizer for Arabic and English Language
 test_files: []