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
//! repl represents Ledger file format representation.
//! Note the structure is quite similar to data module,
//! however, repl is for textual representation while
//! data is more for understanding.
pub mod display;
pub mod expr;
pub mod parser;
pub mod pretty_decimal;
use crate::datamodel;
pub use crate::datamodel::ClearState;
use std::fmt;
use chrono::NaiveDate;
/// Top-level entry of the LedgerFile.
#[derive(Debug, PartialEq, Eq)]
pub enum LedgerEntry {
/// Transaction
Txn(Transaction),
/// Comment, not limited to one-line oppose to `Metadata`.
Comment(TopLevelComment),
/// Apply tag directive.
ApplyTag(ApplyTag),
/// "end apply tag" directive.
EndApplyTag,
/// "include" directive.
Include(IncludeFile),
/// "account" directive.
Account(AccountDeclaration),
/// "commodity" directive.
Commodity(CommodityDeclaration),
}
/// Top-level comment. OK to have multi-line comment.
#[derive(Debug, PartialEq, Eq)]
pub struct TopLevelComment(String);
/// "apply tag" directive content.
#[derive(Debug, PartialEq, Eq)]
pub struct ApplyTag {
pub key: String,
pub value: Option<MetadataValue>,
}
/// "include" directive, taking a path as an argument.
/// Path can be a relative path or an absolute path.
#[derive(Debug, PartialEq, Eq)]
pub struct IncludeFile(String);
/// "account" directive to declare account information.
#[derive(Debug, PartialEq, Eq)]
pub struct AccountDeclaration {
/// Canonical name of the account.
pub name: String,
/// sub-directives for the account.
pub details: Vec<AccountDetail>,
}
/// Sub directives for "account" directive.
#[derive(Debug, PartialEq, Eq)]
pub enum AccountDetail {
/// Comment is a pure comment without any semantics, similar to `TopLevelComment`.
Comment(String),
/// Note is a "note" sub-directive.
/// Usually it would be one-line.
Note(String),
/// Declare the given string is an alias for the declared account.
Alias(String),
}
/// "commodity" directive to declare commodity information.
#[derive(Debug, PartialEq, Eq)]
pub struct CommodityDeclaration {
/// Canonical name of the commodity.
pub name: String,
/// sub-directives for the commodity.
pub details: Vec<CommodityDetail>,
}
/// Sub directives for "commodity" directive.
#[derive(Debug, PartialEq, Eq)]
pub enum CommodityDetail {
/// Comment is a pure comment without any semantics, similar to `TopLevelComment`.
Comment(String),
/// Note is a "note" sub-directive to note the commodity.
/// Usually it would be one-line.
Note(String),
/// Declare the given string is an alias for the declared account.
/// Multiple declaration should work.
Alias(String),
/// Format describes how the comodity should be printed.
Format(expr::Amount),
}
/// Represents a transaction where the money transfered across the accounts.
#[derive(Debug, PartialEq, Eq)]
pub struct Transaction {
/// Date when the transaction issued.
pub date: NaiveDate,
/// Date when the transaction got effective, optional.
pub effective_date: Option<NaiveDate>,
/// Indiacates clearing state of the entire transaction.
pub clear_state: ClearState,
/// Transaction code (not necessarily unique).
pub code: Option<String>,
/// Label of the transaction, often the opposite party of the transaction.
pub payee: String,
/// Postings of the transaction, could be empty.
pub posts: Vec<Posting>,
/// Transaction level metadata.
pub metadata: Vec<Metadata>,
}
impl Transaction {
/// Constructs minimal transaction.
pub fn new(date: NaiveDate, payee: String) -> Transaction {
Transaction {
date,
effective_date: None,
clear_state: ClearState::Uncleared,
code: None,
payee,
metadata: Vec::new(),
posts: Vec::new(),
}
}
}
impl From<datamodel::Transaction> for Transaction {
fn from(orig: datamodel::Transaction) -> Transaction {
Transaction {
date: orig.date,
effective_date: orig.effective_date,
clear_state: orig.clear_state,
code: orig.code,
payee: orig.payee,
metadata: Vec::new(),
posts: orig.posts.into_iter().map(Into::into).collect(),
}
}
}
#[derive(Debug, PartialEq, Eq)]
/// Posting in a transaction to represent a particular account amount increase / decrease.
pub struct Posting {
/// Account of the post target.
pub account: String,
/// Posting specific ClearState.
pub clear_state: ClearState,
/// Amount of the posting.
pub amount: Option<PostingAmount>,
/// Balance after the transaction of the specified account.
pub balance: Option<expr::ValueExpr>,
/// Metadata information such as comment or tag.
pub metadata: Vec<Metadata>,
}
impl Posting {
pub fn new(account: String) -> Posting {
Posting {
account,
clear_state: ClearState::default(),
amount: None,
balance: None,
metadata: Vec::new(),
}
}
}
impl From<datamodel::Posting> for Posting {
fn from(orig: datamodel::Posting) -> Posting {
let metadata = orig
.payee
.into_iter()
.map(|v| Metadata::KeyValueTag {
key: "Payee".to_string(),
value: MetadataValue::Text(v),
})
.collect();
Posting {
account: orig.account,
clear_state: orig.clear_state,
amount: orig.amount.map(Into::into),
balance: orig.balance.map(Into::into),
metadata,
}
}
}
/// Metadata represents meta information associated with transactions / posts.
#[derive(Debug, PartialEq, Eq)]
pub enum Metadata {
/// Comment, which covers just one line (without the suceeding new line).
Comment(String),
/// Tags of word, in a format :tag1:tag2:tag3:, each tag can't contain white spaces.
WordTags(Vec<String>),
/// Key-value paired tag. Key can't contain white spaces.
KeyValueTag { key: String, value: MetadataValue },
}
/// MetadataValue represents the value in key-value pair used in `Metadata`.
#[derive(Debug, PartialEq, Eq)]
pub enum MetadataValue {
/// Regular string.
Text(String),
/// Expression parsed properly prefixed by `::` instead of `:`. Note it should be Expr not String.
Expr(String),
}
/// This is an amout for each posting.
/// Which contains
/// - how much the asset is increased.
/// - what was the cost in the other commodity.
/// - lot information.
#[derive(Debug, PartialEq, Eq)]
pub struct PostingAmount {
pub amount: expr::ValueExpr,
pub cost: Option<Exchange>,
pub lot: Lot,
}
impl From<expr::ValueExpr> for PostingAmount {
fn from(v: expr::ValueExpr) -> Self {
PostingAmount {
amount: v,
cost: None,
lot: Lot::default(),
}
}
}
impl From<datamodel::ExchangedAmount> for PostingAmount {
fn from(v: datamodel::ExchangedAmount) -> Self {
PostingAmount {
amount: v.amount.into(),
cost: v.exchange.map(Into::into),
lot: Lot::default(),
}
}
}
/// Lot information is a set of metadata to record the original lot which the commodity is acquired with.
#[derive(Debug, Default, PartialEq, Eq)]
pub struct Lot {
pub price: Option<Exchange>,
pub date: Option<NaiveDate>,
pub note: Option<String>,
}
/// Exchange represents the amount expressed in the different commodity.
#[derive(Debug, PartialEq, Eq)]
pub enum Exchange {
/// Specified value equals to the total amount.
/// For example,
/// `200 JPY @@ 2 USD`
/// means the amount was 200 JPY, which is equal to 2 USD.
Total(expr::ValueExpr),
/// Specified value equals to the amount of one original commodity.
/// For example,
/// `200 JPY @ (1 / 100 USD)`
/// means the amount was 200 JPY, where 1 JPY is equal to 1/100 USD.
Rate(expr::ValueExpr),
}
impl From<datamodel::Exchange> for Exchange {
fn from(v: datamodel::Exchange) -> Self {
match v {
datamodel::Exchange::Total(total) => Exchange::Total(total.into()),
datamodel::Exchange::Rate(rate) => Exchange::Rate(rate.into()),
}
}
}