moneytize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 02fd4f54325cb10dd242d68fea3c73620a1960dc
+  data.tar.gz: 6b1903d2e77d011fb3427848e746971a8ca7d0d1
+SHA512:
+  metadata.gz: 6d1e63658bb7338f77df3714ad3f6e3eff04833ffebef406602e5d5eabbe10d931b454d805fee491858733963a18b091be99ae40db6679a1664c45eb4d7e10b1
+  data.tar.gz: ea02d22b1798eb24b18fb9bbcd4da0ab83c7de0d3ce41d3eb3110f7f1b837a34f1553dbd9d5a4c3442d0f896fc868408a842ac4d0a90aee1122bd323cdd1c599

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+*.gem
+.yardoc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rake', group: :test

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    moneytize (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (3.1.2)
+      columnize (~> 0.8)
+      debugger-linecache (~> 1.2)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 3.1.2)
+  moneytize!
+  rake

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jaime Andres
+
+MIT License
+
+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,20 @@
+# MONEYTIZE
+Did you ever have the requirement:
+> Can you format the value as currency with "," as decimal separator
+
+or
+
+> Can you display " ' " as millions separator
+
+It's not too hard to parse a numeric value to format it the way you want,
+but why would you like to repeat the same process every time you need to parse
+a numeric value as currency.
+
+*_THAT'S WHY MONEYTIZE EXISTS_*
+
+Just call it with the value to be formatted and the options you expect:
+```
+Moneytize::Currency.format(123456.9803, { currency_symbol: '$', decimal: ',' })
+```
+
+Check the [documentation](#) to see the options you have.

data/lib/moneytize.rb

@@ -0,0 +1,95 @@
+require 'version'
+
+# Moneytize is a simple formatter for currency, it allows to format any currency the way you like,
+# for example, you can decide to separate thousands with ',' and decimals with '.'.
+# Please consider that to avoid unnecessary complexity there are a few valid separators: ',', '.', ' ' and '¢'.
+# For millions separator you can only choose to use it or not, the separator to be used is "'"
+module Moneytize
+
+  # This class is in charge to format any numeric value to the expected currency format.
+  class Currency
+
+    # Converts any numeric value to a formatted string based on the conditions (separators) send
+    # to the method,
+    #
+    # The default values are:
+    # decimals:        '.'
+    # thousands:       ''
+    # millions:        false
+    # currency_symbol: ''
+    #
+    # @param value [Numeric] the value to be formatted
+    # @param options [Hash] collection of values to be used as separators:
+    #   { currency_symbol: '|$|USD|etc|', decimal: "|,|.| |¢|",
+    #     thoushands: "|,|.| |", millions: true|false }
+    #
+    # @return [String] the numeric value formatted to string
+    def self.format(value, options = {})
+      currency = Currency.new
+
+      currency.prepare_separators(options)
+      currency.format_currency_for(value)
+    end
+
+    # Prepare decimals, thousands and millions separators based on parameters passed and defaults
+    def prepare_separators(options)
+      fetch_separators(options)
+      validate_separators
+    end
+
+    # Formats numeric value to string based on separators previously setted
+    def format_currency_for(value)
+      currency = format('%0.2f', value).split('.')
+      currency[0] = thousands(millions(currency[0])).join(@millions).reverse!
+
+      @currency_symbol.concat(currency.join(@decimal))
+    end
+
+    private
+
+    def fetch_separators(options)
+      @currency_symbol = options.fetch(:currency_symbol, '')
+      @decimal = options.fetch(:decimal, '.')
+      @thousands = options.fetch(:thousands, '')
+      @millions = "'" if options[:millions]
+    end
+
+    def validate_separators
+      allowed_symbols = ['.', ',', ' ']
+
+      @decimal = '.' unless allowed_symbols.push('¢').include?(@decimal)
+      @thousands = '' unless allowed_symbols.include?(@thousands)
+
+      if @thousands == @decimal
+        @decimal = '.' if @thousands == ',' or @thousands == ' '
+        @decimal = ',' if @thousands == '.'
+      end
+    end
+
+    def millions(amount)
+      slice_amount(amount.reverse!, 6)
+    end
+
+    def thousands(amounts)
+      amounts = [amounts] if amounts.is_a?(String)
+
+      amounts.map! { |amount| slice_thousands(amount) }
+    end
+
+    def slice_thousands(amount)
+      thousand = slice_amount(amount, 3)
+      thousand.is_a?(String) ? thousand : thousand.join(@thousands)
+    end
+
+    def slice_amount(amount, unit_size)
+      return amount unless amount.size > unit_size
+
+      range = unit_size - 1
+      min_size = unit_size + 1
+
+      final_amount = []
+      final_amount << amount.slice!(0..range) until amount.size < min_size
+      final_amount << amount
+    end
+  end
+end

data/lib/version.rb

@@ -0,0 +1,3 @@
+module Moneytize
+  VERSION = '0.0.1'
+end

data/moneytize.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'moneytize'
+  gem.version = Moneytize::VERSION
+  gem.homepage = "http://moneytize.me"
+  gem.licenses = ["MIT"]
+  gem.authors = ['DiabloUrbano']
+  gem.email = ['andresdavila6@gmail.com']
+  gem.description = 'formats any numeric value to the expected currency format, choose dot, comma, space or even ¢ for cents. Just check it!'
+  gem.summary = 'format your currency the way you expect.'
+
+  gem.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.test_files = gem.files.grep(/^(tests|spec|features)/)
+  gem.require_paths = ['lib']
+
+  gem.has_rdoc = 'yard'
+
+  # ruby version
+  gem.required_ruby_version = '>= 1.9.3'
+
+  if RUBY_VERSION == '1.9.3'
+    gem.add_development_dependency 'debugger', '~> 1.6.6'
+  elsif RUBY_VERSION >= '2.0.0'
+    gem.add_development_dependency 'byebug', '~> 3.1.2'
+  end
+end

data/tests/tc_moneytize.rb

@@ -0,0 +1,74 @@
+require 'test/unit'
+require_relative '../lib/moneytize'
+
+class TestMoneytize < Test::Unit::TestCase
+  def test_format_without_decimals
+    currency = Moneytize::Currency.format(1025)
+    assert_equal('1025.00', currency)
+  end
+
+  def test_format_default
+    currency = Moneytize::Currency.format(1025.54)
+    assert_equal('1025.54', currency)
+  end
+
+  def test_format_with_different_symbol
+    currency = Moneytize::Currency.format(1025.54, currency_symbol: 'USD')
+    assert_equal('USD1025.54', currency)
+  end
+
+  def test_format_with_different_decimal_separator
+    currency = Moneytize::Currency.format(1025.54, decimal: ',')
+    assert_equal('1025,54', currency)
+  end
+
+  def test_format_with_different_decimal_separator
+    currency = Moneytize::Currency.format(1025.54, decimal: '¢', currency_symbol: '$')
+    assert_equal('$1025¢54', currency)
+  end
+
+  def test_format_with_different_thousand_separator
+    currency = Moneytize::Currency.format(1025.54, thousands: '.', currency_symbol: '$')
+    assert_equal('$1.025,54', currency)
+  end
+
+  def test_format_with_different_thousand_separator_comma
+    currency = Moneytize::Currency.format(1025.54, thousands: ',', decimal: ',', currency_symbol: '$')
+    assert_equal('$1,025.54', currency)
+  end
+
+  def test_format_with_different_thousand_separator_and_decimal_separator
+    currency = Moneytize::Currency.format(1025.54, decimal: ',', thousands: '.', currency_symbol: '$')
+    assert_equal('$1.025,54', currency)
+  end
+
+  def test_format_with_millions
+    currency = Moneytize::Currency.format(14578025.54823424, currency_symbol: '$')
+    assert_equal('$14578025.55', currency)
+  end
+
+  def test_format_with_millions_separator
+    currency = Moneytize::Currency.format(14578025.54823424, millions: true, currency_symbol: '$')
+    assert_equal("$14'578025.55", currency)
+  end
+
+  def test_format_with_millions_and_thousands_separator
+    currency = Moneytize::Currency.format(14578025.54823424, millions: true, thousands: '.', currency_symbol: '$')
+    assert_equal("$14'578.025,55", currency)
+  end
+
+  def test_billions_with_format_with_millions_and_thousands_separator
+    currency = Moneytize::Currency.format(14897456578025.54823424, millions: true, thousands: '.', currency_symbol: '$')
+    assert_equal("$14'897.456'578.025,55", currency)
+  end
+
+  def test_format_with_hundreds
+    currency = Moneytize::Currency.format(125.55, millions: true, thousands: '.', currency_symbol: '$')
+    assert_equal('$125,55', currency)
+  end
+
+  def test_it_should_allow_only_specific_separators_or_use_default_values
+    currency = Moneytize::Currency.format(12589080.78, millions: false, thousands: '*', decimal: '%', currency_symbol: '$')
+    assert_equal('$12589080.78', currency)
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: moneytize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- DiabloUrbano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+description: formats any numeric value to the expected currency format, choose dot,
+  comma, space or even ¢ for cents. Just check it!
+email:
+- andresdavila6@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- lib/moneytize.rb
+- lib/version.rb
+- moneytize.gemspec
+- tests/tc_moneytize.rb
+homepage: http://moneytize.me
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: format your currency the way you expect.
+test_files:
+- tests/tc_moneytize.rb
+has_rdoc: yard