compound_interest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: adf78a6367fa405f9122ffc009a83a22c133628e184add4f93b414ab41a097fa
+  data.tar.gz: f6ac5b2d30cdae713cbf722bc6db16d7b37ceb6a396f05efeb052ddd422eb7fc
+SHA512:
+  metadata.gz: fb6bc286299633f0ff66c8341e14e162a57c2a54ceb94910a1131591fc3737809af1b482c281b17ac3ed73f56c6e07b0281d32c9fe2f45f0786077c7c88c29c9
+  data.tar.gz: 119b5909e7e5a74c5d7f09c7931299dbef370be52baa594493736c9a3f6f5e6bfd5d4a1bfa08bb4ecc0dc26b300082da75e66851ce7e193c0f29a2006f71510b

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion:                  2.5
+
+Style/StringLiterals:
+  Enabled:                            true
+  EnforcedStyle:                      double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled:                            true
+  EnforcedStyle:                      double_quotes
+  
+Style/Documentation:
+  Enabled:                            false
+
+Layout/LineLength:
+  Max:                                120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-05-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in compound_interest.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    compound_interest (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.14.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.5.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.5.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  compound_interest!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 VovaK0-23
+
+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,62 @@
+# CompoundInterest
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/compound_interest`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compound_interest'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install compound_interest
+
+## Usage
+
+In order to calculate compound interest, add this lines to your project:
+```ruby
+require "compound_interest"
+
+compound_interest = CompoundInterest::Calculation
+compound_interest.calculate(params)
+```
+method .calculate accept Hash like this:
+```ruby
+params = {
+  initial_payment: 100,
+  # number of terms
+  term: 2,
+  # number of interest payments for the term
+  capitalization_periodicity: 12,
+  # ineterest rate per term
+  interest_rate: 10.0,
+  # (optional)
+  payment: 100,
+  # (optional) number of payments for the term
+  payment_periodicity: 12
+}
+```
+In this example initial payment is 100$ (:initial_payment) for 2 years (:term) deposit, with annual interest rate 10% (:interest_rate). Interest paid every month (capitalization_periodicity: 12, it can be 365 if interest paid every day or anything else). Optionally, you can specify payment (:payment) this is the amount with which you replenish the deposit and payment periodicity (:payment_periodicity) stands for the number of replenishments for the period.
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+This is my first gem so go easy on me =)
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/VovaK0-23/compound_interest.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "compound_interest"
+
+# 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/compound_interest.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/compound_interest/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "compound_interest"
+  spec.version       = CompoundInterest::VERSION
+  spec.authors       = ["VovaK0-23"]
+  spec.email         = ["71105454+VovaK0-23@users.noreply.github.com"]
+
+  spec.summary       = "Calculate compound interest"
+  spec.homepage      = "https://github.com/VovaK0-23/compound_interest_gem"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/VovaK0-23/compound_interest_gem"
+  spec.metadata["changelog_uri"] = "https://github.com/VovaK0-23/compound_interest_gem/blob/master/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/compound_interest.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "compound_interest/version"
+require_relative "compound_interest/calculation"
+
+module CompoundInterest
+  class Error < StandardError; end
+end

data/lib/compound_interest/calculation.rb

@@ -0,0 +1,39 @@
+module CompoundInterest
+  class Calculation
+    def self.calculate(params)
+      raise "Argument must be Hash" if params.class != Hash
+      if params[:initial_payment].nil?
+        raise ArgumentError, "Argument must include :initial_payment"
+      elsif params[:term].nil?
+        raise ArgumentError, "Argument must include :term"
+      elsif params[:interest_rate].nil?
+        raise ArgumentError, "Argument must include :interest_rate"
+      elsif [:capitalization_periodicity].nil?
+        raise ArgumentError, "Argument must include :capitalization_periodicity"
+      end
+
+      initial_payment = params[:initial_payment]
+      # number of terms
+      term = params[:term]
+      # ineterest rate per term
+      interest_rate = params[:interest_rate].to_f / 100
+      # number of interest payments for the term
+      capitalization_periodicity = params[:capitalization_periodicity]
+      payment = params[:payment] || 0
+      # number of payments for the term
+      payment_periodicity = params[:payment_periodicity]
+
+      calculation = (1.0 + interest_rate / capitalization_periodicity)**(term * capitalization_periodicity)
+      result = initial_payment * calculation
+      if payment > 0
+        times = (payment_periodicity * term).to_i
+        payment_result = 0
+        (1..times).each do |i|
+          payment_result += payment * calculation - ((capitalization_periodicity / payment_periodicity) * i)
+        end
+        result = result + payment_result - payment
+      end
+      result
+    end
+  end
+end

data/lib/compound_interest/version.rb

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

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: compound_interest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- VovaK0-23
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description:
+email:
+- 71105454+VovaK0-23@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- compound_interest.gemspec
+- lib/compound_interest.rb
+- lib/compound_interest/calculation.rb
+- lib/compound_interest/version.rb
+homepage: https://github.com/VovaK0-23/compound_interest_gem
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/VovaK0-23/compound_interest_gem
+  source_code_uri: https://github.com/VovaK0-23/compound_interest_gem
+  changelog_uri: https://github.com/VovaK0-23/compound_interest_gem/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Calculate compound interest
+test_files: []