1 package App
::HomeBank2Ledger
::Formatter
::Beancount
;
2 # ABSTRACT: Beancount formatter
6 This is a formatter for L<Beancount|http://furius.ca/beancount/>.
10 L<App::HomeBank2Ledger::Formatter>
14 use v5
.10
.1; # defined-or
18 use App
::HomeBank2Ledger
::Util
qw(commify rtrim);
20 use parent
'App::HomeBank2Ledger::Formatter';
22 our $VERSION = '9999.999'; # VERSION
24 my %STATUS_SYMBOLS = (
28 my $UNKNOWN_DATE = '0001-01-01';
30 sub _croak
{ require Carp
; Carp
::croak
(@_) }
38 $self->format_accounts($ledger),
39 $self->format_commodities($ledger),
40 # $self->format_payees,
42 $self->format_transactions($ledger),
45 return join($/, map { rtrim
($_) } @out);
50 @lines = $formatter->format_header;
52 Get formatted header
. For example
,
55 ; File
: path
/to/finances
.xhb
64 if (my $name = $self->name) {
65 push @out, "; Name: $name";
67 if (my $file = $self->file) {
68 push @out, "; File: $file";
76 =method format_accounts
78 @lines = $formatter->format_accounts($ledger);
80 Get formatted accounts
. For example
,
82 2003-02-14 open Assets
:Bank
:Credit-Union
:Savings
83 2003-02-14 open Assets
:Bank
:Credit-Union
:Checking
94 for my $account (sort @{$ledger->accounts}) {
95 my $oldest_transaction = $self->_find_oldest_transaction_by_account($account, $ledger);
96 my $account_date = $oldest_transaction->{date
} || $UNKNOWN_DATE;
97 $account = $self->_format_account($account);
99 push @out, "${account_date} open ${account}";
106 =method format_commodities
108 @lines = $formatter->format_commodities($ledger);
110 Get formattted commodities
. For example
,
112 2003-02-14 commodity USD
118 sub format_commodities
{
124 for my $commodity (@{$ledger->commodities}) {
125 my $oldest_transaction = $self->_find_oldest_transaction_by_commodity($commodity, $ledger);
126 my $commodity_date = $oldest_transaction->{date
} || $UNKNOWN_DATE;
128 push @out, "${commodity_date} commodity $commodity->{iso}";
129 push @out, ' name: '.$self->_format_string($commodity->{name
}) if $commodity->{name
};
137 =method format_transactions
139 @lines = $formatter->format_transactions($ledger);
141 Get formatted transactions
. For example
,
143 2003-02-14 * "Opening Balance"
144 Assets
:Bank
:Credit-Union
:Savings
458.21 USD
145 Assets
:Bank
:Credit-Union
:Checking
194.17 USD
146 Equity
:Opening-Balances
152 sub format_transactions
{
158 for my $transaction (@{$ledger->transactions}) {
159 push @out, $self->_format_transaction($transaction);
165 sub _format_transaction
{
167 my $transaction = shift;
169 my $account_width = $self->account_width;
171 my $date = $transaction->{date
};
172 my $status = $transaction->{status
};
173 my $payee = $transaction->{payee
} || '';
174 my $memo = $transaction->{memo
} || '';
175 my @postings = @{$transaction->{postings
}};
179 # figure out the Ledger transaction status
180 my $status_symbol = $STATUS_SYMBOLS{$status || ''};
181 if (!$status_symbol) {
182 my %posting_statuses = map { ($_->{status
} || '') => 1 } @postings;
183 if (keys(%posting_statuses) == 1) {
184 my ($status) = keys %posting_statuses;
185 $status_symbol = $STATUS_SYMBOLS{$status || 'none'} || '';
189 push @out, sprintf('%s%s%s%s', $date,
190 $status_symbol && ' '.$status_symbol || ' *', # status (or "txn") is required
191 ($payee || $memo) && ' '.$self->_format_string($payee),
192 $memo && ' '.$self->_format_string($memo),
195 if (my %tags = map { $_ => 1 } map { @{$_->{tags
} || []} } @postings) {
196 my @tags = map { "#$_" } keys %tags;
197 $out[-1] .= ' '.join(' ', @tags);
200 for my $posting (@postings) {
203 my $posting_status_symbol = '';
204 if (!$status_symbol) {
205 $posting_status_symbol = $STATUS_SYMBOLS{$posting->{status
} || ''} || '';
208 my $account = $self->_format_account($posting->{account
});
210 push @line, ($posting_status_symbol ? " $posting_status_symbol " : ' ');
211 push @line, sprintf("\%-${account_width}s", $account);
213 if (defined $posting->{amount
}) {
214 push @line, $self->_format_amount($posting->{amount
}, $posting->{commodity
});
215 my $lot_price = $posting->{lot_price
};
216 my $lot_date = $posting->{lot_date
};
217 my $lot_ref = $posting->{lot_ref
};
218 if ($lot_price || $lot_date || $lot_ref) {
221 $lot_price ? $self->_format_amount($lot_price->{amount
}, $lot_price->{commodity
}) : (),
222 $lot_date ? $lot_date : (),
223 $lot_ref ? $self->_format_string($lot_ref) : (),
227 if (my $cost = $posting->{total_cost
} // $posting->{cost
}) {
228 my $is_total = defined $posting->{total_cost
};
229 my $cost_symbol = $is_total ? '@@' : '@';
230 push @line, ' ', $cost_symbol, ' ',
231 $self->_format_amount($cost->{amount
}, $cost->{commodity
});
235 push @out, join('', @line);
243 sub _format_account
{
246 $account =~ s/[^A-Za-z0-9:]+/-/g;
247 $account =~ s/-+/-/g;
248 $account =~ s/(?:^|(?<=:))([a-z])/uc($1)/eg;
262 my $commodity = shift or _croak
'Must provide a valid currency';
264 my $format = "\% .$commodity->{frac}f";
265 my ($whole, $fraction) = split(/\./, sprintf($format, $amount));
267 # beancount doesn't support different notations
268 my $num = join('.', commify
($whole), $fraction);
270 $num = "$num $commodity->{iso}";
275 sub _find_oldest_transaction_by_account
{
280 $account = $self->_format_account($account);
282 my $oldest = $self->{oldest_transaction_by_account
};
285 for my $transaction (@{$ledger->transactions}) {
286 for my $posting (@{$transaction->{postings
}}) {
287 my $account = $self->_format_account($posting->{account
});
289 if ($transaction->{date
} lt ($oldest->{$account}{date
} || '9999-99-99')) {
290 $oldest->{$account} = $transaction;
295 $self->{oldest_transaction_by_account
} = $oldest;
298 return $oldest->{$account};
301 sub _find_oldest_transaction_by_commodity
{
303 my $commodity = shift;
306 my $oldest = $self->{oldest_transaction_by_commodity
};
309 for my $transaction (@{$ledger->transactions}) {
310 for my $posting (@{$transaction->{postings
}}) {
311 my $symbol = $posting->{commodity
}{symbol
};
314 if ($transaction->{date
} lt ($oldest->{$symbol}{date
} || '9999-99-99')) {
315 $oldest->{$symbol} = $transaction;
320 $self->{oldest_transaction_by_commodity
} = $oldest;
323 return $oldest->{$commodity->{symbol
}};