finrb 0.0.1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Dockerfile

@@ -0,0 +1,35 @@
+FROM ruby:3.1.2 AS development
+
+LABEL maintainer="nadircs11@gmail.co.il"
+
+RUN dpkg --add-architecture i386
+
+SHELL [ "/bin/bash", "-c" ]
+
+RUN apt update -yqq && \
+  apt install --no-install-recommends -yqq nano apt-utils locales && \
+  apt clean && \
+  rm -rf /var/lib/apt/lists/*
+
+RUN gem install bundler
+RUN bundle config --global jobs 16
+
+RUN mkdir -pv /app
+WORKDIR /app
+
+RUN mkdir -pv ./lib/
+COPY *.gemspec ./
+COPY Gemfile* ./
+RUN bundle install
+
+WORKDIR /app
+
+COPY . .
+
+ENTRYPOINT ["/bin/bash", "-c", "/bin/bash"]
+
+FROM development AS testing
+
+RUN bundle exec rake test_units || exit 0
+
+ENTRYPOINT ["/bin/bash", "-c", "/bin/bash"]

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,116 @@
+PATH
+  remote: .
+  specs:
+    finrb (0.0.1)
+      activesupport
+      business_time
+      flt
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (7.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    backport (1.2.0)
+    benchmark (0.2.0)
+    business_time (0.13.0)
+      activesupport (>= 3.2.0)
+      tzinfo
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    e2mmap (0.1.0)
+    flt (1.5.4)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.6.2)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    method_source (1.0.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.2)
+    nokogiri (1.13.8)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    reverse_markdown (2.1.1)
+      nokogiri
+    rexml (3.2.5)
+    rubocop (1.33.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.19.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.19.1)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.21.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-performance (1.14.3)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    semver (1.0.1)
+    solargraph (0.45.0)
+      backport (~> 1.2)
+      benchmark
+      bundler (>= 1.17.2)
+      diff-lcs (~> 1.4)
+      e2mmap
+      jaro_winkler (~> 1.5)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.1)
+      parser (~> 3.0)
+      reverse_markdown (>= 1.0.5, < 3)
+      rubocop (>= 0.52)
+      thor (~> 1.0)
+      tilt (~> 2.0)
+      yard (~> 0.9, >= 0.9.24)
+    thor (1.2.1)
+    tilt (2.0.11)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  finrb!
+  minitest
+  pry
+  rake
+  rubocop
+  rubocop-minitest
+  rubocop-performance
+  rubocop-rake
+  semver
+  solargraph
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,99 @@
+# finrb
+
+Ruby gem for financial calculations/modeling.
+
+finrb forked from the ruby [finance](https://github.com/Edward-Intelligence/finance) gem.
+
+## Overview
+
+### Features
+
+Currently implemented features include:
+
+* Uses the [flt](https://github.com/jgoizueta/flt) gem to ensure precision decimal arithmetic in all calculations.
+* Fixed-rate mortgage amortization (30/360).
+* Interest rates
+* Various cash flow computations, such as NPV and IRR.
+* Adjustable rate mortgage amortization.
+* Payment modifications (i.e., how does paying an additional $75 per month affect the amortization?)
+* Utils class provides basic financial calculation utilities (ported from R's [FinCal](https://github.com/felixfan/FinCal) library):
+  * Computing bank discount yield (BDY) for a T-bill
+  * Computing money market yield (MMY) for a T-bill
+  * Cash ratio - Liquidity ratios measure the firm's ability to satisfy its short-term obligations as they come due.
+  * Computing Coefficient of variation
+  * Cost of goods sold and ending inventory under three methods (FIFO,LIFO,Weighted average)
+  * Current ratio - Liquidity ratios measure the firm's ability to satisfy its short-term obligations as they come due.
+  * Depreciation Expense Recognition - double-declining balance (DDB), the most common declining balance method, which applies two times the straight-line rate to the declining balance.
+  * Debt ratio - Solvency ratios measure the firm's ability to satisfy its long-term obligations.
+  * Diluted Earnings Per Share
+  * Computing the rate of return for each period
+  * Convert stated annual rate to the effective annual rate
+  * Convert stated annual rate to the effective annual rate with continuous compounding
+  * Bond-equivalent yield (BEY), 2 x the semiannual discount rate
+  * Computing HPR, the holding period return
+  * Equivalent/proportional Interest Rates
+  * Basic Earnings Per Share
+  * Financial leverage - Solvency ratios measure the firm's ability to satisfy its long-term obligations.
+  * Estimate future value (fv)
+  * Estimate future value of an annuity
+  * Estimate future value (fv) of a single sum
+  * Computing the future value of an uneven cash flow series
+  * Geometric mean return
+  * Gross profit margin - Evaluate a company's financial performance
+  * Harmonic mean, average price
+  * Computing HPR, the holding period return
+  * Bond-equivalent yield (BEY), 2 x the semiannual discount rate
+  * Convert holding period return to the effective annual rate
+  * Computing money market yield (MMY) for a T-bill
+  * Computing IRR, the internal rate of return
+  * Calculate the net increase in common shares from the potential exercise of stock options or warrants
+  * Long-term debt-to-equity - Solvency ratios measure the firm's ability to satisfy its long-term obligations.
+  * Computing HPR, the holding period return
+  * Estimate the number of periods
+  * Net profit margin - Evaluate a company's financial performance
+  * Computing NPV, the PV of the cash flows less the initial (time = 0) outlay
+  * Estimate period payment
+  * Estimate present value (pv)
+  * Estimate present value (pv) of an annuity
+  * Estimate present value of a perpetuity
+  * Estimate present value (pv) of a single sum
+  * Computing the present value of an uneven cash flow series
+  * Quick ratio - Liquidity ratios measure the firm's ability to satisfy its short-term obligations as they come due.
+  * Convert a given norminal rate to a continuous compounded rate
+  * Convert a given continuous compounded rate to a norminal rate
+  * Rate of return for a perpetuity
+  * Computing Sampling error
+  * Computing Roy's safety-first ratio
+  * Computing Sharpe Ratio
+  * Depreciation Expense Recognition - Straight-line depreciation (SL) allocates an equal amount of depreciation each year over the asset's useful life
+  * Total debt-to-equity - Solvency ratios measure the firm's ability to satisfy its long-term obligations.
+  * Computing TWRR, the time-weighted rate of return
+  * Calculate weighted average shares - weighted average number of common shares
+  * Weighted mean as a portfolio return
+
+### Configuration
+
+In `config/initializers/finrb.rb` Finrb allows to set tolerance (eps) and default guess for IRR and XIRR calculations, such as:
+
+```ruby
+Finrb.configure do |config|
+  config.eps = '1.0e-12'
+  config.guess = 0.5
+  config.business_days = false # only relevant when using Transaction object, skips weekends
+  config.periodic_compound = false # only relevant when using Transaction object
+end
+```
+
+### API and examples
+
+See [api.md](docs/api.md)
+
+## Resources
+
+* [RubyGems Page](https://rubygems.org/gems/finrb)
+* [Source Code](http://github.com/ncs1/finrb)
+* [Bug Tracker](https://github.com/ncs1/finrb/issues)
+
+## License
+
+See [COPYING](./COPYING) and [COPYING.LESSER](./COPYING.LESSER)

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/testtask'
+
+task default: [:test_units]
+
+Rake::TestTask.new('test_units') do |t|
+  t.pattern = 'test/*.rb'
+  t.verbose = true
+  t.warning = true
+end
+
+namespace :docker do
+  desc 'Build docker instance'
+  task :build do
+    Dir.chdir(__dir__.to_s) do
+      system 'docker build --target development -t finrb:1.0 -f Dockerfile .'
+    end
+  end
+
+  desc 'Run test docker build'
+  task :test do
+    Dir.chdir(__dir__.to_s) do
+      system 'docker build --target testing -t finrb:1.0 -f Dockerfile .'
+    end
+  end
+
+  desc 'Run dev docker instance'
+  task :run do
+    system 'docker run --init -it --rm finrb:1.0'
+  end
+end