cashflow_sim 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 15ea823bf47ada32f48f9afa7f9b103b434712498e5aadc4c53ca825d8bb2468
+  data.tar.gz: 051c79a1a8ddfbcdef7ec9cd7f13ef96e53e4d56cf2c431da15f89fdbe6cfb4b
+SHA512:
+  metadata.gz: 42fd8ee7a2d64c36fbc7119fe3d3789e9b679afe59c4f8cbe3bf009595482257f9d7a969617a74d85942efac8b4d411c684802b7612247a214a093ddc0a4f5e4
+  data.tar.gz: c85d2c9ca179873cd7cbe85bef99a9b2aa3b0bb54a58fc04eba414068e61faaf4fae2fedc6ad1c65008e87380a53cada74c2a6ff9f252e1c208fda03269d6e27

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-09-11
+
+- 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 篠原亮太
+
+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,46 @@
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "cashflow_sim"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself:
+
+```bash
+gem install cashflow_sim
+```
+
+## CLI
+
+```bash
+# 固定金利（年次）
+cashflow_sim --principal 1000000 --years 5 --rate 1.5 --yearly
+
+# 線形に変動（1年目0.7%→30年目2.0%へ、以降据え置き）
+cashflow_sim --principal 45000000 --years 40 --start-rate 0.7 --end-rate 2.0 --end-year 30 --format csv > schedule.csv
+
+# ヘルプ
+cashflow_sim --help
+```
+
+## Library (Ruby)
+
+```ruby
+require "cashflow_sim"
+
+am = CashflowSim::Amortization.new(
+  principal: 1_000_000,
+  years: 5,
+  rate_schedule: 1.5,
+  frequency: :yearly
+)
+rows = am.schedule
+```

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/exe/cashflow_sim

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require "json"
+require "csv"
+require_relative "../lib/cashflow_sim"
+
+# ---- オプション定義（デフォルト値）----
+options = {
+  principal: 45_000_000,
+  years: 40,
+  # 固定金利か、線形に変動する金利かを選べる
+  rate: nil,          # 単一の年利%（例: 1.5）を与えたら固定金利として使用
+  start_rate: 0.7,    # 変動開始年利%
+  end_rate: 2.0,      # 変動終了年利%
+  end_year: 30,       # end_rate に到達する年（以降は据え置き）
+  frequency: :monthly,
+  format: "json"
+}
+
+# ---- OptionParser で引数を解析 ----
+# Ruby標準の optparse は「-」「--」のフラグを宣言し、ブロックで値を受け取る仕組み
+parser = OptionParser.new do |o|
+  o.banner = "Usage: cashflow_sim [options]"
+
+  o.on("--principal N", Integer, "元本（例: 45000000）") { |v| options[:principal] = v }
+  o.on("--years N", Integer,    "返済年数（例: 40）") { |v| options[:years] = v }
+
+  # 固定金利（--rate）か、線形変動金利（--start-rate/--end-rate/--end-year）かを選択
+  o.on("--rate F", Float,       "固定の年利%（例: 1.5）") { |v| options[:rate] = v }
+  o.on("--start-rate F", Float, "変動スタート年利%（例: 0.7）") { |v| options[:start_rate] = v }
+  o.on("--end-rate F", Float,   "変動終了年利%（例: 2.0）")     { |v| options[:end_rate] = v }
+  o.on("--end-year N", Integer, "end_rate に到達する年（例: 30）") { |v| options[:end_year] = v }
+
+  o.on("--yearly",  "年次計算にする（既定は月次）") { options[:frequency] = :yearly }
+  o.on("--monthly", "月次計算にする（デフォルト）") { options[:frequency] = :monthly }
+
+  o.on("--format FORMAT", %w[json csv], "出力形式：json | csv（default: json）") { |v| options[:format] = v }
+
+  o.on("-h", "--help", "ヘルプを表示") do
+    puts o
+    exit
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::ParseError => e
+  warn e.message
+  warn parser
+  exit 1
+end
+
+# ---- 金利スケジュールを決定 ----
+# Amortization.new の rate_schedule 引数には、
+#   - Proc（年を受けて年利%を返す） か
+#   - Array（年ごとの年利%）
+#   - Numeric（単一の年利%）
+# のいずれかを渡せる実装になっている。
+rate_schedule =
+  if options[:rate]
+    # 固定金利：Numeric を渡す
+    options[:rate]
+  else
+    # 線形変動金利：Proc を渡す
+    start_rate = options[:start_rate].to_f
+    end_rate   = options[:end_rate].to_f
+    end_year   = [options[:end_year].to_i, 1].max
+
+    # year=1 で start_rate、year=end_year で end_rate、その後は据え置き
+    lambda do |year|
+      y = [[year, 1].max, end_year].min
+      t = (y - 1).to_f / (end_year - 1) # 0..1 に正規化（end_year==1 の場合は下で補正）
+      t = 0.0 if end_year == 1
+      start_rate + (end_rate - start_rate) * t
+    end
+  end
+
+# ---- 計算本体 ----
+am = CashflowSim::Amortization.new(
+  principal: options[:principal],
+  years: options[:years],
+  rate_schedule: rate_schedule,
+  frequency: options[:frequency]
+)
+
+rows = am.schedule
+
+# ---- 出力 ----
+case options[:format]
+when "json"
+  puts JSON.pretty_generate(rows.map(&:to_h))
+when "csv"
+  CSV($stdout) do |csv|
+    csv << %w[year month rate payment interest principal_paid balance]
+    rows.each { |r| csv << [r.year, r.month, r.rate, r.payment, r.interest, r.principal_paid, r.balance] }
+  end
+else
+  warn "unknown format: #{options[:format]}"
+  exit 1
+end

