compounding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eaada2a3507d635e5b87e25b806f8981726c9af90ca80d629f7d96f3134cea33
+  data.tar.gz: 6e82ae3325750f2d7c380ee196786321c60dc52e64f824381d3e58780ea4a593
+SHA512:
+  metadata.gz: 2b25856e5e1215ee621bd86cb10ac9923a816eab70fb956f7b55014f967d21c9b060f50b9aeddb85ea958f2936b9bcebc4279ea0b7d2dc23e5c2a4ce3430aef4
+  data.tar.gz: 4fc66e073af3973039489bf055133c725bfd9fc0a3a9a57f4feac60a26a3bd90b92c01e52dfb9e121415db72ab142ad3a424966f07b455686a0ade043e0db3d0

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-02-25
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Jason Kim
+
+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,35 @@
+# Compounding
+
+
+A Ruby Gem for calculating compound interest
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add compounding
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install compounding
+
+## Usage
+
+```ruby
+calculation_result = Compounding::Calculator.calculate(principal, rate, time, compounding_frequency)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/serv/compounding.
+
+## 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 "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/compounding/calculation_result.rb

@@ -0,0 +1,34 @@
+module Compounding
+  class CalculationResult
+    attr_reader :principal, :rate, :time, :compounding_frequency, :periods, :interest, :total
+
+    # time can be any unit of time, e.g. years, months, days, etc.
+    def initialize(principal, rate, time, compounding_frequency)
+      @principal = principal
+      @rate = rate
+      @time = time
+      @compounding_frequency = compounding_frequency
+      @periods = nil
+    end
+
+    def calculate
+      @interest = (1 + @rate / @compounding_frequency)**(@compounding_frequency * @time)
+      @total = @principal + @interest
+      populate_periods
+    end
+
+    def populate_periods
+      total_number_of_periods = @compounding_frequency * @time
+      @periods = []
+      previous_total = @principal
+
+      for n in 1..total_number_of_periods
+        period_interest = previous_total * @rate / @compounding_frequency
+        previous_total += period_interest
+        @periods.push(DTO::Period.new(n, previous_total, period_interest, previous_total))
+      end
+
+      @periods
+    end
+  end
+end

data/lib/compounding/calculator.rb

@@ -0,0 +1,9 @@
+module Mortgagerb
+  class Calculator
+    def self.calculate(principal, rate, time, compounding_frequency)
+      cr = CalculationResult.new(principal, rate, time, compounding_frequency)
+      cr.calculate
+      cr
+    end
+  end
+end

data/lib/compounding/dto/period.rb

@@ -0,0 +1,14 @@
+module Compounding
+  module DTO
+    class Period
+      attr_reader :period_id, :previous_total, :interest, :total
+
+      def initialize(period_id, previous_total, interest, total)
+        @period_id = period_id
+        @previous_total = previous_total
+        @interest = interest
+        @total = total
+      end
+    end
+  end
+end

data/lib/compounding/version.rb

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

data/lib/compounding.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative "compounding/version"
+
+require_relative "compounding/calculator"
+require_relative "compounding/calculation_result"
+
+require_relative "compounding/dto/period"
+
+module Compounding
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/compounding.rbs

@@ -0,0 +1,4 @@
+module Compounding
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: compounding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Kim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-02-26 00:00:00.000000000 Z
+dependencies: []
+description: Calculate compound interest
+email:
+- iamjsonkim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/compounding.rb
+- lib/compounding/calculation_result.rb
+- lib/compounding/calculator.rb
+- lib/compounding/dto/period.rb
+- lib/compounding/version.rb
+- sig/compounding.rbs
+homepage: https://github.com/serv/compounding
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/serv/compounding
+  source_code_uri: https://github.com/serv/compounding
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Calculate compound interest
+test_files: []