money 6.0.0.pre3 → 6.0.0.pre4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9dae4831f4901cf906ae3d6f155c9bac6e3f67f
-  data.tar.gz: 43718a7d7edfce6329053cd90a7b61ec2d4d3a78
+  metadata.gz: ea888a5a751fe5366637910259bed324998d8946
+  data.tar.gz: 23c2300799b945f0ae892d71bc64511e1978d209
 SHA512:
-  metadata.gz: a13f5e9078a642608bc4d224639b27ca74b44952c6cba8790515534c5e09d50d77eba86c4f0fc0540fb4d840cf8b9c3cef6ef8af6a06fb5c81740850862e971e
-  data.tar.gz: 652d159f7d083c9975f15ad14f3f92cd2aea19c475cacc3dead90711771d5ed04b32e96a66b97b08ee3153816670037088a8ad8fb49f2c5b552b8336a2dde2af
+  metadata.gz: c14c97b517d52e3e78ab675b033eb2f59a2d0d46315d592bc928d87fda3896c2b90a163512468697a8817395db147f98894aa9fc24b6b433b59a33892947386c
+  data.tar.gz: 05ac021536a9b31669856f93a47ccec21605fac4c99b0e828b579dbea7df6a4945dfe6742f71b25e19df28989014b553cccb84a8e2169ea08dccfecb76e88957

data/CHANGELOG.md

@@ -19,6 +19,9 @@
 - Changed `thousands_separator` for Swedish Krona from dot to blank space.
 - Allow mathematical operations with first argument being not an instance of Money (eg. 2 * money instead of money * 2).
 - Money#dollars and Money#amount methods return numbers of type BigDecimal.
+- Change Money.from_bigdecimal (and in that way .to_money too) to keep precision when using `Money.infinite_precision = true`
+- Add :rounded_infinite_precision option to .format
+- Changed the New Taiwan Dollar symbol position from after the amount to before the amount.
 
 ## 5.1.1
 

data/config/currency_iso.json

@@ -1994,7 +1994,7 @@
     "alternate_symbols": ["NT$"],
     "subunit": "Cent",
     "subunit_to_unit": 100,
-    "symbol_first": false,
+    "symbol_first": true,
     "html_entity": "$",
     "decimal_mark": ".",
     "thousands_separator": ",",

data/lib/money/currency.rb

@@ -5,6 +5,8 @@ require 'json'
 class Money
 
   # Represents a specific currency unit.
+  #
+  # @see http://en.wikipedia.org/wiki/Currency
   class Currency
     include Comparable
 
@@ -140,11 +142,14 @@ class Money
     # The international 3-letter code as defined by the ISO 4217 standard.
     #
     # @return [String]
+    # @see http://iso4217.net/
     attr_reader :iso_code
+
     #
     # The international 3-numeric code as defined by the ISO 4217 standard.
     #
     # @return [String]
+    # @see http://iso4217.net/
     attr_reader :iso_numeric
 
     # The currency name.

data/lib/money/money.rb

@@ -4,7 +4,15 @@ require "money/money/arithmetic"
 require "money/money/parsing"
 require "money/money/formatting"
 
-# Represents an amount of money in a given currency.
+# "Money is any object or record that is generally accepted as payment for
+# goods and services and repayment of debts in a given socio-economic context
+# or country." -Wikipedia
+#
+# An instance of Money represents an amount of a specific currency.
+#
+# Money is a value object and should be treated as immutable.
+#
+# @see http://en.wikipedia.org/wiki/Money
 class Money
   include Comparable
   include Arithmetic
@@ -13,14 +21,36 @@ class Money
 
   # Convenience method for fractional part of the amount. Synonym of #fractional
   #
-  # @return [Integer]
+  # @return [Integer] when inifinte_precision is false
+  # @return [BigDecimal] when inifinte_precision is true
+  #
+  # @see infinite_precision
   def cents
     fractional
   end
 
-  # The value of the amount represented in the fractional unit of the currency. Example: USD, 1 dollar (amount) == 100 cents (fractional unit).
+  # The value of the monetary amount represented in the fractional or subunit
+  # of the currency.
+  #
+  # For example, in the US Dollar currency the fractional unit is cents, and
+  # there are 100 cents in one US Dollar. So given the Money representation of
+  # one US dollar, the fractional interpretation is 100.
+  #
+  # Another example is that of the Kuwaiti Dinar. In this case the fractional
+  # unit is the Fils and there 1000 Fils to one Kuwaiti Dinar. So given the
+  # Money representation of one Kuwaiti Dinar, the fractional interpretation is
+  # 1000.
+  #
+  # @example
+  #   Money.new_with_amount(1, "USD").fractional      #=> 100
+  #   Money.new_with_amount(1, "KWD").fractional      #=> 1000
+  #   Money.new_with_amount(105.50, "USD").fractional #=> 10550
+  #   Money.new_with_amount(15.763, 'KWD').fractional #=> 15763
   #
