turkish_numeric 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29df8a76d18edcf7da4ba05ffb469626b89146760c7618aae45d517da61ebab5
-  data.tar.gz: b3907fe5ab989fc6899c3ed0211070ebfa591836c466a889fcb6b0795901d1be
+  metadata.gz: 271ea6e0a9ca641c53d182ea49ce3511a5815eb21d424c7cad97f538e2744e4c
+  data.tar.gz: 681cae2db83a633cd474c81d22d38473a0b0588a93d5fecf34ee2bd521123248
 SHA512:
-  metadata.gz: 2562228d34a67fa9dcff088ba07a3f7c6ccdf103e0d37516f19f2bc2c7e93fc6fac1437c4d6790d02d8d1d0f22025f75dc05e5a66ae7ee017c1683e1ed60508d
-  data.tar.gz: 45d6147d125729765de105534711d3fa3be3369e62246e263b3013e5cd6fa50b3314e76529d16d85950e57d18ef7c2df68228664ce11e26fa0fe8317576698f1
+  metadata.gz: 0e618195377ce4199f55020de3977e9e8170435c469dc57fb7093373e62538c751a9974d587dea20e46762caa5cebf3c21930bd9c38fa4b4d9d7fb271afa8091
+  data.tar.gz: c9f2553ec242b3494c745701f4aec6512be7b27b57c24fa1e60ab3b493929ccdd57b16f2f526c2f673fb527a40b9f9b56d7d5bfd9c1c6a261b7febedfce5e85b

data/.gitignore

@@ -1,3 +1,4 @@
+*.gem
 /.bundle/
 /.yardoc
 /_yardoc/

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.7.0
+  NewCops: enable
 
 Style/StringLiterals:
   Enabled: true
@@ -21,3 +22,4 @@ Style/MixinUsage:
 Metrics/BlockLength:
   Exclude:
     - 'spec/*'
+

data/.travis.yml

@@ -3,4 +3,4 @@ language: ruby
 cache: bundler
 rvm:
   - 2.7.0
-before_install: gem install bundler -v 2.2.5
+before_install: gem install bundler -v 2.2.8

data/Gemfile

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 source 'https://rubygems.org'
-
-# Specify your gem's dependencies in turkish_numeric.gemspec
 gemspec
 
 gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    turkish_numeric (0.0.1)
+    turkish_numeric (0.1.0)
 
 GEM
   remote: https://rubygems.org/
@@ -49,6 +49,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0)
@@ -59,4 +60,4 @@ DEPENDENCIES
   turkish_numeric!
 
 BUNDLED WITH
-   2.2.5
+   2.2.8

data/README.md

