Projects: classes as entities, and the sidebar fits short windows
check / check (push) Canceled after 0s

A project is a class with facts (description, status, kind, party,
dates, links, notes) in one project.set event behind the format
feature projects. Four tools (books.add_project, update_project,
projects, project); documents and decisions link to projects; B-37:
on-spec costs are expensed as incurred, repayment is revenue, and the
unrecovered cost is never below zero (Kani). Viewer: a Projects list
and a project page with its figures, by month and by account. The
sidebar measures its footer instead of reserving a fixed 172 px.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01T3gXMVt7XJPi6ens1or9Dj
This commit is contained in:
swaitsandClaude Opus 5.5 committed 2026-10-22 03:50:52 -06:00
1 parent 0495726001
commit 321b94562a
71 files changed
+7446 -217

No files matched your search

+9
View File
@@ -59,6 +59,7 @@ pub const KNOWN_FEATURES: &[&str] = &[
TAX_CATEGORIES_GAIN_EXEMPT,
DISPOSAL_BEFORE_SERVICE,
DEPRECIATION_CATCH_UP,
PROJECTS,
];
/// Feature: `period.closed` closes to members with `"rounding":
@@ -147,6 +148,13 @@ pub const SCHEDULE_CONVENTION: &str = "schedule_convention";
/// with the value at contribution and the §704(c) method (P3, defect 13).
pub const ASSET_BASIS: &str = "asset_basis";
/// Feature: projects (rules.md B-37): `project.set`, a new event type (a
/// class's project facts); `attachment.linked` to the subject kind
/// `project` (an older version would call it corrupt); and
/// `decision.recorded` with `projects` (an older version would drop them
/// silently).
pub const PROJECTS: &str = "projects";
/// The line type that declares the journal format.
pub const FORMAT_SET: &str = "journal.format_set";
@@ -209,6 +217,7 @@ pub const EVENT_TYPES: &[&str] = &[
"payroll.taxes_remitted",
"period.closed",
"period.created",
"project.set",
"receipt.attached",
"receipt.linked",
"receipt.unlinked",
+87 -1
View File
@@ -17,6 +17,7 @@ use crate::error::StoreError;
use chrono::NaiveDate;
use ledger_core::conventions::{Approval, ConventionKind, NewConvention, NewDecision, NewOpenItem};
use ledger_core::settings::{Change, Source};
use ledger_core::{ClassId, ProjectFacts, ProjectKind, ProjectStatus};
use serde_json::{Map, Value, json};
/// The journal format these events need: an older reader stops at the
@@ -170,7 +171,9 @@ pub fn convention_retired_of(p: &Value) -> Result<(String, String, Source), Stor
}
/// `decision.recorded {id, subject, decision_md, decided_by, decided_on,
/// evidence_attachment?, supersedes?, citation?}`.
/// evidence_attachment?, supersedes?, citation?, projects?}`: `projects`
/// only when it names any (journal feature `projects`), so a decision
/// without them writes the bytes it always did.
pub fn decision_recorded(id: u64, d: &NewDecision) -> Value {
let mut o = Map::new();
o.insert("id".into(), json!(id));
@@ -181,6 +184,9 @@ pub fn decision_recorded(id: u64, d: &NewDecision) -> Value {
put(&mut o, "evidence_attachment", d.evidence_attachment);
put(&mut o, "supersedes", d.supersedes);
put(&mut o, "citation", d.citation.clone());
if !d.projects.is_empty() {
o.insert("projects".into(), json!(d.projects));
}
Value::Object(o)
}
@@ -196,6 +202,17 @@ pub fn decision_recorded_of(p: &Value) -> Result<(u64, NewDecision), StoreError>
.collect::<Option<Vec<_>>>()
})
.ok_or_else(|| corrupt(E, "decided_by"))?;
let projects = match p.get("projects") {
None | Some(Value::Null) => vec![],
Some(v) => v
.as_array()
.and_then(|a| {
a.iter()
.map(|x| x.as_u64().and_then(|n| ClassId::try_from(n).ok()))
.collect::<Option<Vec<_>>>()
})
.ok_or_else(|| corrupt(E, "projects"))?,
};
Ok((
u64_of(p, E, "id")?,
NewDecision {
@@ -206,6 +223,74 @@ pub fn decision_recorded_of(p: &Value) -> Result<(u64, NewDecision), StoreError>
evidence_attachment: opt_u64(p, E, "evidence_attachment")?,
supersedes: opt_u64(p, E, "supersedes")?,
citation: opt_str(p, E, "citation")?,
projects,
},
))
}
/// `project.set {id, name, status, kind?, description?, party_id?,
/// started_on?, ended_on?, links?, notes?}`: a class's whole project
/// record (rules.md B-37; journal feature `projects`). Every optional key
/// is left out when empty, so the payload is canonical.
pub fn project_set(id: ClassId, name: &str, f: &ProjectFacts) -> Value {
let mut o = Map::new();
o.insert("id".into(), json!(id));
o.insert("name".into(), json!(name));
o.insert("status".into(), json!(f.status.key()));
put(&mut o, "kind", f.kind.map(ProjectKind::key));
put(&mut o, "description", f.description.clone());
put(&mut o, "party_id", f.party);
put(&mut o, "started_on", f.started_on.map(|d| d.to_string()));
put(&mut o, "ended_on", f.ended_on.map(|d| d.to_string()));
if !f.links.is_empty() {
o.insert("links".into(), json!(f.links));
}
put(&mut o, "notes", f.notes.clone());
Value::Object(o)
}
/// Read a `project.set`: `(id, name, facts)`. A missing or mistyped key is
/// corrupt; a status or kind this version doesn't know is newer (a newer
/// version wrote it, rules.md B-27).
pub fn project_set_of(
line: &crate::journal::JournalLine,
) -> Result<(ClassId, String, ProjectFacts), StoreError> {
const E: &str = "project.set";
let p = &line.payload;
let id = ClassId::try_from(u64_of(p, E, "id")?).map_err(|_| corrupt(E, "id"))?;
let name = str_of(p, E, "name")?;
let key = str_of(p, E, "status")?;
let status = ProjectStatus::parse(&key)
.ok_or_else(|| crate::format::newer_content(line, format!("the project status {key:?}")))?;
let kind = match opt_str(p, E, "kind")? {
None => None,
Some(k) => Some(ProjectKind::parse(&k).ok_or_else(|| {
crate::format::newer_content(line, format!("the project kind {k:?}"))
})?),
};
let links = match p.get("links") {
None | Some(Value::Null) => vec![],
Some(v) => v
.as_array()
.and_then(|a| {
a.iter()
.map(|x| x.as_str().map(str::to_string))
.collect::<Option<Vec<_>>>()
})
.ok_or_else(|| corrupt(E, "links"))?,
};
Ok((
id,
name,
ProjectFacts {
description: opt_str(p, E, "description")?,
status,
kind,
party: opt_u64(p, E, "party_id")?,
started_on: opt_date(p, E, "started_on")?,
ended_on: opt_date(p, E, "ended_on")?,
links,
notes: opt_str(p, E, "notes")?,
},
))
}
@@ -328,6 +413,7 @@ mod tests {
evidence_attachment: Some(7),
supersedes: None,
citation: None,
projects: vec![],
};
assert_eq!(
decision_recorded_of(&decision_recorded(3, &d)).unwrap(),
+7 -1
View File
@@ -63,7 +63,7 @@ pub fn report_columns(
#[serde(tag = "show", rename_all = "snake_case")]
pub enum ViewerTarget {
/// A top-level page: overview, cash, profit, transactions, reports,
/// accounts, assets, parties, documents, company, journal.
/// accounts, assets, parties, projects, documents, company, journal.
Page {
/// Page name.
page: String,
@@ -120,6 +120,12 @@ pub enum ViewerTarget {
/// Party id.
party_id: u64,
},
/// One project (a class with its facts): its figures, entries,
/// documents and decisions.
Project {
/// Class id.
class_id: u32,
},
/// One reconciliation: its account, with the account's statements and
/// reconciliations.
Reconciliation {
+127 -10
View File
@@ -950,6 +950,9 @@ impl Store {
return Err(StoreError::AttachmentWithdrawn(a));
}
self.ensure_format()?;
if !d.projects.is_empty() {
self.ensure_feature(crate::format::PROJECTS)?;
}
let line =
self.append_journal("decision.recorded", crate::meta::decision_recorded(id, &d))?;
self.ledger.apply_decision(id, d, line.seq)?;
@@ -3365,15 +3368,19 @@ impl Store {
// Classes
// ------------------------------------------------------------------
/// Add a class (division) for line-level P&L tracking. Journaled as
/// `class.added`.
/// Add a class (division) for line-level P&L tracking: a project with
/// only its name. Journaled as `class.added`.
pub fn add_class(&mut self, name: &str) -> Result<ClassId, StoreError> {
// Rehearsed on a copy: the name rules (blank, length, a name
// another class has) refuse here, so the journal write can't be
// followed by a failed mutation.
self.rehearse(|l| l.add_class(name))?;
// The engine's only failure mode is an empty name; replicate it so
// the journal write cannot be followed by a failed mutation.
if name.trim().is_empty() {
return Err(LedgerError::EmptyClassName.into());
}
self.append_class(name)
}
/// `class.added` for a name already rehearsed.
fn append_class(&mut self, name: &str) -> Result<ClassId, StoreError> {
let name = name.trim();
let id = self.ledger.next_class_id();
let line = self.append_journal("class.added", json!({ "id": id, "name": name }))?;
let live = self.ledger.add_class(name)?;
@@ -3382,6 +3389,83 @@ impl Store {
Ok(live)
}
/// Add a project (rules.md B-37): `class.added`, then `project.set`
/// when `facts` say more than the defaults. Returns its id.
///
/// ```text
/// GOAL: a project in one command, journaled as two events only when
/// it has facts, so a name-only project is a plain class.
/// SOURCE: docs/spec/rules.md B-37 item 1; B-27 (journal feature
/// `projects`).
/// INVARIANTS:
/// 1. A refusal journals nothing: the whole record is rehearsed, and
/// the feature asked for, before the first line.
/// 2. Facts equal to the defaults journal `class.added` alone (books
/// waiting for their format upgrade can still add one).
/// ```
pub fn add_project(
&mut self,
name: &str,
facts: &ledger_core::ProjectFacts,
) -> Result<ClassId, StoreError> {
self.rehearse(|l| {
let id = l.add_class(name)?;
if !facts.is_default() {
l.set_project(id, name, facts.clone())?;
}
Ok(())
})?;
let with_facts = !facts.is_default();
if with_facts {
self.ensure_feature(crate::format::PROJECTS)?;
}
let id = self.append_class(name)?;
if with_facts {
let (name, facts) = self.ledger.check_set_project(id, name, facts)?;
self.append_project(id, name, facts)?;
}
Ok(id)
}
/// Set a project's whole record (`project.set`): its name and facts.
/// Unchanged (the same name and facts once checked): journals nothing
/// and returns false.
pub fn set_project(
&mut self,
id: ClassId,
name: &str,
facts: &ledger_core::ProjectFacts,
) -> Result<bool, StoreError> {
let (name, facts) = self.ledger.check_set_project(id, name, facts)?;
let same_name = self.ledger.get_class(id).is_some_and(|c| c.name == name);
if same_name && self.ledger.project_facts(id).as_ref() == Some(&facts) {
return Ok(false);
}
self.ensure_feature(crate::format::PROJECTS)?;
self.append_project(id, name, facts)?;
Ok(true)
}
/// `project.set` for a record already checked.
fn append_project(
&mut self,
id: ClassId,
name: String,
facts: ledger_core::ProjectFacts,
) -> Result<(), StoreError> {
let line =
self.append_journal("project.set", crate::meta::project_set(id, &name, &facts))?;
self.ledger.set_project(id, &name, facts)?;
apply_line_to_sqlite(&self.conn, &line)?;
Ok(())
}
/// A class's project facts (the defaults for a class with none);
/// `None` for no such class.
pub fn project_facts(&self, id: ClassId) -> Option<ledger_core::ProjectFacts> {
self.ledger.project_facts(id)
}
/// All classes, in id order.
pub fn list_classes(&self) -> Vec<Class> {
self.ledger.list_classes().into_iter().cloned().collect()
@@ -4157,6 +4241,17 @@ impl Store {
// Attachment links, statements, reconciliations
// ------------------------------------------------------------------
/// The journal feature a link to `subject` needs, if any: a subject
/// kind an older version doesn't know (a project, rules.md B-37).
/// Callers filing a file with links ask it before filing, so a refusal
/// leaves nothing half-filed.
pub fn subject_feature(subject: Subject) -> Option<&'static str> {
match subject {
Subject::Project(_) => Some(crate::format::PROJECTS),
_ => None,
}
}
/// Whether `subject` exists in the books (what [`Store::link_attachment`]
/// checks, so callers can validate several subjects before linking any).
pub fn subject_exists(&self, subject: Subject) -> Result<bool, StoreError> {
@@ -4166,6 +4261,7 @@ impl Store {
Subject::Account(i) => l.chart().get(i).is_some(),
Subject::Asset(i) => l.get_asset(i).is_some(),
Subject::Party(i) => l.get_party(i).is_some(),
Subject::Project(i) => u32::try_from(i).ok().and_then(|c| l.get_class(c)).is_some(),
Subject::Invoice(i) => l.get_invoice(i).is_some(),
Subject::Bill(i) => l.get_bill(i).is_some(),
Subject::Period(i) => l.list_periods().iter().any(|p| p.id == i),
@@ -4227,8 +4323,8 @@ impl Store {
}
/// Link a stored attachment to a subject: another entry, an account, an
/// asset, a party, an invoice, a bill, a period, a payroll run, a
/// schedule, a reconciliation, or the company.
/// asset, a party, a project, an invoice, a bill, a period, a payroll
/// run, a schedule, a reconciliation, or the company.
///
/// ```text
/// GOAL: one file, linked wherever it's evidence, without refiling.
@@ -4262,6 +4358,9 @@ impl Store {
{
return Err(StoreError::AlreadyLinked(attachment_id, subject.describe()));
}
if let Some(f) = Self::subject_feature(subject) {
self.ensure_feature(f)?;
}
let line = self.append_journal(
"attachment.linked",
json!({"attachment_id": attachment_id, "subject": subject}),
@@ -6105,6 +6204,10 @@ fn replay_line(
"class.added" => {
ledger.replay_class(get_u64(p, "id")? as u32, get_str(p, "name")?.to_string())?;
}
"project.set" => {
let (id, name, facts) = crate::meta::project_set_of(line)?;
ledger.replay_set_project(id, name, facts)?;
}
"entry.line_class_set" => {
// Journaled while the entry was a draft, so at replay time the
// draft exists and takes the class. Missing/null class_id
@@ -7140,6 +7243,14 @@ fn apply_line_rows(conn: &Connection, line: &JournalLine) -> Result<(), StoreErr
params![get_u64(p, "id")? as i64, get_str(p, "name")?],
)?;
}
"project.set" => {
// Facts live in the ledger (as parties'); the projection keeps
// the name, so verify's class check stays exact after a rename.
conn.execute(
"UPDATE classes SET name = ? WHERE id = ?",
params![get_str(p, "name")?, get_u64(p, "id")? as i64],
)?;
}
"entry.line_class_set" => {
// Journaled while the entry is a draft, so the projection
// usually has no lines row yet (drafts never touch the
@@ -7440,6 +7551,9 @@ pub enum Subject {
Schedule(u64),
/// A reconciliation (its statement).
Reconciliation(u64),
/// A project (its contract, spec, pitch, correspondence; rules.md
/// B-37). Journal feature `projects`.
Project(u64),
/// The company itself (formation documents).
Company,
}
@@ -7458,6 +7572,7 @@ impl Subject {
Subject::PayrollRun(_) => "payroll_run",
Subject::Schedule(_) => "schedule",
Subject::Reconciliation(_) => "reconciliation",
Subject::Project(_) => "project",
Subject::Company => "company",
}
}
@@ -7474,7 +7589,8 @@ impl Subject {
| Subject::Period(i)
| Subject::PayrollRun(i)
| Subject::Schedule(i)
| Subject::Reconciliation(i) => i,
| Subject::Reconciliation(i)
| Subject::Project(i) => i,
Subject::Company => 0,
}
}
@@ -7492,6 +7608,7 @@ impl Subject {
"payroll_run" => Subject::PayrollRun(id),
"schedule" => Subject::Schedule(id),
"reconciliation" => Subject::Reconciliation(id),
"project" => Subject::Project(id),
"company" => Subject::Company,
_ => return None,
})