finrb 0.0.1 → 0.1.1

data/lib/finrb.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require 'active_support/configurable'
+require 'finrb/cashflows'
 require 'finrb/config'
 require 'finrb/decimal'
-require 'finrb/cashflows'
 require 'finrb/utils'
 
 class FinrbError < StandardError; end

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finrb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Nadir Cohen
-- Martin Bjeldbak Madsen
-- Bill Kranec
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-05 00:00:00.000000000 Z
+date: 2023-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: business_time
   requirement: !ruby/object:Gem::Requirement
@@ -55,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -69,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -83,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -111,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-minitest
+  name: rubocop-packaging
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -153,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: semver
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -167,7 +179,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: solargraph
+  name: semver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -180,70 +192,11 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |+
-  The finrb library (forked from the finance gem) provides a Ruby interface for financial calculations/modeling.
-
-  - Working with interest rates
-  - Mortgage amortization
-  - Cashflows (NPV, IRR, etc.)
-  - 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
-
+description: "The finrb library (forked from the finance gem) provides a Ruby interface
+  for financial calculations/modeling. Working with interest rates, Mortgage amortization,
+  Cashflows (NPV, IRR, etc.) and other basic utilities.\n\n"
 email:
 - nadircs11@gmail.com
-- me@martinbjeldbak.com
-- wkranec@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -252,25 +205,10 @@ extra_rdoc_files:
 - COPYING.LESSER
 - CHANGELOG.md
 files:
-- ".dockerignore"
-- ".gitattributes"
-- ".gitignore"
-- ".rubocop.yml"
-- ".ruby-version"
-- ".semver"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
 - COPYING
 - COPYING.LESSER
-- Dockerfile
-- Gemfile
-- Gemfile.lock
 - README.md
-- Rakefile
-- docs/.gitkeep
-- docs/api.md
-- finrb.gemspec
 - lib/finrb.rb
 - lib/finrb/amortization.rb
 - lib/finrb/cashflows.rb
@@ -284,7 +222,7 @@ licenses:
 - LGPL-3.0
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -299,8 +237,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Ruby gem for financial calculations/modeling
 test_files: []

data/.dockerignore

@@ -1,2 +0,0 @@
-.dockerignore
-Dockerfile

data/.gitattributes

@@ -1,83 +0,0 @@
-# Common settings that generally should always be used with your language specific settings
-
-# Auto detect text files and perform LF normalization
-*          text=auto
-
-#
-# The above will handle all files NOT found below
-#
-
-# Documents
-*.bibtex   text diff=bibtex
-*.doc      diff=astextplain
-*.DOC      diff=astextplain
-*.docx     diff=astextplain
-*.DOCX     diff=astextplain
-*.dot      diff=astextplain
-*.DOT      diff=astextplain
-*.pdf      diff=astextplain
-*.PDF      diff=astextplain
-*.rtf      diff=astextplain
-*.RTF      diff=astextplain
-*.md       text diff=markdown
-*.mdx      text diff=markdown
-*.tex      text diff=tex
-*.adoc     text
-*.textile  text
-*.mustache text
-*.csv      text
-*.tab      text
-*.tsv      text
-*.txt      text
-*.sql      text
-*.epub     diff=astextplain
-
-# Graphics
-*.png      binary
-*.jpg      binary
-*.jpeg     binary
-*.gif      binary
-*.tif      binary
-*.tiff     binary
-*.ico      binary
-# SVG treated as text by default.
-*.svg      text
-# If you want to treat it as binary,
-# use the following line instead.
-# *.svg    binary
-*.eps      binary
-
-# Scripts
-*.bash     text eol=lf
-*.fish     text eol=lf
-*.sh       text eol=lf
-*.zsh      text eol=lf
-# These are explicitly windows files and should use crlf
-*.bat      text eol=crlf
-*.cmd      text eol=crlf
-*.ps1      text eol=crlf
-
-# Serialisation
-*.json     text
-*.toml     text
-*.xml      text
-*.yaml     text
-*.yml      text
-
-# Archives
-*.7z       binary
-*.gz       binary
-*.tar      binary
-*.tgz      binary
-*.zip      binary
-
-# Text files where line endings should be preserved
-*.patch    -text
-
-#
-# Exclude files from exporting
-#
-
-.gitattributes export-ignore
-.gitignore     export-ignore
-.gitkeep       export-ignore