@@ -1,11 +1,6 @@
-# TurkishNumeric
+# TurkishNumeric [![Gem Version](https://badge.fury.io/rb/turkish_numeric.svg)](https://badge.fury.io/rb/turkish_numeric)   [![Build Status](https://travis-ci.com/sbagdat/turkish_numeric.svg?branch=main)](https://travis-ci.com/sbagdat/turkish_numeric)  [![Code Climate](https://codeclimate.com/github/sbagdat/turkish_numeric/badges/gpa.svg)](https://codeclimate.com/github/sbagdat/turkish_numeric) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-[![Gem Version](https://badge.fury.io/rb/turkish_numeric.svg)](https://badge.fury.io/rb/turkish_numeric)
-[![Build Status](https://travis-ci.com/sbagdat/turkish_numeric.svg?branch=main)](https://travis-ci.com/sbagdat/turkish_numeric)
-[![Code Climate](https://codeclimate.com/github/sbagdat/turkish_numeric/badges/gpa.svg)](https://codeclimate.com/github/sbagdat/turkish_numeric)
-[![Coverage Status](https://coveralls.io/repos/github/sbagdat/turkish_numeric/badge.svg?branch=main)](https://coveralls.io/github/sbagdat/turkish_numeric?branch=main)
-
-Translate any numeric value into Turkish text.
+Translate any numeric value into Turkish text, currency notation and text representation of money.
 
 ## Installation
 
@@ -25,21 +20,75 @@ Or install it yourself as:
 
 ## Usage
 
-After the installation of the gem, you can use it as shown below:
+First, you should require the gem (if you are using rails you don't need to require).
 
 ```ruby
 require 'turkish_numeric'
+```
 
+If you like shorter code lines you can include the module and can use `TrNum(numeric_value)` utility method. 
+Otherwise you should use `TurkishNumeric::TrNum.new(numeric_value)` or `TurkishNumeric.TrNum(numeric_value)`.
+At the examples below, shorter version is used.
+
+```ruby
 include TurkishNumeric
+```
+
+### Translating integer numbers
 
-# Translating integers
+```ruby
+TrNum(0).to_text          # => "sıfır"
 TrNum(34_430_002).to_text # => "otuz dört milyon dört yüz otuz bin iki"
+TrNum(-999999).to_text    # => "eksi dokuz yüz doksan dokuz bin dokuz yüz doksan dokuz"
+```
+
+You can translate any integer value from **-999 * 10<sup>63</sup>** to **999 * 10<sup>63</sup>**.
+
+```ruby
+TrNum(999_000_000_999_000_000_000_000_000_000_000_000_000_000_009_900_000_000_000_000_000_000).to_text
+# => "dokuz yüz doksan dokuz vigintilyon dokuz yüz doksan dokuz septendesilyon dokuz sekstilyon dokuz yüz kentilyon"
+```
+
+### Translating floating point numbers
+
+```ruby
+TrNum(1234.00001).to_text    # => "bin iki yüz otuz dört tam yüz binde bir"
+TrNum(34_430_002.45).to_text # => "otuz dört milyon dört yüz otuz bin iki yüzde kırk beş"
+TrNum(12.00120012).to_text   # => "on iki tam yüz milyonda yüz yirmi bin on iki"
+TrNum(0.9999999999999999).to_text 
+# => "sıfır tam on katrilyonda dokuz katrilyon dokuz yüz doksan dokuz trilyon dokuz yüz doksan dokuz
+#     milyar dokuz yüz doksan dokuz milyon dokuz yüz doksan dokuz bin dokuz yüz doksan dokuz"
+```
+
+### Translating as money
+
+```ruby
+TrNum(12.34).to_money    # => "₺12,34"
+TrNum(120.34).to_money   # => "₺0,34"
+TrNum(343_211_122_332.45).to_money   # => "₺343.211.122.332,45"
+```
+
+Custom currency symbol, thousand seperator, and penny seperator are also supported.
 
-# Translating floats
-TrNum(1234.00001).to_text # => "bin iki yüz otuz dört tam yüz binde bir"
+```ruby
+TrNum(12_332.45).to_money(symbol: '€', 
+                          thousand_sep: ',', 
+                          penny_sep: '.') 
+# => "€12,332.45"
 ```
 
-For more examples look at teh test files [here](spec/tr_num_spec.rb)
+### Translating as money text 
+
+```ruby
+TrNum(234.05).to_money_text       # => "ikiyüzotuzdörtTL,beşkr"
+TrNum(600_000.125).to_money_text  # => "altıyüzbinTL,onikikr"
+```
+
+Custom currency and sub currency are also supported.
+```ruby
+TrNum(234.45).to_money_text(currency: 'USD', sub_currency: 'sent')
+# => 'ikiyüzotuzdörtUSD,kırkbeşsent'
+```
 
 ## Development
 

data/lib/turkish_numeric.rb

@@ -1,10 +1,17 @@
 # frozen_string_literal: true
 
 require_relative 'turkish_numeric/version'
+require_relative 'turkish_numeric/number_presenter'
 require_relative 'turkish_numeric/tr_num'
 
+# Responsible for converting numerical values into Turkish texts,
+# currency nototaion, or text representation of money.
 module TurkishNumeric
-  def TrNum(num)
+  # Helper to create TrNum objects quickly
+  #
+  # @param [Integer, Float] num
+  # @return [TurkishNumeric::TrNum]
+  def TrNum(num)  # rubocop:disable Naming/MethodName
     TrNum.new(num)
   end
 end

data/lib/turkish_numeric/number_presenter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module TurkishNumeric
+  # Responsible for providing helper methods to present numbers as text
+  module NumberPresenter
+    # Create thousand seperated representaion of numeric value
+    #
+    # @param [Integer] numeric
+    # @param [String] sep
+    # @return [String]
+    def thousands_separated(numeric, sep: '.')
+      numeric.digits.each_slice(3).map(&:join).join(sep).reverse
+    end
+
+    # Creates single spaced string representation of the argument
+    #
+    # @param [Array] parts
+    # @return [String]
+    def text_spaced(*parts)
+      parts.flatten.compact.join(' ')
+    end
+
+    # Creates non-spaced string representation of the argument
+    #
+    # @param [Array] parts
+    # @return [String]
+    def text_non_spaced(*parts)
+      parts.join
+    end
+
+    # Extracts pennies from the argument
+    #
+    # @param [Integer] numeric
+    # @return [Integer]
+    def to_pennies(numeric)
+      return numeric if numeric < 100
+
+      numeric.to_s[0, 2].to_i
+    end
+  end
+end

data/lib/turkish_numeric/tr_num.rb

@@ -5,40 +5,64 @@ module TurkishNumeric
     %w[_ bir iki üç dört beş altı yedi sekiz dokuz].freeze,
     %w[_ on yirmi otuz kırk elli altmış yetmiş seksen doksan].freeze
   ].freeze
-
   SUBFIX = %w[yüz bin milyon milyar trilyon katrilyon kentilyon sekstilyon septilyon oktilyon
-              nonilyon desilyon undesilyon dodesilyon trodesilyon katordesilyon kendesilyon seksdesilyon
-              septendesilyon oktodesilyon novemdesilyon vigintilyon].freeze
+              nonilyon desilyon undesilyon dodesilyon trodesilyon katordesilyon kendesilyon
+              seksdesilyon septendesilyon oktodesilyon novemdesilyon vigintilyon].freeze
 
+  # Represents a number in Turkish language
   class TrNum
+    include NumberPresenter
+
+    # A new instance of TrNum
+    #
+    # @param [Integer, Float] number
+    # @return [TurkishNumeric::TrNum]
     def initialize(number)
-      parse_sign(number)
-      parse_number_parts(number)
+      @sign = 'eksi' if number.negative?
+      @decimal = Integer(number.abs)
+      fraction_str = number.to_s.split('.')[1] || '0'
+      @fraction_size = fraction_str.size
+      @fraction = Integer(fraction_str, 10)
     end
 
-    def to_text(spaces: true)
-      text = translate_decimal_part
-      text += [fractional_prefix] + translate_fractional_part unless fraction.zero?
-      clean_text(text, spaces)
+    # Translate numeric value into Turkish text
+    #
+    # @return [String]
+    def to_text
+      decimal_part = translate_partition(decimal)
+      fractional_part = fraction.zero? ? nil : [fractional_prefix, translate_partition(fraction)]
+      text_spaced(sign, decimal_part, fractional_part)
     end
 
-    private
-
-    attr_accessor :sign, :decimal, :fraction, :fraction_size, :current_processing_part
-
-    def clean_text(text, spaces)
-      text = text.flatten.delete_if(&:empty?).join(' ').strip
-      spaces ? text.gsub(/\s+/, ' ') : text.gsub(' ', '').gsub('eksi', 'eksi ')
-      # TODO: Add test for non-spaced representation
+    # Translate numeric value into currency notation
+    #
+    # @param [String] symbol
+    # @param [String] thousand_sep
+    # @param [String] penny_sep
+    # @return [String]
+    def to_money(symbol: '₺', thousand_sep: '.', penny_sep: ',')
+      [symbol,
+       thousands_separated(decimal, sep: thousand_sep),
+       penny_sep,
+       to_pennies(fraction)].join
     end
 
-    def translate_fractional_part
-      translate_partition(fraction)
+    # Translate numeric value into text representaion of money
+    #
+    # @param [String] currency
+    # @param [String] sub_currency
+    # @return [String]
+    def to_money_text(currency: 'TL', sub_currency: 'kr')
+      pennies = to_pennies(fraction)
+      decimal_part = decimal.zero? ? nil : [translate_partition(decimal), currency, ',']
+      fractional_part = pennies&.zero? ? nil : [translate_partition(pennies), sub_currency]
+      text_non_spaced(sign, decimal_part, fractional_part)
     end
 
-    def translate_decimal_part
-      [sign] + translate_partition(decimal)
-    end
+    private
+
+    attr_reader :sign, :decimal, :fraction_size, :fraction
+    attr_accessor :current_processing_part
 
     def translate_partition(partition)
       self.current_processing_part = partition
@@ -47,29 +71,14 @@ module TurkishNumeric
       end.reverse
     end
 
-    def fractional_prefix
-      prefix = self.class.new(10**fraction_size).to_text
-      "tam #{prefix}#{prefix.end_with?('yüz', 'bin') ? 'de' : 'da'}".gsub('bir', '')
-    end
-
-    def parse_sign(number)
-      self.sign = number.negative? ? 'eksi' : ''
-    end
-
     def translate_triplet(triplet, tri_idx)
       triplet.map.with_index do |num, idx|
         digit = translate_digit(num, idx, triplet)
-        "#{digit}#{subfix(num, tri_idx * 3 + idx) unless triplet.all?(&:zero?)}"
+        subfix = triplet.all?(&:zero?) ? nil : subfix(num, tri_idx * 3 + idx)
+        [digit, subfix]
       end.reverse
     end
 
-    def parse_number_parts(number)
-      self.decimal = Integer(number.abs)
-      fraction_str = number.to_s.split('.')[1] || '0'
-      self.fraction_size = fraction_str.size
-      self.fraction = Integer(fraction_str)
-    end
-
     def translate_digit(digit, pos, triplet)
       case digit
       when 0 then translate_zero
@@ -78,21 +87,26 @@ module TurkishNumeric
       end
     end
 
+    def fractional_prefix
+      prefix = self.class.new(10**fraction_size).to_text.gsub('bir', '').lstrip
+      "tam #{prefix}#{prefix.end_with?('yüz', 'bin') ? 'de' : 'da'}"
+    end
+
     def translate_zero
-      current_processing_part.to_s.size == 1 ? 'sıfır' : ''
+      current_processing_part.to_s.size == 1 ? 'sıfır' : nil
     end
 
     def translate_one(digit, pos, triplet)
-      return '' if triplet.size == 1 && current_processing_part.to_s.size == 4
+      return nil if triplet.size == 1 && current_processing_part.to_s.size == 4
 
-      0.step(66, 3).include?(pos) || pos % 3 == 1 ? MAPPINGS[pos % 2][digit] : ''
+      0.step(66, 3).include?(pos) || pos % 3 == 1 ? MAPPINGS[pos % 2][digit] : nil
     end
 
     def subfix(digit, pos)
       sub_pos = pos % 3
-      return " #{SUBFIX[0]}" if sub_pos == 2 && !digit.zero?
+      return SUBFIX[0] if sub_pos == 2 && !digit.zero?
 
-      pos >= 3 && sub_pos.zero? ? " #{SUBFIX[pos / 3]}" : ''
+      pos >= 3 && sub_pos.zero? ? SUBFIX[pos / 3] : nil
     end
   end
 end

data/lib/turkish_numeric/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurkishNumeric
-  VERSION = '0.0.1'
+  VERSION = '0.1.0'
 end

data/spec/tr_num_spec.rb

@@ -49,8 +49,10 @@ RSpec.describe TurkishNumeric do
     { 0.5 => 'sıfır tam onda beş',
       0.555 => 'sıfır tam binde beş yüz elli beş',
       3.14 => 'üç tam yüzde on dört',
+      12.0012 => 'on iki tam on binde on iki',
       1234.00001 => 'bin iki yüz otuz dört tam yüz binde bir',
-      213_321_323.321232 => 'iki yüz on üç milyon üç yüz yirmi bir bin üç yüz yirmi üç tam milyonda üç yüz yirmi bir bin iki yüz otuz iki' }.freeze
+      213_321_323.321232 => 'iki yüz on üç milyon üç yüz yirmi bir bin üç yüz yirmi üç tam milyonda üç yüz yirmi bir bin iki yüz otuz iki',
+      0.9999999999999999 => 'sıfır tam on katrilyonda dokuz katrilyon dokuz yüz doksan dokuz trilyon dokuz yüz doksan dokuz milyar dokuz yüz doksan dokuz milyon dokuz yüz doksan dokuz bin dokuz yüz doksan dokuz' }.freeze
   end
 
   context 'parsing parts' do
@@ -70,19 +72,50 @@ RSpec.describe TurkishNumeric do
     end
   end
 
-  context 'translates integer numbers into text' do
-    it 'works for samples' do
-      sample_integers.each do |num, text|
-        expect(TrNum.new(num).to_text).to eq text
+  context '#to_text' do
+    context 'translates integer numbers into text' do
+      it 'works for samples' do
+        sample_integers.each do |num, text|
+          expect(TrNum.new(num).to_text).to eq text
+        end
       end
     end
-  end
 
-  context 'translates floating point numbers into text' do
-    it 'works for samples' do
-      sample_floats.each do |num, text|
-        expect(TrNum.new(num).to_text).to eq text
+    context 'translates floating point numbers into text' do
+      it 'works for samples' do
+        sample_floats.each do |num, text|
+          expect(TrNum.new(num).to_text).to eq text
+        end
       end
     end
   end
+
+  context '#to_money' do
+    it 'converts numerical format as currency' do
+      expect(TrNum(234.45).to_money).to eq '₺234,45'
+      expect(TrNum(0.115).to_money).to eq '₺0,11'
+    end
+
+    it 'uses thousand seperators' do
+      expect(TrNum(12_332.45).to_money).to eq '₺12.332,45'
+      expect(TrNum(343_211_122_332.45).to_money).to eq '₺343.211.122.332,45'
+    end
+
+    it 'works with custom symbol and seperators' do
+      expect(TrNum(12_332.45).to_money(symbol: '€', thousand_sep: ',', penny_sep: '.')).to eq '€12,332.45'
+    end
+  end
+
+  context '#to_money_text' do
+    it 'translates money to turkish lira' do
+      expect(TrNum(234.45).to_money_text).to eq 'ikiyüzotuzdörtTL,kırkbeşkr'
+      expect(TrNum(234.05).to_money_text).to eq 'ikiyüzotuzdörtTL,beşkr'
+      expect(TrNum(600_000.125).to_money_text).to eq 'altıyüzbinTL,onikikr'
+      expect(TrNum(0.15).to_money_text).to eq 'onbeşkr'
+    end
+
+    it 'translates money to custom currency' do
+      expect(TrNum(234.45).to_money_text(currency: 'USD', sub_currency: 'sent')).to eq 'ikiyüzotuzdörtUSD,kırkbeşsent'
+    end
+  end
 end

data/turkish_numeric.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['sbagdat@gmail.com']
 
   spec.summary       = 'Translate any numeric value into Turkish text.'
-  spec.description   = 'Translate any numeric value into Turkish text.'
+  spec.description   = 'Translate any numeric value into Turkish text, currency notation, or text representation of money.'
   spec.homepage      = 'https://github.com/sbagdat/turkish_numeric'
   spec.license       = 'MIT'
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: turkish_numeric
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Sıtkı Bağdat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-06 00:00:00.000000000 Z
 dependencies: []
-description: Translate any numeric value into Turkish text.
+description: Translate any numeric value into Turkish text, currency notation, or
+  text representation of money.
 email:
 - sbagdat@gmail.com
 executables:
@@ -20,12 +21,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".idea/.gitignore"
-- ".idea/inspectionProfiles/Project_Default.xml"
-- ".idea/modules.xml"
-- ".idea/redis-manager-config.xml"
-- ".idea/turkish_numeric.iml"
-- ".idea/vcs.xml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -39,6 +34,7 @@ files:
 - bin/console
 - bin/setup
 - lib/turkish_numeric.rb
+- lib/turkish_numeric/number_presenter.rb
 - lib/turkish_numeric/tr_num.rb
 - lib/turkish_numeric/version.rb
 - spec/spec_helper.rb
@@ -64,7 +60,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.2.8
 signing_key: 
 specification_version: 4
 summary: Translate any numeric value into Turkish text.