amortizy 1.0.0 → 2.0.0

data/tasks/todo.md

@@ -0,0 +1,74 @@
+# Amortizy v2.0 — Dynamic Payment Model
+
+## Goal
+
+Replace the hardcoded term/payment lookup table with a dynamic calculation engine.
+Support two entry points: `term_months` (calculate payment count) or `num_payments`
+(calculate end date). Add monthly and bi-weekly frequencies.
+
+---
+
+## Phase 1: Dynamic Payment Engine
+
+### 1.1 Dual input model
+- [ ] Accept `term_months` OR `num_payments` — one required, not both
+- [ ] Validate: raise `ArgumentError` if both provided, or neither
+- [ ] When `term_months` given: calculate `num_payments` from frequency
+  - monthly: `term_months`
+  - bi-weekly: `term_months * 2` (approx 26/year)
+  - weekly: `term_months * 52 / 12` (rounded)
+  - daily: calculate actual business/calendar days in the term
+- [ ] When `num_payments` given: calculate end date by walking the payment schedule forward
+- [ ] Remove the hardcoded `calculate_total_payments` lookup table
+- [ ] Remove `validate_term_months!` (any positive integer is now valid)
+
+### 1.2 New frequencies
+- [ ] Add `:monthly` frequency — payment on same day each month (or last business day)
+- [ ] Add `:biweekly` frequency — every 14 days
+- [ ] Update `validate_frequency!` to accept all four
+- [ ] Handle month-end edge cases for monthly (e.g., start Jan 31 — Feb payment is Feb 28)
+
+### 1.3 Dynamic day calculation
+- [ ] Replace static payment counts with actual date walking
+- [ ] For daily + `bank_days_only`: count actual business days in the term
+- [ ] For weekly/biweekly: walk forward by 7/14 days, skip to next bank day if needed
+- [ ] For monthly: advance by calendar month, adjust for bank days
+
+## Phase 2: Public API Cleanup
+
+### 2.1 Expose schedule data
+- [ ] Make `generate_schedule_data` public, rename to `schedule` or `to_a`
+- [ ] Return frozen array of payment hashes
+- [ ] Add `summary` method — returns hash with totals, dates, payment count
+- [ ] Remove `send(:generate_schedule_data)` from README examples
+
+### 2.2 Convenience methods
+- [ ] `#end_date` — last payment date
+- [ ] `#total_interest` — sum of all interest payments
+- [ ] `#total_paid` — sum of all payments
+- [ ] `#payment_amount` — make public (currently private)
+
+## Phase 3: Extract Formatters
+
+- [ ] Extract `ConsoleFormatter` — takes schedule data, renders table
+- [ ] Extract `CsvFormatter` — takes schedule data, writes CSV
+- [ ] `generate(output:)` delegates to formatter
+- [ ] Engine class focuses on math only
+
+## Phase 4: Polish
+
+- [ ] Fix README broken markdown in Development section
+- [ ] Update README examples for new API
+- [ ] Update gemspec description
+- [ ] Add CHANGELOG entry for v2.0
+- [ ] Bump version
+- [ ] Update Ruby requirement to >= 3.0
+- [ ] Run full spec suite, update/add specs for new features
+
+---
+
+## Breaking changes (v2.0)
+
+- `term_months` no longer restricted to [6, 9, 12, 15, 18]
+- `generate_schedule_data` renamed to public method
+- New frequencies may change default behavior for existing users (unlikely — additive)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: amortizy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Rich Zapata
@@ -23,26 +23,27 @@ dependencies:
     - - "~>"
       - !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
+description: Generate loan amortization schedules with monthly, bi-weekly, weekly,
+  or daily payments. Supports 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
+- CONTRIBUTING.md
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/.DS_Store
 - lib/amortizy.rb
+- lib/amortizy/console_formatter.rb
+- lib/amortizy/csv_formatter.rb
 - lib/amortizy/engine.rb
 - lib/amortizy/version.rb
 - sig/amortizy.rbs
+- tasks/todo.md
 homepage: https://github.com/zapatify/amortizy
 licenses:
 - MIT
@@ -51,6 +52,7 @@ metadata:
   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
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -58,14 +60,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.6
 specification_version: 4
 summary: A gem to generate amortization schedules
 test_files: []

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# 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