currency_to_words 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YmY4ZjNjNWQwYTg2MjAxMzg0MWY4M2U1ZTg5ZWE2YjhhZDcxMzIzYg==
+  data.tar.gz: !binary |-
+    NGFkZjIwZmNkNzU4YTA5OTBlMGI1MGJmNTdmOWQ4Y2EwNmJhNTY5OQ==
+SHA512:
+  metadata.gz: !binary |-
+    ZGYwM2E4YmJiNWZiNGMzOTk2OTI4NmJiNGM4MmI1MzhmZTNiMjE5N2U3M2Ey
+    Zjk2Zjk3NjUxYmQzNjc5Njg3YTAyYTliM2IzMWEzNGZhMmQwZGViODAwZWUz
+    NmZiMjdjYmRlMDZkZDYzMGQyOWM2N2RlMWNkODdiZmM5ZTRmZGY=
+  data.tar.gz: !binary |-
+    NDg2MDJlMjQ5MjYxNTg5Y2Q2YWI2ZDBiM2YwOTA3MjI2ZjEzOWMxOWNiMDE0
+    NGM1OTUxNDViYTdiOGIwOTkwZWViNWQwYmQzZTE4NWFlYjM1NTAwMjY1YTQz
+    NThiZmIyNDVhNmRmMGU4ZDNmMjAzNWVkYzdhZGFkOTg0OGViNTA=

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jakub Malina
+
+THIS GEM LIBRARY IS MODIFICATION OF CURRENCY IN WORDS GEM BY BRUNO CARRERE.
+
+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.rdoc

