xirr 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c709c5e546741c7000bd7e496c33bcc3dc01217bbb658d3a11f32133fcbc6497
-  data.tar.gz: f3b599422007ddfab2054b82e2aa2ea8e8cd2eb8c7704d4dddeca3e0fe857bc4
+  metadata.gz: f1281b23c8069cbd5bf16cecf50ae129ea2d4bab31c4c5e89906d970f6e15b7d
+  data.tar.gz: 2431eed14a1de0deb4694621eb8136b10b53c6ce44d888682101e9ca04e46aca
 SHA512:
-  metadata.gz: 7c4a8e5b379d2da61d3fd5294a7615dfe9d023cc027d8c33cf8144e82b8ab05ecffe80095638821becec30e0d14840bff6d1aa1a16c4f67eec3c13eb5d87c13d
-  data.tar.gz: 5e79738f91734d2717d0292c29c3ec3bfe0960a53c2ecef784f75591e0cf60f761a9c36286f3051ff3ca8f331adffaa71427bab5b492a95476ac4e4ceb8ddea8
+  metadata.gz: f6e38c8051ab43168cfafb1442fc897a96e9e25c62b55eb95320cc8f22fca57421ac360626ade4764115c17a4c7aa0fca84568f8d03238d78bc5bb3a123039cf
+  data.tar.gz: 4b450e70ef5d58150e0b9cf416f9246e67b8fa015449f6697042dafe49b49e9114065bc6f711dafa41c5e2bcbff7882ee87d2a77ae55046c89c55aa7d81f6b90

data/.ruby-version

@@ -1 +1 @@
-3.3
+3.3.1

data/CHANGE_LOG.md

@@ -1,3 +1,9 @@
+## Unreleased
+* Fix removal of `RubyInLine`
+* Allow activesupport 7. Fixes #30
+* Breaking: Require activesupport >= 6.1
+* Breaking: Require ruby >= 3.1
+
 ## Version 0.7.0
 * Removed `RubyInLine`
 * Removed possibility to return false from `irr_guess`

data/README.md

