refi-calculator 0.8.0__py3-none-any.whl

refi_calculator/gui/builders/options_tab.py

@@ -0,0 +1,81 @@
+"""Options tab builder."""
+
+from __future__ import annotations
+
+import tkinter as tk
+from tkinter import ttk
+from typing import TYPE_CHECKING
+
+from .helpers import add_option
+
+if TYPE_CHECKING:
+    from ..app import RefinanceCalculatorApp
+
+
+def build_options_tab(
+    app: RefinanceCalculatorApp,
+    parent: ttk.Frame,
+) -> None:
+    """Build the options tab for NPV/chart settings.
+
+    Args:
+        app: Application instance with option state.
+        parent: Frame that hosts the options controls.
+    """
+    ttk.Label(parent, text="Application Options", font=("Segoe UI", 10, "bold")).pack(
+        anchor=tk.W,
+        pady=(0, 15),
+    )
+
+    options_frame = ttk.LabelFrame(parent, text="NPV & Chart Settings", padding=15)
+    options_frame.pack(fill=tk.X, pady=(0, 10))
+
+    add_option(
+        options_frame,
+        "NPV Window (years):",
+        app.npv_window_years,
+        0,
+        "Time horizon for NPV calculation (e.g., 5 = 5-Year NPV)",
+    )
+    add_option(
+        options_frame,
+        "Chart Horizon (years):",
+        app.chart_horizon_years,
+        1,
+        "How many years to display on the cumulative savings chart",
+    )
+
+    sens_frame = ttk.LabelFrame(parent, text="Sensitivity Analysis", padding=15)
+    sens_frame.pack(fill=tk.X, pady=(0, 10))
+
+    add_option(
+        sens_frame,
+        "Max Rate Reduction (%):",
+        app.sensitivity_max_reduction,
+        0,
+        "How far below current rate to analyze (e.g., 2.0 = current - 2%)",
+    )
+    add_option(
+        sens_frame,
+        "Rate Step (%):",
+        app.sensitivity_step,
+        1,
+        "Increment between rate scenarios (e.g., 0.25)",
+    )
+
+    ttk.Button(parent, text="Apply & Recalculate", command=app._calculate).pack(pady=15)
+    ttk.Label(
+        parent,
+        text="Changes take effect after clicking 'Apply & Recalculate' or running a new calculation.",
+        font=("Segoe UI", 8),
+        foreground="#666",
+    ).pack(anchor=tk.W)
+
+
+__all__ = [
+    "build_options_tab",
+]
+
+__description__ = """
+Constructs the options tab controls.
+"""

refi_calculator/gui/builders/visuals_tab.py

