xirr 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfe1ad8aa4e571c85347827c80894312fcc0c2e1
-  data.tar.gz: dd2705ba456cccc2b6e01f1d10febdaf65cd7aef
+  metadata.gz: 50b1c197309bdd06705daf0badab16e913e3dd2b
+  data.tar.gz: 7a8b870eb1de0e1fdc0c6eead98de46c9e6084de
 SHA512:
-  metadata.gz: 5e6b8f6b854db434c1e295f5421adaa5b4860c254e76bf7e38663a666c1cac34a925ccc11b44ebefd8f49ff72d2f2082275d7251432360341c0d7efbb2b8a60d
-  data.tar.gz: edd72d68efe8fc75192d01b1ad432b6f88b94c8d5c9767b7141a8ffa28bdb9148bcfa4b19d03501e3f7ecc8ea12e219c2ac6e785d0410c15c5d3884028d6388c
+  metadata.gz: 5d23ecb62b426a25d8d97341c40da0fc5a058c4a13d3945010511ef34bb1206430e7883199f49b28d836d7f98dfc8b8e5343dbe9f689bd7c5be17de4f26f6648
+  data.tar.gz: e91a1d141d2d64167e9b473921bb4e5f1f656e36953d5ffbecb0acb77aa81ea1f1e93010661231063a7035007d15528fc0b806af009ffe98bca17bf295488006

data/CHANGE_LOG.md

@@ -1,3 +1,9 @@
+## Version 0.4.0
+
+* Xirr returns nil and there is now a default settings to replace nil rate.
+* It will compact the flow automatically, unless specified in the defaults.
+* Attention to the new way, the Cashflow is created. Cashflow.new requires a Compacted boolean before the array of flow.
+
 ## Version 0.3.1
 
 * Added fallback to secondary calculation method.

data/lib/xirr/cashflow.rb

@@ -11,11 +11,20 @@ module Xirr
     #   cf << Transaction.new(-1234, date: '2013-03-31'.to_date)
     #   Or
     #   cf = Cashflow.new Transaction.new( 1000, date: '2013-01-01'.to_date), Transaction.new(-1234, date: '2013-03-31'.to_date)
-    def initialize(*args)
+    def initialize(compacted = false, *args)
+      @compacted = compacted
       args.each { |a| self << a }
       self.flatten!
     end
 
+    def compacted?
+      @compacted && self.count > uniq_dates.count
+    end
+
+    def uniq_dates
+      @uniq_dates = self.map(&:date).uniq
+    end
+
     # Check if Cashflow is invalid
     # @return [Boolean]
     def invalid?
@@ -43,30 +52,40 @@ module Xirr
     # Calculates a simple IRR guess based on period of investment and multiples.
     # @return [Float]
     def irr_guess
-      valid? ? ((multiple ** (1 / years_of_investment)) - 1).round(3) : false
+      @irr_guess = valid? ? ((multiple ** (1 / years_of_investment)) - 1).round(3) : false
+      @irr_guess == 1.0/0 ? 0.0 : @irr_guess
     end
 
     # @param guess [Float]
     # @param method [Symbol]
     # @return [Float]
     # Finds the XIRR according to the method provided.
-    def xirr_with_exception(guess = nil, method = Xirr.config.default_method)
-      if valid?
-        choose_(method).send(:xirr, guess) || choose_(method == :newton_method ? :bisection : :newton_method).send(:xirr, guess)
-      else
-        raise ArgumentError, invalid_message
-      end
+    def xirr_with_exception(guess = nil, method = Xirr.config.default_method, compact = Xirr.config.compact)
+      raise ArgumentError, invalid_message if invalid?
+      xirr = choose_(method, compact).send(:xirr, guess) || choose_(other_calculation_method(method), compact).send(:xirr, guess)
+      xirr.nil? ? Xirr.config.replace_for_nil : xirr
+    end
+
+    def other_calculation_method(method)
+      method == :newton_method ? :bisection : :newton_method
+    end
+
+    def compact_cf
+      compact = Hash.new
+      uniq_dates.each { |date| compact[date] = 0 }
+      self.each { |flow| compact[flow.date] += flow.amount }
+      Cashflow.new(true, compact.map { |key, value| Transaction.new(value, date: key.to_date) })
     end
 
     # Calls XIRR but throws no exception and returns with 0
     # @param guess [Float]
     # @param method [Symbol]
     # @return [Float]
-    def xirr(guess = nil, method = Xirr.config.default_method)
+    def xirr(guess = nil, method = Xirr.config.default_method, compact = Xirr.config.compact)
       if invalid?
         BigDecimal.new(0, Xirr::PRECISION)
       else
-        xirr_with_exception(guess, method)
+        xirr_with_exception(guess, method, compact)
       end
     end
 
@@ -89,12 +108,12 @@ module Xirr
     # @param method [Symbol]
     # Choose a Method to call.
     # @return [Class]
