arabic-wordify 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 225232ca7bff186e1138abeb7524c00e460b233891f2c5f4e31583a0f2ec267f
+  data.tar.gz: 6dbf9d93c9653356500db73354559cd39ad2520f57d162c0f21566fd3552ad46
+SHA512:
+  metadata.gz: 2c56df992a49cf2668e15fe5b190d8059630f16e68c81f57c56a5787907c8675904b4cd20a130a2331cae089796b7a9fdefd641031eda4f591cff94da6865896
+  data.tar.gz: 4447f70bffe00bee6c980f501908f4d28da1886c6200397e71ef01a05d5c3c50db27e33dc8aadd6037a75a4432b6b339ae566159cb381020cbbfa3a1affc8d45

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+- Converting various numbers to their word equivalents.
+- Handling invalid inputs and ensuring appropriate errors are raised.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 MAVEN
+
+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,132 @@
+# arabic-wordify - Arabic Number to Words Converter
+
+arabic-wordify is a Ruby gem that converts Arabic numbers into their word equivalents in Arabic. It supports numbers up to a septillion (1 followed by 24 zeros), including trillions, quadrillions, quintillions, sextillions, and septillions.
+
+## Features
+
+- **Comprehensive Number Conversion**: Convert any number from 0 up to 10^24 into its Arabic word equivalent.
+- **Arabic Digits Support**: Automatically converts Arabic digits (٠١٢٣٤٥٦٧٨٩) to English digits before conversion.
+- **Error Handling**: Properly handles invalid inputs, such as non-integer values or empty inputs.
+- **Support for Large Numbers**: Includes support for large number names such as million, billion, trillion, and beyond.
+
+## Installation
+
+To install arabic-wordify, add this line to your application's Gemfile:
+
+```ruby
+gem 'arabic-wordify'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install arabic-wordify
+```
+
+## Usage
+
+Using arabic-wordify in your Ruby application is simple. Here's an example:
+
+```ruby
+require 'arabic-wordify'
+
+number = "٢٢٠٣٤٢٢"
+
+str = ArabicWordify::ArabicNumberWords.convert_to_text(number)
+puts str
+```
+
+This will output:
+
+```
+اثنان مليون و مائتان و ثلاثة آلاف و أربعمائة و اثنان و عشرون
+```
+
+### Note on Arabic Digits
+
+If you want to input Arabic digits directly without using quotation marks, please note that Ruby does not natively support this. You must input Arabic digits as strings (e.g., `"٢٢٠٣٤٢٢"`). The `arabic-wordify` gem will automatically convert these Arabic digits into their English equivalents before processing them.
+
+### Error Handling
+
+arabic-wordify will raise an `ArabicWordifyError` if an invalid input is provided. For example:
+
+```ruby
+begin
+  ArabicWordify.convert(nil)
+rescue ArabicWordify::ArabicWordifyError => e
+  puts e.message
+end
+```
+
+This will output:
+
+```
+Failed to convert number to words: Number cannot be nil or empty
+```
+
+## Development
+
+To set up your development environment:
+
+1. Clone the repository:
+
+```bash
+$ git clone https://github.com/Abo5/arabic-wordify.git
+$ cd arabic-wordify
+```
+
+2. Install dependencies:
+
+```bash
+$ bundle install
+```
+
+3. Run tests:
+
+```bash
+$ bundle exec rspec
+```
+
+## Testing
+
+arabic-wordify uses RSpec for testing. All test files are located in the `spec/` directory. To run the tests, execute:
+
+```bash
+$ bundle exec rspec
+```
+
+Example test cases include:
+
+- Converting various numbers to their word equivalents.
+- Handling invalid inputs and ensuring appropriate errors are raised.
+
+## Continuous Integration
+
+arabic-wordify uses GitHub Actions for continuous integration. The configuration file is located at `.github/workflows/ruby.yml`. It ensures that every push and pull request is automatically tested on the specified Ruby versions.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [arabic-wordify repository](https://github.com/Abo5/arabic-wordify). This project is intended to be a safe, welcoming space for collaboration.
+
+## License
+
+arabic-wordify is available as open-source under the terms of the [MIT License](https://github.com/Abo5/arabic-wordify/blob/main/LICENSE).
+
+## Future Plans
+
+- **Internationalization**: Extend support to more languages.
+- **Additional Number Formats**: Support for ordinal numbers and other formats.
+
+## Support
+
+If you encounter any issues or have questions, please open an issue on GitHub or contact the maintainers.
+
+## Acknowledgements
+
+This project was inspired by the need for a robust Arabic number-to-word converter that supports large numbers and provides accurate results in the Arabic language.# arabic-wordify

data/lib/Arabic-Wordify.rb

@@ -0,0 +1,15 @@
+# lib/Arabic-Wordify.rb
+require_relative 'ArabicWordify/arabic_number_words.rb'
+require_relative 'ArabicWordify/error'
+
+module ArabicWordify
+  def self.convert(number)
+    raise ArgumentError, 'Number cannot be nil or empty' if number.nil? || number.to_s.empty?
+    raise ArgumentError, 'Number must be an integer' unless number.is_a?(Integer)
+  
+    ArabicWordify::ArabicNumberWords.convert_to_text(number)
+  rescue => e
+    raise ArabicWordifyError, "Failed to convert number to words: #{e.message}"
+  end
+  
+end

data/lib/ArabicWordify/arabic_number_words.rb

@@ -0,0 +1,53 @@
+require_relative 'units'
+module ArabicWordify
+  class ArabicNumberWords
+    def self.convert_to_text(number)
+      number = convert_arabic_num_to_english_num(number)
+      return 'صفر' if number.to_i.zero?
+
+      parts = []
+      thousand_index = 0
+
+      while number > 0
+        part = number % 1000
+        unless part.zero?
+          part_text = convert_hundreds(part)
+          part_text += " #{THOUSANDS[thousand_index]}" unless thousand_index.zero?
+          parts.unshift(part_text)
+        end
+        number /= 1000
+        thousand_index += 1
+      end
+
+      parts.join(' و ')
+    end
+
+    private
+
+    def self.convert_hundreds(number)
+      return UNITS[number] if number <= 19
+
+      hundreds = number / 100
+      tens = number % 100
+      words = []
+
+      words << HUNDREDS[hundreds * 100] if hundreds > 0
+
+      if tens > 0
+        if tens <= 19
+          words << UNITS[tens]
+        else
+          ones = tens % 10
+          words << UNITS[ones] if ones > 0
+          words << TENS[(tens / 10) * 10]
+        end
+      end
+
+      words.join(' و ')
+    end
+
+    def self.convert_arabic_num_to_english_num(number)
+      number.to_s.tr('٠١٢٣٤٥٦٧٨٩', '0123456789').to_i
+    end
+  end
+end

data/lib/ArabicWordify/error.rb

@@ -0,0 +1,5 @@
+# lib/ArabicWordify/error.rb
+module ArabicWordify
+    class ArabicWordifyError < StandardError
+    end
+  end

data/lib/ArabicWordify/units.rb

@@ -0,0 +1,18 @@
+UNITS = {
+  0 => '', 1 => 'واحد', 2 => 'اثنان', 3 => 'ثلاثة', 4 => 'أربعة', 5 => 'خمسة',
+  6 => 'ستة', 7 => 'سبعة', 8 => 'ثمانية', 9 => 'تسعة', 10 => 'عشرة',
+  11 => 'أحد عشر', 12 => 'اثنا عشر', 13 => 'ثلاثة عشر', 14 => 'أربعة عشر', 15 => 'خمسة عشر',
+  16 => 'ستة عشر', 17 => 'سبعة عشر', 18 => 'ثمانية عشر', 19 => 'تسعة عشر'
+}
+
+TENS = {
+  20 => 'عشرون', 30 => 'ثلاثون', 40 => 'أربعون', 50 => 'خمسون',
+  60 => 'ستون', 70 => 'سبعون', 80 => 'ثمانون', 90 => 'تسعون'
+}
+
+HUNDREDS = {
+  100 => 'مائة', 200 => 'مئتان', 300 => 'ثلاثمائة', 400 => 'أربعمائة', 500 => 'خمسمائة',
+  600 => 'ستمائة', 700 => 'سبعمائة', 800 => 'ثمانمائة', 900 => 'تسعمائة'
+}
+
+THOUSANDS = ['', 'ألف', 'مليون', 'مليار', 'تريليون', 'كوادريليون', 'كوينتليون', 'سكستليون', 'سبتيليون']

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: arabic-wordify
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- MAVEN
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-08-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Arabic-Wordify is a Ruby gem designed to convert Arabic numbers (integers)
+  into their word equivalents in Arabic, supporting numbers from zero up to a septillion.
+email: qppn@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/Arabic-Wordify.rb
+- lib/ArabicWordify/arabic_number_words.rb
+- lib/ArabicWordify/error.rb
+- lib/ArabicWordify/units.rb
+homepage: https://github.com/Abo5/arabic-wordify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Abo5/arabic-wordify
+  source_code_uri: https://github.com/Abo5/arabic-wordify
+  changelog_uri: https://github.com/Abo5/arabic-wordify/CHANGELOG.md
+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: []
+rubygems_version: 3.3.3
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that converts Arabic numbers into their word equivalents in Arabic.
+test_files: []