data/.gitignore

@@ -1,114 +0,0 @@
-# Used by dotenv library to load environment variables.
-# .env
-
-# Ignore Byebug command history file.
-.byebug_history
-
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-*.bridgesupport
-build-iPhoneOS/
-build-iPhoneSimulator/
-
-## Specific to RubyMotion (use of CocoaPods):
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# vendor/Pods/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalization:
-/.bundle/
-/vendor/bundle
-/lib/bundler/man/
-
-# for a library or gem, you might want to ignore these files since the code is
-# intended to run in multiple environments; otherwise, check them in:
-# Gemfile.lock
-# .ruby-version
-# .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# Used by RuboCop. Remote config files pulled in from inherit_from directive.
-# .rubocop-https?--*
-
-*.rbc
-capybara-*.html
-.rspec
-/db/*.sqlite3
-/db/*.sqlite3-journal
-/db/*.sqlite3-[0-9]*
-/public/system
-/coverage/
-/spec/tmp
-*.orig
-rerun.txt
-pickle-email-*.html
-
-# Ignore all logfiles and tempfiles.
-/log/*
-/tmp/*
-!/log/.keep
-!/tmp/.keep
-
-# TODO Comment out this rule if you are OK with secrets being uploaded to the repo
-config/initializers/secret_token.rb
-config/master.key
-
-# Only include if you have production secrets in this file, which is no longer a Rails default
-# config/secrets.yml
-
-# dotenv, dotenv-rails
-# TODO Comment out these rules if environment variables can be committed
-.env
-.env*.local
-
-## Environment normalization:
-/.bundle
-/vendor/bundle
-
-# these should all be checked in to normalize the environment:
-# Gemfile.lock, .ruby-version, .ruby-gemset
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-# if using bower-rails ignore default bower_components path bower.json files
-/vendor/assets/bower_components
-*.bowerrc
-bower.json
-
-# Ignore pow environment settings
-.powenv
-
-# Ignore Byebug command history file.
-.byebug_history
-
-# Ignore node_modules
-node_modules/
-
-# Ignore precompiled javascript packs
-/public/packs
-/public/packs-test
-/public/assets
-
-# Ignore yarn files
-/yarn-error.log
-yarn-debug.log*
-.yarn-integrity
-
-# Ignore uploaded files in development
-/storage/*
-!/storage/.keep
-/public/uploads

data/.rubocop.yml

@@ -1,19 +0,0 @@
-require:
-  - rubocop-performance
-  - rubocop-rake
-  - rubocop-minitest
-
-Lint/NumberConversion:
-  Enabled: false
-
-AllCops:
-  TargetRubyVersion: 3.0
-  EnabledByDefault: true
-  NewCops: enable
-  UseCache: true
-  Exclude:
-    - '.git/**/*'
-    - 'tmp/**/*'
-    - 'bin/**/*'
-  CacheRootDirectory: tmp
-  MaxFilesInCache: 36000

data/.ruby-version

@@ -1 +0,0 @@
-3.1.2

data/.semver

@@ -1,5 +0,0 @@
----
-:major: 0
-:minor: 0
-:patch: 1
-:special: ''

data/.travis.yml

@@ -1,7 +0,0 @@
-language: ruby
-cache:
-  bundler: true
-rvm:
-  - '3.1.2'
-script:
-  - bundle exec rake test_units

data/.yardopts

@@ -1 +0,0 @@
---no-private lib/**/*.rb - COPYING COPYING.LESSER HISTORY README

data/Dockerfile

@@ -1,35 +0,0 @@
-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

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

data/Gemfile.lock

@@ -1,116 +0,0 @@
-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/Rakefile

@@ -1,33 +0,0 @@
-# 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