@@ -1,5 +1,15 @@
+[![Build Status](https://travis-ci.org/tubedude/xirr.svg)](https://travis-ci.org/tubedude/xirr)[![Coverage Status](https://coveralls.io/repos/tubedude/xirr/badge.svg?branch=master)](https://coveralls.io/r/tubedude/xirr?branch=master)[![Code Climate](https://codeclimate.com/github/tubedude/xirr/badges/gpa.svg)](https://codeclimate.com/github/tubedude/xirr)
+
+## NOTE
+
+This gem is not very well maintained. You can check out a new and properlly maintained library for fast XIRR calculation:
+https://github.com/fintual-oss/fast-xirr
+
+I haven't tried it yet, but I liked two things:
+- All calculations are underlying C ( = Fast )
+- Bad results return NaN ( = you can decide how to deal with it )
+
 # Xirr
-[![Build Status](https://travis-ci.org/tubedude/xirr.svg)](https://travis-ci.org/tubedude/xirr)[![Coverage Status](https://coveralls.io/repos/tubedude/xirr/badge.svg?branch=master)](https://coveralls.io/r/tubedude/xirr?branch=master)[![Code Climate](https://codeclimate.com/github/tubedude/xirr/badges/gpa.svg)](https://codeclimate.com/github/tubedude/xirr)[![Ebert](https://ebertapp.io/github/tubedude/xirr.svg)](https://ebertapp.io/github/tubedude/xirr)
 
 This is a gem to calculate XIRR on Bisection Method or Newton Method.
 

data/lib/xirr/base.rb

@@ -4,7 +4,6 @@ module Xirr
   #  Base module for XIRR calculation Methods
   module Base
     extend ActiveSupport::Concern
-    require 'inline'
     attr_reader :cf
 
     # @param cf [Cashflow]

data/lib/xirr/cashflow.rb

@@ -49,8 +49,10 @@ module Xirr
     # @return [Float]
     def irr_guess
       return @irr_guess = 0.0 if periods_of_investment.zero?
-      @irr_guess = valid? ? ((multiple**(1 / periods_of_investment)) - 1).round(3) : 0.0
-      @irr_guess == 1.0 / 0 ? 0.0 : @irr_guess
+      return @irr_guess = 0.0 if multiple <= 0
+    
+      @irr_guess = valid? ? ((multiple**(1.0 / periods_of_investment)) - 1).round(3) : 0.0
+      @irr_guess.infinite? ? 0.0 : @irr_guess
     end
 
     # @param guess [Float]

data/lib/xirr/version.rb

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

data/test/test_cashflow.rb

@@ -84,7 +84,7 @@ describe 'Cashflows' do
       assert_equal '22.352207  '.to_f, @cf.xirr(method: :bisection)
     end
 
-    it 'It won\'t fall back if method provided' do
+    it 'it won\'t fall back if method provided' do
       @cf.xirr method: :bisection
       assert_equal false, @cf.fallback
     end
@@ -344,4 +344,71 @@ describe 'Cashflows' do
       end
     end
   end
+
+  describe 'irr_guess' do
+    it 'Basic Scenario with Simple Positive Cash Flows' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-1200, date: '2001-01-01'.to_date)
+      assert_equal '0.2'.to_f, @cf.irr_guess
+    end
+    
+    it 'Zero Periods of Investment' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-1000, date: '2000-01-01'.to_date)
+      assert_equal '0.0'.to_f, @cf.irr_guess
+    end
+    
+    it 'Negative Multiple' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-2000, date: '2000-01-01'.to_date)
+      assert_equal '0.0'.to_f, @cf.irr_guess
+    end
+    
+    it 'No Cash Flows' do
+      @cf = Cashflow.new
+      assert_equal '0.0'.to_f, @cf.irr_guess
+    end
+    
+    it 'Multiple Positive Cash Flows and Large Investment Period' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-100, date: '2010-01-01'.to_date)
+      @cf << Transaction.new(-100, date: '2020-01-01'.to_date)
+      assert_equal '0.072'.to_f, @cf.irr_guess
+    end
+    
+    it 'Very Small Periods of Investment' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-500, date: '2000-01-02'.to_date)
+      assert_equal '0.0'.to_f, @cf.irr_guess
+    end
+    
+    it 'Complex Cash Flows' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-500, date: '2001-01-01'.to_date)
+      @cf << Transaction.new(-300, date: '2002-01-01'.to_date)
+      @cf << Transaction.new(-200, date: '2003-01-01'.to_date)
+      assert_equal '0.195'.to_f, @cf.irr_guess
+    end
+    
+    it 'Only Negative Cash Flows' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(-1000, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-500, date: '2001-01-01'.to_date)
+      assert_equal '0.0'.to_f, @cf.irr_guess
+    end
+    
+    it 'Positive and Negative Cash Flows Spread Over Different Periods' do
+      @cf = Cashflow.new
+      @cf << Transaction.new(500, date: '2000-01-01'.to_date)
+      @cf << Transaction.new(-100, date: '2005-01-01'.to_date)
+      @cf << Transaction.new(-400, date: '2010-01-01'.to_date)
+      assert_equal '0.033'.to_f, @cf.irr_guess
+    end
+  end 
 end

data/xirr.gemspec

@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>=2.2.2'
+  spec.required_ruby_version = '>=3.1'
 
-  spec.add_dependency 'activesupport', '>= 5.2', '< 7'
+  spec.add_dependency 'activesupport', '>= 6.1', '< 8'
 
-  spec.add_development_dependency 'activesupport', '>= 5.2', '< 7'
+  spec.add_development_dependency 'activesupport', '>= 6.1', '< 8'
   spec.add_development_dependency 'minitest', '~> 5.14'
   spec.add_development_dependency 'coveralls', '~> 0.8'
   spec.add_development_dependency 'bundler', '>= 2.2'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xirr
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - tubedude
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2025-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +148,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.2
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: Calculates XIRR (Bisection and Newton method) of a cashflow