amortizy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '098cde951446da868e5cc5790b832794a09dd7ba991ffb34125f02053e59489e'
+  data.tar.gz: 923b3440f1046b7c0c92483997c24934623f234c5e47f78333b9d87ca8536bfa
+SHA512:
+  metadata.gz: 01c8a63684018625527eb633d6b7febc03b92d37ed20221b6138dc66080908ba4d5a0ef4649ae65172cbe67a9d1cb6c455ad70d95804ef9b64e9df083c75ec1b
+  data.tar.gz: d57d565cf0631f7f7016776111b1c1fe680549ae1a7583f30ba2c0cdf7b44bf2650e029a43e1593368f162c9209c1c5bca2d93c3eb5e7e95e96c98571b5d2de8

data/CHANGELOG.md

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Zapata
+
+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,43 @@
+# Amortizy
+
+TODO: Delete this and the text below, and describe your gem
+
+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/amortizy`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/amortizy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/amortizy/blob/main/CODE_OF_CONDUCT.md).
+
+## 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 Amortizy project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/amortizy/blob/main/CODE_OF_CONDUCT.md).

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/lib/amortizy/engine.rb

@@ -0,0 +1,516 @@
+# Amortization Schedule Generator
+# 
+# Generates comprehensive loan amortization schedules with support for:
+# - Grace periods with capitalized interest
+# - Interest-only payment periods
+# - Origination and additional fees
+# - Simple or precomputed interest methods
+# - Bank business day calculations (Federal Reserve holidays)
+# - Daily or weekly payment frequencies
+
+require 'date'
+require 'csv'
+require 'holidays'
+
+module Amortizy 
+  class AmortizationSchedule
+    attr_reader :start_date, :principal, :term_months, :annual_rate, :frequency
+
+    def initialize(start_date:, principal:, term_months:, annual_rate:, frequency:, origination_fee: 0, additional_fee: 0, additional_fee_label: 'Additional Fee', additional_fee_treatment: :distributed, bank_days_only: false, interest_only_periods: 0, grace_period_days: 0, interest_method: :simple)
+      @start_date = Date.parse(start_date.to_s)
+      @principal = principal.to_f
+      @term_months = term_months.to_i
+      @annual_rate = annual_rate.to_f / 100.0
+      @frequency = frequency.to_sym
+      @origination_fee = origination_fee.to_f
+      @additional_fee = additional_fee.to_f
+      @additional_fee_label = additional_fee_label.to_s
+      @additional_fee_treatment = additional_fee_treatment.to_sym
+      @bank_days_only = bank_days_only
+      @interest_only_periods = interest_only_periods.to_i
+      @grace_period_days = grace_period_days.to_i
+      @interest_method = interest_method.to_sym
+      
+      validate_term_months!
+      validate_frequency!
+      validate_fee_treatment!
+      validate_interest_only_periods!
+      validate_interest_method!
+    end
+
+    def generate(output: :console, csv_path: nil)
+      case output
+      when :console
+        generate_console_output
+      when :csv
+        raise ArgumentError, "csv_path required for CSV output" unless csv_path
+        generate_csv_output(csv_path)
+      else
+        raise ArgumentError, "Output must be :console or :csv"
+      end
+    end
+
+    private
+
+    def validate_frequency!
+      unless [:daily, :weekly].include?(@frequency)
+        raise ArgumentError, "Frequency must be :daily or :weekly"
+      end
+    end
+
+    def validate_term_months!
+      unless [6, 9, 12, 15, 18].include?(@term_months)
+        raise ArgumentError, "Term must be 6, 9, 12, 15, or 18 months"
+      end
+    end
+
+    def validate_fee_treatment!
+      unless [:distributed, :add_to_principal, :separate_payment].include?(@additional_fee_treatment)
+        raise ArgumentError, "Additional fee treatment must be :distributed, :add_to_principal, or :separate_payment"
+      end
+    end
+
+    def validate_interest_only_periods!
+      total_payments = calculate_total_payments
+      if @interest_only_periods >= total_payments
+        raise ArgumentError, "Interest-only periods (#{@interest_only_periods}) must be less than total payments (#{total_payments})"
+      end
+    end
+
+    def validate_interest_method!
+      unless [:simple, :precomputed].include?(@interest_method)
+        raise ArgumentError, "Interest method must be :simple or :precomputed"
+      end
+    end
+
+    def calculate_total_payments
+      payment_schedule = {
+        6 => { daily: 124, weekly: 27 },
+        9 => { daily: 185, weekly: 39 },
+        12 => { daily: 248, weekly: 53 },
+        15 => { daily: 312, weekly: 65 },
+        18 => { daily: 370, weekly: 79 }
+      }
+      
+      payment_schedule[@term_months][@frequency]
+    end
+
+    def calculate_average_days_per_period
+      return 1 if @frequency == :daily && !@bank_days_only
+      return 7 if @frequency == :weekly && !@bank_days_only
+      
+      if @bank_days_only
+        total_payments = calculate_total_payments
+        current_date = first_payment_date
+        total_days = 0
+        sample_size = [30, total_payments].min
+        
+        (1..sample_size).each do |i|
+          next_date = next_payment_date(current_date)
+          total_days += calculate_days_between(current_date, next_date)
+          current_date = next_date
+        end
+        
+        return total_days.to_f / sample_size
+      end
+      
+      @frequency == :daily ? 1 : 7
+    end
+
+    def estimate_total_loan_days
+      total_payments = calculate_total_payments
+      avg_days_per_period = calculate_average_days_per_period
+      total_payments * avg_days_per_period
+    end
+
+    def calculate_precomputed_total_interest
+      principal_for_interest = initial_principal_with_origination
+      total_days = estimate_total_loan_days
+      principal_for_interest * @annual_rate * (total_days / 365.0)
+    end
+
+    def precomputed_interest_per_payment
+      total_payments = calculate_total_payments
+      calculate_precomputed_total_interest / total_payments
+    end
+
+    def initial_principal_with_origination
+      @principal + @origination_fee
+    end
+
+    def grace_period_interest
+      return 0.0 if @grace_period_days == 0
+      grace_rate = (@annual_rate / 365.0) * @grace_period_days
+      initial_principal_with_origination * grace_rate
+    end
+
+    def effective_principal
+      base_principal = initial_principal_with_origination + grace_period_interest
+      
+      case @additional_fee_treatment
+      when :add_to_principal
+        base_principal + @additional_fee
+      else
+        base_principal
+      end
+    end
+
+    def first_payment_date
+      if @grace_period_days > 0
+        grace_end_date = @start_date + @grace_period_days
+        next_bank_day(grace_end_date)
+      else
+        @start_date
+      end
+    end
+
+    def calculate_payment
+      total_payments = calculate_total_payments
+      principal_payments = total_payments - @interest_only_periods
+      
+      if @interest_method == :precomputed
+        principal_payment_portion = effective_principal / principal_payments
+        interest_portion = precomputed_interest_per_payment
+        
+        if @additional_fee_treatment == :distributed
+          principal_payment_portion + interest_portion + (@additional_fee / total_payments)
+        else
+          principal_payment_portion + interest_portion
+        end
+      else
+        days_per_period = calculate_average_days_per_period
+        period_rate = (@annual_rate / 365.0) * days_per_period
+        
+        base_payment = if period_rate == 0
+          effective_principal / principal_payments
+        else
+          effective_principal * (period_rate * (1 + period_rate)**principal_payments) / 
+                      ((1 + period_rate)**principal_payments - 1)
+        end
+
+        if @additional_fee_treatment == :distributed
+          base_payment + (@additional_fee / total_payments)
+        else
+          base_payment
+        end
+      end
+    end
+
+    def federal_holiday?(date)
+      holidays = Holidays.on(date, :federalreserve, :observed)
+      !holidays.empty?
+    end
+
+    def bank_day?(date)
+      return true unless @bank_days_only
+      return false if date.saturday? || date.sunday?
+      return false if federal_holiday?(date)
+      true
+    end
+
+    def next_bank_day(date)
+      return date unless @bank_days_only
+      
+      current = date
+      until bank_day?(current)
+        current += 1
+      end
+      current
+    end
+
+    def next_payment_date(current_date)
+      case @frequency
+      when :daily
+        next_date = current_date + 1
+      when :weekly
+        next_date = current_date + 7
+      end
+      
+      next_bank_day(next_date)
+    end
+
+    def calculate_days_between(start_date, end_date)
+      (end_date - start_date).to_i
+    end
+
+    def generate_schedule_data
+      payment_amount = calculate_payment
+      balance = effective_principal
+      accrued_interest = 0.0
+      payment_date = first_payment_date
+      previous_payment_date = first_payment_date
+      payment_number = 0
+      total_payments = calculate_total_payments
+      schedule_data = []
+
+      if @grace_period_days > 0
+        grace_interest = grace_period_interest
+        schedule_data << {
+          payment_number: 'Grace',
+          date: first_payment_date,
+          principal_payment: 0.0,
+          interest_payment: 0.0,
+          additional_fee_payment: 0.0,
+          total_payment: 0.0,
+          principal_balance: balance,
+          accrued_interest: 0.0,
+          total_balance: balance,
+          payment_type: 'Grace Period',
+          days_in_period: @grace_period_days,
+          grace_interest_capitalized: grace_interest
+        }
+      end
+
+      if @additional_fee_treatment == :separate_payment && @additional_fee > 0
+        payment_date = next_payment_date(payment_date)
+        schedule_data << {
+          payment_number: 0,
+          date: payment_date,
+          principal_payment: 0.0,
+          interest_payment: 0.0,
+          additional_fee_payment: @additional_fee,
+          total_payment: @additional_fee,
+          principal_balance: balance,
+          accrued_interest: 0.0,
+          total_balance: balance,
+          payment_type: 'Additional Fee Payment',
+          days_in_period: 0
+        }
+        previous_payment_date = payment_date
+      end
+
+      additional_fee_per_payment = @additional_fee_treatment == :distributed ? (@additional_fee / total_payments) : 0.0
+      precomputed_interest = @interest_method == :precomputed ? precomputed_interest_per_payment : 0.0
+
+      while payment_number < total_payments && balance > 0.01
+        payment_number += 1
+        payment_date = next_payment_date(previous_payment_date)
+        days_in_period = calculate_days_between(previous_payment_date, payment_date)
+        
+        if @interest_method == :precomputed
+          interest_payment = precomputed_interest
+        else
+          period_rate = (@annual_rate / 365.0) * days_in_period
+          interest_payment = balance * period_rate
+        end
+        
+        accrued_interest += interest_payment
+        is_interest_only = payment_number <= @interest_only_periods
+        
+        if is_interest_only
+          principal_payment = 0.0
+          payment_type = 'Interest Only'
+        else
+          principal_payment = [payment_amount - interest_payment - additional_fee_per_payment, balance].min
+          principal_payment = balance if payment_number == total_payments
+          payment_type = 'Regular Payment'
+        end
+        
+        total_payment = principal_payment + interest_payment + additional_fee_per_payment
+        balance -= principal_payment
+        balance = 0 if balance < 0.01
+        total_balance = balance + accrued_interest
+        
+        schedule_data << {
+          payment_number: payment_number,
+          date: payment_date,
+          principal_payment: principal_payment,
+          interest_payment: interest_payment,
+          additional_fee_payment: additional_fee_per_payment,
+          total_payment: total_payment,
+          principal_balance: balance,
+          accrued_interest: accrued_interest,
+          total_balance: total_balance,
+          payment_type: payment_type,
+          days_in_period: days_in_period
+        }
+        
+        accrued_interest = 0.0
+        previous_payment_date = payment_date
+      end
+
+      schedule_data
+    end
+
+    def generate_console_output
+      puts format_header
+      puts "-" * 195
+
+      generate_schedule_data.each do |row|
+        if row[:payment_type] == 'Grace Period'
+          puts format_grace_row(
+            row[:payment_number],
+            row[:date],
+            row[:grace_interest_capitalized],
+            row[:principal_balance],
+            row[:days_in_period]
+          )
+        else
+          puts format_row(
+            row[:payment_number],
+            row[:date],
+            row[:principal_payment],
+            row[:interest_payment],
+            row[:additional_fee_payment],
+            row[:total_payment],
+            row[:principal_balance],
+            row[:accrued_interest],
+            row[:total_balance],
+            row[:payment_type],
+            row[:days_in_period]
+          )
+        end
+      end
+
+      print_summary
+    end
+
+    def generate_csv_output(csv_path)
+      CSV.open(csv_path, 'w') do |csv|
+        csv << [
+          'Payment Number',
+          'Date',
+          'Days in Period',
+          'Principal Payment',
+          'Interest Payment',
+          'Additional Fee Payment',
+          'Total Payment',
+          'Principal Balance Remaining',
+          'Accrued Interest',
+          'Total Balance',
+          'Payment Type',
+          'Grace Interest Capitalized'
+        ]
+
+        generate_schedule_data.each do |row|
+          csv << [
+            row[:payment_number],
+            row[:date].strftime("%Y-%m-%d"),
+            row[:days_in_period],
+            format("%.2f", row[:principal_payment] || 0),
+            format("%.2f", row[:interest_payment] || 0),
+            format("%.2f", row[:additional_fee_payment] || 0),
+            format("%.2f", row[:total_payment] || 0),
+            format("%.2f", row[:principal_balance]),
+            format("%.2f", row[:accrued_interest] || 0),
+            format("%.2f", row[:total_balance]),
+            row[:payment_type],
+            row[:grace_interest_capitalized] ? format("%.2f", row[:grace_interest_capitalized]) : ''
+          ]
+        end
+      end
+
+      puts "CSV file generated: #{csv_path}"
+    end
+
+    def print_summary
+      puts "\n" + "=" * 195
+      puts "LOAN SUMMARY"
+      puts "=" * 195
+      puts "Loan Start Date: #{@start_date.strftime('%Y-%m-%d')}"
+      puts "First Payment Date: #{first_payment_date.strftime('%Y-%m-%d')}"
+      puts "Term: #{@term_months} months"
+      puts "Payment Frequency: #{@frequency.to_s.capitalize}"
+      puts "Grace Period: #{@grace_period_days} days"
+      
+      if @grace_period_days > 0
+        puts "Grace Period Interest (Capitalized): $#{format('%.2f', grace_period_interest)}"
+      end
+      
+      puts "\nOriginal Principal: $#{format('%.2f', @principal)}"
+      puts "Origination Fee: $#{format('%.2f', @origination_fee)} (added to principal)"
+      puts "Additional Fee: $#{format('%.2f', @additional_fee)}"
+      puts "#{@additional_fee_label} Treatment: #{@additional_fee_treatment.to_s.split('_').map(&:capitalize).join(' ')}"
+      puts "Bank Days Only: #{@bank_days_only}"
+      puts "Interest-Only Periods: #{@interest_only_periods}"
+      puts "Interest Method: #{@interest_method.to_s.capitalize}"
+      
+      puts "\nPrincipal after Origination Fee: $#{format('%.2f', initial_principal_with_origination)}"
+      
+      if @grace_period_days > 0
+        puts "Principal after Grace Period (with capitalized interest): $#{format('%.2f', initial_principal_with_origination + grace_period_interest)}"
+      end
+      
+      case @additional_fee_treatment
+      when :add_to_principal
+        puts "Total Principal (with all fees): $#{format('%.2f', effective_principal)}"
+      when :distributed
+        puts "#{@additional_fee_label} per payment: $#{format('%.2f', @additional_fee / calculate_total_payments)}"
+      when :separate_payment
+        puts "#{@additional_fee_label} collected as separate payment"
+      end
+      
+      if @interest_method == :precomputed
+        puts "\nPrecomputed Interest Calculation:"
+        puts "  Estimated Total Loan Days: #{format('%.0f', estimate_total_loan_days)}"
+        puts "  Total Precomputed Interest: $#{format('%.2f', calculate_precomputed_total_interest)}"
+        puts "  Interest per Payment: $#{format('%.2f', precomputed_interest_per_payment)}"
+      end
+      
+      schedule_data = generate_schedule_data
+      total_interest = schedule_data.sum { |row| row[:interest_payment] || 0 }
+      total_additional_fees = schedule_data.sum { |row| row[:additional_fee_payment] || 0 }
+      total_paid = effective_principal + total_interest + (@additional_fee_treatment == :separate_payment ? @additional_fee : 0)
+      
+      puts "\nTotal Interest Paid (during payments): $#{format('%.2f', total_interest)}"
+      if @grace_period_days > 0
+        puts "Total Interest Including Grace Period: $#{format('%.2f', total_interest + grace_period_interest)}"
+      end
+      puts "Total #{@additional_fee_label} Paid: $#{format('%.2f', total_additional_fees)}"
+      puts "Total Amount Paid: $#{format('%.2f', total_paid)}"
+      puts "=" * 195
+    end
+
+    def format_header
+      format(
+        "%-8s %-12s %-8s %15s %15s %18s %18s %20s %18s %18s %20s",
+        "Payment",
+        "Date",
+        "Days",
+        "Principal Pmt",
+        "Interest Pmt",
+        @additional_fee_label,
+        "Total Payment",
+        "Principal Balance",
+        "Accrued Interest",
+        "Total Balance",
+        "Payment Type"
+      )
+    end
+
+    def format_grace_row(payment_num, date, grace_interest, principal_balance, days)
+      format(
+        "%-8s %-12s %-8d %15s %15s %18s %18s %20.2f %18s %18.2f %20s",
+        "Grace",
+        date.strftime("%Y-%m-%d"),
+        days,
+        "---",
+        "+#{format('%.2f', grace_interest)}",
+        "---",
+        "0.00",
+        principal_balance,
+        "---",
+        principal_balance,
+        "Grace Period"
+      )
+    end
+
+    def format_row(payment_num, date, principal_pmt, interest_pmt, additional_fee_pmt, total_pmt, principal_balance, accrued_interest, total_balance, payment_type, days)
+      format(
+        "%-8s %-12s %-8d %15.2f %15.2f %18.2f %18.2f %20.2f %18.2f %18.2f %20s",
+        payment_num == 0 ? "Fee" : payment_num.to_s,
+        date.strftime("%Y-%m-%d"),
+        days,
+        principal_pmt,
+        interest_pmt,
+        additional_fee_pmt,
+        total_pmt,
+        principal_balance,
+        accrued_interest,
+        total_balance,
+        payment_type
+      )
+    end
+  end
+end
+

data/lib/amortizy/version.rb

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

data/lib/amortizy.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "amortizy/version"
+require_relative "amortizy/engine"
+
+module Amortizy
+  class Error < StandardError; end
+end

data/sig/amortizy.rbs

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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: amortizy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rich Zapata
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: holidays
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description: A comprehensive Ruby gem for generating loan amortization schedules with
+  advanced features including grace periods, interest-only payments, federal bank
+  holidays, and multiple interest calculation methods
+email:
+- rzapata@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/amortizy.rb
+- lib/amortizy/engine.rb
+- lib/amortizy/version.rb
+- sig/amortizy.rbs
+homepage: https://github.com/zapatify/amortizy
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/zapatify/amortizy
+  source_code_uri: https://github.com/zapatify/amortizy
+  changelog_uri: https://github.com/zapatify/amortizy/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.2
+specification_version: 4
+summary: A gem to generate amortization schedules
+test_files: []