commerce-theory 0.1.0

Runtime Rust mirror of the CommerceTheory Lean package
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

use crate::foundation::*;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum PostingSide {
    Debit,
    Credit,
}

domain_struct! {
    pub struct LedgerAccount {
        id: Id,
        name: String,
    }
}

domain_struct! {
    pub struct Posting {
        account: LedgerAccount,
        side: PostingSide,
        amount: Money,
    }
}

pub fn debit(account: LedgerAccount, amount: Money) -> Posting {
    Posting::new(account, PostingSide::Debit, amount)
}

pub fn credit(account: LedgerAccount, amount: Money) -> Posting {
    Posting::new(account, PostingSide::Credit, amount)
}

pub fn debit_total(postings: &[Posting]) -> DomainResult<Money> {
    checked_sum(
        postings.iter().map(|posting| {
            if posting.side == PostingSide::Debit {
                posting.amount
            } else {
                0
            }
        }),
        "debit_total",
    )
}

pub fn credit_total(postings: &[Posting]) -> DomainResult<Money> {
    checked_sum(
        postings.iter().map(|posting| {
            if posting.side == PostingSide::Credit {
                posting.amount
            } else {
                0
            }
        }),
        "credit_total",
    )
}

#[derive(Clone, Debug, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct BalancedJournalEntry {
    pub(crate) postings: Vec<Posting>,
}

impl BalancedJournalEntry {
    pub fn try_new(postings: Vec<Posting>) -> DomainResult<Self> {
        if debit_total(&postings)? != credit_total(&postings)? {
            return Err(ValidationError::Invariant("journal entry is not balanced"));
        }
        Ok(Self { postings })
    }

    pub fn postings(&self) -> &[Posting] {
        &self.postings
    }
}

domain_struct! {
    pub struct AccountingAccounts {
        cash: LedgerAccount,
        deferred_revenue: LedgerAccount,
        revenue: LedgerAccount,
        refunds: LedgerAccount,
        inventory: LedgerAccount,
        cogs: LedgerAccount,
    }
}

pub fn payment_captured_journal(
    accounts: &AccountingAccounts,
    amount: Money,
) -> DomainResult<BalancedJournalEntry> {
    BalancedJournalEntry::try_new(vec![
        debit(accounts.cash.clone(), amount),
        credit(accounts.deferred_revenue.clone(), amount),
    ])
}

pub fn refund_issued_journal(
    accounts: &AccountingAccounts,
    amount: Money,
) -> DomainResult<BalancedJournalEntry> {
    BalancedJournalEntry::try_new(vec![
        debit(accounts.refunds.clone(), amount),
        credit(accounts.cash.clone(), amount),
    ])
}