monetize 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7f96f9f99c2fc04ab625a2977f370eff77d33696
-  data.tar.gz: 75817ce67a91ae35019f6ef3a3b290b937b64749
+  metadata.gz: f097cc5d74682b06292fd1f13a33f02b2f7559f0
+  data.tar.gz: fad265ffdc0fa112f1116ea78974b20c865719bf
 SHA512:
-  metadata.gz: 657c4f4be74370f9a8b2b1f4fcb91e60a013e9d2e01f39f95258a48c47710c5418767770af32ca61c19d52b0a94ccaa875fd3a4b7d8f21023ff7f4b036700c90
-  data.tar.gz: 4cb6265937f209b0797cc4c0d2e78b4fa27a9f27f9f045cfac8d00812dcb2ccb86072672897b7fb36f7337dab52cbb62c3e58739b9cdcdc9ec32b73393bedd9a
+  metadata.gz: 7a7bee5359f9c717b01434c2e95f7bb8a58116fd629971e04c44453a96d26e2a7a7bc1d7088873eba4628769ad2d79476bdf669199d02f19de6e51d7a211e456
+  data.tar.gz: c831f37f346f27ad1d44e6757c7afbc2ab845380c5fa5ca9874029f9a507f208d7401c32d5de9113a8667832035fd14fdd6c6294cb5185ac4713a2c79128e5ec

data/.travis.yml

