Files
wanderbooks/crates/ledger-gui/tests/invoices.rs
T
swaits 13282cf80e feat(arap): terms, numbers and line accounts in the core (P4b S4.1)
Documents could name only one revenue or general-expenses account per
project, had no number of their own, and took a due date the caller had
to work out. This slice gives the core the pieces the rest of S4 needs,
and journals nothing: an old-shape document still writes byte for byte,
so the owner's books need no upgrade for it.

- Payment terms (B-39): Net n, Net n EOM, due on receipt and a custom
  date, with the early-payment discount and its exact bound
  (kernel::discount_max, Kani + bridge). A due date past the calendar's
  end is refused, never a panic, and a discount is refused with terms
  that have no net days.
- Invoice numbers (B-40, A-2): first_number plus the count of numbered
  invoices, zero-padded to four digits and wider past 9,999, stored at
  issue, kept by a void; legacy invoices are uncounted.
- Line accounts (A-10): a document line may name its account, and the
  entry posts one line per (account, project) part. An invoice line takes
  revenue or a liability holding no role (deferred revenue); a bill line
  an expense or a non-cash asset holding no role. Roles, cash accounts
  and headers are refused.
- A line's amount is exactly its quantity times its unit price
  (kernel::line_amount, Kani + bridge): both or neither, never rounded.
- A vendor's invoice number names one standing bill per vendor, with
  case, spaces and hyphens ignored, unless a duplicate reason says why
  (B-40).
- The record fields S4.3 will journal: number, terms, bill-to and seller
  snapshots, customer reference, memo, the empty sends list S5 fills, and
  the bill's received_on, all optional and defaulted.

The store refuses a line carrying an account, quantity or unit price
before it rehearses or journals anything: those fields are journaled from
S4.3's documents_v2 on, and I-3 will not let a public write replay
without them. `document_line_fields_wait_for_documents_v2` proves the
refusal, the unchanged journal and allocators, and that an ordinary line
journals exactly as before. S4.3 removes this guard in the same change
that journals the fields and adds its byte-for-byte test.

The document commands keep their signatures; create_invoice_with and
create_bill_with take the optional fields for S4.3 and for tests. They
are the existing issue commands with more fields, not a new state
transition, so no Lean Step is added. Kani: line_amount_is_exact runs in
`just prove`; discount_max_is_bounded relates a product to a quotient and
runs in `prove-slow` (163 s), as the proration charge harnesses do.

just check green; just prove green.
2026-10-27 00:02:51 -06:00

211 lines
6.6 KiB
Rust