-  # @return [Integer]
+  # @return [Integer] when inifinte_precision is false
+  # @return [BigDecimal] when inifinte_precision is true
+  #
+  # @see infinite_precision
   def fractional
     # Ensure we have a BigDecimal. If the Money object is created
     # from YAML, @fractional can end up being set to a Float.
@@ -188,12 +218,9 @@ class Money
   # @return [Money]
   #
   # @example
-  #   Money.new_with_amount(100)
-  #   #=> #<Money @fractional=10000 @currency="USD">
-  #   Money.new_with_amount(100, "USD")
-  #   #=> #<Money @fractional=10000 @currency="USD">
-  #   Money.new_with_amount(100, "EUR")
-  #   #=> #<Money @fractional=10000 @currency="EUR">
+  #   Money.new_with_amount(100)        #=> #<Money @fractional=10000 @currency="USD">
+  #   Money.new_with_amount(100, "USD") #=> #<Money @fractional=10000 @currency="USD">
+  #   Money.new_with_amount(100, "EUR") #=> #<Money @fractional=10000 @currency="EUR">
   #
   # @see Money.new
   #
@@ -225,8 +252,7 @@ class Money
     Money.default_bank.add_rate(from_currency, to_currency, rate)
   end
 
-
-  # Creates a new Money object of value given in the 
+  # Creates a new Money object of value given in the
   # +fractional unit+ of the given +currency+.
   #
   # Alternatively you can use the convenience
@@ -239,12 +265,9 @@ class Money
   # @return [Money]
   #
   # @example
-  #   Money.new(100)
-  #   #=> #<Money @fractional=100 @currency="USD">
-  #   Money.new(100, "USD")
-  #   #=> #<Money @fractional=100 @currency="USD">
-  #   Money.new(100, "EUR")
-  #   #=> #<Money @fractional=100 @currency="EUR">
+  #   Money.new(100)        #=> #<Money @fractional=100 @currency="USD">
+  #   Money.new(100, "USD") #=> #<Money @fractional=100 @currency="USD">
+  #   Money.new(100, "EUR") #=> #<Money @fractional=100 @currency="EUR">
   #
   # @see Money.new_with_dollars
   #
@@ -263,8 +286,8 @@ class Money
   # @return [BigDecimal]
   #
   # @example
-  #   Money.new(100).dollars           # => 1.0
-  #   Money.new_with_dollars(1).dollar # => 1.0
+  #   Money.new(1_00, "USD").dollars   # => BigDecimal.new("1.00")
+  #   Money.new_with_dollars(1).dollar # => BigDecimal.new("1.00")
   #
   # @see #amount
   # @see #to_d
@@ -279,8 +302,8 @@ class Money
   # @return [BigDecimal]
   #
   # @example
-  #   Money.new(100).amount            # => 1.0
-  #   Money.new_with_amount(1).amount  # => 1.0
+  #   Money.new(1_00, "USD").amount    # => BigDecimal.new("1.00")
+  #   Money.new_with_amount(1).amount  # => BigDecimal.new("1.00")
   #
   # @see #to_d
   # @see #fractional
@@ -388,7 +411,7 @@ class Money
   # @return [BigDecimal]
   #
   # @example
-  #   Money.us_dollar(100).to_d => BigDecimal.new("1.0")
+  #   Money.us_dollar(1_00).to_d #=> BigDecimal.new("1.00")
   def to_d
     as_d(fractional) / as_d(currency.subunit_to_unit)
   end
@@ -401,7 +424,7 @@ class Money
   # @return [Float]
   #
   # @example
-  #   Money.us_dollar(100).to_f => 1.0
+  #   Money.us_dollar(100).to_f #=> 1.0
   def to_f
     to_d.to_f
   end
@@ -473,13 +496,14 @@ class Money
   # be distributed round-robin amongst the parties. This means that parties
   # listed first will likely recieve more pennies then ones that are listed later
   #
-  # @param [Array<Float, Float, Float>] splits [0.50, 0.25, 0.25] to give 50% of the cash to party1, 25% to party2, and 25% to party3.
+  # @param [Array<Numeric>] splits [0.50, 0.25, 0.25] to give 50% of the cash to party1, 25% to party2, and 25% to party3.
   #
-  # @return [Array<Money, Money, Money>]
+  # @return [Array<Money>]
   #
   # @example
-  #   Money.new(5, "USD").allocate([0.3,0.7)) #=> [Money.new(2), Money.new(3)]
-  #   Money.new(100, "USD").allocate([0.33,0.33,0.33]) #=> [Money.new(34), Money.new(33), Money.new(33)]
+  #   Money.new(5,   "USD").allocate([0.3, 0.7])         #=> [Money.new(2), Money.new(3)]
+  #   Money.new(100, "USD").allocate([0.33, 0.33, 0.33]) #=> [Money.new(34), Money.new(33), Money.new(33)]
+  #
   def allocate(splits)
     allocations = splits.inject(0) { |sum, n| sum + as_d(n) }
 
