finance_velocity 2.0.3

data/test/test_rates.rb

@@ -0,0 +1,72 @@
+require_relative 'test_helper'
+
+describe "Rates" do
+  describe "an interest rate" do
+    describe "can compound with different periods" do
+      it "should compound monthly by default" do
+        rate = Rate.new(0.15, :nominal)
+        assert_equal D('0.16075'), rate.effective.round(5)
+      end
+
+      it "should compound annually" do
+        rate = Rate.new(0.15, :nominal, :compounds => :annually)
+        assert_equal D('0.15'), rate.effective
+      end
+
+      it "should compound continuously" do
+        rate = Rate.new(0.15, :nominal, :compounds => :continuously)
+        assert_equal D('0.16183'), rate.effective.round(5)
+      end
+
+      it "should compound daily" do
+        rate = Rate.new(0.15, :nominal, :compounds => :daily)
+        assert_equal D('0.16180'), rate.effective.round(5)
+      end
+
+      it "should compound quarterly" do
+        rate = Rate.new(0.15, :nominal, :compounds => :quarterly)
+        assert_equal D('0.15865'), rate.effective.round(5)
+      end
+
+      it "should compound semiannually" do
+        rate = Rate.new(0.15, :nominal, :compounds => :semiannually)
+        assert_equal D('0.15563'), rate.effective.round(5)
+      end
+
+      it "should accept a numerical value as the compounding frequency per year" do
+        rate = Rate.new(0.15, :nominal, :compounds => 7)
+        assert_equal D('0.15999'), rate.effective.round(5)
+      end
+
+      it "should raise an exception if an unknown string is given" do
+        assert_raises(ArgumentError){ Rate.new(0.15, :nominal, :compounds => :quickly) }
+      end
+    end
+
+    it "should accept a duration if given" do
+      rate = Rate.new(0.0375, :effective, :duration => 360)
+      assert_equal 360, rate.duration
+    end
+
+    it "should be comparable to other interest rates" do
+      r1 = Rate.new(0.15, :nominal)
+      r2 = Rate.new(0.16, :nominal)
+      assert_equal( 1, r2 <=> r1)
+      assert_equal(-1, r1 <=> r2)
+    end
+
+    it "should convert to a monthly value" do
+      rate = Rate.new(0.0375, :effective)
+      assert_equal D('0.003125'), rate.monthly
+    end
+
+    it "should convert effective interest rates to nominal" do
+      assert_equal D('0.03687'), Rate.to_nominal(D('0.0375'), 12).round(5)
+      assert_equal D('0.03681'), Rate.to_nominal(D('0.0375'), Flt::DecNum.infinity).round(5)
+    end
+
+    it "should raise an exception if an unknown value is given for :type" do
+      assert_raises(ArgumentError){ Rate.new(0.0375, :foo) }
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: finance_velocity
+version: !ruby/object:Gem::Version
+  version: 2.0.3
+platform: ruby
+authors:
+- Mani Bhushan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: flt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: The finance library provides a Ruby interface for working with interest
+  rates, mortgage amortization, and cashflows (NPV, IRR, etc.).
+email: manilnct@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- COPYING
+- COPYING.LESSER
+- HISTORY
+files:
+- ".gitignore"
+- ".rbenv-version"
+- ".yardopts"
+- COPYING
+- COPYING.LESSER
+- Gemfile
+- HISTORY
+- README.md
+- Rakefile
+- finance.gemspec
+- lib/finance.rb
+- lib/finance/amortization.rb
+- lib/finance/cashflows.rb
+- lib/finance/decimal.rb
+- lib/finance/rates.rb
+- lib/finance/transaction.rb
+- test/test_amortization.rb
+- test/test_cashflows.rb
+- test/test_helper.rb
+- test/test_rates.rb
+homepage: https://rubygems.org/gems/finance
+licenses:
+- LGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.12
+signing_key:
+specification_version: 4
+summary: a library for financial modelling in Ruby.
+test_files: []