financial_math 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c921d52e51e5f58cc4f57b35fb3be689be412fe951b7c47c827841cfae32c69e
+  data.tar.gz: 36d24ce900c09e7c004e944928bb02b94d0bc02ecbaaee195ff1a0255dac2231
+SHA512:
+  metadata.gz: 1034b3bad2c684ffb511babb43a232bf76e74bc6f8805c6f6d54e4b392ca2d7668673c40fff3e7c37f0d43bd28d986f85ae966e709d2b49e43e9fa7e71196d98
+  data.tar.gz: 94660004e27d53b1bf246d4f3e42e75ea16069f65abd8362f53eeb3a3456e2113be17cf60856f0d819728685b6c0fc515eea1318eb1380ad54f3bce0eb1bca8a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at daniel.omar.vergara@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in financial_math.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    financial_math (0.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  financial_math!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Daniel Omar Vergara Pérez
+
+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,94 @@
+# FinancialMath
+> A set of financial equations.
+
+This library provides a set of financial equations.
+This library is based on the book titled:
+
+## Matemáticasfi nancieras
+El valor del dinero en el tiempo
+
+by *Zbigniew Kozikowski Zarska*
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'financial_math'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install financial_math
+
+## Usage
+
+To calculate the last item of a geometric progression:
+
+```ruby
+args = { initial_value: 1100, ratio: 1.1, times: 5 }
+geometric_progression = FinancialMath::GeometricProgression.new(args)
+expect(geometric_progression.last_item).to eql(1610.51)
+```
+
+To calculate the future value:
+
+```ruby
+args = { present_value: 100_000.0, interest_rate: 0.05, periods: 3 }
+simple_interest = FinancialMath::SimpleInterest.new(args)
+simple_interest.future_value
+```
+## Development
+
+If want test this gem without clone this repo, type:
+
+```shell
+$ gem install financial_math --dev
+```
+
+This command will get the development dependencies installed too.
+
+## Release History
+
+* 0.3.1
+    * CHANGE: Update docs (module code remains unchanged)
+* 0.3.0
+    * ADD: Add `SimpleInterest` class
+* 0.3.0
+    * ADD: Add `GEometricProgression` class  
+* 0.2.0
+    * ADD: Add `ArithemeticProgression` class
+* 0.1.0
+    * The first proper release
+    * ADD: The basic file with basic equations
+* 0.0.1
+    * Work in progress
+
+## Meta
+
+Daniel Omar Vergara Pérez – [@dan1_net](https://twitter.com/dan1_net) – daniel.omar.vergara@gmail.com
+
+[https://github.com/dany2691/](https://github.com/dany2691/)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dany2691/financial_math. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## Contributing
+
+1. Fork it (<https://github.com/dany2691/financial_math/fork>)
+2. Create your feature branch (`git checkout -b feature/fooBar`)
+3. Commit your changes (`git commit -am 'Add some fooBar'`)
+4. Push to the branch (`git push origin feature/fooBar`)
+5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FinancialMath project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/financial_math/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "financial_math"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/financial_math.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "financial_math/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "financial_math"
+  spec.version       = FinancialMath::VERSION
+  spec.authors       = ["Daniel Omar Vergara Pérez"]
+  spec.email         = ["daniel.omar.vergara@gmail.com"]
+
+  spec.summary       = %q{Financial equations}
+  spec.description   = %q{Set of financial functions}
+  spec.homepage      = "https://github.com/dany2691/financial_math"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/financial_math/arithmetic_progression.rb

@@ -0,0 +1,19 @@
+module FinancialMath
+  class ArithmeticProgression
+    attr_reader :distance, :times, :initial_value
+
+    def initialize(args)
+      @distance = args.fetch(:distance, 1)
+      @times = args.fetch(:times, 1)
+      @initial_value = args.fetch(:initial_value, 0)
+    end
+
+    def last_item
+      (initial_value + (times - 1.0) * distance).round(2)
+    end
+
+    def sum
+      (times / 2.0 * (initial_value + last_item)).round(2)
+    end
+  end
+end

data/lib/financial_math/basics.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal :true
+
+# Basic financial functions
+module FinancialMath
+  # A class that contains basic functions in finance
+  def self.geometric_mean(growth_rates)
+    raw_geometric_mean(growth_rates).round(4)
+  end
+
+  def self.continuous_capitalization(initial_value, rate, time)
+    (initial_value * Math.exp(rate * time)).round(2)
+  end
+
+  def self.raw_geometric_mean(growth_rates)
+    growth_rates.map { |i| i + 1 }.inject(:*)**(1.0 / growth_rates.size) - 1
+  end
+end
+
+# module FinancialMath
+#   # A class that contains basic functions in finance
+#   class Basics
+#     def self.geometric_mean(growth_rates)
+#       raw_geometric_mean(growth_rates).round(4)
+#     end
+#
+#     def self.continuous_capitalization(initial_value, rate, time)
+#       (initial_value * Math.exp(rate * time)).round(2)
+#     end
+#
+#     def self.raw_geometric_mean(growth_rates)
+#       growth_rates.map { |i| i + 1 }.inject(:*)**(1.0 / growth_rates.size) - 1
+#     end
+#
+#     private_class_method :raw_geometric_mean
+#   end
+# end

data/lib/financial_math/geometric_progression.rb

@@ -0,0 +1,39 @@
+module FinancialMath
+  class GeometricProgression
+    attr_reader :initial_value, :ratio, :times
+
+    def initialize(args)
+      @initial_value = args.fetch(:initial_value, 1)
+      @ratio = args.fetch(:ratio, 0)
+      @times = args.fetch(:times, 1)
+    end
+
+    def last_item
+      (initial_value * ratio**(times - 1)).round(2)
+    end
+
+    def sum
+      if ratio > 1
+        growing_progression
+      elsif ratio < 1
+        decreasing_progression
+      elsif ratio == 1
+        raise ZeroDivisionError, "ratio can't be equal to one"
+      end
+    end
+
+    def infinite_decreasing_sum
+      initial_value / (1 - ratio)
+    end
+
+    private
+
+    def growing_progression
+      (initial_value * (ratio**times - 1.0) / (ratio - 1.0)).round(2)
+    end
+
+    def decreasing_progression
+      (initial_value * (1.0 - ratio**times) / (1.0 - ratio)).round(2)
+    end
+  end
+end

data/lib/financial_math/simple_interest.rb

@@ -0,0 +1,63 @@
+module FinancialMath
+  class SimpleInterest
+    attr_reader :periods
+
+    def initialize(args)
+      @present_value = args.fetch(:present_value, 0)
+      @periods = args.fetch(:periods, 0)
+      @interest_rate = args.fetch(:interest_rate, 0)
+      @future_value = args.fetch(:future_value, 0)
+      @bank_discount_rate = args.fetch(:bank_discount_rate, 0)
+    end
+
+    def bank_discount_rate
+      @bank_discount_rate = (discount / future_value).round(2)
+    end
+
+    def discount
+      (@future_value - @present_value).round(2)
+    end
+
+    def future_value
+      @future_value = (@present_value * (1 + periods * @interest_rate)).round(2)
+    end
+
+    def future_value_in_days
+      @future_value = @present_value * (1 + @interest_rate * periods_in_days)
+      @future_value.round(2)
+    end
+
+    def present_value
+      @present_value = (@future_value / (1 + periods * @interest_rate)).round(2)
+    end
+
+    def present_value_in_days
+      @present_value = @future_value / (1 + @interest_rate * periods_in_days)
+      @present_value.round(2)
+    end
+
+    def rational_discount_in_days
+      (@present_value * @interest_rate * @periods_in_days).round(2)
+    end
+
+    def bank_discount_in_days
+      (@future_value * @bank_discount_rate * @periods_in_days).round(2)
+    end
+
+    def interest_rate_given_discount_rate
+      divisor = 1 - @bank_discount_rate * periods_in_days
+      @interest_rate = (@bank_discount_rate / divisor).round(2)
+    end
+
+    def discount_rate_given_interest_rate
+      divisor = 1 + @interest_rate * periods_in_days
+      @bank_discount_rate = (@interest_rate / divisor).round(2)
+    end
+
+    private
+
+    def periods_in_days
+      periods / 360.0
+    end
+  end
+end

data/lib/financial_math/version.rb

@@ -0,0 +1,3 @@
+module FinancialMath
+  VERSION = '0.3.1'
+end

data/lib/financial_math.rb

@@ -0,0 +1,9 @@
+require 'financial_math/version'
+require 'financial_math/basics'
+require 'financial_math/geometric_progression'
+require 'financial_math/arithmetic_progression'
+require 'financial_math/simple_interest'
+
+module FinancialMath
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: financial_math
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Daniel Omar Vergara Pérez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Set of financial functions
+email:
+- daniel.omar.vergara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- financial_math.gemspec
+- lib/financial_math.rb
+- lib/financial_math/arithmetic_progression.rb
+- lib/financial_math/basics.rb
+- lib/financial_math/geometric_progression.rb
+- lib/financial_math/simple_interest.rb
+- lib/financial_math/version.rb
+homepage: https://github.com/dany2691/financial_math
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Financial equations
+test_files: []