@@ -510,7 +534,7 @@ class Money
   #
   # @param [Numeric] num number of parties.
   #
-  # @return [Array<Money, Money, Money>]
+  # @return [Array<Money>]
   #
   # @example
   #   Money.new(100, "USD").split(3) #=> [Money.new(34), Money.new(33), Money.new(33)]
@@ -537,15 +561,19 @@ class Money
 
   # Round the monetary amount to smallest unit of coinage.
   #
-  # This method is only useful when operating with infinite_precision turned
-  # on. Without infinite_precision values are rounded to the smallest unit of
-  # coinage automatically.
+  # @note
+  #   This method is only useful when operating with infinite_precision turned
+  #   on. Without infinite_precision values are rounded to the smallest unit of
+  #   coinage automatically.
   #
   # @return [Money]
   #
   # @example
   #   Money.new(10.1, 'USD').round #=> Money.new(10, 'USD')
   #
+  # @see
+  #   Money.infinite_precision
+  #
   def round(rounding_mode = self.class.rounding_mode)
     if self.class.infinite_precision
       return Money.new(fractional.round(0, rounding_mode), self.currency)

data/lib/money/money/formatting.rb

@@ -63,10 +63,18 @@ class Money
     #  should be appended to the result string.
     #
     # @example
-    #   Money.ca_dollar(100).format => "$1.00"
+    #   Money.ca_dollar(100).format #=> "$1.00"
     #   Money.ca_dollar(100).format(:with_currency => true) #=> "$1.00 CAD"
     #   Money.us_dollar(85).format(:with_currency => true)  #=> "$0.85 USD"
     #
+    # @option *rules [Boolean] :rounded_infinite_precision (false) Whether the
+    #  amount of money should be rounded when using infinite_precision
+    #
+    # @example
+    #   Money.us_dollar(100.1).format #=> "$1.001"
+    #   Money.us_dollar(100.1).format(:rounded_infinite_precision => true) #=> "$1"
+    #   Money.us_dollar(100.9).format(:rounded_infinite_precision => true) #=> "$1.01"
+    #
     # @option *rules [Boolean] :no_cents (false) Whether cents should be omitted.
     #
     # @example
@@ -220,12 +228,24 @@ class Money
           symbol
         end
 
-      sign = self.negative? ? '-' : ''
-      formatted = rules[:no_cents] ? "#{self.abs.to_s.to_i}" : self.abs.to_s
+      formatted = self.abs.to_s
+
+      if rules[:rounded_infinite_precision]
+        formatted = ((BigDecimal(formatted) * currency.subunit_to_unit).round / BigDecimal(currency.subunit_to_unit.to_s)).to_s("F")
+        formatted.gsub!(/\..*/) do |decimal_part|
+          if decimal_part == '.0'
+            ''
+          else
+            decimal_part << '0' while decimal_part.length < (currency.decimal_places + 1)
+            decimal_part
+          end
+        end
+      end
 
+      sign = self.negative? ? '-' : ''
 
-      if rules[:no_cents_if_whole] && cents % currency.subunit_to_unit == 0
-        formatted = "#{self.to_s.to_i}"
+      if rules[:no_cents] || (rules[:no_cents_if_whole] && cents % currency.subunit_to_unit == 0)
+        formatted = "#{formatted.to_i}"
       end
 
       thousands_separator_value = thousands_separator

data/lib/money/money/parsing.rb

@@ -187,7 +187,8 @@ class Money
       def from_bigdecimal(value, currency = Money.default_currency)
         currency = Money::Currency.wrap(currency)
         amount   = value * currency.subunit_to_unit
-        new(amount.round, currency)
+        amount   = amount.round unless Money.infinite_precision
+        new(amount, currency)
       end
 
       # Converts a Numeric value into a Money object treating the +value+

data/money.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |s|
   s.name        = "money"
-  s.version     = "6.0.0.pre3"
+  s.version     = "6.0.0.pre4"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Tobias Luetke", "Hongli Lai", "Jeremy McNevin",
                    "Shane Emmons", "Simone Carletti"]

data/spec/money/formatting_spec.rb

@@ -439,6 +439,36 @@ describe Money, "formatting" do
       end
     end
 
