money 5.1.0.beta1 → 5.1.0

data/config/currency_bc.json

@@ -4,6 +4,7 @@
     "iso_code": "EEK",
     "name": "Estonian Kroon",
     "symbol": "KR",
+    "alternate_symbols": [],
     "subunit": "Sent",
     "subunit_to_unit": 100,
     "symbol_first": false,
@@ -17,6 +18,7 @@
     "iso_code": "GHS",
     "name": "Ghanaian Cedi",
     "symbol": "₵",
+    "alternate_symbols": ["GH₵"],
     "subunit": "Pesewa",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -30,6 +32,7 @@
     "iso_code": "TMM",
     "name": "Turkmenistani Manat",
     "symbol": "m",
+    "alternate_symbols": [],
     "subunit": "Tennesi",
     "subunit_to_unit": 100,
     "symbol_first": false,
@@ -43,6 +46,7 @@
     "iso_code": "JPY",
     "name": "Japanese Yen",
     "symbol": "¥",
+    "alternate_symbols": ["円", "圓"],
     "subunit": "Sen",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -56,6 +60,7 @@
     "iso_code": "ZWD",
     "name": "Zimbabwean Dollar",
     "symbol": "$",
+    "alternate_symbols": ["Z$"],
     "subunit": "Cent",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -69,6 +74,7 @@
     "iso_code": "ZWL",
     "name": "Zimbabwean Dollar",
     "symbol": "$",
+    "alternate_symbols": ["Z$"],
     "subunit": "Cent",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -82,6 +88,7 @@
     "iso_code": "ZWN",
     "name": "Zimbabwean Dollar",
     "symbol": "$",
+    "alternate_symbols": ["Z$"],
     "subunit": "Cent",
     "subunit_to_unit": 100,
     "symbol_first": true,
@@ -95,6 +102,7 @@
     "iso_code": "ZWR",
     "name": "Zimbabwean Dollar",
     "symbol": "$",
+    "alternate_symbols": ["Z$"],
     "subunit": "Cent",
     "subunit_to_unit": 100,
     "symbol_first": true,

data/lib/money.rb

@@ -1,7 +1,6 @@
 require "bigdecimal"
 require "bigdecimal/util"
 require "i18n" rescue LoadError
-require "money/currency_loader"
 require "money/currency"
 require "money/money"
 require "money/core_extensions"

data/lib/money/currency.rb

@@ -7,7 +7,12 @@ class Money
   # Represents a specific currency unit.
   class Currency
     include Comparable
-    extend  CurrencyLoader
+
+    require "money/currency/loader"
+    extend  Loader
+
+    require "money/currency/heuristics"
+    extend  Heuristics
 
     # Thrown when an unknown currency is requested.
     class UnknownCurrency < StandardError; end

