envelope-cli 0.2.6

Terminal-based zero-based budgeting application
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
//! Budget CLI commands
//!
//! Implements CLI commands for budget management including period navigation,
//! allocation, and overview.

use clap::Subcommand;

use crate::config::settings::Settings;
use crate::error::EnvelopeResult;
use crate::services::{BudgetService, CategoryService, PeriodService};
use crate::storage::Storage;

/// Budget subcommands
#[derive(Subcommand)]
pub enum BudgetCommands {
    /// Show budget overview for a period
    Overview {
        /// Budget period (e.g., "2025-01", "January", "current", "last")
        #[arg(short, long)]
        period: Option<String>,
    },

    /// Show information about the current period
    Period {
        /// Budget period (e.g., "2025-01", "January", "current", "last")
        period: Option<String>,
    },

    /// List recent budget periods
    Periods {
        /// Number of periods to show
        #[arg(short, long, default_value = "6")]
        count: usize,
    },

    /// Go to the previous period
    Prev,

    /// Go to the next period
    Next,

    // These will be implemented in Step 9:
    /// Assign funds to a category
    Assign {
        /// Category name
        category: String,
        /// Amount (e.g., "100" or "100.00")
        amount: String,
        /// Budget period
        #[arg(short, long)]
        period: Option<String>,
    },

    /// Move funds between categories
    Move {
        /// Source category
        from: String,
        /// Destination category
        to: String,
        /// Amount
        amount: String,
        /// Budget period
        #[arg(short, long)]
        period: Option<String>,
    },

    /// Apply rollover from previous period
    Rollover {
        /// Budget period to apply rollover to (defaults to current)
        #[arg(short, long)]
        period: Option<String>,
    },

    /// Show overspent categories
    Overspent {
        /// Budget period
        #[arg(short, long)]
        period: Option<String>,
    },
}