//! Invoices & Bills in the viewer (plan P4b S2): the list shows each
//! document's figures as the ledger has them (a reversed payment no
//! longer counts), overdue ones say how late, the tiles add up the open
//! ones and tie the list to its account; a document's page shows its
//! lines and its timeline; the overview shows what is owed both ways once
//! the books have documents.
use chrono::NaiveDate;
use egui_kittest::Harness;
use egui_kittest::kittest::Queryable;
use ledger_core::{AccountType, Currency, DocumentLine};
use ledger_gui::nav::Route;
use ledger_gui::{App, Source, data};
use ledger_store::Store;
use rust_decimal::Decimal;
use std::path::PathBuf;
struct TempDir(PathBuf);
impl TempDir {
fn new(tag: &str) -> TempDir {
let d =
std::env::temp_dir().join(format!("ledger-gui-invoices-{tag}-{}", std::process::id()));
let _ = std::fs::remove_dir_all(&d);
std::fs::create_dir_all(&d).unwrap();
TempDir(d)
}
}
impl Drop for TempDir {
fn drop(&mut self) {
let _ = std::fs::remove_dir_all(&self.0);
}
}
fn d(y: i32, m: u32, day: u32) -> NaiveDate {
NaiveDate::from_ymd_opt(y, m, day).unwrap()
}
fn line(description: &str, cents: i64) -> DocumentLine {
DocumentLine {
description: description.into(),
amount: Decimal::new(cents, 2),
class_id: None,
account: None,
quantity: None,
unit_price: None,
}
}
/// Today is 2026-03-15. Invoice 1 ($500, due Mar 1): $200 paid, then the
/// payment reversed, so it owes $500 and is 14 days late. Invoice 2 ($80,
/// due Apr 30): open. Invoice 3 ($40): paid in full. Bill 1 ($300, due
/// Mar 20): open.
fn books(dir: &TempDir) -> (u64, u64) {
let mut s = Store::create(&dir.0.join("books-data"), Currency::USD).unwrap();
for (code, name, t) in [
("1000", "Checking", AccountType::Asset),
("3000", "Capital", AccountType::Equity),
] {
s.add_account(code, name, t, None, false).unwrap();
}
let checking = s.ledger().chart().find_by_code("1000").unwrap().id;
let client = s.add_customer("Harbor Client").unwrap();
let late = s
.create_invoice(
client,
d(2026, 2, 1),
d(2026, 3, 1),
vec![line("Consulting", 50_000)],
)
.unwrap();
s.create_invoice(
client,
d(2026, 2, 5),
d(2026, 4, 30),
vec![line("Support", 8_000)],
)
.unwrap();
let paid = s
.create_invoice(
client,
d(2026, 2, 6),
d(2026, 3, 6),
vec![line("Setup", 4_000)],
)
.unwrap();
let pay = s
.receive_payment(late, d(2026, 2, 10), Decimal::new(20_000, 2), checking)
.unwrap();
s.reverse_entry(pay, d(2026, 2, 12), "the transfer bounced")
.unwrap();
s.receive_payment(paid, d(2026, 2, 20), Decimal::new(4_000, 2), checking)
.unwrap();
let vendor = s.add_vendor("Clay Co").unwrap();
s.create_bill(
vendor,
d(2026, 3, 2),
d(2026, 3, 20),
vec![line("Glaze", 30_000)],
)
.unwrap();
(late, pay)
}
fn open(dir: &TempDir, route: Route) -> Harness<'static, App> {
let books = data::load_once(&Source {
data_dir: dir.0.join("books-data"),
today: Some(d(2026, 3, 15)),
})
.unwrap();
let mut h = Harness::builder()
.with_size(egui::vec2(1200.0, 900.0))
.build_eframe(|cc| App::with_books(&cc.egui_ctx, books, false, route));
h.run_steps(4);
h
}
/// SHOT_DIR set: the page as drawn, to look at.
fn shot(h: &mut Harness<'static, App>, name: &str) {
if let Ok(out) = std::env::var("SHOT_DIR") {
let out = PathBuf::from(out);
std::fs::create_dir_all(&out).unwrap();
h.render()
.unwrap()
.save(out.join(format!("{name}.png")))
.unwrap();
}
}
#[test]
fn the_list_shows_the_ledgers_figures() {
let dir = TempDir::new("list");
books(&dir);
let mut h = open(&dir, Route::Receivables);
shot(&mut h, "receivables");
// Open: invoices 1 and 2 (3 is paid): $580 owed, $500 of it late.
assert!(h.query_by_label("$580.00").is_some());
assert!(h.query_by_label("$500.00").is_some());
assert!(
h.query_by_label("Invoice 1, Harbor Client, 14 days late, owes 500.00")
.is_some()
);
assert!(
h.query_by_label_contains("Invoice 2, Harbor Client, Open")
.is_some()
);
assert!(h.query_by_label_contains("Invoice 3,").is_none());
assert!(h.query_by_label_contains("with 1200").is_some());
// All shows the paid one too.
h.get_by_label("All").click();
h.run_steps(2);
assert!(
h.query_by_label_contains("Invoice 3, Harbor Client, Paid")
.is_some()
);
let mut h = open(&dir, Route::Payables);
shot(&mut h, "payables");
assert!(
h.query_by_label_contains("Bill 1, Clay Co, Open, owes 300.00")
.is_some()
);
}
#[test]
fn a_documents_page_shows_its_timeline() {
let dir = TempDir::new("doc");
let (late, pay) = books(&dir);
let mut h = open(&dir, Route::Invoice(late));
shot(&mut h, "invoice");
assert!(
h.query_by_label_contains("Payment (reversed later), entry #")
.is_some()
);
assert!(
h.query_by_label_contains("Payment reversed, entry #")
.is_some()
);
// Received: nothing stands.
assert!(h.query_by_label("$0.00").is_some());
// An invoice can be saved as PDF (a bill can't: it is the vendor's).
assert!(h.query_by_label_contains("Save invoice PDF").is_some());
// A timeline row opens its entry.
h.get_by_label_contains(&format!("Payment (reversed later), entry #{pay},"))
.click();
h.run_steps(2);
assert_eq!(h.state_mut().route(), &Route::Entry(pay));
}
#[test]
fn the_overview_shows_what_is_owed_both_ways() {
let dir = TempDir::new("overview");
books(&dir);
let mut h = open(&dir, Route::Overview);
shot(&mut h, "overview");
assert!(h.query_by_label("Owed to you").is_some());
assert!(h.query_by_label("You owe on bills").is_some());
assert!(h.query_by_label("1 invoice overdue").is_some());
}
#[test]
fn books_without_documents_show_no_overview_tiles_for_them() {
let dir = TempDir::new("none");
Store::create(&dir.0.join("books-data"), Currency::USD).unwrap();
let h = open(&dir, Route::Overview);
assert!(h.query_by_label("Owed to you").is_none());
let mut h = open(&dir, Route::Receivables);
shot(&mut h, "receivables-empty");
assert!(h.query_by_label("No invoices").is_some());
}