@@ -1,8 +1,12 @@
+sudo: false
 language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.2
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
+  - jruby-9.0.5.0
 script: bundle exec rspec spec
 notifications:
   recipients:

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 1.5.0
+- Add extra currencies:
+  - Azerbaijani manat
+  - Chinese yuan
+  - Czech koruna
+  - Hungarian forint
+  - Indinan rupee
+  - Russian ruble
+  - Turkish Lira
+  - Ukrainian Hryvnia
+  - Swiss Frank
+  - Polish Zloty
+  - Kazakhstani Tenge
+- Parsing a Money object returns it unchanged
+- Fix issue with loosing precision on BigDecimal input
+- Add Swedish krona
+- Exclud ambiguous kr symbol from parsing
+- Fix JPY parsing
+- Sublcass all errors to Monetize::Error
+- Fix ruby 1.9.3 compatibility
+- Suppress errors when using parse. Use `parse!` instead
+- Strip currency symbol prefix when parsing input
+
+
 ## 1.4.0
 - Required Forwardable on Collection to resolve NameError [\#44](https://github.com/RubyMoney/monetize/issues/44)
 - Add capability to parse currency amounts given with suffixes (K, M, B, and T)
@@ -19,3 +43,5 @@
 - Reformat code to adapt to Rubocop guidelines
 - Add config setting to always enforce currency delimiters
 - Add rake console task
+- Fix issue where parsing a Money object resulted in a Money object with its currency set to `Money.default_currency`,
+  rather than the currency that it was sent in as.

data/Gemfile

@@ -2,4 +2,13 @@ source 'https://rubygems.org'
 
 gem 'coveralls', require: false
 
+# JSON gem no longer supports ruby < 2.0.0
+if defined?(JRUBY_VERSION)
+  gem 'json'
+elsif RUBY_VERSION =~ /^1/
+  gem 'json', '~> 1.8.3'
+  gem 'tins', '~> 1.6.0'
+  gem 'term-ansicolor', '~> 1.3.0'
+end
+
 gemspec

data/README.md

@@ -1,11 +1,11 @@
 # Monetize
 
-[![Gem Version](https://badge.fury.io/rb/monetize.png)](http://badge.fury.io/rb/monetize)
-[![Build Status](https://travis-ci.org/RubyMoney/monetize.png?branch=master)](https://travis-ci.org/RubyMoney/monetize)
-[![Code Climate](https://codeclimate.com/github/RubyMoney/monetize.png)](https://codeclimate.com/github/RubyMoney/monetize)
-[![Coverage Status](https://coveralls.io/repos/RubyMoney/monetize/badge.png)](https://coveralls.io/r/RubyMoney/monetize)
-[![Dependency Status](https://gemnasium.com/RubyMoney/monetize.png)](https://gemnasium.com/RubyMoney/monetize)
-[![License](http://img.shields.io/license/MIT.png?color=green)](http://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/monetize.svg)](http://badge.fury.io/rb/monetize)
+[![Build Status](https://travis-ci.org/RubyMoney/monetize.svg?branch=master)](https://travis-ci.org/RubyMoney/monetize)
+[![Code Climate](https://codeclimate.com/github/RubyMoney/monetize.svg)](https://codeclimate.com/github/RubyMoney/monetize)
+[![Coverage Status](https://coveralls.io/repos/RubyMoney/monetize/badge.svg)](https://coveralls.io/r/RubyMoney/monetize)
+[![Dependency Status](https://gemnasium.com/RubyMoney/monetize.svg)](https://gemnasium.com/RubyMoney/monetize)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 
 A library for converting various objects into `Money` objects.
 
@@ -33,6 +33,16 @@ Monetize.parse("GBP 100") == Money.new(100_00, "GBP")
 "100".to_money == Money.new(100_00, "USD")
 ```
 
+`parse` will return `nil` if it is unable to parse the input. Use `parse!` instead if you want a `Monetize::Error` (or one of the subclasses) to be raised instead:
+
+```ruby
+>> Monetize.parse('OMG 100')
+=> nil
+
+>> Monetize.parse!('OMG 100')
+Monetize::ParseError: Unknown currency 'omg'
+```
+
 Optionally, enable the ability to assume the currency from a passed symbol. Otherwise, currency symbols will be ignored, and USD used as the default currency:
 
 ```ruby

data/lib/monetize.rb

@@ -2,6 +2,7 @@
 
 require 'money'
 require 'monetize/core_extensions'
+require 'monetize/errors'
 require 'monetize/version'
 require 'collection'
 
@@ -14,7 +15,18 @@ module Monetize
     'R$'   => 'BRL',
     'R'    => 'ZAR',
     '¥'    => 'JPY',
-    'C$'   => 'CAD'
+    'C$'   => 'CAD',
+    '₼'    => 'AZN',
+    '元'   => 'CNY',
+    'Kč'   => 'CZK',
+    'Ft'   => 'HUF',
+    '₹'    => 'INR',
+    '₽'    => 'RUB',
+    '₺'    => 'TRY',
+    '₴'    => 'UAH',
+    'Fr'   => 'CHF',
+    'zł'   => 'PLN',
+    '₸'    => 'KZT',
   }
 
   MULTIPLIER_SUFFIXES = {
@@ -40,6 +52,15 @@ module Monetize
   end
 
   def self.parse(input, currency = Money.default_currency, options = {})
+    parse! input, currency, options
+  rescue Error
+    nil
+  end
+
+  def self.parse!(input, currency = Money.default_currency, options = {})
+    return input if input.is_a?(Money)
+    return from_numeric(input, currency) if input.is_a?(Numeric)
+
     input = input.to_s.strip
 
     computed_currency = if options.fetch(:assume_from_symbol) { assume_from_symbol }
@@ -53,6 +74,8 @@ module Monetize
 
     fractional = extract_cents(input, currency)
     Money.new(fractional, currency)
+  rescue Money::Currency::UnknownCurrency => e
+    fail ParseError, e.message
   end
 
   def self.parse_collection(input, currency = Money.default_currency, options = {})
@@ -97,7 +120,7 @@ module Monetize
   def self.extract_cents(input, currency = Money.default_currency)
     multiplier_exp, input = extract_multiplier(input)
 
-    num = input.gsub(/[^\d.,'-]/, '')
+    num = input.gsub(/(?:^#{currency.symbol}|[^\d.,'-]+)/, '')
 
     negative, num = extract_sign(num)
 
@@ -105,9 +128,9 @@ module Monetize
 
     major, minor = extract_major_minor(num, currency)
 
-    cents = major.to_i * currency.subunit_to_unit
+    major, minor = apply_multiplier(multiplier_exp, major.to_i, minor)
 
-    cents, minor = apply_multiplier(multiplier_exp, cents, minor)
+    cents = major.to_i * currency.subunit_to_unit
 
     cents += set_minor_precision(minor, currency)
 
@@ -116,13 +139,13 @@ module Monetize
 
   private
 
-  def self.apply_multiplier(multiplier_exp, cents, minor)
-    cents *= (10**multiplier_exp)
+  def self.apply_multiplier(multiplier_exp, major, minor)
+    major *= 10**multiplier_exp
     minor = minor.to_s + ('0' * multiplier_exp)
-    shift = minor[0...multiplier_exp].to_i * 100
-    cents += shift
+    shift = minor[0...multiplier_exp].to_i
+    major += shift
     minor = (minor[multiplier_exp..-1] || '')
-    [cents, minor]
+    [major, minor]
   end
 
   def self.apply_sign(negative, cents)
@@ -154,7 +177,7 @@ module Monetize
     when 1
       extract_major_minor_with_single_delimiter(num, currency, used_delimiters.first)
     else
-      fail ArgumentError, 'Invalid currency amount'
+      fail ParseError, 'Invalid amount'
     end
   end
 
@@ -195,7 +218,7 @@ module Monetize
 
   def self.extract_sign(input)
     result = (input =~ /^-+(.*)$/ or input =~ /^(.*)-+$/) ? [true, $1] : [false, input]
-    fail ArgumentError, 'Invalid currency amount (hyphen)' if result[1].include?('-')
+    fail ParseError, 'Invalid amount (hyphen)' if result[1].include?('-')
     result
   end
 

data/lib/monetize/core_extensions/string.rb

@@ -2,7 +2,7 @@
 
 class String
   def to_money(currency = nil)
-    Monetize.parse(self, currency)
+    Monetize.parse!(self, currency)
   end
 
   def to_currency

data/lib/monetize/errors.rb

@@ -0,0 +1,6 @@
+module Monetize
+  class Error < StandardError; end
+
+  class ParseError < Error; end
+  class ArgumentError < Error; end
+end

data/lib/monetize/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 
 module Monetize
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/monetize.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec', '~> 3.0.0.beta1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/monetize_spec.rb

@@ -56,76 +56,69 @@ describe Monetize do
           Monetize.assume_from_symbol = false
         end
 
-        it 'parses formatted inputs with Euros passed as a symbol' do
-          expect(Monetize.parse('€5.95')).to eq Money.new(595, 'EUR')
-        end
-
-        it 'parses formatted inputs with Euros passed as a symbol with surrounding space' do
-          expect(Monetize.parse(' €5.95 ')).to eq Money.new(595, 'EUR')
-        end
-
-        it 'parses formatted inputs with British Pounds Sterling passed as a symbol' do
-          expect(Monetize.parse('£9.99')).to eq Money.new(999, 'GBP')
-        end
-
-        it 'parses formatted inputs with British Pounds Sterling passed as a lira sign symbol' do
-          expect(Monetize.parse('₤9.99')).to eq Money.new(999, 'GBP')
-        end
-
-        it 'parses formatted inputs with South African Rand passed as a symbol' do
-          expect(Monetize.parse('R9.99')).to eq Money.new(999, 'ZAR')
-        end
-
-        it 'parses formatted inputs with Brazilian real passed as a symbol' do
-          expect(Monetize.parse('R$R9.99')).to eq Money.new(999, 'BRL')
-        end
-
-        it 'parses formatted inputs with Japanese Yen passed as a symbol' do
-          expect(Monetize.parse('¥999')).to eq Money.new(999, 'JPY')
-        end
-
-        it 'parses formatted inputs with Canadian Dollar passed as a symbol' do
-          expect(Monetize.parse('C$9.99')).to eq Money.new(999, 'CAD')
+        Monetize::CURRENCY_SYMBOLS.each_pair do |symbol, iso_code|
+          context iso_code do
+            let(:currency) { Money::Currency.find(iso_code) }
+            let(:amount) { 5_95 }
+            let(:amount_in_units) { amount.to_f / currency.subunit_to_unit }
+
+            it 'ensures correct amount calculations for test' do
+              expect(amount_in_units * currency.subunit_to_unit).to eq(amount)
+            end
+
+            it "parses formatted inputs with #{iso_code} passed as a symbol" do
+              expect(Monetize.parse("#{symbol}#{amount_in_units}")).to eq Money.new(amount, iso_code)
+            end
+
+            context 'prefix' do
+              it 'parses formatted inputs with plus sign and currency as a symbol' do
+                expect(Monetize.parse("+#{symbol}#{amount_in_units}")).to eq Money.new(amount, iso_code)
+              end
+
+              it 'parses formatted inputs with minus sign and currency as a symbol' do
+                expect(Monetize.parse("-#{symbol}#{amount_in_units}")).to eq Money.new(-amount, iso_code)
+              end
+            end
+
+            context 'postfix' do
+              it 'parses formatted inputs with currency symbol and postfix minus sign' do
+                expect(Monetize.parse("#{symbol}#{amount_in_units}-")).to eq Money.new(-amount, iso_code)
+              end
+
+              it 'parses formatted inputs with currency symbol and postfix plus sign' do
+                expect(Monetize.parse("#{symbol}#{amount_in_units}+")).to eq Money.new(amount, iso_code)
+              end
+            end
+
+            context 'amount suffixes' do
+              it 'parses formatted inputs with amounts given with suffixes' do
+                expect(Monetize.parse("#{symbol}1.26K")).to eq Money.new(1_260 * currency.subunit_to_unit, iso_code)
+                expect(Monetize.parse("#{symbol}126.36M")).to eq Money.new(126_360_000 * currency.subunit_to_unit, iso_code)
+                expect(Monetize.parse("#{symbol}.45B")).to eq Money.new(450_000_000 * currency.subunit_to_unit, iso_code)
+                expect(Monetize.parse("-#{symbol}2.45B")).to eq Money.new(-2_450_000_000 * currency.subunit_to_unit, iso_code)
+                expect(Monetize.parse("#{symbol}1.65T")).to eq Money.new(1_650_000_000_000 * currency.subunit_to_unit, iso_code)
+              end
+            end
+
+            it 'parses formatted inputs with symbol and surrounding spaces' do
+              expect(Monetize.parse(" #{symbol}#{amount_in_units} ")).to eq Money.new(amount, iso_code)
+            end
+
+            it 'parses formatted inputs without currency detection when overridden' do
+              expect(Monetize.parse("#{symbol}5.95", nil, assume_from_symbol: false)).to eq Money.new(amount, 'USD')
+            end
+          end
         end
 
         it 'should assume default currency if not a recognised symbol' do
           expect(Monetize.parse('L9.99')).to eq Money.new(999, 'USD')
         end
 
-        it 'parses formatted inputs without currency detection when overridden' do
-          expect(Monetize.parse('£9.99', nil, assume_from_symbol: false)).to eq Money.new(999, 'USD')
-        end
-
-        it 'parses formatted inputs with minus sign and currency symbol' do
-          expect(Monetize.parse('-€9.99')).to eq Money.new(-999, 'EUR')
-          expect(Monetize.parse('-£9.99')).to eq Money.new(-999, 'GBP')
-          expect(Monetize.parse('-R$R9.99')).to eq Money.new(-999, 'BRL')
-          expect(Monetize.parse('-¥999')).to eq Money.new(-999, 'JPY')
-          expect(Monetize.parse('-C$9.99')).to eq Money.new(-999, 'CAD')
-        end
-
-        it 'parses formatted inputs with plus and GBP passed as symbol' do
-          expect(Monetize.parse('+€9.99')).to eq Money.new(999, 'EUR')
-          expect(Monetize.parse('+£9.99')).to eq Money.new(999, 'GBP')
-          expect(Monetize.parse('+R$R9.99')).to eq Money.new(999, 'BRL')
-          expect(Monetize.parse('+¥999')).to eq Money.new(999, 'JPY')
-          expect(Monetize.parse('+C$9.99')).to eq Money.new(999, 'CAD')
-        end
-
-        it 'parses formatted inputs with currency symbol and postfix minus sign' do
-          expect(Monetize.parse('€9.99-')).to eq Money.new(-999, 'EUR')
-        end
-
-        it 'parses formatted inputs with currency symbol and postfix plus sign' do
-          expect(Monetize.parse('€9.99+')).to eq Money.new(999, 'EUR')
-        end
-
-        it 'parses formatted inputs with amounts given with suffixes' do
-          expect(Monetize.parse('$1.26K')).to eq Money.new(1_260_00, 'USD')
-          expect(Monetize.parse('$126.36M')).to eq Money.new(126_360_000_00, 'USD')
-          expect(Monetize.parse('€.45B')).to eq Money.new(450_000_000_00, 'EUR')
-          expect(Monetize.parse('-$2.45B')).to eq Money.new(-2_450_000_000_00, 'USD')
-          expect(Monetize.parse('€1.65T')).to eq Money.new(1_650_000_000_000_00, 'EUR')
+        context 'negatives' do
+          it 'ignores the ambiguous kr symbol' do
+            # Could mean either of DKK, EEK, ISK, NOK, SEK
+            expect(Monetize.parse('kr9.99')).to eq Money.new(999, 'USD')
+          end
         end
       end
 
@@ -158,6 +151,18 @@ describe Monetize do
       it 'should opt out by default' do
         expect(Monetize.assume_from_symbol).to be_falsy
       end
+
+      context 'ISO code' do
+        it 'parses currency given as ISO code' do
+          expect('20.00 USD'.to_money).to eq Money.new(20_00, 'USD')
+          expect('20.00 EUR'.to_money).to eq Money.new(20_00, 'EUR')
+          expect('20.00 GBP'.to_money).to eq Money.new(20_00, 'GBP')
+        end
+
+        it 'raises an error if currency code is invalid' do
+          expect { '20.00 OMG'.to_money }.to raise_error Monetize::ParseError
+        end
+      end
     end
 
     it 'parses USD-formatted inputs under $10' do
@@ -177,10 +182,16 @@ describe Monetize do
       expect(Monetize.parse('1,111,234,567.89')).to eq Money.new(1_111_234_567_89, 'USD')
     end
 
-    it 'does not return a price if there is a price range' do
-      expect { Monetize.parse('$5.95-10.95') }.to raise_error ArgumentError
-      expect { Monetize.parse('$5.95 - 10.95') }.to raise_error ArgumentError
-      expect { Monetize.parse('$5.95 - $10.95') }.to raise_error ArgumentError
+    it 'parses DKK-formatted inputs' do
+      expect(Monetize.parse('kr.123,45', 'DKK')).to eq Money.new(123_45, 'DKK')
+      expect(Monetize.parse('kr.123.45', 'DKK')).to eq Money.new(123_45, 'DKK')
+      expect(Monetize.parse('kr.45k', 'DKK')).to eq Money.new(45_000_00, 'DKK')
+    end
+
+    it 'returns nil if input is a price range' do
+      expect(Monetize.parse('$5.95-10.95')).to be_nil
+      expect(Monetize.parse('$5.95 - 10.95')).to be_nil
+      expect(Monetize.parse('$5.95 - $10.95')).to be_nil
     end
 
     it 'does not return a price for completely invalid input' do
@@ -197,8 +208,8 @@ describe Monetize do
       expect(Monetize.parse('$5.95-')).to eq five_ninety_five
     end
 
-    it 'raises ArgumentError when unable to detect polarity' do
-      expect { Monetize.parse('-$5.95-') }.to raise_error ArgumentError
+    it 'returns nil when unable to detect polarity' do
+      expect(Monetize.parse('-$5.95-')).to be_nil
     end
 
     it 'parses correctly strings with exactly 3 decimal digits' do
@@ -210,6 +221,32 @@ describe Monetize do
       Monetize.enforce_currency_delimiters = false
     end
 
+    context 'Money object attempting to be parsed' do
+      let(:money) { Money.new(595, 'GBP') }
+
+      it 'returns the original Money object' do
+        expect(Monetize.parse(money)).to eq money
+        expect(Monetize.parse(money).currency).to eq 'GBP'
+        expect(Monetize.parse(money).cents).to eq 595
+      end
+    end
+
+    context 'parsing an instance of Numeric class' do
+      let(:fixnum)      { 10 }
+      let(:float)       { 10.0 }
+      let(:big_decimal) { BigDecimal.new('10') }
+
+      [:fixnum, :float, :big_decimal].each do |type|
+        it "returns a new Money object based on the #{type} input" do
+          money = Monetize.parse(send(type), 'USD')
+
+          expect(money).to be_instance_of(Money)
+          expect(money.currency).to eq('USD')
+          expect(money.cents).to eq(10_00)
+        end
+      end
+    end
+
     context 'custom currencies with 4 decimal places' do
       before :each do
         Money::Currency.register(JSON.parse(bar, symbolize_names: true))
@@ -265,6 +302,18 @@ describe Monetize do
     end
   end
 
+  describe '.parse!' do
+    it 'does not return a price if there is a price range' do
+      expect { Monetize.parse!('$5.95-10.95') }.to raise_error Monetize::ParseError
+      expect { Monetize.parse!('$5.95 - 10.95') }.to raise_error Monetize::ParseError
+      expect { Monetize.parse!('$5.95 - $10.95') }.to raise_error Monetize::ParseError
+    end
+
+    it 'raises ArgumentError when unable to detect polarity' do
+      expect { Monetize.parse!('-$5.95-') }.to raise_error Monetize::ParseError
+    end
+  end
+
   describe '.parse_collection' do
     it 'parses into a Money::Collection' do
       expect(Monetize.parse_collection('$7')).to be_a Monetize::Collection
@@ -421,7 +470,7 @@ describe Monetize do
     end
 
     it 'raises ArgumentError with unsupported argument' do
-      expect { Monetize.from_numeric('100') }.to raise_error(ArgumentError)
+      expect { Monetize.from_numeric('100') }.to raise_error(Monetize::ArgumentError)
     end
 
     it 'optimizes workload' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monetize
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Shane Emmons
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-15 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: money
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0.beta1
+        version: '3.0'
 description: A library for converting various objects into `Money` objects.
 email:
 - shane@emmons.io
@@ -91,6 +91,7 @@ files:
 - lib/monetize/core_extensions/numeric.rb
 - lib/monetize/core_extensions/string.rb
 - lib/monetize/core_extensions/symbol.rb
+- lib/monetize/errors.rb
 - lib/monetize/version.rb
 - monetize.gemspec
 - spec/core_extensions_spec.rb
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A library for converting various objects into `Money` objects.
@@ -124,4 +125,3 @@ test_files:
 - spec/core_extensions_spec.rb
 - spec/monetize_spec.rb
 - spec/spec_helper.rb
-has_rdoc: