finance_rb 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fa908552e787182999bb782ed6c7f7f624307f0acd77ff969c0171e07dd0179
+  data.tar.gz: e0492ef3dd7baa271a4d7893ff32c5c94de852d2328d1c49321bb1d78147f08e
+SHA512:
+  metadata.gz: ccc866a27aecf49b0f869f9ddf590ac58d7682bc35c30a5abfda526251b800960b143fa19b05063411e30061a96f950963c4f8c38d867da763b1654ec77bfb52
+  data.tar.gz: 5ca7d064faf5bb38ad5cd70ddb1595d8983833e4ad9b46290f17b9f5ca8eee2abd4e4c99eedf852bbf79790c28d54e4aa4743beeffbf72921ff0dccc95f1cc94

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## [Unreleased]
+
+## [0.0.2] - 2021-03-22
+
+- Initial public release
+
+
+## [0.0.1] - 2021-03-20
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Vladislav
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+# finance_rb
+
+This package is a ruby native port of the numpy-financial package with some helpful additional functions.
+
+The functions in this package are a scalar version of their vectorised counterparts in  the [numpy-financial](https://github.com/numpy/numpy-financial) library.
+
+Currently, only some functions are ported,  
+which are as follows:  
+
+| numpy-financial function     | ruby native function ported?   | info|
+|:------------------------:    |:------------------:  | :------------------|
+| fv                           |    |   Computes the  future value|
+| ipmt                         |    |   Computes interest payment for a loan|
+| pmt                          |    |   Computes the fixed periodic payment(principal + interest) made against a loan amount|
+| ppmt                         |    |   Computes principal payment for a loan|
+| nper                         |    |    Computes the number of periodic payments|
+| pv                           |      |   Computes the present value of a payment|
+| rate                         |      |    Computes the rate of interest per period|
+| irr                          |       |    Computes the internal rate of return|
+| npv                          |  ✅   |   Computes the net present value of a series of cash flow|
+| mirr                         |       |    Computes the modified internal rate of return|

data/lib/finance/calculations.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Finance
+  class Calculations
+    class << self
+      # Npv computes the Net Present Value of a cash flow series.
+      # @return [Numeric] The NPV of the input cash flow series `values` at the discount `rate`.
+      #
+      # @param [Numeric] :rate A discount rate applied once per period.
+      # @param [Array<Numeric>] :values The values of the time series of cash flows.
+      # 
+      # @example
+      #   require 'finance_rb'
+      #   Finance::Calculations.npv(0.1, [-1000, 100, 100, 100]) #=> -789.3518518518517
+      #
+      # @see http://en.wikipedia.org/wiki/Net_present_value
+      # @see L. J. Gitman, “Principles of Managerial Finance, Brief,” 3rd ed.,
+      #   Addison-Wesley, 2003, pg. 346.
+      def npv(rate, values)
+        npv_value = 0.0
+        values.each_with_index do |current_value, pow_index|
+          npv_value += current_value / (1.0 + rate) ** pow_index
+        end
+        npv_value
+      end
+
+      alias net_present_value npv
+    end
+  end
+end

data/lib/finance/loan.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Finance
+  class Loan
+    def initialize; end
+
+    def pmt; end
+
+    def ipmt; end
+
+    def ppmt; end
+  end
+end

data/lib/finance/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Finance
+  VERSION = "0.0.2"
+end

data/lib/finance_rb.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "finance/calculations"
+require "finance/loan"

data/spec/finance/calculations_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe Finance::Calculations do
+  describe '#npv' do
+    it 'calculates correct npv value' do
+      expect(Finance::Calculations.npv(0.2, [-1000, 100, 100, 100])).to eq(-789.3518518518517)
+    end
+
+    it 'is available through alias name' do
+      expect(
+        Finance::Calculations.net_present_value(0.1, [-100, 6, 6, 6])
+      ).to eq(-85.07888805409468)
+    end
+
+    it 'returns correct npv for zero rates' do
+      expect(
+        Finance::Calculations.net_present_value(0.0, [-2000, 55, 55, 55])
+      ).to eq(-1835.0)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "finance/calculations"
+require "finance/loan"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: finance_rb
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Vlad Dyachenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-03-22 00:00:00.000000000 Z
+dependencies: []
+description: A ruby port of numpy-financial functions. This library provides a Ruby
+  interface for working with interest rates, mortgage amortization, and cashflows
+  and other stuff from finance.
+email:
+- vla-dy@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/finance/calculations.rb
+- lib/finance/loan.rb
+- lib/finance/version.rb
+- lib/finance_rb.rb
+- spec/finance/calculations_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/wowinter13/finance_rb
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/wowinter13/finance_rb/issues
+  changelog_uri: https://github.com/wowinter13/finance_rb/blob/v0.0.2/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/wowinter13/finance_rb/0.0.2
+  source_code_uri: https://github.com/wowinter13/finance_rb/tree/v0.0.2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: A library for finance manipulations in Ruby.
+test_files:
+- spec/finance/calculations_spec.rb
+- spec/spec_helper.rb