-    def choose_(method)
+    def choose_(method, compact)
       case method
         when :bisection
-          Bisection.new(self)
+          Bisection.new(compact && compacted? ? compact_cf : self)
         when :newton_method
-          NewtonMethod.new(self)
+          NewtonMethod.new(compact && compacted? ? compact_cf : self)
         else
           raise ArgumentError, "There is no method called #{method} "
       end
@@ -124,7 +143,7 @@ module Xirr
     # Counts how many years from first to last transaction in the cashflow
     # @return
     def years_of_investment
-      (max_date - min_date) / (365).to_f
+      (max_date - min_date) / (365.0)
     end
 
     # @api private

data/lib/xirr/config.rb

@@ -3,13 +3,14 @@ module Xirr
 
   # Sets as constants all the entries in the Hash Default values
   default_values = {
-      eps: '1.0e-6'.to_f,
-      days_in_year: 365,
+      eps:             '1.0e-6'.to_f,
+      days_in_year:    365.0,
       iteration_limit: 50,
-      precision: 6,
-      # default_method: :bisection,
-      default_method: :newton_method,
-      fallback: true
+      precision:       6,
+      default_method:  :newton_method,
+      fallback:        true,
+      replace_for_nil: 0.0,
+      compact:         true
   }
 
   # Iterates though default values and sets in config

data/lib/xirr/version.rb

@@ -1,4 +1,4 @@
 module Xirr
   # Version of the Gem
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/test/test_cashflow.rb

@@ -129,7 +129,7 @@ describe 'Cashflows' do
       assert true, !@cf.valid?
     end
 
-    it 'returns 0 instead of expection ' do
+    it 'returns 0 instead of exception ' do
       assert_equal BigDecimal.new(0, 6), @cf.xirr
     end
 
@@ -193,9 +193,7 @@ describe 'Cashflows' do
 
   describe 'of a long investment' do
     before(:all) do
-      @cf = Cashflow.new
-      @cf << Transaction.new(-1000, date: Date.new(1957, 1, 1))
-      @cf << Transaction.new(390000, date: Date.new(2013, 1, 1))
+      @cf = Cashflow.new false, Transaction.new(-1000, date: Date.new(1957, 1, 1)), Transaction.new(390000, date: Date.new(2013, 1, 1))
     end
 
     it 'has an Internal Rate of Return on Bisection Method' do
@@ -212,6 +210,25 @@ describe 'Cashflows' do
 
   end
 
+  describe 'reapeated cashflow' do
+    before(:all) do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000.0, date: '2011-12-07'.to_date)
+      @cf << Transaction.new(2000.0, date: '2011-12-07'.to_date)
+      @cf << Transaction.new(-2000.0, date: '2013-05-21'.to_date)
+      @cf << Transaction.new(-4000.0, date: '2013-05-21'.to_date)
+    end
+
+    it 'has a compact cashflow' do
+      assert_equal 2, @cf.compact_cf.count
+    end
+
+    it 'sums all transactions' do
+      assert_equal -3000.0, @cf.compact_cf.map(&:amount).inject(&:+)
+    end
+
+  end
+
   describe 'of a real case' do
     before(:all) do
       @cf = Cashflow.new
@@ -249,12 +266,32 @@ describe 'Cashflows' do
       @cf << Transaction.new(84710.65, date: '2013-05-21'.to_date)
       @cf << Transaction.new(-84710.65, date: '2013-05-21'.to_date)
       @cf << Transaction.new(-144413.24, date: '2013-05-21'.to_date)
+
     end
 
-    it 'has an Internal Rate of Return on Newton Method HERE' do
+    it 'is a long and bad investment and newton generates an error' do
       assert_equal '-0.99'.to_f, @cf.xirr(nil, :newton_method)
     end
 
+    it 'compacted ' do
+      cf = @cf
+      cf << Transaction.new(-1000000.0, date: '2013-05-21'.to_date)
+      assert_kind_of(Cashflow, cf.compact_cf)
+      assert_equal -0.885744, cf.xirr(nil, :newton_method, true)
+      assert_equal -0.885744, cf.xirr(nil, :bisection, true)
+    end
+
+    it 'has zero for years of investment' do
+      cf = Cashflow.new false, Transaction.new(105187.06, date: '2011-12-07'.to_date), Transaction.new(-105187.06 * 1.0697668105671994, date: '2011-12-07'.to_date)
+      assert_equal 0.0, cf.irr_guess
+      assert_equal Xirr.config.replace_for_nil, cf.xirr(nil, :newton_method)
+    end
+
+    it 'has is valid even if compacted' do
+      cf = Cashflow.new false, Transaction.new(100, date: Date.today), Transaction.new(-100, date: Date.today)
+      assert_equal 0.0, cf.xirr(nil, :newton_method, true)
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xirr
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - tubedude