@@ -0,0 +1,128 @@
+"""Visual tab builders for amortization and chart views."""
+
+from __future__ import annotations
+
+import tkinter as tk
+from tkinter import ttk
+from typing import TYPE_CHECKING
+
+from ..chart import AmortizationChart, SavingsChart
+from .helpers import result_block
+
+if TYPE_CHECKING:
+    from ..app import RefinanceCalculatorApp
+
+
+def build_amortization_tab(
+    app: RefinanceCalculatorApp,
+    parent: ttk.Frame,
+) -> None:
+    """Build amortization comparison tree and summary.
+
+    Args:
+        app: Application instance owning the amortization data.
+        parent: Frame that contains amortization widgets.
+    """
+    ttk.Label(
+        parent,
+        text="Amortization Schedule Comparison (Annual)",
+        font=("Segoe UI", 10, "bold"),
+    ).pack(anchor=tk.W, pady=(0, 10))
+
+    tree_frame = ttk.Frame(parent)
+    tree_frame.pack(fill=tk.BOTH, expand=True)
+
+    columns = (
+        "year",
+        "curr_principal",
+        "curr_interest",
+        "curr_balance",
+        "new_principal",
+        "new_interest",
+        "new_balance",
+        "int_diff",
+        "cum_interest_diff",
+    )
+    app.amort_tree = ttk.Treeview(tree_frame, columns=columns, show="headings", height=15)
+
+    app.amort_tree.heading("year", text="Year")
+    app.amort_tree.heading("curr_principal", text="Curr Principal")
+    app.amort_tree.heading("curr_interest", text="Curr Interest")
+    app.amort_tree.heading("curr_balance", text="Curr Balance")
+    app.amort_tree.heading("new_principal", text="New Principal")
+    app.amort_tree.heading("new_interest", text="New Interest")
+    app.amort_tree.heading("new_balance", text="New Balance")
+    app.amort_tree.heading("int_diff", text="Interest Δ")
+    app.amort_tree.heading("cum_interest_diff", text="Cumulative Interest Δ")
+
+    app.amort_tree.column("year", width=45, anchor=tk.CENTER)
+    app.amort_tree.column("curr_principal", width=85, anchor=tk.E)
+    app.amort_tree.column("curr_interest", width=80, anchor=tk.E)
+    app.amort_tree.column("curr_balance", width=85, anchor=tk.E)
+    app.amort_tree.column("new_principal", width=85, anchor=tk.E)
+    app.amort_tree.column("new_interest", width=80, anchor=tk.E)
+    app.amort_tree.column("new_balance", width=85, anchor=tk.E)
+    app.amort_tree.column("int_diff", width=70, anchor=tk.E)
+    app.amort_tree.column("cum_interest_diff", width=105, anchor=tk.E)
+
+    y_scroll = ttk.Scrollbar(tree_frame, orient="vertical", command=app.amort_tree.yview)
+    app.amort_tree.configure(yscrollcommand=y_scroll.set)
+
+    app.amort_tree.pack(side=tk.LEFT, fill=tk.BOTH, expand=True)
+    y_scroll.pack(side=tk.RIGHT, fill=tk.Y)
+
+    summary_frame = ttk.LabelFrame(parent, text="Cumulative Totals", padding=10)
+    summary_frame.pack(fill=tk.X, pady=(10, 5))
+
+    summary_cols = ttk.Frame(summary_frame)
+    summary_cols.pack(fill=tk.X)
+
+    app.amort_curr_total_int = result_block(summary_cols, "Current Total Interest", 0)
+    app.amort_new_total_int = result_block(summary_cols, "New Total Interest", 1)
+    app.amort_int_savings = result_block(summary_cols, "Interest Savings", 2)
+
+    ttk.Button(
+        parent,
+        text="Export Amortization CSV",
+        command=app._export_amortization_csv,
+    ).pack(pady=10)
+
+
+def build_chart_tab(
+    app: RefinanceCalculatorApp,
+    parent: ttk.Frame,
+) -> None:
+    """Build cumulative savings chart tab.
+
+    Args:
+        app: App instance providing chart parameters.
+        parent: Frame used for the chart canvas.
+    """
+    chart_years = int(float(app.chart_horizon_years.get() or 10))
+    ttk.Label(
+        parent,
+        text=f"Cumulative Savings Over Time ({chart_years} Years)",
+        font=("Segoe UI", 10, "bold"),
+    ).pack(anchor=tk.W, pady=(0, 10))
+
+    app.chart = SavingsChart(parent, width=480, height=280)
+    app.chart.pack(fill=tk.BOTH, expand=True)
+
+    ttk.Label(
+        parent,
+        text="Loan Balance Comparison",
+        font=("Segoe UI", 10, "bold"),
+    ).pack(anchor=tk.W, pady=(18, 6))
+
+    app.amortization_balance_chart = AmortizationChart(parent, width=480, height=240)
+    app.amortization_balance_chart.pack(fill=tk.BOTH, expand=True)
+
+
+__all__ = [
+    "build_amortization_tab",
+    "build_chart_tab",
+]
+
+__description__ = """
+Builders for the visuals sub-tabs.
+"""

refi_calculator/gui/chart.py