data/lib/money/currency/heuristics.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+
+module Money::Currency::Heuristics
+
+  # An robust and efficient algorithm for finding currencies in 
+  # text. Using several algorithms it can find symbols, iso codes and 
+  # even names of currencies. 
+  # Although not recommendable, it can also attempt to find the given 
+  # currency in an entire sentence
+  #
+  # Returns: Array (matched results)
+  def analyze(str)
+    return Analyzer.new(str, search_tree).process
+  end
+
+  private
+
+  # Build a search tree from the currency database
+  def search_tree
+    @_search_tree ||= { 
+      :by_symbol => currencies_by_symbol,
+      :by_iso_code => currencies_by_iso_code,
+      :by_name => currencies_by_name
+    }
+  end
+
+  def currencies_by_symbol
+    {}.tap do |r|
+      table.each do |dummy, c|
+        symbol = (c[:symbol]||"").downcase
+        symbol.chomp!('.')
+        (r[symbol] ||= []) << c
+        
+        (c[:alternate_symbols]||[]).each do |ac|
+          ac = ac.downcase
+          ac.chomp!('.')
+          (r[ac] ||= []) << c
+        end
+      end
+    end
+  end
+
+  def currencies_by_iso_code
+    {}.tap do |r|
+      table.each do |dummy,c|
+        (r[c[:iso_code].downcase] ||= []) << c
+      end
+    end
+  end
+
+  def currencies_by_name
+    {}.tap do |r|
+      table.each do |dummy,c|
+        name_parts = c[:name].downcase.split
+        name_parts.each {|part| part.chomp!('.')}
+
+        # construct one branch per word
+        root = r
+        while name_part = name_parts.shift
+          root = (root[name_part] ||= {})
+        end
+
+        # the leaf is a currency
+        (root[:value] ||= []) << c
+      end
+    end
+  end
+
+  class Analyzer
+    attr_reader :search_tree, :words
+    attr_accessor :str, :currencies
+
+    def initialize str, search_tree
+      @str = (str||'').dup
+      @search_tree = search_tree
+      @currencies = []
+    end
+
+    def process
+      format
+      return [] if str.empty?
+
+      search_by_symbol
+      search_by_iso_code
+      search_by_name
+
+      prepare_reply
+    end
+
+    def format
+      str.gsub!(/[\r\n\t]/,'')
+      str.gsub!(/[0-9][\.,:0-9]*[0-9]/,'')
+      str.gsub!(/[0-9]/, '')
+      str.downcase!
+      @words = str.split
+      @words.each {|word| word.chomp!('.'); word.chomp!(',') }
+    end
+
+    def search_by_symbol
+      words.each do |word|
+        if found = search_tree[:by_symbol][word]
+          currencies.concat(found)
+        end
+      end
+    end
+
+    def search_by_iso_code
+      words.each do |word|
+        if found = search_tree[:by_iso_code][word]
+          currencies.concat(found)
+        end
+      end
+    end
+
+    def search_by_name
+      # remember, the search tree by name is a construct of branches and leaf!
+      # We need to try every combination of words within the sentence, so we 
+      # end up with a x^2 equation, which should be fine as most names are either
+      # one or two words, and this is multiplied with the words of given sentence
+
+      search_words = words.dup
+
+      while search_words.length > 0
+        root = search_tree[:by_name]
+
+        search_words.each do |word|
+          if root = root[word]
+            if root[:value]
+              currencies.concat(root[:value])
+            end
+          else
+            break
+          end
+        end
+
+        search_words.delete_at(0)
+      end
+    end
+
+    def prepare_reply
+      codes = currencies.map do |currency|
+        currency[:iso_code]
+      end
+      codes.uniq!
+      codes.sort!
+      codes
+    end
+  end
+end

data/lib/money/{currency_loader.rb → currency/loader.rb}

@@ -1,7 +1,7 @@
-module CurrencyLoader
+module Money::Currency::Loader
   extend self
 
-  DATA_PATH = File.expand_path("../../../config", __FILE__)
+  DATA_PATH = File.expand_path("../../../../config", __FILE__)
 
   # Loads and returns the currencies stored in JSON files in the config directory.
   #

data/lib/money/money/parsing.rb

@@ -42,7 +42,7 @@ class Money
         # from the stated currency string
         c = if Money.assume_from_symbol && i =~ /^(\$|€|£)/
           case i
-          when /^$/ then "USD"
+          when /^\$/ then "USD"
           when /^€/ then "EUR"
           when /^£/ then "GBP"
           end

data/money.gemspec

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

