papercavalier-money 3.7.1

data/spec/money/formatting_spec.rb

@@ -0,0 +1,375 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Money do
+  specify "Money.format brute force :subunit_to_unit = 1" do
+    ("0".."9").each do |amt|
+      amt.to_money("VUV").format(:symbol => false).should == amt
+    end
+    ("-1".."-9").each do |amt|
+      amt.to_money("VUV").format(:symbol => false).should == amt
+    end
+    "1000".to_money("VUV").format(:symbol => false).should == "1,000"
+    "-1000".to_money("VUV").format(:symbol => false).should == "-1,000"
+  end
+
+  specify "Money.format brute force :subunit_to_unit = 5" do
+    ("0.0".."9.4").each do |amt|
+      next if amt[-1].to_i > 4
+      amt.to_money("MGA").format(:symbol => false).should == amt
+    end
+    ("-0.1".."-9.4").each do |amt|
+      next if amt[-1].to_i > 4
+      amt.to_money("MGA").format(:symbol => false).should == amt
+    end
+    "1000.0".to_money("MGA").format(:symbol => false).should == "1,000.0"
+    "-1000.0".to_money("MGA").format(:symbol => false).should == "-1,000.0"
+  end
+
+  specify "Money.format brute force :subunit_to_unit = 10" do
+    ("0.0".."9.9").each do |amt|
+      amt.to_money("VND").format(:symbol => false).should == amt.to_s.gsub(/\./, ",")
+    end
+    ("-0.1".."-9.9").each do |amt|
+      amt.to_money("VND").format(:symbol => false).should == amt.to_s.gsub(/\./, ",")
+    end
+    "1000.0".to_money("VND").format(:symbol => false).should == "1.000,0"
+    "-1000.0".to_money("VND").format(:symbol => false).should == "-1.000,0"
+  end
+
+  specify "Money.format brute force :subunit_to_unit = 100" do
+    ("0.00".."9.99").each do |amt|
+      amt.to_money("USD").format(:symbol => false).should == amt
+    end
+    ("-0.01".."-9.99").each do |amt|
+      amt.to_money("USD").format(:symbol => false).should == amt
+    end
+    "1000.00".to_money("USD").format(:symbol => false).should == "1,000.00"
+    "-1000.00".to_money("USD").format(:symbol => false).should == "-1,000.00"
+  end
+
+  specify "Money.format brute force :subunit_to_unit = 1000" do
+    ("0.000".."9.999").each do |amt|
+      amt.to_money("IQD").format(:symbol => false).should == amt
+    end
+    ("-0.001".."-9.999").each do |amt|
+      amt.to_money("IQD").format(:symbol => false).should == amt
+    end
+    "1000.000".to_money("IQD").format(:symbol => false).should == "1,000.000"
+    "-1000.000".to_money("IQD").format(:symbol => false).should == "-1,000.000"
+  end
+
+  context "without i18n" do
+    subject{ Money.empty("USD") }
+
+    its(:thousands_separator){should == ","}
+    its(:decimal_mark){should == "."}
+  end
+
+  context "with i18n but use_i18n = false" do
+    before :each do
+      reset_i18n
+      I18n.locale = :de
+      I18n.backend.store_translations(
+        :de, :number => {:currency => {:format => {:delimiter => ".",
+                                                   :separator => ","}}}
+      )
+
+      Money.use_i18n = false
+    end
+
+    after :each do
+      reset_i18n
+      I18n.locale = :en
+      Money.use_i18n = true
+    end
+
+    subject{ Money.new(1000_00, :usd) }
+
+    its(:format){should == "$1,000.00"}
+  end
+
+  context "with i18n" do
+    after :each do
+      reset_i18n
+      I18n.locale = :en
+    end
+
+    context "with number.format.*" do
+      before :each do
+        reset_i18n
+        I18n.locale = :de
+        I18n.backend.store_translations(
+          :de, :number => {:format => {:delimiter => ".",
+                                       :separator => ","}}
+        )
+      end
+
+      subject{ Money.empty("USD") }
+
+      its(:thousands_separator){should == "."}
+      its(:decimal_mark){should == ","}
+    end
+
+    context "with number.currency.format.*" do
+      before :each do
+        reset_i18n
+        I18n.locale = :de
+        I18n.backend.store_translations(
+          :de, :number => {:currency => {:format => {:delimiter => ".",
+                                                     :separator => ","}}}
+        )
+      end
+
+      subject{ Money.empty("USD") }
+
+      its(:thousands_separator){should == "."}
+      its(:decimal_mark){should == ","}
+    end
+  end
+
+  describe "#format" do
+    it "returns the monetary value as a string" do
+      Money.ca_dollar(100).format.should == "$1.00"
+      Money.new(40008).format.should == "$400.08"
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.new(10_00, "BHD").format.should == "ب.د1.000"
+    end
+
+    it "doesn't display a decimal when :subunit_to_unit is 1" do
+      Money.new(10_00, "CLP").format.should == "$1.000"
+    end
+
+    it "respects the thousands_separator and decimal_mark defaults" do
+      one_thousand = Proc.new do |currency|
+        Money.new(1000_00, currency).format
+      end
+
+      # Pounds
+      one_thousand["GBP"].should == "£1,000.00"
+
+      # Dollars
+      one_thousand["USD"].should == "$1,000.00"
+      one_thousand["CAD"].should == "$1,000.00"
+      one_thousand["AUD"].should == "$1,000.00"
+      one_thousand["NZD"].should == "$1,000.00"
+      one_thousand["ZWD"].should == "$1,000.00"
+
+      # Yen
+      one_thousand["JPY"].should == "¥1,000.00"
+      one_thousand["CNY"].should == "¥1,000.00"
+
+      # Euro
+      one_thousand["EUR"].should == "1.000,00 €"
+
+      # Rupees
+      one_thousand["INR"].should == "₨1,000.00"
+      one_thousand["NPR"].should == "₨1,000.00"
+      one_thousand["SCR"].should == "1,000.00 ₨"
+      one_thousand["LKR"].should == "1,000.00 ₨"
+
+      # Brazilian Real
+      one_thousand["BRL"].should == "R$ 1.000,00"
+
+      # Other
+      one_thousand["SEK"].should == "kr1,000.00"
+      one_thousand["GHC"].should == "₵1,000.00"
+    end
+
+    describe "if the monetary value is 0" do
+      before :each do
+        @money = Money.us_dollar(0)
+      end
+
+      it "returns 'free' when :display_free is true" do
+        @money.format(:display_free => true).should == 'free'
+      end
+
+      it "returns '$0.00' when :display_free is false or not given" do
+        @money.format.should == '$0.00'
+        @money.format(:display_free => false).should == '$0.00'
+        @money.format(:display_free => nil).should == '$0.00'
+      end
+
+      it "returns the value specified by :display_free if it's a string-like object" do
+        @money.format(:display_free => 'gratis').should == 'gratis'
+      end
+    end
+
+    specify "#format(:with_currency => true) works as documented" do
+      Money.ca_dollar(100).format(:with_currency => true).should == "$1.00 CAD"
+      Money.us_dollar(85).format(:with_currency => true).should == "$0.85 USD"
+    end
+
+    specify "#format(:no_cents => true) works as documented" do
+      Money.ca_dollar(100).format(:no_cents => true).should == "$1"
+      Money.ca_dollar(599).format(:no_cents => true).should == "$5"
+      Money.ca_dollar(570).format(:no_cents => true, :with_currency => true).should == "$5 CAD"
+      Money.ca_dollar(39000).format(:no_cents => true).should == "$390"
+    end
+
+    specify "#format(:no_cents => true) should respect :subunit_to_unit currency property" do
+      Money.new(10_00, "BHD").format(:no_cents => true).should == "ب.د1"
+    end
+    
+    specify "#format(:no_cents_if_whole => true) works as documented" do
+      Money.new(10000, "VUV").format(:no_cents_if_whole => true, :symbol => false).should == "10,000"
+      Money.new(10034, "VUV").format(:no_cents_if_whole => true, :symbol => false).should == "10,034"
+      Money.new(10000, "MGA").format(:no_cents_if_whole => true, :symbol => false).should == "2,000"
+      Money.new(10034, "MGA").format(:no_cents_if_whole => true, :symbol => false).should == "2,006.4"
+      Money.new(10000, "VND").format(:no_cents_if_whole => true, :symbol => false).should == "1.000"
+      Money.new(10034, "VND").format(:no_cents_if_whole => true, :symbol => false).should == "1.003,4"
+      Money.new(10000, "USD").format(:no_cents_if_whole => true, :symbol => false).should == "100"
+      Money.new(10034, "USD").format(:no_cents_if_whole => true, :symbol => false).should == "100.34"
+      Money.new(10000, "IQD").format(:no_cents_if_whole => true, :symbol => false).should == "10"
+      Money.new(10034, "IQD").format(:no_cents_if_whole => true, :symbol => false).should == "10.034"
+    end
+    
+    specify "#format(:no_cents_if_whole => false) works as documented" do
+      Money.new(10000, "VUV").format(:no_cents_if_whole => false, :symbol => false).should == "10,000"
+      Money.new(10034, "VUV").format(:no_cents_if_whole => false, :symbol => false).should == "10,034"
+      Money.new(10000, "MGA").format(:no_cents_if_whole => false, :symbol => false).should == "2,000.0"
+      Money.new(10034, "MGA").format(:no_cents_if_whole => false, :symbol => false).should == "2,006.4"
+      Money.new(10000, "VND").format(:no_cents_if_whole => false, :symbol => false).should == "1.000,0"
+      Money.new(10034, "VND").format(:no_cents_if_whole => false, :symbol => false).should == "1.003,4"
+      Money.new(10000, "USD").format(:no_cents_if_whole => false, :symbol => false).should == "100.00"
+      Money.new(10034, "USD").format(:no_cents_if_whole => false, :symbol => false).should == "100.34"
+      Money.new(10000, "IQD").format(:no_cents_if_whole => false, :symbol => false).should == "10.000"
+      Money.new(10034, "IQD").format(:no_cents_if_whole => false, :symbol => false).should == "10.034"
+    end
+
+    specify "#format(:symbol => a symbol string) uses the given value as the money symbol" do
+      Money.new(100, "GBP").format(:symbol => "£").should == "£1.00"
+    end
+
+    specify "#format(:symbol => true) returns symbol based on the given currency code" do
+      one = Proc.new do |currency|
+        Money.new(100, currency).format(:symbol => true)
+      end
+
+      # Pounds
+      one["GBP"].should == "£1.00"
+
+      # Dollars
+      one["USD"].should == "$1.00"
+      one["CAD"].should == "$1.00"
+      one["AUD"].should == "$1.00"
+      one["NZD"].should == "$1.00"
+      one["ZWD"].should == "$1.00"
+
+      # Yen
+      one["JPY"].should == "¥1.00"
+      one["CNY"].should == "¥1.00"
+
+      # Euro
+      one["EUR"].should == "1,00 €"
+
+      # Rupees
+      one["INR"].should == "₨1.00"
+      one["NPR"].should == "₨1.00"
+      one["SCR"].should == "1.00 ₨"
+      one["LKR"].should == "1.00 ₨"
+
+      # Brazilian Real
+      one["BRL"].should == "R$ 1,00"
+
+      # Other
+      one["SEK"].should == "kr1.00"
+      one["GHC"].should == "₵1.00"
+    end
+
+    specify "#format(:symbol => true) returns $ when currency code is not recognized" do
+      currency = Money::Currency.new("EUR")
+      currency.should_receive(:symbol).and_return(nil)
+      Money.new(100, currency).format(:symbol => true).should == "1,00 ¤"
+    end
+
+    specify "#format(:symbol => some non-Boolean value that evaluates to true) returns symbol based on the given currency code" do
+      Money.new(100, "GBP").format(:symbol => true).should == "£1.00"
+      Money.new(100, "EUR").format(:symbol => true).should == "1,00 €"
+      Money.new(100, "SEK").format(:symbol => true).should == "kr1.00"
+    end
+
+    specify "#format with :symbol == "", nil or false returns the amount without a symbol" do
+      money = Money.new(100, "GBP")
+      money.format(:symbol => "").should == "1.00"
+      money.format(:symbol => nil).should == "1.00"
+      money.format(:symbol => false).should == "1.00"
+    end
+
+    specify "#format without :symbol assumes that :symbol is set to true" do
+      money = Money.new(100)
+      money.format.should == "$1.00"
+
+      money = Money.new(100, "GBP")
+      money.format.should == "£1.00"
+
+      money = Money.new(100, "EUR")
+      money.format.should == "1,00 €"
+    end
+
+    specify "#format(:decimal_mark => a decimal_mark string) works as documented" do
+      Money.us_dollar(100).format(:decimal_mark => ",").should == "$1,00"
+    end
+
+    specify "#format will default decimal_mark to '.' if currency isn't recognized" do
+      Money.new(100, "ZWD").format.should == "$1.00"
+    end
+
+    specify "#format(:separator => a separator  string) works as documented" do
+      Money.us_dollar(100).format(:separator  => ",").should == "$1,00"
+    end
+
+    specify "#format(:thousands_separator => a thousands_separator string) works as documented" do
+      Money.us_dollar(100000).format(:thousands_separator => ".").should == "$1.000.00"
+      Money.us_dollar(200000).format(:thousands_separator => "").should  == "$2000.00"
+    end
+
+    specify "#format(:thousands_separator => false or nil) works as documented" do
+      Money.us_dollar(100000).format(:thousands_separator => false).should == "$1000.00"
+      Money.us_dollar(200000).format(:thousands_separator => nil).should   == "$2000.00"
+    end
+
+    specify "#format(:delimiter => a delimiter string) works as documented" do
+      Money.us_dollar(100000).format(:delimiter => ".").should == "$1.000.00"
+      Money.us_dollar(200000).format(:delimiter => "").should  == "$2000.00"
+    end
+
+    specify "#format(:delimiter => false or nil) works as documented" do
+      Money.us_dollar(100000).format(:delimiter => false).should == "$1000.00"
+      Money.us_dollar(200000).format(:delimiter => nil).should   == "$2000.00"
+    end
+
+    specify "#format will default thousands_separator to ',' if currency isn't recognized" do
+      Money.new(100000, "ZWD").format.should == "$1,000.00"
+    end
+
+    specify "#format(:html => true) works as documented" do
+      string = Money.ca_dollar(570).format(:html => true, :with_currency => true)
+      string.should == "$5.70 <span class=\"currency\">CAD</span>"
+    end
+
+    it "should insert commas into the result if the amount is sufficiently large" do
+      Money.us_dollar(1_000_000_000_12).format.should == "$1,000,000,000.12"
+      Money.us_dollar(1_000_000_000_12).format(:no_cents => true).should == "$1,000,000,000"
+    end
+
+    it "inserts thousands separator into the result if the amount is sufficiently large and the currency symbol is at the end" do
+      Money.euro(1_234_567_12).format.should == "1.234.567,12 €"
+      Money.euro(1_234_567_12).format(:no_cents => true).should == "1.234.567 €"
+    end
+
+    it "inserts currency symbol before the amount when :symbol_position is set to :before" do
+      Money.euro(1_234_567_12).format(:symbol_position => :before).should == "€1.234.567,12"
+    end
+
+    it "inserts currency symbol after the amount when :symbol_position is set to :after" do
+      Money.us_dollar(1_000_000_000_12).format(:symbol_position => :after).should == "1,000,000,000.12 $"
+    end
+  end
+
+end
+