data/lib/cashflow_sim/amortization.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module CashflowSim
+  # 返済スケジュールを生成するクラス
+  # - principal:     元本
+  # - years:         返済年数
+  # - rate_schedule: 年ごとの「年利（%）」を返す Proc / 配列 / 数値
+  # - frequency:     :monthly or :yearly
+  class Amortization
+    Period = Struct.new(:year, :month, :rate, :payment, :interest, :principal_paid, :balance, keyword_init: true)
+
+    def initialize(principal:, years:, rate_schedule:, frequency: :monthly)
+      @principal = principal.to_f
+      @years     = years.to_i
+      @rate_fn   = to_rate_fn(rate_schedule)
+      @freq      = frequency
+    end
+
+    def schedule
+      periods = []
+      balance = @principal
+      total   = (@freq == :monthly ? (@years * 12) : @years)
+
+      (1..total).each do |i|
+        y = year_of(i)
+        m = month_of(i)
+        annual_percent = @rate_fn.call(y)
+        r = period_rate(annual_percent)
+
+        # 残期間（いまの期も含める）
+        n_left = total - i + 1
+        # 残期間が0にならないようガード
+        n_left = 1 if n_left < 1
+
+        pmt = annuity_payment(balance, r, n_left)
+
+        interest       = balance * r
+        principal_paid = [pmt - interest, balance].min
+        balance        = (balance - principal_paid).clamp(0.0, Float::INFINITY)
+
+        periods << Period.new(
+          year: y,
+          month: m,
+          rate: r.round(8),
+          payment: pmt.round(2),
+          interest: interest.round(2),
+          principal_paid: principal_paid.round(2),
+          balance: balance.round(2)
+        )
+
+        break if balance <= 0.0
+      end
+
+      periods
+    end
+
+    private
+
+    def to_rate_fn(obj)
+      case obj
+      when Proc
+        obj
+      when Array
+        # yが配列長を超えたら最終年の利率を継続
+        ->(y) { obj[[y - 1, obj.length - 1].min] }
+      when Numeric
+        ->(_y) { obj }
+      else
+        raise ArgumentError, "rate_schedule must be Proc, Array, or Numeric"
+      end
+    end
+
+    def year_of(i)
+      @freq == :monthly ? ((i - 1) / 12 + 1) : i
+    end
+
+    def month_of(i)
+      @freq == :monthly ? (((i - 1) % 12) + 1) : 1
+    end
+
+    def period_rate(annual_percent)
+      annual = annual_percent.to_f / 100.0
+      @freq == :monthly ? (annual / 12.0) : annual
+    end
+
+    # 元利均等の期間支払額（r==0 にも対応）
+    def annuity_payment(balance, r, n)
+      return balance / n if r.zero?
+
+      balance * r / (1 - (1 + r)**(-n))
+    end
+  end
+end

data/lib/cashflow_sim/version.rb

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

data/lib/cashflow_sim.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "cashflow_sim/version"
+require_relative "cashflow_sim/amortization"
+
+module CashflowSim
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/cashflow_sim.rbs

@@ -0,0 +1,4 @@
+module CashflowSim
+  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: cashflow_sim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 篠原亮太
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Generate schedules with variable interest rates, CSV/JSON output, and
+  an extensible API.
+email:
+- your.email@example.com
+executables:
+- cashflow_sim
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/cashflow_sim
+- lib/cashflow_sim.rb
+- lib/cashflow_sim/amortization.rb
+- lib/cashflow_sim/version.rb
+- sig/cashflow_sim.rbs
+homepage: https://github.com/ryota1119/cashflow_sim
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ryota1119/cashflow_sim
+  source_code_uri: https://github.com/ryota1119/cashflow_sim
+  changelog_uri: https://github.com/ryota1119/cashflow_sim/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: Simple amortization & cashflow simulator for loans/investments.
+test_files: []