data/spec/currency/heuristics_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Money::Currency::Heuristics do
+  describe "#analyze_string" do
+    let(:it) { Money::Currency }
+
+    it "is not affected by blank characters and numbers" do
+      it.analyze('123').should == []
+      it.analyze('\n123 \t').should == []
+    end
+
+    it "returns nothing when given nothing" do
+      it.analyze('').should == []
+      it.analyze(nil).should == []
+    end
+
+    it "finds a currency by use of its symbol" do
+      it.analyze('zł').should == ['PLN']
+    end
+
+    it "is not affected by trailing dot" do
+      it.analyze('zł.').should == ['PLN']
+    end
+
+    it "finds match even if has numbers after" do
+      it.analyze('zł 123').should == ['PLN']
+    end
+
+    it "finds match even if has numbers before" do
+      it.analyze('123 zł').should == ['PLN']
+    end
+
+    it "find match even if symbol is next to number" do
+      it.analyze('300zł').should == ['PLN']
+    end
+
+    it "finds match even if has numbers with delimiters" do
+      it.analyze('zł 123,000.50').should == ['PLN']
+      it.analyze('zł123,000.50').should == ['PLN']
+    end
+
+    it "finds currencies with dots in symbols" do
+      it.analyze('L.E.').should == ['EGP']
+    end
+
+    it "finds by name" do
+      it.analyze('1900 bulgarian lev').should == ['BGN']
+      it.analyze('Swedish Krona').should == ['SEK']
+    end
+
+    it "Finds several currencies when several match" do
+      r = it.analyze('$400')
+      r.should include("ARS")
+      r.should include("USD")
+      r.should include("NZD")
+
+      r = it.analyze('9000 £')
+      r.should include("GBP")
+      r.should include("SHP")
+      r.should include("SYP")
+    end
+
+    it "should use alternate symbols" do
+      it.analyze('US$').should == ['USD']
+    end
+
+    it "finds a currency by use of its iso code" do
+      it.analyze('USD 200').should == ['USD']
+    end
+
+    it "finds currencies in the middle of a sentence!" do
+      it.analyze('It would be nice to have 10000 Albanian lek by tomorrow!').should == ['ALL']
+    end
+
+    it "finds several currencies in the same text!" do
+      it.analyze("10EUR is less than 100:- but really, I want US$1").should == ['EUR', 'SEK', 'USD']
+    end
+
+    it "should function with unicode characters" do
+      it.analyze("10 դր.").should == ["AMD"]
+    end
+  end
+end

data/spec/money/formatting_spec.rb

@@ -124,7 +124,7 @@ describe Money, "formatting" do
       one_thousand["EUR"].should == "€1.000,00"
 
       # Rupees
-      one_thousand["INR"].should == "₨1,000.00"
+      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 ₨"
@@ -223,7 +223,7 @@ describe Money, "formatting" do
         one["EUR"].should == "€1,00"
 
         # Rupees
-        one["INR"].should == "₨1.00"
+        one["INR"].should == "₹1.00"
         one["NPR"].should == "₨1.00"
         one["SCR"].should == "1.00 ₨"
         one["LKR"].should == "1.00 ₨"
@@ -361,64 +361,10 @@ describe Money, "formatting" do
       end
     end
 
-    it "brute forces :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
-
-    it "brute forces :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
-
-    it "brute forces :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"
+    it "maintains floating point precision" do
+      "0.01".to_money("USD").format(:symbol => false).should == "0.01"
     end
 
-    it "brute forces :subunit_to_unit = 100" do
-      %w{0.00 0.01 1.00 1.01 5.67 9.99}.each do |amt|
-        amt.to_money("USD").format(:symbol => false).should == amt
-      end
-      %w{-0.01 -1.00 -1.01 -5.67 -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
-
-    it "brute forces :subunit_to_unit = 1000" do
-      %w{0.000 0.001 1.000 1.001 5.678 9.999}.each do |amt|
-        amt.to_money("IQD").format(:symbol => false).should == amt
-      end
-
-      %w{-0.001 -1.000 -1.001 -5.678 -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
   end
 
   context "custom currencies with 4 decimal places" do

data/spec/money/parsing_spec.rb

@@ -27,8 +27,10 @@ describe Money, "parsing" do
         before do
           Money.assume_from_symbol = true
         end
-        it "parses formatted inputs with the currency passed as a symbol" do
-          Money.parse("$5.95").should == Money.new(595, 'USD')
+        it "parses formatted inputs with the currency passed as a symbol" do 
+          with_default_currency("EUR") do
+            Money.parse("$5.95").should == Money.new(595, 'USD')
+          end
           Money.parse("€5.95").should == Money.new(595, 'EUR')
           Money.parse(" €5.95 ").should == Money.new(595, 'EUR')
           Money.parse("£9.99").should == Money.new(999, 'GBP')

data/spec/spec_helper.rb

@@ -1,8 +1,11 @@
+$LOAD_PATH.unshift File.dirname(__FILE__)
 require 'rspec'
 require 'money'
+require 'support/default_currency_helper'
 
 RSpec.configure do |c|
   c.order = "rand"
+  c.include DefaultCurrencyHelper
 end
 
 def silence_warnings