data/spec/money/parsing_spec.rb

@@ -0,0 +1,197 @@
+# encoding: utf-8
+
+require "spec_helper"
+
+describe Money do
+  describe "Money.parse" do
+
+    it "should be able to parse european-formatted inputs under 10EUR" do
+      five_ninety_five = Money.new(595, 'EUR')
+
+      Money.parse('EUR 5,95').should    == five_ninety_five
+      #TODO: try and handle these
+      #Money.parse('€5,95').should       == five_ninety_five
+      #Money.parse('$5.95').should  == five_ninety_five
+    end
+
+    it "should be able to parse european-formatted inputs with multiple thousands-seperators" do
+      Money.parse('EUR 1.234.567,89').should     == Money.new(123456789, 'EUR')
+      Money.parse('EUR 1.111.234.567,89').should == Money.new(111123456789, 'EUR')
+    end
+
+    it "should be able to parse USD-formatted inputs under $10" do
+      five_ninety_five = Money.new(595, 'USD')
+
+      Money.parse(5.95).should          == five_ninety_five
+      Money.parse('5.95').should        == five_ninety_five
+      Money.parse('$5.95').should       == five_ninety_five
+      Money.parse("\n $5.95 \n").should == five_ninety_five
+      Money.parse('$ 5.95').should      == five_ninety_five
+      Money.parse('$5.95 ea.').should   == five_ninety_five
+      Money.parse('$5.95, each').should == five_ninety_five
+    end
+
+    it "should be able to parse USD-formatted inputs with multiple thousands-seperators" do
+      Money.parse('1,234,567.89').should     == Money.new(123456789, 'USD')
+      Money.parse('1,111,234,567.89').should == Money.new(111123456789, 'USD')
+    end
+
+    it "should not return a price if there is a price range" do
+      lambda {Money.parse('$5.95-10.95')}.should    raise_error ArgumentError
+      lambda {Money.parse('$5.95 - 10.95')}.should  raise_error ArgumentError
+      lambda {Money.parse('$5.95 - $10.95')}.should raise_error ArgumentError
+    end
+
+    it "should not return a price for completely invalid input" do
+      # TODO: shouldn't these throw an error instead of being considered
+      # equal to $0.0?
+      empty_price = Money.new(0, 'USD')
+
+      Money.parse(nil).should             == empty_price
+      Money.parse('hellothere').should    == empty_price
+      Money.parse('').should              == empty_price
+    end
+  end
+
+  describe "Money.from_string" do
+    it "converts given amount to cents" do
+      Money.from_string("1").should == Money.new(1_00)
+      Money.from_string("1").should == Money.new(1_00, "USD")
+      Money.from_string("1", "EUR").should == Money.new(1_00, "EUR")
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.from_string("1", "USD").should == Money.new(1_00,  "USD")
+      Money.from_string("1", "TND").should == Money.new(1_000, "TND")
+      Money.from_string("1", "CLP").should == Money.new(1,     "CLP")
+    end
+
+    it "accepts a currency options" do
+      m = Money.from_string("1")
+      m.currency.should == Money.default_currency
+
+      m = Money.from_string("1", Money::Currency.wrap("EUR"))
+      m.currency.should == Money::Currency.wrap("EUR")
+
+      m = Money.from_string("1", "EUR")
+      m.currency.should == Money::Currency.wrap("EUR")
+    end
+  end
+
+  describe "Money.from_fixnum" do
+    it "converts given amount to cents" do
+      Money.from_fixnum(1).should == Money.new(1_00)
+      Money.from_fixnum(1).should == Money.new(1_00, "USD")
+      Money.from_fixnum(1, "EUR").should == Money.new(1_00, "EUR")
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.from_fixnum(1, "USD").should == Money.new(1_00,  "USD")
+      Money.from_fixnum(1, "TND").should == Money.new(1_000, "TND")
+      Money.from_fixnum(1, "CLP").should == Money.new(1,     "CLP")
+    end
+
+    it "accepts a currency options" do
+      m = Money.from_fixnum(1)
+      m.currency.should == Money.default_currency
+
+      m = Money.from_fixnum(1, Money::Currency.wrap("EUR"))
+      m.currency.should == Money::Currency.wrap("EUR")
+
+      m = Money.from_fixnum(1, "EUR")
+      m.currency.should == Money::Currency.wrap("EUR")
+    end
+  end
+
+  describe "Money.from_float" do
+    it "converts given amount to cents" do
+      Money.from_float(1.2).should == Money.new(1_20)
+      Money.from_float(1.2).should == Money.new(1_20, "USD")
+      Money.from_float(1.2, "EUR").should == Money.new(1_20, "EUR")
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.from_float(1.2, "USD").should == Money.new(1_20,  "USD")
+      Money.from_float(1.2, "TND").should == Money.new(1_200, "TND")
+      Money.from_float(1.2, "CLP").should == Money.new(1,     "CLP")
+    end
+
+    it "accepts a currency options" do
+      m = Money.from_float(1.2)
+      m.currency.should == Money.default_currency
+
+      m = Money.from_float(1.2, Money::Currency.wrap("EUR"))
+      m.currency.should == Money::Currency.wrap("EUR")
+
+      m = Money.from_float(1.2, "EUR")
+      m.currency.should == Money::Currency.wrap("EUR")
+    end
+  end
+
+  describe "Money.from_bigdecimal" do
+    it "converts given amount to cents" do
+      Money.from_bigdecimal(BigDecimal.new("1")).should == Money.new(1_00)
+      Money.from_bigdecimal(BigDecimal.new("1")).should == Money.new(1_00, "USD")
+      Money.from_bigdecimal(BigDecimal.new("1"), "EUR").should == Money.new(1_00, "EUR")
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.from_bigdecimal(BigDecimal.new("1"), "USD").should == Money.new(1_00,  "USD")
+      Money.from_bigdecimal(BigDecimal.new("1"), "TND").should == Money.new(1_000, "TND")
+      Money.from_bigdecimal(BigDecimal.new("1"), "CLP").should == Money.new(1,     "CLP")
+    end
+
+    it "accepts a currency options" do
+      m = Money.from_bigdecimal(BigDecimal.new("1"))
+      m.currency.should == Money.default_currency
+
+      m = Money.from_bigdecimal(BigDecimal.new("1"), Money::Currency.wrap("EUR"))
+      m.currency.should == Money::Currency.wrap("EUR")
+
+      m = Money.from_bigdecimal(BigDecimal.new("1"), "EUR")
+      m.currency.should == Money::Currency.wrap("EUR")
+    end
+  end
+
+  describe "Money.from_numeric" do
+    it "converts given amount to cents" do
+      Money.from_numeric(1).should == Money.new(1_00)
+      Money.from_numeric(1.0).should == Money.new(1_00)
+      Money.from_numeric(BigDecimal.new("1")).should == Money.new(1_00)
+    end
+
+    it "should raise ArgumentError with unsupported argument" do
+      lambda { Money.from_numeric("100") }.should raise_error(ArgumentError)
+    end
+
+    it "should optimize workload" do
+      Money.should_receive(:from_fixnum).with(1, "USD").and_return(Money.new(1_00,  "USD"))
+      Money.from_numeric(1, "USD").should == Money.new(1_00,  "USD")
+      Money.should_receive(:from_bigdecimal).with(BigDecimal.new("1.0"), "USD").and_return(Money.new(1_00,  "USD"))
+      Money.from_numeric(1.0, "USD").should == Money.new(1_00,  "USD")
+    end
+
+    it "should respect :subunit_to_unit currency property" do
+      Money.from_numeric(1, "USD").should == Money.new(1_00,  "USD")
+      Money.from_numeric(1, "TND").should == Money.new(1_000, "TND")
+      Money.from_numeric(1, "CLP").should == Money.new(1,     "CLP")
+    end
+
+    it "accepts a bank option" do
+      Money.from_numeric(1).should == Money.new(1_00)
+      Money.from_numeric(1).should == Money.new(1_00, "USD")
+      Money.from_numeric(1, "EUR").should == Money.new(1_00, "EUR")
+    end
+
+    it "accepts a currency options" do
+      m = Money.from_numeric(1)
+      m.currency.should == Money.default_currency
+
+      m = Money.from_numeric(1, Money::Currency.wrap("EUR"))
+      m.currency.should == Money::Currency.wrap("EUR")
+
+      m = Money.from_numeric(1, "EUR")
+      m.currency.should == Money::Currency.wrap("EUR")
+    end
+  end
+end