ec-abacus 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7a06d9174b4665f2d0f6c72826755accf882558c3003b6831742fd08bb807c0f
+  data.tar.gz: 3c8594c380161da7cbbddbc8cacc50cf8b57438563e93f83a89270902bf2dfd9
+SHA512:
+  metadata.gz: 2068130a9795faf9805e3b422f4813324e4c21b863c918650b2cf52b36f6a7a92bf7e2a77fd6fcb21e53284f7c8e9ae6c590800f130fd61ee4e8531a8afd5baa
+  data.tar.gz: 12305b271c60c0f89a6b7448306486041600e97e7dece333573221b3deb87c636ba91c54a52a519bfc4b43c78618c4cd04c30158132f344b60530a2b813bb400

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,10 @@
+# Code of Conduct
+
+"ec-abacus" follows [The Ruby Community Conduct Guideline](https://www.ruby-lang.org/en/conduct) in all "collaborative space", which is defined as community communications channels (such as mailing lists, submitted patches, commit comments, etc.):
+
+* Participants will be tolerant of opposing views.
+* Participants must ensure that their language and actions are free of personal attacks and disparaging personal remarks.
+* When interpreting the words and actions of others, participants should always assume good intentions.
+* Behaviour which can be reasonably considered harassment will not be tolerated.
+
+If you have any concerns about behaviour within this project, please contact us at ["gxssd624@duck.com"](mailto:"gxssd624@duck.com").

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Eclectic Code
+
+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 @@
+# Ec::Abacus
+
+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/ec/abacus`. 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/binnablus/ec-abacus. 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/binnablus/ec-abacus/blob/master/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 Ec::Abacus project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/binnablus/ec-abacus/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/ec/abacus/interest_calculator.rb

@@ -0,0 +1,316 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Ec
+  module Abacus
+    class InterestCalculator
+
+    def initialize(principal:, annual_rate:, start_date:, end_date:, rule:)
+      @principal = principal
+      @annual_rate = annual_rate # e.g., 0.05 for 5%
+      @start_date = Date.parse(start_date)
+      @end_date = Date.parse(end_date)
+      @rule = rule
+    end
+
+    def calculate_interest
+      daily_rate = @annual_rate / 360.0
+      @principal * daily_rate * days_count
+    end
+
+    private
+    attr_accessor :principal, :annual_rate, :start_date, :end_date, :rule
+
+    def days_count
+      case rule
+      when :actual_actual, :actual_360, :actual_365, :fixed_schedule
+        # Actual number of days between dates
+        (end_date - start_date).to_i
+      when :normalized_30_360, :normalized_30_365
+        # NASD/ISDA standard 30/360 formulation
+        d1 = start_date.day
+        m1 = start_date.month
+        y1 = start_date.year
+
+        d2 = end_date.day
+        m2 = end_date.month
+        y2 = end_date.year
+
+        # Apply 30/360 adjustment rules
+        d1 = 30 if d1 == 31
+        d2 = 30 if d2 == 31 && d1 >= 30
+
+        (360 * (y2 - y1)) + (30 * (m2 - m1)) + (d2 - d1)
+      else
+        raise ArgumentError, "Unknown day count rule: #{@rule}"
+      end
+    end
+  end
+end
+
+# frozen_string_literal: true
+
+require "date"
+
+# InterestCalculator
+#
+# Calculates interest using the major day count conventions and
+# interest methods used in finance.
+#
+# Day count conventions supported (pass as `convention:`):
+#
+#   :thirty_360_us      - 30/360 US (Bond Basis). Months are 30 days,
+#                         year is 360 days, with US end-of-month rules.
+#   :thirty_e_360       - 30E/360 (Eurobond Basis). Any 31st becomes the 30th.
+#   :thirty_e_360_isda  - 30E/360 ISDA. Last day of any month (incl. February)
+#                         is treated as the 30th, except a maturity date in February.
+#   :actual_360         - Actual/360. Actual days elapsed over a 360-day year.
+#   :actual_365         - Actual/365 Fixed. Actual days over 365, even in leap years.
+#   :actual_actual      - Actual/Actual ISDA. Actual days over the actual year
+#                         length, split across calendar years.
+#
+# Interest methods:
+#
+#   .simple             - P * r * t
+#   .compound           - P * ((1 + r/n)^(n*t) - 1), n = compounding frequency
+#   .continuous         - P * (e^(r*t) - 1)
+#   .amortization_schedule - level-payment (actuarial) loan schedule
+#   .rule_of_78s        - precomputed interest allocated by the Rule of 78s
+#
+# Usage:
+#
+#   calc = InterestCalculator.new(
+#     principal: 1_000_000,
+#     annual_rate: 0.06,                 # 6% as a decimal
+#     start_date: Date.new(2026, 1, 1),
+#     end_date:   Date.new(2026, 2, 1),
+#     convention: :thirty_360_us
+#   )
+#   calc.simple            #=> 5000.0
+#   calc.year_fraction     #=> 0.08333...
+#
+class InterestCalculator
+  CONVENTIONS = %i[
+    thirty_360_us
+    thirty_e_360
+    thirty_e_360_isda
+    actual_360
+    actual_365
+    actual_actual
+  ].freeze
+
+  attr_reader :principal, :annual_rate, :start_date, :end_date, :convention
+
+  # maturity_date is only relevant for :thirty_e_360_isda, where the period
+  # end date is NOT adjusted if it is the maturity date and falls in February.
+  def initialize(principal:, annual_rate:, start_date:, end_date:,
+                 convention: :actual_365, maturity_date: nil)
+    unless CONVENTIONS.include?(convention)
+      raise ArgumentError,
+            "Unknown convention #{convention.inspect}. Valid: #{CONVENTIONS.join(', ')}"
+    end
+    raise ArgumentError, "end_date must be on or after start_date" if end_date < start_date
+    raise ArgumentError, "annual_rate must be non-negative" if annual_rate.negative?
+
+    @principal     = principal.to_f
+    @annual_rate   = annual_rate.to_f
+    @start_date    = start_date
+    @end_date      = end_date
+    @convention    = convention
+    @maturity_date = maturity_date
+  end
+
+  # ---------------------------------------------------------------
+  # Day count / year fraction
+  # ---------------------------------------------------------------
+
+  # Fraction of a year between start_date and end_date under the
+  # chosen convention. This is the "t" used in all interest formulas.
+  def year_fraction
+    case convention
+    when :thirty_360_us     then thirty_360_us_fraction
+    when :thirty_e_360      then thirty_e_360_fraction
+    when :thirty_e_360_isda then thirty_e_360_isda_fraction
+    when :actual_360        then actual_days / 360.0
+    when :actual_365        then actual_days / 365.0
+    when :actual_actual     then actual_actual_fraction
+    end
+  end
+
+  # Number of accrual days the convention counts (numerator of the fraction).
+  def day_count
+    case convention
+    when :thirty_360_us     then (thirty_360_us_fraction * 360).round
+    when :thirty_e_360      then (thirty_e_360_fraction * 360).round
+    when :thirty_e_360_isda then (thirty_e_360_isda_fraction * 360).round
+    else actual_days
+    end
+  end
+
+  def actual_days
+    (end_date - start_date).to_i
+  end
+
+  # ---------------------------------------------------------------
+  # Interest methods
+  # ---------------------------------------------------------------
+
+  # Simple interest: P * r * t
+  def simple
+    principal * annual_rate * year_fraction
+  end
+
+  # Compound interest earned (not the balance): P * ((1 + r/n)^(n*t) - 1)
+  # frequency: compounding periods per year (12 = monthly, 4 = quarterly,
+  # 1 = annually, 365 = daily).
+  def compound(frequency: 12)
+    raise ArgumentError, "frequency must be positive" unless frequency.positive?
+
+    principal * ((1 + annual_rate / frequency)**(frequency * year_fraction) - 1)
+  end
+
+  # Continuously compounded interest earned: P * (e^(r*t) - 1)
+  def continuous
+    principal * (Math.exp(annual_rate * year_fraction) - 1)
+  end
+
+  # Future value under compound interest (principal + interest).
+  def future_value(frequency: 12)
+    principal + compound(frequency: frequency)
+  end
+
+  # ---------------------------------------------------------------
+  # Loan-style methods
+  # ---------------------------------------------------------------
+
+  # Level monthly payment for a fully amortizing loan (actuarial method).
+  def amortized_payment(months:)
+    raise ArgumentError, "months must be positive" unless months.positive?
+
+    monthly_rate = annual_rate / 12.0
+    return principal / months if monthly_rate.zero?
+
+    principal * monthly_rate / (1 - (1 + monthly_rate)**-months)
+  end
+
+  # Full amortization schedule. Returns an array of hashes:
+  #   { period:, payment:, interest:, principal:, balance: }
+  def amortization_schedule(months:)
+    payment      = amortized_payment(months: months)
+    monthly_rate = annual_rate / 12.0
+    balance      = principal
+
+    (1..months).map do |period|
+      interest  = balance * monthly_rate
+      principal_paid = payment - interest
+      # Final payment absorbs rounding drift so the balance lands on zero.
+      if period == months
+        principal_paid = balance
+        payment_this   = balance + interest
+      else
+        payment_this = payment
+      end
+      balance -= principal_paid
+      {
+        period:    period,
+        payment:   payment_this.round(2),
+        interest:  interest.round(2),
+        principal: principal_paid.round(2),
+        balance:   balance.abs < 0.005 ? 0.0 : balance.round(2)
+      }
+    end
+  end
+
+  # Rule of 78s (sum-of-digits) allocation of precomputed interest.
+  #
+  # total_interest defaults to simple interest for the term implied by
+  # `months` (months/12 of a year), which is how precomputed loans are
+  # typically quoted. Returns an array of per-period interest charges,
+  # front-loaded: period 1 carries months/sum, period 2 (months-1)/sum, etc.
+  def rule_of_78s(months:, total_interest: nil)
+    raise ArgumentError, "months must be positive" unless months.positive?
+
+    total = total_interest || principal * annual_rate * (months / 12.0)
+    sum_of_digits = months * (months + 1) / 2
+
+    (1..months).map do |period|
+      weight = months - period + 1
+      { period: period, interest: (total * weight / sum_of_digits).round(2) }
+    end
+  end
+
+  # ---------------------------------------------------------------
+  # Convenience: compare every convention for the same period
+  # ---------------------------------------------------------------
+
+  def self.compare(principal:, annual_rate:, start_date:, end_date:)
+    CONVENTIONS.to_h do |conv|
+      calc = new(principal: principal, annual_rate: annual_rate,
+                 start_date: start_date, end_date: end_date, convention: conv)
+      [conv, { days: calc.day_count, year_fraction: calc.year_fraction, simple_interest: calc.simple.round(2) }]
+    end
+  end
+
+  private
+
+  # --- 30/360 US (Bond Basis) --------------------------------------
+  # 1. If d1 is 31, set d1 to 30.
+  # 2. If d2 is 31 and d1 is 30 (after step 1), set d2 to 30.
+  def thirty_360_us_fraction
+    d1 = start_date.day
+    d2 = end_date.day
+    d1 = 30 if d1 == 31
+    d2 = 30 if d2 == 31 && d1 == 30
+    thirty_360(start_date.year, start_date.month, d1, end_date.year, end_date.month, d2)
+  end
+
+  # --- 30E/360 (Eurobond Basis) ------------------------------------
+  # Any date on the 31st becomes the 30th, unconditionally.
+  def thirty_e_360_fraction
+    d1 = [start_date.day, 30].min
+    d2 = [end_date.day, 30].min
+    thirty_360(start_date.year, start_date.month, d1, end_date.year, end_date.month, d2)
+  end
+
+  # --- 30E/360 ISDA ------------------------------------------------
+  # d1 = 30 if start_date is the last day of its month.
+  # d2 = 30 if end_date is the last day of its month, UNLESS end_date is
+  # the maturity date and falls in February.
+  def thirty_e_360_isda_fraction
+    d1 = last_day_of_month?(start_date) ? 30 : start_date.day
+    d2 = end_date.day
+    if last_day_of_month?(end_date) &&
+       !(end_date.month == 2 && @maturity_date && end_date == @maturity_date)
+      d2 = 30
+    end
+    thirty_360(start_date.year, start_date.month, d1, end_date.year, end_date.month, d2)
+  end
+
+  def thirty_360(y1, m1, d1, y2, m2, d2)
+    (360 * (y2 - y1) + 30 * (m2 - m1) + (d2 - d1)) / 360.0
+  end
+
+  def last_day_of_month?(date)
+    date.day == Date.new(date.year, date.month, -1).day
+  end
+
+  # --- Actual/Actual ISDA ------------------------------------------
+  # Days in each calendar year divided by that year's actual length
+  # (366 for leap years, 365 otherwise), summed across the period.
+  def actual_actual_fraction
+    return 0.0 if start_date == end_date
+
+    (start_date.year..end_date.year).sum do |year|
+      year_start = [Date.new(year, 1, 1), start_date].max
+      year_end   = [Date.new(year + 1, 1, 1), end_date].min
+      days = (year_end - year_start).to_i
+      next 0.0 if days <= 0
+
+      days / (Date.gregorian_leap?(year) ? 366.0 : 365.0)
+    end
+  end
+end
+
+
+

data/lib/ec/abacus/simple_interest.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module Ec
+  module Abacus
+    class SimpleInterest
+      def initialize(principal:, annual_rate:, start_date:, end_date:, rule:, period: nil)
+        @principal = principal
+        @annual_rate = annual_rate # e.g., 0.05 for 5%
+        @start_date = Date.parse(start_date)
+        @end_date = Date.parse(end_date)
+        @rule = rule
+      end
+
+      def call 
+        principal * annual_rate * year_fraction
+      end
+
+      private
+      attr_accessor :principal, :annual_rate, :start_date, :end_date, :rule
+
+      # Fraction of a year between start_date and end_date under the
+      # chosen convention. This is the "t" used in all interest formulas.
+      def year_fraction
+        case rule 
+        when :actual_365        then actual_days / 365.0
+        when :actual_360        then actual_days / 360.0
+        when :actual_actual     then actual_actual_fraction
+        when :normalized_30_360 then thirty_days / 360.0
+        when :normalized_30_365 then thirty_days / 365.0
+        when :fixed_fee_no_interest then 0
+        end
+      end
+
+      def thirty_days
+        day1 = [start_date.day, 30].min
+        day2 = end_date.day
+
+        if day1 == 30
+          day2 = [day2, 30].min
+        end
+
+        (
+          360 * (end_date.year - start_date.year) + 
+          30 * (end_date.month - start_date.month) + 
+          (day2 - day1)
+        )
+      end
+
+      def actual_days
+        (end_date - start_date).to_i
+      end
+
+      # --- Actual/Actual ISDA ------------------------------------------
+      # Days in each calendar year divided by that year's actual length
+      # (366 for leap years, 365 otherwise), summed across the period.
+      def actual_actual_fraction
+        if start_date == end_date
+          0.0
+        else
+          (start_date.year..end_date.year).sum do |year|
+            period_start = [Date.new(year, 1, 1), start_date].max
+            period_end   = [Date.new(year + 1, 1, 1), end_date].min
+            days = (period_end - period_start).to_i
+            next 0.0 if days <= 0
+
+            days / (Date.gregorian_leap?(year) ? 366.0 : 365.0)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ec/abacus/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Ec
+  module Abacus
+    VERSION = "0.1.0"
+  end
+end

data/lib/ec/abacus.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "abacus/version"
+
+module Ec
+  module Abacus
+    class Error < StandardError; end
+    # Your code goes here...
+
+    autoload :InterestCalculator, 'abacus/interest_calculator'
+  end
+end

data/sig/ec/abacus.rbs

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

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: ec-abacus
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eclectic Code
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Provide various financial calculations.
+email:
+- gxssd624@duck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ec/abacus.rb
+- lib/ec/abacus/interest_calculator.rb
+- lib/ec/abacus/simple_interest.rb
+- lib/ec/abacus/version.rb
+- sig/ec/abacus.rbs
+homepage: https://github.com/binnablus/ec-abacus
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/binnablus/ec-abacus
+  source_code_uri: https://github.com/binnablus/ec-abacus
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.10
+specification_version: 4
+summary: Provide various financial calculations.
+test_files: []