xirr 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 474f38451b70bce0aab930fb7d7cefd20d9e3aa5
-  data.tar.gz: d9eac1f09cf640bc7cb1eb6c99c5e9cbfb2563a1
+  metadata.gz: 66b347b5dff9686099a5cc4c5edf591f69bfdb80
+  data.tar.gz: cb80f9aba97b06a467e7155f9d787b8de172745d
 SHA512:
-  metadata.gz: b6d71d8d7d43f56b11e22544276319623ecfc88ac1d7e6d483984450fcc0f9cb823dc1e34b7a2a167151f85154e9a31811c1c6c4df32fe3cceb6e135e5db671c
-  data.tar.gz: 0ca6b6c8d79be51df9c866666ccb9180a41aac883d5f99e972d986ab1145a27dfc2bec6976bdb2c713e8c8e50c0fa433dd372ae1524973ef862808db162d30b9
+  metadata.gz: 098443d1b4836a96cd65544cd932f7dacfecc60632e0dfc5d2db08289948eea691113adaa73a3da21d8508dc3f6272fd62f222e7de4306d66e5c6bb4f2c7cdba
+  data.tar.gz: f1cd69d853329c9efcab026153906c887ccdf565028300fd52d96a24eb5f10f408801e030cd3cb36fad9531f5763ad5bcf55c5cc3dc0242125b7630227ba4664

data/CHANGE_LOG.md

@@ -1,3 +1,10 @@
+## Version 0.2.4
+
+* Cashflow Invalid Messages are now public.
+* Cashflow Invalid? won't raise exception
+* Running XIRR in an invalid cashflow will throw exception
+* New Cashflow No Exception XIRR call.
+
 ## Version 0.2.3
 
 * Major fix to Bisection Engine.

data/lib/xirr/cashflow.rb

@@ -19,11 +19,7 @@ module Xirr
     # Check if Cashflow is invalid and raises ArgumentError
     # @return [Boolean]
     def invalid?
-      if positives.empty? || negatives.empty?
-        raise ArgumentError, invalid_message
-      else
-        false
-      end
+      positives.empty? || negatives.empty?
     end
 
     # Inverse of #invalid?
@@ -47,7 +43,7 @@ module Xirr
     # Calculates a simple IRR guess based on period of investment and multiples.
     # @return [Float]
     def irr_guess
-      ((multiple ** (1 / years_of_investment)) - 1).round(3) if valid?
+      valid? ? ((multiple ** (1 / years_of_investment)) - 1).round(3) : false
     end
 
     # @param guess [Float]
@@ -55,25 +51,55 @@ module Xirr
     # @return [Float]
     # Finds the XIRR according to the method provided. Default to Bisection
     def xirr(guess = nil, method = Xirr.config.default_method)
-      _method = case method
-                  when :bisection
-                    Bisection.new(self)
-                  when :newton_method
-                    NewtonMethod.new(self)
-                  else
-                    raise ArgumentError, "There is no #{method} method"
-                end
-      _method.send :xirr, guess if valid?
+      if valid?
+        choose_(method).send :xirr, guess
+      else
+        raise ArgumentError, invalid_message
+      end
+    end
+
+    # Calls XIRR but throws no exception and returns with 0
+    # @param guess [Float]
+    # @param method [Symbol]
+    # @return [Float]
+    def xirr_no_exception(guess = nil, method = Xirr.config.default_method)
+      if invalid?
+        BigDecimal.new(0, Xirr::PRECISION)
+      else
+        xirr(guess, method)
+      end
     end
 
+
     # First investment date
     # @return [Time]
     def min_date
       @min_date ||= self.map(&:date).min
     end
 
+    # @return [String]
+    # Error message depending on the missing transaction
+    def invalid_message
+      return 'No positive transaction' if positives.empty?
+      return 'No negative transaction' if negatives.empty?
+    end
+
     private
 
+    # @param method [Symbol]
+    # Choose a Method to call.
+    # @return [Class]
+    def choose_(method)
+      case method
+        when :bisection
+          Bisection.new(self)
+        when :newton_method
+          NewtonMethod.new(self)
+        else
+          raise ArgumentError, "There is no #{method} method"
+      end
+    end
+
     # @api private
     # Sorts the {Cashflow} by date ascending
     #   and finds the signal of the first transaction.
@@ -129,13 +155,6 @@ module Xirr
       @negatives, @positives = self.partition { |x| x.amount >= 0 } # Inverted as negative amount is good
     end
 
-    # @api private
-    # @return [String]
-    # Error message depending on the missing transaction
-    def invalid_message
-      return 'No positive transaction' if positives.empty?
-      return 'No negative transaction' if negatives.empty?
-    end
 
   end
 

data/lib/xirr/version.rb

@@ -1,4 +1,4 @@
 module Xirr
   # Version of the Gem
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/test/test_cashflow.rb

@@ -89,9 +89,14 @@ describe 'Cashflows' do
     end
 
     it 'is invalid' do
-      assert_raises(ArgumentError) { @cf.valid? }
+      assert true, !@cf.valid?
     end
 
+    it 'returns 0 instead of expection ' do
+      assert_equal BigDecimal.new(0, 6), @cf.xirr_no_exception
+    end
+
+
     it 'with a wrong method is invalid' do
       assert_raises(ArgumentError) { @cf.xirr(nil, :no_method) }
     end
@@ -101,7 +106,7 @@ describe 'Cashflows' do
     end
 
     it 'raises error when xirr is called' do
-      assert_raises(ArgumentError) { @cf.irr_guess }
+      assert true, !@cf.irr_guess
     end
 
   end
@@ -114,7 +119,7 @@ describe 'Cashflows' do
     end
 
     it 'is invalid' do
-      assert_raises(ArgumentError) { @cf.valid? }
+      assert true, !@cf.valid?
     end
 
     it 'raises error when xirr is called' do
@@ -122,7 +127,7 @@ describe 'Cashflows' do
     end
 
     it 'raises error when xirr is called' do
-      assert_raises(ArgumentError) { @cf.irr_guess }
+      assert true, !@cf.irr_guess
     end
   end
 

metadata

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