rustledger_core/

shift_spans_impls.rs

//! `ShiftSpans` impls for every type reachable from a `Directive`.
//!
//! The discipline introduced in round 18 lifted span shifting out of
//! the parser (monolithic `shift_directive_inner_spans` with per-
//! variant named-field destructure) and into the type system. Round
//! 19 closes the residual hole: enum-variant payloads are now bound
//! BY NAME and dispatched via `value.shift_spans(shift)` rather than
//! via a wildcard `Self::Variant(_)` arm. A future payload type
//! change (e.g., wrapping a leaf `String` payload in `Spanned<String>`)
//! routes through the wrapper's `ShiftSpans` impl automatically —
//! no edit to this file required, no silent discipline gap.
//!
//! Each type that appears anywhere inside a `Directive` payload
//! either:
//!
//! 1. **Carries no spans** — implements `ShiftSpans` as a no-op via
//!    the `impl_shift_spans_noop!` macro (for foreign leaf types
//!    like `Decimal`, `NaiveDate`) or via an explicit empty body
//!    with exhaustive structural destructure (for variant enums
//!    whose payloads currently have no spans, like `PriceKind`).
//!
//! 2. **Has structural payloads** — implements `ShiftSpans` by
//!    destructuring every field/variant BY NAME and dispatching
//!    into the binding's own impl. Compound shapes (`Vec`,
//!    `Option`, `Box`, `Spanned`, `HashMap`) are handled by blanket
//!    impls in `crate::span` and below.
//!
//! All impls live here (not next to each type) so the discipline is
//! reviewable in one place; a contributor adding a new directive-
//! payload type can use the existing impls as a template.

use crate::cost::{BookedCost, Cost, CostNumber, CostSpec};
use crate::directive::{
    Balance, Close, Commodity, Custom, Directive, Document, Event, MetaValue, Note, Open, Pad,
    Posting, Price, PriceAnnotation, PriceKind, Query, Transaction,
};
use crate::identifiers::{Account, Currency, Link, Tag};
use crate::{Amount, IncompleteAmount, InternedStr, ShiftSpans, Span};

// --- HashMap blanket impl ------------------------------------------
//
// Round-19 replacement for the pre-19 `shift_metadata` free fn. The
// orphan rule allows the impl because rustledger-core owns the
// `ShiftSpans` trait — the type can be foreign. The `S` type
// parameter covers both `std::collections::HashMap`'s default
// `RandomState` and `rustc_hash::FxHashMap`'s `FxBuildHasher`, so
// `Metadata = FxHashMap<String, MetaValue>` is covered without a
// separate impl.
//
// Keys are not visited today (`Metadata`'s key is `String`, span-
// free). If a future Metadata changes its key type to something
// span-bearing, extend this impl to also dispatch on keys via
// `keys_mut()` — but that doesn't exist on HashMap; the impl would
// need to rebuild via `drain()`+`insert()`.

impl<K, V: ShiftSpans, S> ShiftSpans for std::collections::HashMap<K, V, S> {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        for value in self.values_mut() {
            value.shift_spans(shift);
        }
    }
}

// --- External / foreign leaf types ---------------------------------
//
// Types from std / outside crates that appear in directive payloads
// but carry no spans. Grouped here so the "we treat these as span-
// free" set is easy to audit.

crate::impl_shift_spans_noop!(
    rust_decimal::Decimal,
    jiff::civil::Date,
    char,
    f32,
    f64,
    InternedStr,
    Account,
    Currency,
    Tag,
    Link,
);

// --- Amount / IncompleteAmount -------------------------------------

impl ShiftSpans for Amount {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self { number, currency } = self;
        number.shift_spans(shift);
        currency.shift_spans(shift);
    }
}

impl ShiftSpans for IncompleteAmount {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        // Round-19 discipline: bind each variant payload BY NAME and
        // dispatch via the payload's own impl. Pre-round-19 used
        // `Self::Variant(_)` which silently bound any payload type
        // (including future Spanned wrappers) without dispatching.
        match self {
            Self::Complete(amount) => amount.shift_spans(shift),
            Self::NumberOnly(number) => number.shift_spans(shift),
            Self::CurrencyOnly(currency) => currency.shift_spans(shift),
        }
    }
}

// --- Cost / CostSpec / CostNumber ----------------------------------

impl ShiftSpans for Cost {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            number,
            currency,
            date,
            label,
        } = self;
        number.shift_spans(shift);
        currency.shift_spans(shift);
        date.shift_spans(shift);
        label.shift_spans(shift);
    }
}

