tackler_core/model/posting.rs
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 276 277 278 279 280 281 282 283 284 285 286 287 288
/*
* Copyright 2023 E257.FI
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
use crate::model::Commodity;
use crate::model::{AccountTreeNode, Posts};
use rust_decimal::Decimal;
use std::error::Error;
use std::fmt::{Display, Formatter};
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct Posting {
pub acctn: AccountTreeNode,
pub amount: Decimal,
// todo: fix / rename these (position?, exchange? amount, commodity)
pub txn_amount: Decimal,
pub is_total_amount: bool,
pub txn_commodity: Option<Commodity>,
pub comment: Option<String>,
// fixme: remove duplicate information, this is kind of available via ATN
// See fixme in ATN
pub atn_key: String,
}
impl Posting {
pub(crate) fn from(
acctn: AccountTreeNode,
amount: Decimal,
txn_amount: Decimal,
is_total_amount: bool,
txn_commodity: Option<Commodity>,
comment: Option<String>,
) -> Result<Posting, Box<dyn Error>> {
if amount.is_zero() {
let msg = format!("Zero sum postings are not allowed: {}", acctn.account);
return Err(msg.into());
}
let atn_key = acctn.get_full();
Ok(Posting {
acctn,
amount,
txn_amount,
is_total_amount,
txn_commodity,
comment,
atn_key,
})
}
}
pub fn txn_sum(posts: &Posts) -> Decimal {
posts.iter().map(|p| p.txn_amount).sum()
}
impl Display for Posting {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let sign_space = if self.amount.is_sign_negative() {
""
} else {
" "
};
write!(
f,
"{} {}{}{}{}{}",
self.acctn,
sign_space,
self.amount,
self.acctn
.commodity
.as_ref()
.map(|c| format!(" {}", c.name))
.unwrap_or_default(),
self.txn_commodity
.as_ref()
.map(|txn_c| {
#[allow(clippy::collapsible_else_if)]
// todo: old-scala comment: fix this
if txn_c.name == self.acctn.commodity_str {
String::default()
} else {
if self.is_total_amount {
format!(" = {} {}", self.txn_amount, txn_c.name)
} else {
format!(" @ {} {}", (self.txn_amount / self.amount), txn_c.name)
}
}
})
.unwrap_or_default(),
self.comment
.as_ref()
.map(|c| format!(" ; {c}"))
.unwrap_or_default()
)
}
}
#[cfg(test)]
#[allow(non_snake_case)]
mod tests {
use super::*;
#[test]
// desc: "reject zero postings"
fn id_42ad9d32_64aa_4fcd_a4ab_1e8521b921e3__reject_zero_posting() {
{
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
Decimal::new(0, 0),
Decimal::new(0, 0),
false,
None,
None,
);
assert!(p.is_err());
}
{
// check that difference precision doesn't mess Decimal comparisons
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
Decimal::new(0, 28),
Decimal::new(0, 28),
false,
None,
None,
);
assert!(p.is_err());
}
}
#[test]
// desc: "preserve precision - 1E20"
fn id_e3c97b66_318c_4396_8857_0cd2c1dfb0d2__preserve_precision_1E20() {
/*
* val v = // 3 2 1 . 1 2 3 4
* TacklerReal("123456789012345678901234567890.123456789012345678901234567890123456789012")
* val p = Posting(acctn, v, v, false, None, None)
* assert(p.toString === "a:b 123456789012345678901234567890.123456789012345678901234567890123456789012")
*/
let v_str =
//2 1 . 1 2 3 4
"12345678901234567890.123456789";
let ref_str = format!("a:b {}", v_str);
let v = Decimal::from_str_exact(v_str).unwrap(/*:test:*/);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(acctn, v, v, false, None, None).unwrap(/*:test:*/);
let p_str = format!("{}", p);
assert_eq!(p_str, ref_str);
assert_eq!(p.to_string(), ref_str);
}
#[test]
// desc: "preserve precision - 1E15"
fn id_26da0769_de5f_4344_b1d4_d3ddbf3f7f5a__preserve_precision_1E15() {
/*
* val v = // 3 2 1 . 1 2 3 4
* TacklerReal("123456789012345678901234567890.123456789012345678901234567890123456789012")
* val p = Posting(acctn, v, v, false, None, None)
* assert(p.toString === "a:b 123456789012345678901234567890.123456789012345678901234567890123456789012")
*/
let v_str =
// Quadrillion is 15 digits, e.g. 100 * USA budget
//2 1 . 1 2 3 4
"678901234567890.12345678901234";
let ref_str = format!("a:b {}", v_str);
let v = Decimal::from_str_exact(v_str).unwrap(/*:test:*/);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(acctn, v, v, false, None, None).unwrap(/*:test:*/);
let p_str = format!("{}", p);
assert_eq!(p_str, ref_str);
assert_eq!(p.to_string(), ref_str);
}
#[test]
// desc: "toString e.g. Display"
fn id_6ce68af4_5349_44e0_8fbc_35bebd8ac1ac__display() {
let v = Decimal::new(12301, 2);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p =
Posting::from(acctn, v, v, false, None, Some("comment".to_string())).unwrap(/*:test:*/);
let p_str = format!("{}", p);
assert_eq!(p_str, "a:b 123.01 ; comment");
}
#[test]
// desc: "unit price"
fn id_16b54e8c_5ea6_420c_bd72_157dbcc06a49__unit_price() {
let pv = Decimal::new(12300, 2);
let tv = Decimal::new(24600, 2);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
pv,
tv,
false,
Some(Commodity {
name: "€".to_string(),
}),
None,
)
.unwrap(/*:test:*/);
assert_eq!(p.to_string(), "a:b 123.00 @ 2 €");
}
#[test]
// desc: "unit price with comment"
fn id_22059d1d_7c10_42dc_831f_03bd1f1d6257__unit_price_w_comment() {
let pv = Decimal::new(12300, 2);
let tv = Decimal::new(24600, 2);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
pv,
tv,
false,
Some(Commodity {
name: "€".to_string(),
}),
Some("comment".to_string()),
)
.unwrap(/*:test:*/);
assert_eq!(p.to_string(), "a:b 123.00 @ 2 € ; comment");
}
#[test]
// desc: "total price"
fn id_0fef204a_19da_418f_b7d0_86b5211c2182__total_price() {
let pv = Decimal::new(12300, 2);
let tv = Decimal::new(24600, 2);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
pv,
tv,
true,
Some(Commodity {
name: "€".to_string(),
}),
None,
)
.unwrap(/*:test:*/);
assert_eq!(p.to_string(), "a:b 123.00 = 246.00 €");
}
#[test]
// desc: "total price with comment"
fn id_718dd25c_aebc_4f29_9903_67942c6ba531__total_price_w_comment() {
let pv = Decimal::new(12300, 2);
let tv = Decimal::new(24600, 2);
let acctn = AccountTreeNode::from("a:b".to_string(), None).unwrap(/*:test:*/);
let p = Posting::from(
acctn,
pv,
tv,
true,
Some(Commodity {
name: "€".to_string(),
}),
Some("comment".to_string()),
)
.unwrap(/*:test:*/);
assert_eq!(p.to_string(), "a:b 123.00 = 246.00 € ; comment");
}
}