danconia 0.2.4 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad8e13934be05481be0f5f5830df44fb673655b72478fb72521949c231d165c
-  data.tar.gz: bbf515b791d138967fa50435214ecdfe3f29e967f6b758f1731c82c2eb965aaa
+  metadata.gz: a7427977cd93825975491eddf43bcd9e5fda9389102d2c2b32c16efdfb11f590
+  data.tar.gz: 15bccf8fc66c26679cc101d5f27dd9aabc5398b28fe1a04a00b167500993eedf
 SHA512:
-  metadata.gz: 1cf5f8694e43c05f90aa6be8dbc07ebf9a8b07ae43ed1bf219ff0ab4e7a79cffd0c69220997b7733eb8b78900e987fe61a2c18acc1fb361daef3a4f96cfce610
-  data.tar.gz: 5168ff74019cec1a6b39536fe6ffc1f7b94d9adb9dd7610692305990768db8c3b6fcd8c07dec8b276c2f57eb1bea5d6a9e5f7e5730a46ca74c020fac27474faf
+  metadata.gz: 95d1edfd74b3388998c3251ac204a61a10a7454e0eda2fc2ca3b6105f95d9ead47c511a67790e82d34d4d54f934db83cc7326da53abef51c074846571b28a819
+  data.tar.gz: 033bb6ae1f171059bceb87495b9490b2d760f6371d71ec74f8a6a494f628ab52302f91f19f2a0e9f344c9c4775fecd0027c071e0cc21db51568e1efd80ea8c70

data/.travis.yml

@@ -1 +1,5 @@
+---
+sudo: false
 language: ruby
+cache: bundler
+before_install: gem install bundler -v 1.16.1

data/Gemfile.lock

@@ -1,28 +1,27 @@
 PATH
   remote: .
   specs:
-    danconia (0.2.4)
+    danconia (0.2.9)
       activerecord (>= 3.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
-      arel (>= 9.0)
-    activesupport (5.2.0)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
-    arel (9.0.0)
     coderay (1.1.2)
-    concurrent-ruby (1.0.5)
+    concurrent-ruby (1.1.7)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -43,7 +42,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.7)
-    i18n (1.0.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -51,7 +50,7 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
     method_source (0.9.0)
-    minitest (5.11.3)
+    minitest (5.14.2)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -60,7 +59,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     public_suffix (3.0.2)
-    rake (10.3.2)
+    rake (13.0.1)
     rb-fsevent (0.10.3)
     rb-inotify (0.9.10)
       ffi (>= 0.5.0, < 2)
@@ -80,15 +79,16 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sqlite3 (1.3.13)
+    sqlite3 (1.4.1)
     thor (0.20.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     webmock (3.4.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby
@@ -103,4 +103,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.16.1
+   1.17.3

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'danconia'
+
+require 'pry'
+Pry.start

data/examples/currency_layer.rb

@@ -1,6 +1,5 @@
 # Remember to supply your CurrencyLayer key in the ACCESS_KEY environment variable to run this example
-require 'danconia'
-
+ActiveRecord::Base.logger = Logger.new(STDOUT)
 ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
 
 ActiveRecord::Schema.define do
@@ -23,4 +22,4 @@ end
 puts 'Updating dates with CurrencyLayer API...'
 Danconia.config.default_exchange.update_rates!
 
-puts Money(1, 'USD').exchange_to('EUR').inspect # => 0.854896 EUR
+puts Money(1, 'USD').exchange_to('EUR').inspect # => 0.854896 EUR

data/examples/fixed_rates.rb

@@ -1,8 +1,6 @@
-require 'danconia'
-
 Danconia.configure do |config|
   config.default_currency = 'ARS'
   config.default_exchange = Danconia::Exchanges::FixedRates.new(rates: {'USDARS' => 27.5, 'USDEUR' => 0.86})
 end
 
-puts Money(10, 'ARS').exchange_to('EUR').inspect # => 0.31273 EUR
+puts Money(10, 'ARS').exchange_to('EUR').inspect # => 0.31273 EUR

data/examples/single_currency.rb

@@ -1,5 +1,3 @@
-require 'danconia'
-
 # USD is the default currency if no configuration is provided
 puts (Money(10.25) / 2).inspect # => 5.125 USD
 puts (Money(10.25) / 2).to_s # => $5.13

data/lib/danconia/currency.rb

@@ -5,4 +5,4 @@ module Danconia
       new Danconia.config.available_currencies.find { |c| c[:code] == code } || {code: code, symbol: '$'}
     end
   end
-end
+end

data/lib/danconia/exchanges/exchange.rb

@@ -1,3 +1,5 @@
+require 'danconia/pair'
+
 module Danconia
   module Exchanges
     class Exchange
@@ -8,15 +10,11 @@ module Danconia
       end
 
       def rate from, to
-        if from == 'USD' and direct_rate = @store.direct_rate(from, to)
-          direct_rate
-        elsif to == 'USD' and inverse_rate = @store.direct_rate(to, from)
-          (1.0 / inverse_rate).round 6
-        elsif from != 'USD' and to != 'USD' and from_in_usd = rate(from, 'USD') and to_per_usd = rate('USD', to)
-          (from_in_usd * to_per_usd).round 6
-        else
-          raise Errors::ExchangeRateNotFound.new(from, to)
-        end
+        return 1.0 if from == to
+
+        pair = Pair.new(from, to)
+        rates = direct_and_inverted_rates()
+        rates[pair] or indirect_rate(pair, rates) or raise Errors::ExchangeRateNotFound.new(from, to)
       end
 
       def rates
@@ -26,6 +24,24 @@ module Danconia
       def update_rates!
         @store.save_rates fetch_rates
       end
+
+      private
+
+      # Returns the original rates plus the inverted ones, to simplify rate finding logic.
+      def direct_and_inverted_rates
+        rates.each_with_object({}) do |(pair_str, rate), rs|
+          pair = Pair.parse(pair_str)
+          rs[pair] = rate
+          rs[pair.invert] ||= 1.0 / rate
+        end
+      end
+
+      def indirect_rate ind_pair, rates
+        if (from_pair = rates.keys.detect { |(pair, rate)| pair.from == ind_pair.from }) &&
+           (to_pair = rates.keys.detect { |(pair, rate)| pair.to == ind_pair.to })
+          rates[from_pair] * rates[to_pair]
+        end
+      end
     end
   end
-end
+end

data/lib/danconia/money.rb

@@ -13,13 +13,12 @@ module Danconia
       @exchange = exchange
     end
 
-    def format decimals: @decimals
-      ActiveSupport::NumberHelper.number_to_currency amount, precision: decimals, unit: currency.symbol
+    def format decimals: @decimals, **other_options
+      opts = other_options.reverse_merge precision: decimals, unit: currency.symbol
+      ActiveSupport::NumberHelper.number_to_currency amount, opts
     end
 
-    def to_s
-      format
-    end
+    alias to_s format
 
     def inspect
       "#{amount} #{currency.code}"
@@ -46,23 +45,17 @@ module Danconia
       amount <=> other
     end
 
-    def exchange_to other_currency
+    def exchange_to other_currency, exchange: @exchange
       other_currency = other_currency.presence && Currency.find(other_currency, exchange) || currency
-      rate = exchange_rate_to(other_currency.code)
-      clone_with amount * rate, other_currency
-    end
-
-    def exchange_rate_to to
-      from = currency.code
-      return 1 if from == to
-      exchange.rate from, to
+      rate = exchange.rate currency.code, other_currency.code
+      clone_with amount * rate, other_currency, exchange
     end
 
     %w(+ - * /).each do |op|
       class_eval <<-EOR, __FILE__, __LINE__ + 1
         def #{op} other
-          other = other.exchange_to(currency).amount if other.is_a? Money
-          clone_with amount #{op} other
+          other = other.exchange_to(currency, exchange: @exchange).amount if other.is_a? Money
+          clone_with(amount #{op} other)
         end
       EOR
     end
@@ -101,7 +94,7 @@ module Danconia
       BigDecimal(object.to_s) rescue BigDecimal(0)
     end
 
-    def clone_with amount, currency = @currency
+    def clone_with amount, currency = @currency, exchange = @exchange
       Money.new amount, currency, decimals: decimals, exchange: exchange
     end
   end

data/lib/danconia/pair.rb

@@ -0,0 +1,15 @@
+module Danconia
+  Pair = Struct.new(:from, :to) do
+    def self.parse str
+      new str[0..2], str[3..-1]
+    end
+
+    def invert
+      Pair.new to, from
+    end
+
+    def to_s
+      [from, to].join
+    end
+  end
+end

data/lib/danconia/stores/active_record.rb

@@ -9,12 +9,8 @@ module Danconia
         end
       end
 
-      def direct_rate from, to
-        ExchangeRate.find_by(pair: [from, to].join)&.rate
-      end
-
       def rates
-        ExchangeRate.all
+        Hash[ExchangeRate.all.map { |er| [er.pair, er.rate] }]
       end
     end
 

data/lib/danconia/stores/in_memory.rb

@@ -3,18 +3,14 @@ module Danconia
     class InMemory
       attr_reader :rates
 
+      # `rates` should be of a map of pair->rate like {'USDEUR' => 1.25}
       def initialize rates: {}
         save_rates rates
       end
 
-      # @rates should be of a map of pair->rate like {'USDEUR' => 1.25}
       def save_rates rates
         @rates = rates
       end
-
-      def direct_rate from, to
-        @rates[[from, to].join]
-      end
     end
   end
 end

data/lib/danconia/version.rb

@@ -1,3 +1,3 @@
 module Danconia
-  VERSION = '0.2.4'
+  VERSION = '0.2.9'
 end

data/spec/danconia/exchanges/currency_layer_spec.rb

@@ -7,29 +7,12 @@ module Danconia
 
       context 'fetch_rates' do
         it 'uses the API to retrive the rates' do
-          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: <<~END
-            {
-                "success": true,
-                "source": "USD",
-                "quotes": {
-                    "USDARS": 27.110001,
-                    "USDAUD": 1.346196
-                }
-            }
-          END
+          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: fixture('success.json')
           expect(subject.fetch_rates).to eq 'USDARS' => 27.110001, 'USDAUD' => 1.346196
         end
 
         it 'when the API returns an error' do
-          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: <<~END
-            {
-                "success": false,
-                "error": {
-                  "code": 104,
-                  "info": "Your monthly usage limit has been reached. Please upgrade your subscription plan."
-                }
-            }
-          END
+          stub_request(:get, 'http://www.apilayer.net/api/live?access_key=[KEY]').to_return body: fixture('failure.json')
           expect { subject.fetch_rates }.to raise_error Errors::APIError
         end
       end
@@ -38,7 +21,7 @@ module Danconia
         it 'fetches the rates and stores them' do
           expect(subject).to receive(:fetch_rates) { {'USDARS' => 3, 'USDAUD' => 4} }
           subject.update_rates!
-          expect(subject.rates.size).to eq 2
+          expect(subject.store.rates.size).to eq 2
           expect(subject.rate('USD', 'ARS')).to eq 3
           expect(subject.rate('USD', 'AUD')).to eq 4
         end
@@ -50,6 +33,10 @@ module Danconia
           expect(subject.rate('USD', 'ARS')).to eq 3.1
         end
       end
+
+      def fixture file
+        File.read("#{__dir__}/fixtures/currency_layer/#{file}")
+      end
     end
   end
-end
+end

data/spec/danconia/exchanges/exchange_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+module Danconia
+  module Exchanges
+    describe Exchange do
+      context 'rate' do
+        it 'returns the exchange rate value for the supplied currencies' do
+          exchange = fake_exchange('USDEUR' => 3, 'USDARS' => 4)
+          expect(exchange.rate('USD', 'EUR')).to eq 3
+          expect(exchange.rate('USD', 'ARS')).to eq 4
+        end
+
+        it 'if the direct conversion is not found, tries to find the inverse' do
+          exchange = fake_exchange('USDEUR' => 3)
+          expect(exchange.rate('EUR', 'USD')).to be_within(0.00001).of(1.0 / 3)
+        end
+
+        it 'if not direct nor inverse conversion is found, tries to convert through USD' do
+          exchange = fake_exchange('USDEUR' => 3, 'USDARS' => 6)
+          expect(exchange.rate('EUR', 'ARS')).to be_within(0.00001).of 2
+          expect(exchange.rate('ARS', 'EUR')).to be_within(0.00001).of 0.5
+        end
+
+        it 'pairs can have a different common currency' do
+          exchange = fake_exchange('EURARS' => 3, 'BRLARS' => 1.5)
+          expect(exchange.rate('EUR', 'ARS')).to eq 3
+          expect(exchange.rate('ARS', 'EUR')).to be_within(0.00001).of(1.0 / 3)
+          expect(exchange.rate('BRL', 'ARS')).to eq 1.5
+          expect(exchange.rate('EUR', 'BRL')).to eq 3 / 1.5
+        end
+
+        it 'raises an error if the conversion cannot be made' do
+          expect { subject.rate('USD', 'EUR') }.to raise_error Errors::ExchangeRateNotFound
+        end
+
+        def fake_exchange(rates)
+          FixedRates.new(rates: rates)
+        end
+      end
+    end
+  end
+end

data/spec/danconia/exchanges/fixtures/currency_layer/failure.json

@@ -0,0 +1,7 @@
+{
+  "success": false,
+  "error": {
+    "code": 104,
+    "info": "Your monthly usage limit has been reached. Please upgrade your subscription plan."
+  }
+}

data/spec/danconia/exchanges/fixtures/currency_layer/success.json

@@ -0,0 +1,8 @@
+{
+  "success": true,
+  "source": "USD",
+  "quotes": {
+    "USDARS": 27.110001,
+    "USDAUD": 1.346196
+  }
+}

data/spec/danconia/money_spec.rb

@@ -39,7 +39,7 @@ module Danconia
       end
 
       it 'should exchange the other currency if it is different' do
-        expect(Money(1, 'ARS') + Money(1, 'USD', exchange: fake_exchange(rate: 4))).to eq Money(5, 'ARS')
+        expect(Money(1, 'ARS', exchange: fake_exchange(rate: 4)) + Money(1, 'USD')).to eq Money(5, 'ARS')
       end
 
       it 'should return a new object with the same options' do
@@ -89,6 +89,10 @@ module Danconia
       it 'allow to override the number of decimals' do
         expect(Money(3.561, decimals: 3).format(decimals: 1)).to eq '$3.6'
       end
+
+      it 'pass the options to the activesupport helper' do
+        expect(Money(2).format(format: '%n %u')).to eq '2.00 $'
+      end
     end
 
     context 'to_s' do
@@ -117,17 +121,29 @@ module Danconia
     end
 
     context 'exchange_to' do
-      it 'should use the exchange passed to the instance to get the rate' do
-        expect(Money(2, 'USD', exchange: fake_exchange(rate: 3)).exchange_to('ARS')).to eq Money(6, 'ARS')
-      end
-
-      it 'should use the default exchange if not set' do
+      it 'should use a default exchange if not overriden' do
         TestHelpers.with_rates 'USDEUR' => 3, 'USDARS' => 4 do
           expect(Money(2, 'USD').exchange_to('EUR')).to eq Money(6, 'EUR')
           expect(Money(2, 'USD').exchange_to('ARS')).to eq Money(8, 'ARS')
         end
       end
 
+      it 'should allow to pass the exchange to the instance' do
+        expect(Money(2, 'USD', exchange: fake_exchange(rate: 3)).exchange_to('ARS')).to eq Money(6, 'ARS')
+      end
+
+      it 'should allow to pass the exchange when converting' do
+        expect(Money(2, 'USD').exchange_to('ARS', exchange: fake_exchange(rate: 4))).to eq Money(8, 'ARS')
+      end
+
+      it 'when overriding the exchange, should preserve it in the new instances' do
+        m1 = Money(1, 'USD').exchange_to('ARS', exchange: fake_exchange(rate: 2))
+        m2 = m1 + Money(3, 'USD')
+        m3 = m2 * Money(1, 'USD')
+        expect(m2).to eq Money(8, 'ARS')
+        expect(m3).to eq Money(16, 'ARS')
+      end
+
       it 'if no rate if found should raise error' do
         expect { Money(2, 'USD').exchange_to('ARS') }.to raise_error Errors::ExchangeRateNotFound
       end
@@ -174,7 +190,7 @@ module Danconia
     end
 
     def fake_exchange args = {}
-      double 'exchange', args.reverse_merge(rate: nil)
+      double 'Danconia::Exchanges::Exchange', args.reverse_merge(rate: nil)
     end
   end
 end

data/spec/danconia/stores/active_record_spec.rb

@@ -7,15 +7,15 @@ module Danconia
         it 'should create or update the rates' do
           ExchangeRate.create! pair: 'USDEUR', rate: 2
           expect { subject.save_rates 'USDEUR' => 3, 'USDARS' => 4 }.to change { ExchangeRate.count }.by 1
-          expect(subject.rates.map { |e| [e.pair, e.rate] }).to eq({'USDEUR' => 3, 'USDARS' => 4}.to_a)
+          expect(subject.rates).to eq('USDEUR' => 3, 'USDARS' => 4)
         end
       end
 
-      context '#direct_rate' do
-        it 'should find the rate for the pair' do
+      context 'rates' do
+        it 'returns a hash with rate by pair' do
           ExchangeRate.create! pair: 'USDEUR', rate: 2
-          expect(subject.direct_rate('USD', 'EUR')).to eq 2
-          expect(subject.direct_rate('USD', 'ARS')).to eq nil
+          ExchangeRate.create! pair: 'USDARS', rate: 40
+          expect(subject.rates).to eq('USDEUR' => 2, 'USDARS' => 40)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danconia
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.9
 platform: ruby
 authors:
 - Emmanuel Nicolau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-16 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -110,7 +110,8 @@ dependencies:
         version: '0'
 description: Multi-currency money library backed by BigDecimal
 email: emmanicolau@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
@@ -124,6 +125,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - danconia.gemspec
 - examples/currency_layer.rb
 - examples/fixed_rates.rb
@@ -139,12 +141,15 @@ files:
 - lib/danconia/integrations/active_record.rb
 - lib/danconia/kernel.rb
 - lib/danconia/money.rb
+- lib/danconia/pair.rb
 - lib/danconia/stores/active_record.rb
 - lib/danconia/stores/in_memory.rb
 - lib/danconia/test_helpers.rb
 - lib/danconia/version.rb
 - spec/danconia/exchanges/currency_layer_spec.rb
-- spec/danconia/exchanges/fixed_rates_spec.rb
+- spec/danconia/exchanges/exchange_spec.rb
+- spec/danconia/exchanges/fixtures/currency_layer/failure.json
+- spec/danconia/exchanges/fixtures/currency_layer/success.json
 - spec/danconia/integrations/active_record_spec.rb
 - spec/danconia/money_spec.rb
 - spec/danconia/stores/active_record_spec.rb
@@ -176,7 +181,9 @@ specification_version: 4
 summary: Multi-currency money library backed by BigDecimal
 test_files:
 - spec/danconia/exchanges/currency_layer_spec.rb
-- spec/danconia/exchanges/fixed_rates_spec.rb
+- spec/danconia/exchanges/exchange_spec.rb
+- spec/danconia/exchanges/fixtures/currency_layer/failure.json
+- spec/danconia/exchanges/fixtures/currency_layer/success.json
 - spec/danconia/integrations/active_record_spec.rb
 - spec/danconia/money_spec.rb
 - spec/danconia/stores/active_record_spec.rb

data/spec/danconia/exchanges/fixed_rates_spec.rb

@@ -1,30 +0,0 @@
-require 'spec_helper'
-
-module Danconia
-  module Exchanges
-    describe FixedRates do
-      context 'rate' do
-        it 'returns the exchange rate value for the supplied currencies' do
-          exchange = FixedRates.new rates: {'USDEUR' => 3, 'USDARS' => 4}
-          expect(exchange.rate 'USD', 'EUR').to eq 3
-          expect(exchange.rate 'USD', 'ARS').to eq 4
-        end
-
-        it 'returns nil if not found' do
-          expect { subject.rate 'USD', 'EUR' }.to raise_error Errors::ExchangeRateNotFound
-        end
-
-        it 'if the direct conversion is not found, tries to find the inverse' do
-          exchange = FixedRates.new rates: {'USDEUR' => 3}
-          expect(exchange.rate 'EUR', 'USD').to eq (1.0 / 3).round 6
-        end
-
-        it 'if not direct nor inverse conversion is found and both are different than USD, tries to convert through USD' do
-          exchange = FixedRates.new rates: {'USDEUR' => 3, 'USDARS' => 6}
-          expect(exchange.rate 'EUR', 'ARS').to be_within(0.00001).of 2
-          expect(exchange.rate 'ARS', 'EUR').to be_within(0.00001).of 0.5
-        end
-      end
-    end
-  end
-end