impl ShiftSpans for CostSpec {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            number,
            currency,
            date,
            label,
            merge,
        } = self;
        number.shift_spans(shift);
        currency.shift_spans(shift);
        date.shift_spans(shift);
        label.shift_spans(shift);
        merge.shift_spans(shift);
    }
}

impl ShiftSpans for CostNumber {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        match self {
            Self::PerUnit { value } | Self::Total { value } => value.shift_spans(shift),
            Self::PerUnitFromTotal(booked) => booked.shift_spans(shift),
        }
    }
}

impl ShiftSpans for BookedCost {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self { per_unit, total } = self;
        per_unit.shift_spans(shift);
        total.shift_spans(shift);
    }
}

// --- PriceAnnotation -----------------------------------------------

impl ShiftSpans for PriceAnnotation {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self { kind, amount } = self;
        kind.shift_spans(shift);
        amount.shift_spans(shift);
    }
}

impl ShiftSpans for PriceKind {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, _: &F) {
        // Unit-like variants — no payload to dispatch into. The
        // exhaustive match still gates against added variants.
        match self {
            Self::Unit | Self::Total => {}
        }
    }
}

// --- MetaValue -----------------------------------------------------

impl ShiftSpans for MetaValue {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        // Round-19 discipline: bind each variant payload BY NAME and
        // dispatch via the payload's own `ShiftSpans` impl. Pre-
        // round-19's `Self::String(_) | Self::Account(_) | ...`
        // silently bound any payload type to `_` without dispatching
        // — a future `MetaValue::String(Spanned<String>)` would have
        // kept the new span in the BOM-stripped frame undetected.
        //
        // Today every payload type is a no-span leaf (`String`,
        // `Account`, `Currency`, `Tag`, `Link`, `NaiveDate`,
        // `Decimal`, `bool`, `Amount`), so each binding's dispatch
        // resolves to a no-op impl and the body is still a runtime
        // no-op. Wrapping any payload in a `Spanned<T>` automatically
        // routes through the wrapper's recursing impl — no edit to
        // this file required.
        match self {
            Self::String(s) => s.shift_spans(shift),
            Self::Account(a) => a.shift_spans(shift),
            Self::Currency(c) => c.shift_spans(shift),
            Self::Tag(t) => t.shift_spans(shift),
            Self::Link(l) => l.shift_spans(shift),
            Self::Date(d) => d.shift_spans(shift),
            Self::Number(n) => n.shift_spans(shift),
            Self::Bool(b) => b.shift_spans(shift),
            Self::Amount(a) => a.shift_spans(shift),
            Self::None => {}
            Self::Int(i) => i.shift_spans(shift),
        }
    }
}

// --- Posting --------------------------------------------------------

impl ShiftSpans for Posting {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            account,
            units,
            cost,
            price,
            flag,
            meta,
            comments,
            trailing_comments,
        } = self;
        account.shift_spans(shift);
        units.shift_spans(shift);
        cost.shift_spans(shift);
        price.shift_spans(shift);
        flag.shift_spans(shift);
        meta.shift_spans(shift);
        comments.shift_spans(shift);
        trailing_comments.shift_spans(shift);
    }
}

// --- Directive variant structs -------------------------------------

impl ShiftSpans for Transaction {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            flag,
            payee,
            narration,
            tags,
            links,
            meta,
            postings,
            trailing_comments,
        } = self;
        date.shift_spans(shift);
        flag.shift_spans(shift);
        payee.shift_spans(shift);
        narration.shift_spans(shift);
        tags.shift_spans(shift);
        links.shift_spans(shift);
        meta.shift_spans(shift);
        postings.shift_spans(shift);
        trailing_comments.shift_spans(shift);
    }
}