/// Handle a budget command
pub fn handle_budget_command(
    storage: &Storage,
    settings: &Settings,
    cmd: BudgetCommands,
) -> EnvelopeResult<()> {
    let period_service = PeriodService::new(settings);

    match cmd {
        BudgetCommands::Overview { period } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let friendly = period_service.format_period_friendly(&period);

            println!("Budget Overview: {}", friendly);
            println!("{}", "=".repeat(72));

            // Get categories with groups
            let category_service = CategoryService::new(storage);
            let groups = category_service.list_groups_with_categories()?;

            // Get budget service for summaries
            let budget_service = BudgetService::new(storage);

            // Calculate totals
            let mut total_budgeted = crate::models::Money::zero();
            let mut total_carryover = crate::models::Money::zero();
            let mut total_activity = crate::models::Money::zero();
            let mut total_available = crate::models::Money::zero();
            let mut has_any_carryover = false;

            // First pass: check if any categories have carryover
            for gwc in &groups {
                for category in &gwc.categories {
                    let summary = budget_service.get_category_summary(category.id, &period)?;
                    if !summary.carryover.is_zero() {
                        has_any_carryover = true;
                        break;
                    }
                }
                if has_any_carryover {
                    break;
                }
            }

            for gwc in &groups {
                if gwc.categories.is_empty() {
                    continue;
                }

                println!("\n{}", gwc.group.name);
                if has_any_carryover {
                    println!(
                        "{:26} {:>10} {:>10} {:>10} {:>10}",
                        "", "Budgeted", "Carryover", "Activity", "Available"
                    );
                } else {
                    println!(
                        "{:30} {:>10} {:>10} {:>10}",
                        "", "Budgeted", "Activity", "Available"
                    );
                }
                println!("{}", "-".repeat(72));

                for category in &gwc.categories {
                    let summary = budget_service.get_category_summary(category.id, &period)?;

                    total_budgeted += summary.budgeted;
                    total_carryover += summary.carryover;
                    total_activity += summary.activity;
                    total_available += summary.available;

                    let status = if summary.is_overspent() {
                        ""
                    } else if let Some(goal) = category.goal_amount {
                        let goal_money = crate::models::Money::from_cents(goal);
                        if summary.budgeted >= goal_money {
                            ""
                        } else {
                            ""
                        }
                    } else {
                        ""
                    };

                    if has_any_carryover {
                        println!(
                            "  {:24} {:>10} {:>10} {:>10} {:>10} {}",
                            category.name,
                            summary.budgeted,
                            summary.carryover,
                            summary.activity,
                            summary.available,
                            status
                        );
                    } else {
                        println!(
                            "  {:28} {:>10} {:>10} {:>10} {}",
                            category.name,
                            summary.budgeted,
                            summary.activity,
                            summary.available,
                            status
                        );
                    }
                }
            }

            println!("\n{}", "=".repeat(72));
            if has_any_carryover {
                println!(
                    "{:26} {:>10} {:>10} {:>10} {:>10}",
                    "TOTALS:", total_budgeted, total_carryover, total_activity, total_available
                );
            } else {
                println!(
                    "{:30} {:>10} {:>10} {:>10}",
                    "TOTALS:", total_budgeted, total_activity, total_available
                );
            }

            // Show available to budget
            let available_to_budget = budget_service.get_available_to_budget(&period)?;
            println!(
                "\n{:30} {:>10}",
                "Available to Budget:", available_to_budget
            );

            if available_to_budget.is_negative() {
                println!(
                    "\n⚠️  Warning: Overbudgeted by {}",
                    available_to_budget.abs()
                );
            } else if available_to_budget.is_positive() {
                println!(
                    "\n📌 Tip: You have {} ready to assign!",
                    available_to_budget
                );
            } else {
                println!("\n✅ Budget is balanced!");
            }

            // Show warning about overspent categories
            let overspent = budget_service.get_overspent_categories(&period)?;
            if !overspent.is_empty() {
                println!(
                    "\n⚠️  {} category/categories overspent. Run 'envelope budget overspent' for details.",
                    overspent.len()
                );
            }
        }

        BudgetCommands::Period { period } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let friendly = period_service.format_period_friendly(&period);
            let is_current = period_service.is_current(&period);

            println!("Budget Period: {}", friendly);
            println!("  Format: {}", period);
            println!("  Start:  {}", period.start_date());
            println!("  End:    {}", period.end_date());
            if is_current {
                println!("  Status: Current period");
            }
        }

        BudgetCommands::Periods { count } => {
            println!("Recent Budget Periods:");
            println!();

            let periods = period_service.recent_periods(count);
            for period in periods {
                let friendly = period_service.format_period_friendly(&period);
                let marker = if period_service.is_current(&period) {
                    " <- current"
                } else {
                    ""
                };
                println!("  {} ({}){}", friendly, period, marker);
            }
        }

        BudgetCommands::Prev => {
            let current = period_service.current_period();
            let prev = period_service.previous_period(&current);
            let friendly = period_service.format_period_friendly(&prev);
            println!("Previous period: {} ({})", friendly, prev);
        }

        BudgetCommands::Next => {
            let current = period_service.current_period();
            let next = period_service.next_period(&current);
            let friendly = period_service.format_period_friendly(&next);
            println!("Next period: {} ({})", friendly, next);
        }

        BudgetCommands::Assign {
            category,
            amount,
            period,
        } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let amount = crate::models::Money::parse(&amount).map_err(|e| {
                crate::error::EnvelopeError::Validation(format!("Invalid amount: {}", e))
            })?;

            let category_service = CategoryService::new(storage);
            let cat = category_service
                .find_category(&category)?
                .ok_or_else(|| crate::error::EnvelopeError::category_not_found(&category))?;

            let budget_service = BudgetService::new(storage);
            let allocation = budget_service.assign_to_category(cat.id, &period, amount)?;

            println!(
                "Assigned {} to '{}' for {}",
                allocation.budgeted,
                cat.name,
                period_service.format_period_friendly(&period)
            );

            // Show updated Available to Budget
            let atb = budget_service.get_available_to_budget(&period)?;
            if atb.is_negative() {
                println!("Warning: Overbudgeted! Available to Budget: {}", atb);
            } else {
                println!("Available to Budget: {}", atb);
            }
        }

        BudgetCommands::Move {
            from,
            to,
            amount,
            period,
        } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let amount = crate::models::Money::parse(&amount).map_err(|e| {
                crate::error::EnvelopeError::Validation(format!("Invalid amount: {}", e))
            })?;

            let category_service = CategoryService::new(storage);
            let from_cat = category_service
                .find_category(&from)?
                .ok_or_else(|| crate::error::EnvelopeError::category_not_found(&from))?;
            let to_cat = category_service
                .find_category(&to)?
                .ok_or_else(|| crate::error::EnvelopeError::category_not_found(&to))?;

            let budget_service = BudgetService::new(storage);
            budget_service.move_between_categories(from_cat.id, to_cat.id, &period, amount)?;

            println!(
                "Moved {} from '{}' to '{}' for {}",
                amount,
                from_cat.name,
                to_cat.name,
                period_service.format_period_friendly(&period)
            );
        }

        BudgetCommands::Rollover { period } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let friendly = period_service.format_period_friendly(&period);
            let prev_period = period.prev();
            let prev_friendly = period_service.format_period_friendly(&prev_period);

            println!(
                "Applying rollover from {} to {}...",
                prev_friendly, friendly
            );
            println!();

            let budget_service = BudgetService::new(storage);
            let category_service = CategoryService::new(storage);
            let allocations = budget_service.apply_rollover_all(&period)?;

            let mut positive_count = 0;
            let mut negative_count = 0;
            let mut total_carryover = crate::models::Money::zero();

            for alloc in &allocations {
                if !alloc.carryover.is_zero() {
                    let cat = category_service.get_category(alloc.category_id)?;
                    let cat_name = cat.map(|c| c.name).unwrap_or_else(|| "Unknown".to_string());

                    if alloc.carryover.is_positive() {
                        println!("  {} +{} (surplus)", cat_name, alloc.carryover);
                        positive_count += 1;
                    } else {
                        println!("  {} {} (deficit)", cat_name, alloc.carryover);
                        negative_count += 1;
                    }
                    total_carryover += alloc.carryover;
                }
            }

            println!();
            if positive_count == 0 && negative_count == 0 {
                println!("No carryover to apply (all categories had zero balance).");
            } else {
                println!(
                    "Applied rollover to {} categories ({} surplus, {} deficit)",
                    positive_count + negative_count,
                    positive_count,
                    negative_count
                );
                println!("Net carryover: {}", total_carryover);
            }
        }

        BudgetCommands::Overspent { period } => {
            let period = period_service.parse_or_current(period.as_deref())?;
            let friendly = period_service.format_period_friendly(&period);

            let budget_service = BudgetService::new(storage);
            let category_service = CategoryService::new(storage);
            let overspent = budget_service.get_overspent_categories(&period)?;

            if overspent.is_empty() {
                println!("No overspent categories for {}.", friendly);
                println!("All categories are within budget!");
            } else {
                println!("Overspent Categories for {}:", friendly);
                println!("{}", "-".repeat(50));
                println!("{:30} {:>10} {:>10}", "Category", "Available", "Overspent");
                println!("{}", "-".repeat(50));

                let mut total_overspent = crate::models::Money::zero();

                for summary in &overspent {
                    let cat = category_service.get_category(summary.category_id)?;
                    let cat_name = cat.map(|c| c.name).unwrap_or_else(|| "Unknown".to_string());
                    let overspent_amount = summary.available.abs();

                    println!(
                        "{:30} {:>10} {:>10}",
                        cat_name, summary.available, overspent_amount
                    );

                    total_overspent += overspent_amount;
                }

                println!("{}", "-".repeat(50));
                println!("{:30} {:>10} {:>10}", "TOTAL", "", total_overspent);
                println!();
                println!(
                    "⚠️  You have {} category/categories overspent by {} total.",
                    overspent.len(),
                    total_overspent
                );
                println!("Consider moving funds from other categories to cover the deficit.");
            }
        }
    }

    Ok(())
}