@@ -0,0 +1,459 @@
+"""Chart components for the refinance GUI."""
+
+from __future__ import annotations
+
+import tkinter as tk
+from collections.abc import Callable
+
+from ..core.charts import build_linear_ticks, build_month_ticks
+
+
+class SavingsChart(tk.Canvas):
+    """Canvas that draws cumulative savings / NPV trends.
+
+    Attributes:
+        width: Canvas width.
+        height: Canvas height.
+        padding: Padding around the plot area.
+    """
+
+    width: int
+    height: int
+    padding: dict[str, int]
+
+    def __init__(
+        self,
+        parent: tk.Misc,
+        width: int = 400,
+        height: int = 200,
+    ):
+        """Initialize SavingsChart.
+
+        Args:
+            parent: Parent Tkinter widget (any widget subclass).
+            width: Canvas width.
+            height: Canvas height.
+        """
+        super().__init__(
+            parent,
+            width=width,
+            height=height,
+            bg="white",
+            highlightthickness=1,
+            highlightbackground="#ccc",
+        )
+        self.width = width
+        self.height = height
+        self.padding = {
+            "left": 60,
+            "right": 20,
+            "top": 20,
+            "bottom": 40,
+        }
+
+    def plot(
+        self,
+        data: list[tuple[int, float, float]],
+        breakeven: int | None,
+    ) -> None:
+        """Plot cumulative savings tuples and optional breakeven marker.
+
+        Args:
+            data: List of (month, nominal savings, NPV savings) tuples.
+            breakeven: Optional breakeven month to mark on the chart.
+        """
+        self.delete("all")
+        min_number_of_data_points = 2
+        if len(data) < min_number_of_data_points:
+            return
+
+        months = [d[0] for d in data]
+        nominal = [d[1] for d in data]
+        npv = [d[2] for d in data]
+
+        all_values = nominal + npv
+        y_min, y_max = min(all_values), max(all_values)
+        if y_min == y_max:
+            expansion = abs(y_max) or 1.0
+            y_min -= expansion / 2
+            y_max += expansion / 2
+        y_range = y_max - y_min
+        if y_range == 0:
+            y_range = 1.0
+
+        plot_w = self.width - self.padding["left"] - self.padding["right"]
+        plot_h = self.height - self.padding["top"] - self.padding["bottom"]
+
+        max_month = max(months)
+        if max_month == 0:
+            max_month = 1
+
+        def to_canvas(month: int, value: float) -> tuple[float, float]:
+            x = self.padding["left"] + (month / max_month) * plot_w
+            y = self.padding["top"] + (1 - (value - y_min) / y_range) * plot_h
+            return x, y
+
+        if y_min < 0 < y_max:
+            self._draw_zero_reference(to_canvas)
+
+        if breakeven and breakeven <= max_month:
+            self._draw_breakeven_line(breakeven, to_canvas)
+
+        nominal_points = self._canvas_points(months, nominal, to_canvas)
+        npv_points = self._canvas_points(months, npv, to_canvas)
+
+        self._render_series(nominal_points, "#2563eb")
+        self._render_series(npv_points, "#16a34a")
+
+        left = self.padding["left"]
+        right = self.width - self.padding["right"]
+        bottom = self.height - self.padding["bottom"]
+
+        self._draw_axis_lines(left, bottom, right)
+        self._draw_month_ticks(left, bottom, plot_w, max_month)
+        self._draw_value_ticks(left, plot_h, bottom, y_min, y_max, y_range)
+        self._draw_range_labels(left, bottom, y_min, y_max)
+        self._draw_legend()
+
+    def _draw_zero_reference(
+        self,
+        to_canvas: Callable[[int, float], tuple[float, float]],
+    ) -> None:
+        _, zero_y = to_canvas(0, 0)
+        self.create_line(
+            self.padding["left"],
+            zero_y,
+            self.width - self.padding["right"],
+            zero_y,
+            fill="#ccc",
+            dash=(4, 2),
+        )
+        self.create_text(
+            self.padding["left"] + 4,
+            zero_y - 5,
+            text="0 cumulative savings",
+            anchor=tk.SW,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+
+    def _draw_breakeven_line(
+        self,
+        breakeven: int,
+        to_canvas: Callable[[int, float], tuple[float, float]],
+    ) -> None:
+        be_x, _ = to_canvas(breakeven, 0)
+        self.create_line(
+            be_x,
+            self.padding["top"],
+            be_x,
+            self.height - self.padding["bottom"],
+            fill="#888",
+            dash=(2, 2),
+        )
+        self.create_text(
+            be_x,
+            self.padding["top"] - 5,
+            text=f"BE: {breakeven}mo",
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+
+    def _canvas_points(
+        self,
+        months: list[int],
+        values: list[float],
+        to_canvas: Callable[[int, float], tuple[float, float]],
+    ) -> list[tuple[float, float]]:
+        return [to_canvas(month, value) for month, value in zip(months, values)]
+
+    def _render_series(self, points: list[tuple[float, float]], color: str) -> None:
+        if len(points) > 1:
+            self.create_line(
+                *[coord for point in points for coord in point],
+                fill=color,
+                width=2,
+                smooth=True,
+            )
+
+    def _draw_axis_lines(self, left: float, bottom: float, right: float) -> None:
+        self.create_line(
+            left,
+            self.padding["top"],
+            left,
+            bottom,
+            fill="#333",
+        )
+        self.create_line(
+            left,
+            bottom,
+            right,
+            bottom,
+            fill="#333",
+        )
+
+    def _draw_month_ticks(
+        self,
+        left: float,
+        bottom: float,
+        plot_width: float,
+        max_month: int,
+    ) -> None:
+        for month in build_month_ticks(max_month):
+            x = left + (month / max_month) * plot_width
+            self.create_line(x, bottom, x, bottom + 5, fill="#999")
+            self.create_text(
+                x,
+                bottom + 12,
+                text=f"{month} mo",
+                anchor=tk.N,
+                font=("Segoe UI", 7),
+                fill="#666",
+            )
+
+    def _draw_value_ticks(
+        self,
+        left: float,
+        plot_height: float,
+        bottom: float,
+        y_min: float,
+        y_max: float,
+        y_range: float,
+    ) -> None:
+        top = self.padding["top"]
+        for value in build_linear_ticks(y_min, y_max):
+            y = top + (1 - (value - y_min) / y_range) * plot_height
+            self.create_line(left - 5, y, left, y, fill="#999")
+            self.create_text(
+                left - 8,
+                y,
+                text=f"${value / 1000:.0f}k",
+                anchor=tk.E,
+                font=("Segoe UI", 7),
+                fill="#666",
+            )
+
+    def _draw_range_labels(self, left: float, bottom: float, y_min: float, y_max: float) -> None:
+        self.create_text(
+            self.width // 2,
+            self.height - 8,
+            text="Months",
+            font=("Segoe UI", 8),
+            fill="#666",
+        )
+        self.create_text(
+            left - 5,
+            self.padding["top"],
+            text=f"${y_max / 1000:.0f}k",
+            anchor=tk.E,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+        self.create_text(
+            left - 5,
+            bottom,
+            text=f"${y_min / 1000:.0f}k",
+            anchor=tk.E,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+
+    def _draw_legend(self) -> None:
+        legend_x = self.width - self.padding["right"] - 90
+        self.create_line(legend_x, 14, legend_x + 24, 14, fill="#2563eb", width=2)
+        self.create_text(
+            legend_x + 28,
+            14,
+            text="Nominal",
+            anchor=tk.W,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+        self.create_line(legend_x, 26, legend_x + 24, 26, fill="#16a34a", width=2)
+        self.create_text(
+            legend_x + 28,
+            26,
+            text="NPV",
+            anchor=tk.W,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+
+
+class AmortizationChart(tk.Canvas):
+    """Chart showing remaining balances for current and new loans.
+
+    Attributes:
+        width: Canvas width.
+        height: Canvas height.
+        padding: Plot padding.
+    """
+
+    width: int
+    height: int
+    padding: dict[str, int]
+
+    def __init__(
+        self,
+        parent: tk.Misc,
+        width: int = 400,
+        height: int = 220,
+    ):
+        """Initialize AmortizationChart.
+
+        Args:
+            parent: Parent Tkinter widget (any widget subclass).
+            width: Canvas width.
+            height: Canvas height.
+        """
+        super().__init__(
+            parent,
+            width=width,
+            height=height,
+            bg="white",
+            highlightthickness=1,
+            highlightbackground="#ccc",
+        )
+        self.width = width
+        self.height = height
+        self.padding = {
+            "left": 60,
+            "right": 20,
+            "top": 30,
+            "bottom": 40,
+        }
+
+    def plot(
+        self,
+        current_schedule: list[dict],
+        new_schedule: list[dict],
+    ) -> None:
+        """Plot remaining balances for both loans.
+
+        Args:
+            current_schedule: Monthly data for the current loan.
+            new_schedule: Monthly data for the new loan.
+        """
+        self.delete("all")
+        if not current_schedule or not new_schedule:
+            return
+
+        current_months = [row["month"] for row in current_schedule]
+        current_balances = [row["balance"] for row in current_schedule]
+        new_months = [row["month"] for row in new_schedule]
+        new_balances = [row["balance"] for row in new_schedule]
+
+        max_month = max(current_months[-1], new_months[-1])
+        if max_month == 0:
+            max_month = 1
+
+        all_balances = [0.0]
+        all_balances.extend(current_balances)
+        all_balances.extend(new_balances)
+        max_balance = max(all_balances)
+        y_min = 0.0
+        y_max = max_balance if max_balance > 0 else 1.0
+        y_range = y_max - y_min if y_max != y_min else 1.0
+
+        plot_w = self.width - self.padding["left"] - self.padding["right"]
+        plot_h = self.height - self.padding["top"] - self.padding["bottom"]
+
+        def to_canvas(month: int, balance: float) -> tuple[float, float]:
+            x = self.padding["left"] + (month / max_month) * plot_w
+            y = self.padding["top"] + (1 - (balance - y_min) / y_range) * plot_h
+            return x, y
+
+        current_points = [to_canvas(m, b) for m, b in zip(current_months, current_balances)]
+        new_points = [to_canvas(m, b) for m, b in zip(new_months, new_balances)]
+
+        if len(current_points) > 1:
+            self.create_line(
+                *[value for point in current_points for value in point],
+                fill="#dc2626",
+                width=2,
+                smooth=True,
+            )
+        if len(new_points) > 1:
+            self.create_line(
+                *[value for point in new_points for value in point],
+                fill="#2563eb",
+                width=2,
+                smooth=True,
+            )
+
+        left = self.padding["left"]
+        bottom = self.height - self.padding["bottom"]
+        right = self.width - self.padding["right"]
+
+        self.create_line(left, self.padding["top"], left, bottom, fill="#333")
+        self.create_line(left, bottom, right, bottom, fill="#333")
+
+        for month in build_month_ticks(max_month):
+            x = left + (month / max_month) * plot_w
+            self.create_line(x, bottom, x, bottom + 5, fill="#999")
+            self.create_text(
+                x,
+                bottom + 12,
+                text=f"{month} mo",
+                anchor=tk.N,
+                font=("Segoe UI", 7),
+                fill="#666",
+            )
+
+        for value in build_linear_ticks(y_min, y_max):
+            y = self.padding["top"] + (1 - (value - y_min) / y_range) * plot_h
+            self.create_line(left - 5, y, left, y, fill="#999")
+            self.create_text(
+                left - 8,
+                y,
+                text=f"${value / 1000:.0f}k",
+                anchor=tk.E,
+                font=("Segoe UI", 7),
+                fill="#666",
+            )
+
+        self.create_text(
+            self.padding["left"],
+            self.padding["top"] - 6,
+            text="Remaining Balance",
+            anchor=tk.SW,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+        self.create_text(
+            self.width // 2,
+            self.height - 8,
+            text="Months",
+            font=("Segoe UI", 8),
+            fill="#666",
+        )
+
+        legend_x = self.width - self.padding["right"] - 90
+        self.create_line(legend_x, 14, legend_x + 24, 14, fill="#dc2626", width=2)
+        self.create_text(
+            legend_x + 28,
+            14,
+            text="Current",
+            anchor=tk.W,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+        self.create_line(legend_x, 26, legend_x + 24, 26, fill="#2563eb", width=2)
+        self.create_text(
+            legend_x + 28,
+            26,
+            text="New",
+            anchor=tk.W,
+            font=("Segoe UI", 7),
+            fill="#666",
+        )
+
+
+__all__ = [
+    "AmortizationChart",
+    "SavingsChart",
+]
+
+__description__ = """
+Canvas helpers for cumulative savings and amortization comparison visuals.
+"""