+    describe ":rounded_infinite_precision option" do
+      before do
+        Money.infinite_precision = true
+      end
+
+      after do
+        Money.infinite_precision = false
+      end
+
+      it "does round fractional when set to true" do
+        Money.new(BigDecimal.new('12.1'), "USD").format(:rounded_infinite_precision => true).should == "$0.12"
+        Money.new(BigDecimal.new('12.5'), "USD").format(:rounded_infinite_precision => true).should == "$0.13"
+        Money.new(BigDecimal.new('123.1'), "BHD").format(:rounded_infinite_precision => true).should == "ب.د0.123"
+        Money.new(BigDecimal.new('123.5'), "BHD").format(:rounded_infinite_precision => true).should == "ب.د0.124"
+        Money.new(BigDecimal.new('100.1'), "USD").format(:rounded_infinite_precision => true).should == "$1"
+        Money.new(BigDecimal.new('109.5'), "USD").format(:rounded_infinite_precision => true).should == "$1.10"
+        Money.new(BigDecimal.new('1'), "MGA").format(:rounded_infinite_precision => true).should == "Ar0.2"
+      end
+
+      it "does not round fractional when set to false" do
+        Money.new(BigDecimal.new('12.1'), "USD").format(:rounded_infinite_precision => false).should == "$0.121"
+        Money.new(BigDecimal.new('12.5'), "USD").format(:rounded_infinite_precision => false).should == "$0.125"
+        Money.new(BigDecimal.new('123.1'), "BHD").format(:rounded_infinite_precision => false).should == "ب.د0.1231"
+        Money.new(BigDecimal.new('123.5'), "BHD").format(:rounded_infinite_precision => false).should == "ب.د0.1235"
+        Money.new(BigDecimal.new('100.1'), "USD").format(:rounded_infinite_precision => false).should == "$1.001"
+        Money.new(BigDecimal.new('109.5'), "USD").format(:rounded_infinite_precision => false).should == "$1.095"
+        Money.new(BigDecimal.new('1'), "MGA").format(:rounded_infinite_precision => false).should == "Ar0.1"
+      end
+    end
+
     context "when the monetary value is 0" do
       let(:money) { Money.us_dollar(0) }
 

data/spec/money/parsing_spec.rb

@@ -260,6 +260,23 @@ describe Money, "parsing" do
       m = Money.from_bigdecimal(BigDecimal.new("1"), "EUR")
       m.currency.should == Money::Currency.wrap("EUR")
     end
+
+    context "infinite_precision = true" do
+      before do
+        Money.infinite_precision = true
+      end
+
+      after do
+        Money.infinite_precision = false
+      end
+
+      it "keeps precision" do
+        Money.from_bigdecimal(BigDecimal.new("1.23456")).should == Money.new(123.456)
+        Money.from_bigdecimal(BigDecimal.new("-1.23456")).should == Money.new(-123.456)
+        Money.from_bigdecimal(BigDecimal.new("1.23456")).should == Money.new(123.456, "USD")
+        Money.from_bigdecimal(BigDecimal.new("1.23456"), "EUR").should == Money.new(123.456, "EUR")
+      end
+    end
   end
 
   describe ".from_numeric" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: money
 version: !ruby/object:Gem::Version
-  version: 6.0.0.pre3
+  version: 6.0.0.pre4
 platform: ruby
 authors:
 - Tobias Luetke
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -77,32 +77,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- config/currency_backwards_compatible.json
 - config/currency_iso.json
+- config/currency_backwards_compatible.json
 - config/currency_non_iso.json
-- lib/money.rb
-- lib/money/bank/base.rb
-- lib/money/bank/variable_exchange.rb
-- lib/money/core_extensions.rb
 - lib/money/currency.rb
-- lib/money/currency/heuristics.rb
-- lib/money/currency/loader.rb
-- lib/money/deprecations.rb
-- lib/money/money.rb
 - lib/money/money/arithmetic.rb
-- lib/money/money/formatting.rb
 - lib/money/money/parsing.rb
-- spec/bank/base_spec.rb
-- spec/bank/variable_exchange_spec.rb
-- spec/core_extensions_spec.rb
-- spec/currency/heuristics_spec.rb
+- lib/money/money/formatting.rb
+- lib/money/core_extensions.rb
+- lib/money/deprecations.rb
+- lib/money/currency/loader.rb
+- lib/money/currency/heuristics.rb
+- lib/money/bank/variable_exchange.rb
+- lib/money/bank/base.rb
+- lib/money/money.rb
+- lib/money.rb
+- spec/support/default_currency_helper.rb
 - spec/currency_spec.rb
+- spec/core_extensions_spec.rb
+- spec/money/parsing_spec.rb
 - spec/money/arithmetic_spec.rb
 - spec/money/formatting_spec.rb
-- spec/money/parsing_spec.rb
 - spec/money_spec.rb
+- spec/currency/heuristics_spec.rb
 - spec/spec_helper.rb
-- spec/support/default_currency_helper.rb
+- spec/bank/variable_exchange_spec.rb
+- spec/bank/base_spec.rb
 - CHANGELOG.md
 - LICENSE
 - README.md