impl ShiftSpans for Open {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            currencies,
            booking,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        currencies.shift_spans(shift);
        booking.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Close {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Balance {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            amount,
            tolerance,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        amount.shift_spans(shift);
        tolerance.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Pad {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            source_account,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        source_account.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Note {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            comment,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        comment.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Document {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            account,
            path,
            tags,
            links,
            meta,
        } = self;
        date.shift_spans(shift);
        account.shift_spans(shift);
        path.shift_spans(shift);
        tags.shift_spans(shift);
        links.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Price {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            currency,
            amount,
            meta,
        } = self;
        date.shift_spans(shift);
        currency.shift_spans(shift);
        amount.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Custom {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            custom_type,
            values,
            meta,
        } = self;
        date.shift_spans(shift);
        custom_type.shift_spans(shift);
        // `values: Vec<MetaValue>` — routes through the Vec blanket
        // impl in crate::span, which delegates per-element to
        // `MetaValue::shift_spans`. Consistent with how `tags`,
        // `links`, `postings`, `comments` are handled across sibling
        // impls; the round-18 hand-rolled `for v in values` loop was
        // inconsistent.
        values.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Event {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            event_type,
            value,
            meta,
        } = self;
        date.shift_spans(shift);
        event_type.shift_spans(shift);
        value.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Query {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            name,
            query,
            meta,
        } = self;
        date.shift_spans(shift);
        name.shift_spans(shift);
        query.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

impl ShiftSpans for Commodity {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        let Self {
            date,
            currency,
            meta,
        } = self;
        date.shift_spans(shift);
        currency.shift_spans(shift);
        meta.shift_spans(shift);
    }
}

// --- Directive enum ------------------------------------------------

impl ShiftSpans for Directive {
    fn shift_spans<F: Fn(&mut Span)>(&mut self, shift: &F) {
        match self {
            Self::Transaction(t) => t.shift_spans(shift),
            Self::Balance(b) => b.shift_spans(shift),
            Self::Open(o) => o.shift_spans(shift),
            Self::Close(c) => c.shift_spans(shift),
            Self::Commodity(c) => c.shift_spans(shift),
            Self::Pad(p) => p.shift_spans(shift),
            Self::Event(e) => e.shift_spans(shift),
            Self::Query(q) => q.shift_spans(shift),
            Self::Note(n) => n.shift_spans(shift),
            Self::Document(d) => d.shift_spans(shift),
            Self::Price(p) => p.shift_spans(shift),
            Self::Custom(c) => c.shift_spans(shift),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{NaiveDate, Spanned};

    /// `Directive::shift_spans` recurses through `Transaction.postings`
    /// and shifts every `Spanned<Posting>`'s outer span.
    #[test]
    fn directive_shift_spans_propagates_into_posting_spans() {
        use crate::Amount;
        use rust_decimal_macros::dec;

        let posting = Spanned::new(
            Posting::new("Assets:Bank", Amount::new(dec!(100), "USD")),
            Span::new(50, 75),
        );
        let txn = Transaction {
            date: NaiveDate::new(2024, 1, 1).unwrap(),
            flag: '*',
            payee: None,
            narration: "Test".into(),
            tags: Vec::new(),
            links: Vec::new(),
            meta: crate::Metadata::default(),
            postings: vec![posting],
            trailing_comments: Vec::new(),
        };
        let mut d = Directive::Transaction(txn);
        d.shift_spans(&|s: &mut Span| {
            s.start += 10;
            s.end += 10;
        });
        if let Directive::Transaction(t) = d {
            assert_eq!(t.postings[0].span, Span::new(60, 85));
        } else {
            unreachable!();
        }
    }

    /// Round-19 contract: `MetaValue::String(value)` dispatches via
    /// the payload's `ShiftSpans` impl, NOT via a wildcard `_` arm.
    /// Concretely, if `MetaValue::String` ever carried a `Spanned<T>`
    /// payload, that wrapper's impl would be invoked automatically.
    ///
    /// This test pins the dispatch shape via a `MetaValue::Amount`
    /// variant carrying a (no-span) `Amount` — the dispatch path
    /// resolves to `Amount::shift_spans`, which destructures
    /// exhaustively. The compile-time check on the binding pattern
    /// itself catches the discipline gap; this runtime test pins
    /// that the wiring works end-to-end through the `HashMap` impl.
    #[test]
    fn metadata_shift_spans_dispatches_via_value_impl() {
        use crate::Amount;
        use rust_decimal_macros::dec;

        let mut meta = crate::Metadata::default();
        meta.insert(
            "amt".to_string(),
            MetaValue::Amount(Amount::new(dec!(1), "USD")),
        );

        // The shift closure here panics if invoked — we want to
        // verify it is NOT called (because no payload carries a
        // span today), but the dispatch chain (HashMap → MetaValue
        // → Amount → Currency/Decimal no-ops) must execute without
        // dispatching the shift on any leaf.
        let shift = |_: &mut Span| {
            // No-op; the test passes iff the dispatch tree resolves
            // without ever calling shift on a Span.
        };
        meta.shift_spans(&shift);
    }
}