number_humanizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bee08fad90938a6a325f38247dd514ea74d15bd9dd933bb85a9e2d5957e36ab
+  data.tar.gz: 4cb455486f3a821b7d8c8c2e467500f7af2d3322e380d50ae6257a37805cfb3c
+SHA512:
+  metadata.gz: 53a440130c332ee8e96be505b607fb8e5b7097e5096d1ef01eaf9a9e79ebb577628d904b5152f31f5d9fad8dbe493052459a4797f2b8b587ff7e894f0e41453e
+  data.tar.gz: cd86d07430b0bc9c49a6ceef13de00150b4c1993cad75b94ef4c02be748161cfebaee42d76b3d7295c2a4dbaae6adb0e082eb6c3dd1d3b9ff06a8c16bafd10cd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bahajaj135@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in number_humanizer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    number_humanizer (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (12.3.3)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  number_humanizer!
+  rake (~> 12.3, >= 12.3.3)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Ahmed Ba Haggag
+
+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,72 @@
+# NumberHumanizer
+
+A ruby gem to convert numbers into Arabic words. It has been designed to support multiple languages and currently support only Arabic language.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'number_humanizer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install number_humanizer
+
+## Usage
+
+You have two ways to use the gem:
+
+1. Using service class
+
+```ruby
+require 'number_humanizer'
+
+NumberHumanizer::Manager.new(1500).call.result
+#=> "ألف و خمسة مائة"
+```
+
+2. Call monkey patching methods added to Integer and Float classes
+```ruby
+require 'number_humanizer'
+
+1500.to_word
+#=> "ألف و خمسة مائة"
+```
+
+Also you can pass currency option as follows:
+
+```ruby
+require 'number_humanizer'
+
+NumberHumanizer::Manager.new(1500, currency: 'ريال').call.result
+#=> "ألف و خمسة مائة ريال"
+
+1500.to_word(currency: 'ريال')
+#=> "ألف و خمسة مائة ريال"
+```
+
+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.
+
+## 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.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abahaggag/number_humanizer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the NumberHumanizer project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/number_humanizer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "number_humanizer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/number_humanizer/languages/arabic.rb

@@ -0,0 +1,139 @@
+module NumberHumanizer::Languages
+  class Arabic < Base
+    UNITS_DICTIONARY = {
+      1 => '',
+      2 => 'ألف',
+      3 => 'مليون',
+      4 => 'مليار',
+      5 => 'مليون',
+      6 => 'مليار',
+      7 => 'بليون',
+      8 => 'بليار',
+      9 => 'تريليون',
+      10 => 'تريليار',
+      11 => 'كريليون',
+      12 => 'كريليار',
+      13 => 'سنكليون',
+      14 => 'سنكليار',
+      15 => 'سيزيليون',
+      16 => 'سيزيليار',
+      17 => 'سيتليون',
+      18 => 'سيتليار',
+      19 => 'ويتليون',
+      20 => 'ويتليار',
+      21 => 'تيفليون',
+      22 => 'تيفليار',
+      23 => 'ديشليون',
+      24 => 'ديشلي',
+    }.freeze
+
+    NUMBERS_DICTIONARY = {
+      0   => 'صفر',
+      1   => 'واحد',
+      2   => 'أثنين',
+      3   => 'ثلاثة',
+      4   => 'أربعة',
+      5   => 'خمسة',
+      6   => 'ستة',
+      7   => 'سبعة',
+      8   => 'ثمانية',
+      9   => 'تسعة',
+      10  => 'عشرة',
+      11  => 'احد عشر',
+      12  => 'اثنا عشر',
+      20  => 'عشرون',
+      30  => 'ثلاثون',
+      40  => 'اربعون',
+      50  => 'خمسون',
+      60  => 'ستون',
+      70  => 'سبعون',
+      80  => 'ثمانون',
+      90  => 'تسعون',
+      100 => 'مائة',
+      200 => 'مائتين',
+    }.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.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)}" unless unit_key == 1
+      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/base.rb

@@ -0,0 +1,25 @@
+module NumberHumanizer::Languages
+  class Base
+    attr_reader :result
+
+    def initialize(number, **args)
+      @number = number
+      @real_part, @fraction_part = exctract_real_and_fraction_parts
+      @currency = args[:currency]
+      @sub_currency = args[:sub_currency]
+    end
+
+    def call
+      @result = process_result
+      self
+    end
+
+    private
+
+    attr_reader :number, :real_part, :fraction_part, :currency, :sub_currency
+
+    def exctract_real_and_fraction_parts
+      number.abs.to_s.split('.').map(&:to_i)
+    end
+  end
+end

data/lib/number_humanizer/monkey_patchers.rb

@@ -0,0 +1,47 @@
+module NumberHumanizer
+  module StringExtensions
+    def squish!
+      self.strip.gsub(/s+/, ' ')
+    end
+
+    def blank?
+      self.nil? || self.empty?
+    end
+
+    def present?
+      !blank?
+    end
+  end
+
+  module NumericExtensions
+    def to_word(**args)
+      NumberHumanizer::Manager.new(self, **args).call.result
+    end
+
+    def present?
+      true
+    end
+  end
+
+  module NilExtensions
+    def present?
+      false
+    end
+  end
+end
+
+class String
+  include NumberHumanizer::StringExtensions
+end
+
+class NilClass
+  include NumberHumanizer::NilExtensions
+end
+
+class Integer
+  include NumberHumanizer::NumericExtensions
+end
+
+class Float
+  include NumberHumanizer::NumericExtensions
+end

data/lib/number_humanizer/version.rb

@@ -0,0 +1,3 @@
+module NumberHumanizer
+  VERSION = "0.1.0"
+end

data/lib/number_humanizer.rb

@@ -0,0 +1,32 @@
+require "number_humanizer/version"
+require "number_humanizer/monkey_patchers"
+require "number_humanizer/languages/base"
+require "number_humanizer/languages/arabic"
+
+module NumberHumanizer
+  class Manager
+    attr_reader :result, :number, :language, :args
+
+    def initialize(number, language: :arabic, **args)
+      @number = number
+      @language = language
+      @args = args
+    end
+
+    def call
+      @result = language_service_class.new(number, **args).call.result
+      self
+    end
+
+    private
+
+
+    def language_service_class
+      @language_service_class ||= \
+        case language
+        when :arabic, :ar then NumberHumanizer::Languages::Arabic
+        else raise(StandardError, 'Language not supported')
+        end
+    end
+  end
+end

data/number_humanizer.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "number_humanizer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "number_humanizer"
+  spec.version       = NumberHumanizer::VERSION
+  spec.authors       = ["Ahmed Ba Haggag"]
+  spec.email         = ["ahmedbahaggag@gmail.com"]
+
+  spec.summary       = %q{Number to word humanizer for Arabic Language}
+  spec.description   = %q{}
+  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
+
+  # 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.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: number_humanizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ahmed Ba Haggag
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- ahmedbahaggag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/number_humanizer.rb
+- lib/number_humanizer/languages/arabic.rb
+- lib/number_humanizer/languages/base.rb
+- lib/number_humanizer/monkey_patchers.rb
+- lib/number_humanizer/version.rb
+- number_humanizer.gemspec
+homepage: https://github.com/abahaggag/number_humanizer
+licenses:
+- MIT
+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
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Number to word humanizer for Arabic Language
+test_files: []