@@ -0,0 +1,93 @@
+= Gem currency_to_words
+
+Provides a view helper for Rails that translate a currency amount to words (eg. <tt>to_words(200)</tt> \=> 'dvě stě').
+
+This helper comes with two supported locales (Czech and Polish) but it is possible and easy to implement your own (see "Implementing a new locale").
+
+== Installation
+
+Add the gem to your Gemfile.
+
+  gem 'currency_to_words'
+
+== Usage
+
+Install gem and create locale file in your project where you want to provide translation from currency to words. You can use locale file from I18n files below section or create your own.
+
+== Examples
+
+In your views write for example:
+  currency_to_words(235.58)
+
+== I18n files
+
+=== Czech locale
+  
+  cs:
+    number:
+      currency_in_words:
+        format: '%n'
+        options_precision:
+          precision: 2
+          delimiter: ''
+          significant: false
+          strip_insignificant_zeros: false
+          separator: '.'
+          raise: false
+        connector: ' a '
+        negative_format: '(%n)'
+        skip_and: true
+        ones: [nula, jedna, dvě, tři, čtyři, pět, šest, sedm, osm, devět]
+        teens: [deset, jedenáct, dvanáct, třináct, čtrnáct, patnáct, šestnáct, sedmnáct, osmnáct, devatenáct]
+        tens: [nil, nil,'dvacet','třicet','čtyřicet','padesát','šedesát','sedmdesát', 'osmdesát','devadesát']
+        hundreds: [sto, dvě stě, tři sta, čtyři sta, pět set, šest set, sedm set, osm set, devět set]
+        thousands_ones: [_, jeden, dva, tři, čtyři, pět, šest, sedm, osm, devět]
+        megs: [_, thousand, milion, bilion, trilion]
+        thousand:
+          one: 'tisíc'
+          few: 'tisíce'
+          other: 'tisíc'
+        milion:
+          one: 'milion'
+          few: 'miliony'
+          other: 'milionů'
+        bilion:
+          one: 'bilion'
+          few: 'biliony'
+          other: 'bilionů'
+        trilion:
+          one: 'trilion'
+          few: 'triliony'
+          other: 'trilionů'
+        currencies:
+          integer:
+            one: 'koruna'
+            few: 'koruny'
+            other: 'korun'
+          decimal:
+            one: 'haléř'
+            few: 'haléře'
+            other: 'haléřů'
+
+== Missing locale?
+
+If you need locale that is not supported yet, you can easily add one. All you need to do is translated locale file and create class in /lib. 
+Convention is that the class has to be named [locale]Currency. 
+
+So for example EnCurrency or FrCurrency. So override or duplicate the existing class and add diffrences of your language. Thats it!
+
+== Inspiration
+
+This project is heavily inspirated by {bcarrere/currency-in-words}[https://github.com/bcarrere/currency-in-words] and uses blocks of code from this repository.
+
+Reason for creating my own repository was requirement to use I18n gem for "currency to words" translation and also for settings.
+This means, that this gem can be configured from locale file and translation is not hardcoded to source of library.
+
+== Contribution
+
+Did you created locales that is not supported here yet? Please write me e-mail if you want contribute at majak108@gmail.com.
+
+== Copyright
+
+Copyright (c) 2014 Jakub Malina. See LICENSE.txt for
+further details.

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/cs_currency.rb

@@ -0,0 +1,94 @@
+# encoding: utf-8
+module CurrencyToWords
+
+  # This is the strategy class for Czech language
+  class CsCurrency
+
+    def process number_parts
+      # default values
+      @skip_and = false
+
+      # scopes for I18n
+      @scope = [:number, :currency_in_words]
+      @currency_scope = [:number, :currency_in_words, :currencies]
+
+      # split to integer and decimal parts
+      int_part, dec_part = number_parts.map(&:to_i)
+
+      # find suitable unit form
+      int_unit = (I18n.t :integer, scope: @currency_scope, count: int_part) # always use int unit
+      dec_unit = (I18n.t :decimal, scope: @currency_scope, count: dec_part) if dec_part > 0
+
+      # connector between words
+      connector = (I18n.t :connector, scope: @scope)
+
+      # skip constant
+      @skip_and = (I18n.t :skip_and, scope: @scope)
+
+      # load number forms
+      @ones = (I18n.t :ones, scope: @scope)
+      @teens = (I18n.t :teens, scope: @scope)
+      @tens = (I18n.t :tens, scope: @scope)
+      @hundreds = (I18n.t :hundreds, scope: @scope)
+      @megs = (I18n.t :megs, scope: @scope)
+      @thousand_ones = (I18n.t :thousands_ones, scope: @scope)
+
+      # iteration algorithm for integer and decimal part
+      processed_int_part = (processed_by_group(int_part).compact << int_unit).flatten.join(' ')
+      processed_dec_part = (processed_by_group(dec_part).compact << dec_unit).flatten.join(' ')
+
+      # if decimal part is not 0, connect it to integer part with connector
+      if dec_part.zero?
+        processed_int_part
+      else
+        processed_int_part << connector << processed_dec_part
+      end
+    end
+
+    private
+
+    def processed_by_group number, group=0
+      return [under_100(number, group)] if number.zero?
+
+      # q is modulo after dividing by 1000
+      # r is residue
+      q,r = number.divmod 1000
+
+      # if q is bigger than 0, iterate!
+      arr = processed_by_group(q, group+1) if q > 0
+
+      # return arr if r is 0
+      if r.zero?
+        arr
+      else
+        arr = arr.to_a
+        arr << under_1000(r, group)
+        group.zero? ? arr : arr << (I18n.t @megs[group], scope: @scope, count: number)
+        arr
+      end
+    end
+
+    # algorithm part for numbers under 1000
+    def under_1000 number, group
+      q,r = number.divmod 100
+      arr = []
+      arr << @hundreds[q-1] if q > 0
+      r.zero? ? arr : arr.to_a << under_100(r, group)
+      arr << (' a' unless @skip_and || r.zero?).to_s if q > 0
+      arr
+    end
+
+    # algorithm part for numbers under 100
+    def under_100 number, group
+      case number
+        # in czech is different between form for ones, tens, hundreds and thousands
+        when 0..9   then group.zero? ? @ones[number] : @thousand_ones[number]
+        when 10..19 then @teens[number - 10]
+        else
+          q,r = number.divmod 10
+          @tens[q] + (' ' + @ones[r] unless r.zero?).to_s
+      end
+    end
+  end
+
+end

data/lib/currency_to_words.rb

@@ -0,0 +1,95 @@
+# encoding: utf-8
+module CurrencyToWords
+
+  require 'cs_currency'
+
+  ActionView::Helpers::NumberHelper.class_eval do
+
+    def currency_to_words number, options = {}
+      # scopes
+      scope = [:number, :currency_in_words]
+      options_precision_scope = [:number, :currency_in_words, :options_precision]
+
+      # format of number
+      format = (I18n.t :format, scope: scope)
+
+      # options for precision to split int and decimal part
+      options_precision = {
+        :precision => (I18n.t :precision, scope: options_precision_scope),
+        :delimiter => (I18n.t :delimiter, scope: options_precision_scope),
+        :significant => (I18n.t :significant, scope: options_precision_scope),
+        :strip_insignificant_zeros => (I18n.t :strip_insignificant_zeros, scope: options_precision_scope),
+        :separator => (I18n.t :separator, scope: options_precision_scope),
+        :raise => (I18n.t :raise, scope: options_precision_scope)
+      }
+
+      # try to split number
+      begin
+        rounded_number = number_with_precision(number, options_precision)
+      rescue ActionView::Helpers::NumberHelper::InvalidNumberError => e
+        if options[:raise]
+          raise
+        else
+          rounded_number = format.gsub(/%n/, e.number)
+          return e.number.to_s.html_safe? ? rounded_number.html_safe : rounded_number
+        end
+      end
+
+      # try to find locale class with language algorithm
+      begin
+        klass = "CurrencyToWords::#{I18n.locale.to_s.capitalize}Currency".constantize
+      rescue NameError
+        if options[:raise]
+          raise NameError, "Implement a class #{options[:locale].to_s.capitalize}Currency to support this locale, please."
+        else
+          klass = CsCurrency
+        end
+      end
+
+      # map number parts
+      number_parts = rounded_number.split(options_precision[:separator]).map(&:to_i)
+
+      # Create instance of base class and try to process through.
+      base_class = CurrencyToWords::Currency.new(klass.new, number_parts, options)
+      processed_number = base_class.process
+
+      # return formatted number
+      format.gsub(/%n/, processed_number).html_safe
+    end
+  end
+
+  # Base class that will load language specific class with specific language algorithm.
+  class Currency
+    attr_reader :number_parts, :options, :texterizer
+
+    # constructor of Currency class
+    def initialize lang_class, splitted_number, options = {}
+      @lang_class   = lang_class
+      @number_parts = splitted_number
+      @options      = options
+    end
+
+    # Process and try to find language specific for current locale!
+    def process
+      if @lang_class.respond_to?('process')
+        processed_number = @lang_class.process @number_parts
+        if processed_number.is_a?(String)
+          return processed_number
+        else
+          raise TypeError, "a lang_class must return a String" if @options[:raise]
+        end
+      else
+        raise NoMethodError, "a lang_class must provide a 'lang_class' method" if @options[:raise]
+      end
+
+      # fallback on CsCurrency
+      unless @lang_class.instance_of?(CsCurrency)
+        @lang_class = CsCurrency.new
+        self.process
+      else
+        raise RuntimeError, "you should use the option ':raise => true' to see what goes wrong"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: currency_to_words
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jakub Malina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Rails 4 helper to_words that displays a currency amount in words (eg.
+  'one hundred dollars')
+email: majak108@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- VERSION
+- lib/cs_currency.rb
+- lib/currency_to_words.rb
+homepage: https://github.com/kuba108/currency_to_words
+licenses:
+- MIT
+metadata: {}
+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.4.1
+signing_key: 
+specification_version: 3
+summary: Rails 4 helper to_words that displays a currency amount in words (eg. 'one
+  hundred dollars')
+test_files: []