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
//! Warn about unused accounts.
use crate::types::{DirectiveData, MetaValueData, PluginError, PluginInput, PluginOutput};
use super::super::NativePlugin;
/// Plugin that identifies accounts that are opened but never used.
///
/// Reports a warning for each account that has an Open directive but is never
/// referenced in any transaction, balance, pad, or other directive.
pub struct NoUnusedPlugin;
impl NativePlugin for NoUnusedPlugin {
fn name(&self) -> &'static str {
"nounused"
}
fn description(&self) -> &'static str {
"Warn about unused accounts"
}
fn process(&self, input: PluginInput) -> PluginOutput {
use std::collections::HashSet;
let mut opened_accounts: HashSet<String> = HashSet::new();
let mut used_accounts: HashSet<String> = HashSet::new();
// Collect all opened accounts and used accounts in one pass
for wrapper in &input.directives {
match &wrapper.data {
DirectiveData::Open(data) => {
opened_accounts.insert(data.account.clone());
}
DirectiveData::Close(data) => {
// Closing an account counts as using it
used_accounts.insert(data.account.clone());
}
DirectiveData::Transaction(txn) => {
for posting in &txn.postings {
used_accounts.insert(posting.account.clone());
}
}
DirectiveData::Balance(data) => {
used_accounts.insert(data.account.clone());
}
DirectiveData::Pad(data) => {
used_accounts.insert(data.account.clone());
used_accounts.insert(data.source_account.clone());
}
DirectiveData::Note(data) => {
used_accounts.insert(data.account.clone());
}
DirectiveData::Document(data) => {
used_accounts.insert(data.account.clone());
}
DirectiveData::Custom(data) => {
// Check custom directive values for account references
for value in &data.values {
if let MetaValueData::Account(account) = value {
used_accounts.insert(account.clone());
}
}
}
_ => {}
}
}
// Find unused accounts (opened but never used)
let mut errors = Vec::new();
let mut unused: Vec<_> = opened_accounts
.difference(&used_accounts)
.cloned()
.collect();
unused.sort(); // Consistent ordering for output
for account in unused {
errors.push(PluginError::warning(format!(
"Account '{account}' is opened but never used"
)));
}
PluginOutput {
directives: input.directives,
errors,
}
}
}
#[cfg(test)]
mod nounused_tests {
use super::*;
use crate::types::*;
#[test]
fn test_nounused_reports_unused_account() {
let plugin = NoUnusedPlugin;
let input = PluginInput {
directives: vec![
DirectiveWrapper {
directive_type: "open".to_string(),
date: "2024-01-01".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Open(OpenData {
account: "Assets:Bank".to_string(),
currencies: vec![],
booking: None,
metadata: vec![],
}),
},
DirectiveWrapper {
directive_type: "open".to_string(),
date: "2024-01-01".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Open(OpenData {
account: "Assets:Unused".to_string(),
currencies: vec![],
booking: None,
metadata: vec![],
}),
},
DirectiveWrapper {
directive_type: "transaction".to_string(),
date: "2024-01-15".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Transaction(TransactionData {
flag: "*".to_string(),
payee: None,
narration: "Test".to_string(),
tags: vec![],
links: vec![],
metadata: vec![],
postings: vec![PostingData {
account: "Assets:Bank".to_string(),
units: Some(AmountData {
number: "100".to_string(),
currency: "USD".to_string(),
}),
cost: None,
price: None,
flag: None,
metadata: vec![],
}],
}),
},
],
options: PluginOptions {
operating_currencies: vec!["USD".to_string()],
title: None,
},
config: None,
};
let output = plugin.process(input);
assert_eq!(output.errors.len(), 1);
assert!(output.errors[0].message.contains("Assets:Unused"));
assert!(output.errors[0].message.contains("never used"));
}
#[test]
fn test_nounused_no_warning_for_used_accounts() {
let plugin = NoUnusedPlugin;
let input = PluginInput {
directives: vec![
DirectiveWrapper {
directive_type: "open".to_string(),
date: "2024-01-01".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Open(OpenData {
account: "Assets:Bank".to_string(),
currencies: vec![],
booking: None,
metadata: vec![],
}),
},
DirectiveWrapper {
directive_type: "transaction".to_string(),
date: "2024-01-15".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Transaction(TransactionData {
flag: "*".to_string(),
payee: None,
narration: "Test".to_string(),
tags: vec![],
links: vec![],
metadata: vec![],
postings: vec![PostingData {
account: "Assets:Bank".to_string(),
units: Some(AmountData {
number: "100".to_string(),
currency: "USD".to_string(),
}),
cost: None,
price: None,
flag: None,
metadata: vec![],
}],
}),
},
],
options: PluginOptions {
operating_currencies: vec!["USD".to_string()],
title: None,
},
config: None,
};
let output = plugin.process(input);
assert_eq!(output.errors.len(), 0);
}
#[test]
fn test_nounused_close_counts_as_used() {
let plugin = NoUnusedPlugin;
let input = PluginInput {
directives: vec![
DirectiveWrapper {
directive_type: "open".to_string(),
date: "2024-01-01".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Open(OpenData {
account: "Assets:OldAccount".to_string(),
currencies: vec![],
booking: None,
metadata: vec![],
}),
},
DirectiveWrapper {
directive_type: "close".to_string(),
date: "2024-12-31".to_string(),
filename: None,
lineno: None,
data: DirectiveData::Close(CloseData {
account: "Assets:OldAccount".to_string(),
metadata: vec![],
}),
},
],
options: PluginOptions {
operating_currencies: vec!["USD".to_string()],
title: None,
},
config: None,
};
let output = plugin.process(input);
// Close counts as usage, so no warning
assert_eq!(output.errors.len(), 0);
}
}