mortgagerb 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15d0932e45e8a052fd914fe4deec87393e381d67e8b3cfdd7303b3d96072375c
+  data.tar.gz: be02a4e36939c96e569540b0a67a9b07e744482fd3493ae330ab6c2dd2b9ee50
+SHA512:
+  metadata.gz: bf8847fda2ddf9ddb30b1373dff35ba4845f47902079e321e9993a6b64b92eca62a63832683a51ef6fd83a1a794a08b4536b305ecfacf23de4d6ef35afac5c1a
+  data.tar.gz: fba108618cbaf0b44d918460ba2c9194586942b6744bef324234d29cac72c6276ffd9e20ba40bd8b7c74acca817131e3744951b0beab6e0da8296b8651fa0489

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-10
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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,45 @@
+# Mortgagerb
+
+Calculates monthly payment for various types of mortgage. To learn more about how the calculations are done, see [amortizing loan](https://en.wikipedia.org/wiki/Amortizing_loan).
+
+Currently supported loan types
+
+- 30 year fixed
+- Others coming soon
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add mortgagerb 
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install mortgagerb
+
+## Usage
+
+```ruby
+require 'mortgagerb'
+
+rate = 5.5
+principal = 1000000
+type = :thirty_year_fixed 
+
+scenario = Mortgagerb::Scenario.new(principal, rate, type)
+amortization_payment = scenario.calculate # 5677.89
+```
+
+## 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/mortgagerb.
+
+## 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/mortgagerb/calculator.rb

@@ -0,0 +1,34 @@
+module Mortgagerb
+  class Calculator
+    NUMBER_OF_MONTHS = 12
+
+    # r
+    def self.periodic_interest_rate(annual_rate)
+      annual_rate / 100 / NUMBER_OF_MONTHS
+    end
+
+    # n
+    def self.total_number_of_payments(years)
+      years * NUMBER_OF_MONTHS
+    end
+
+    # A
+    def self.periodic_amortization_payment(principal, rate, n)
+      rate_multiplier = rate_plus_one_power_to_n(rate, n)
+      (principal * (rate * rate_multiplier) / (rate_multiplier - 1)).round(2)
+    end
+
+    # P
+    def self.principal_from_amortization_payment(amortization_payment, rate, n)
+      rate_multiplier = rate_plus_one_power_to_n(rate, n)
+      (amortization_payment * (1 - (1 / rate_multiplier)) / rate).round(2)
+    end
+
+    private
+
+    # (1 + r) ^ n
+    def self.rate_plus_one_power_to_n(rate, n)
+      (1 + rate)**n
+    end
+  end
+end

data/lib/mortgagerb/scenario.rb

@@ -0,0 +1,50 @@
+module Mortgagerb
+  class Scenario
+    attr_accessor :amortization_payment, :principal
+
+    def initialize(amount, rate, type)
+      @amount = amount
+      @rate = rate
+      @type = type
+      @amortization_payment = nil
+      @principal = nil
+    end
+
+    def calculate
+      if %i[thirty_year_fixed three_year_arm five_year_arm seven_year_arm ten_year_arm].include?(@type)
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(30)
+        @amortization_payment = Calculator.periodic_amortization_payment(@amount, r, n)
+      elsif %i[thirty_year_fixed_get_pricipal three_year_arm_get_principal five_year_arm_get_principal
+               seven_year_arm_get_principal ten_year_arm_get_principal].include?(@type)
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(30)
+        @principal = Calculator.principal_from_amortization_payment(@amount, r, n)
+      elsif @type === :twenty_year_fixed
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(20)
+        @amortization_payment = Calculator.periodic_amortization_payment(@amount, r, n)
+      elsif @type === :twenty_year_fixed_get_principal
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(20)
+        @principal = Calculator.principal_from_amortization_payment(@amount, r, n)
+      elsif @type === :fifteen_year_fixed
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(15)
+        @amortization_payment = Calculator.periodic_amortization_payment(@amount, r, n)
+      elsif @type === :fifteen_year_fixed_get_principal
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(15)
+        @principal = Calculator.principal_from_amortization_payment(@amount, r, n)
+      elsif @type === :ten_year_fixed
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(10)
+        @amortization_payment = Calculator.periodic_amortization_payment(@amount, r, n)
+      elsif @type === :ten_year_fixed_get_principal
+        r = Calculator.periodic_interest_rate(@rate)
+        n = Calculator.total_number_of_payments(10)
+        @principal = Calculator.principal_from_amortization_payment(@amount, r, n)
+      end
+    end
+  end
+end

data/lib/mortgagerb/version.rb

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

data/lib/mortgagerb.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "mortgagerb/version"
+require_relative "mortgagerb/calculator"
+require_relative "mortgagerb/scenario"
+
+module Mortgagerb
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/mortgagerb.rbs

@@ -0,0 +1,4 @@
+module Mortgagerb
+  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: mortgagerb
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Jason Kim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies: []
+description: Calculate periodic payment given principal, rate and mortgage type
+email:
+- iamjsonkim@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mortgagerb.rb
+- lib/mortgagerb/calculator.rb
+- lib/mortgagerb/scenario.rb
+- lib/mortgagerb/version.rb
+- sig/mortgagerb.rbs
+homepage: https://github.com/serv/mortgagerb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/serv/mortgagerb
+  source_code_uri: https://github.com/serv/mortgagerb
+  changelog_uri: https://github.com/serv/mortgagerb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.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: Mortgage calculator
+test_files: []