# ABSTRACT: Ledger formatter
+use v5.10.1; # defined-or
use warnings;
use strict;
use parent 'App::HomeBank2Ledger::Formatter';
-our $VERSION = '0.003'; # VERSION
+our $VERSION = '0.007'; # VERSION
my %STATUS_SYMBOLS = (
cleared => '*',
my $ledger = shift;
my @out = (
- $self->_format_header,
- $self->_format_accounts($ledger),
- $self->_format_commodities($ledger),
- $self->_format_payees($ledger),
- $self->_format_tags($ledger),
- $self->_format_transactions($ledger),
+ $self->format_header,
+ $self->format_accounts($ledger),
+ $self->format_commodities($ledger),
+ $self->format_payees($ledger),
+ $self->format_tags($ledger),
+ $self->format_transactions($ledger),
);
return join($/, map { rtrim($_) } @out);
}
-sub _format_header {
+
+sub format_header {
my $self = shift;
my @out;
if (my $name = $self->name) {
push @out, "; Name: $name";
}
-
- my $file = $self->file;
- push @out, "; Converted from ${file} using homebank2ledger ${VERSION}";
+ if (my $file = $self->file) {
+ push @out, "; File: $file";
+ }
push @out, '';
return @out;
}
-sub _format_accounts {
+
+sub format_accounts {
my $self = shift;
my $ledger = shift;
return @out;
}
-sub _format_commodities {
+
+sub format_commodities {
my $self = shift;
my $ledger = shift;
return @out;
}
-sub _format_payees {
+
+sub format_payees {
my $self = shift;
my $ledger = shift;
return @out;
}
-sub _format_tags {
+
+sub format_tags {
my $self = shift;
my $ledger = shift;
return @out;
}
-sub _format_transactions {
+
+sub format_transactions {
my $self = shift;
my $ledger = shift;
$memo && " ; $memo",
);
+ my $metadata = $transaction->{metadata} || {};
+ for my $key (sort keys %$metadata) {
+ my $value = $self->_format_string($metadata->{$key});
+ push @out, " ; ${key}: ${value}";
+ }
+
for my $posting (@postings) {
my @line;
push @line, ($posting_status_symbol ? " $posting_status_symbol " : ' ');
push @line, sprintf("\%-${account_width}s", $posting->{account});
push @line, ' ';
- push @line, $self->_format_amount($posting->{amount}, $posting->{commodity}) if defined $posting->{amount};
+ if (defined $posting->{amount}) {
+ push @line, $self->_format_amount($posting->{amount}, $posting->{commodity});
+ if (my $price = $posting->{lot_price}) {
+ my $is_fixed = $posting->{lot_fixed};
+ my $fixed_symbol = $is_fixed ? '=' : '';
+ push @line, " {${fixed_symbol}",
+ $self->_format_amount($price->{amount}, $price->{commodity}),
+ '}';
+ }
+ if (my $lot_date = $posting->{lot_date}) {
+ push @line, " [$posting->{lot_date}]";
+ }
+ if (my $cost = $posting->{total_cost} // $posting->{cost}) {
+ my $is_total = defined $posting->{total_cost};
+ my $cost_symbol = $is_total ? '@@' : '@';
+ push @line, ' ', $cost_symbol, ' ',
+ $self->_format_amount($cost->{amount}, $cost->{commodity});
+ }
+ }
+ if (my $note = $posting->{note}) {
+ $note = $self->_format_string($note);
+ push @line, " ; $note" if $note ne $memo;
+ }
push @out, join('', @line);
- if (my $payee = $posting->{payee}) {
- push @out, ' ; Payee: '.$self->_format_string($payee);
+ my $metadata = $posting->{metadata} || {};
+ for my $key (sort keys %$metadata) {
+ my $value = $self->_format_string($metadata->{$key});
+ push @out, " ; ${key}: ${value}";
+ }
+
+ if (my $posting_payee = $posting->{payee}) {
+ $posting_payee = $self->_format_string($posting_payee);
+ push @out, " ; Payee: $posting_payee" if $posting_payee ne $payee;
}
if (my @tags = @{$posting->{tags} || []}) {
- push @out, " ; :".join(':', @tags).":";
+ push @out, ' ; :'.join(':', @tags).':';
}
}
return $str;
}
+sub _quote_string {
+ my $self = shift;
+ my $str = shift;
+ $str =~ s/"/\\"/g;
+ return "\"$str\"";
+}
+
sub _format_amount {
my $self = shift;
my $amount = shift;
my $format = "\% .$commodity->{frac}f";
my ($whole, $fraction) = split(/\./, sprintf($format, $amount));
+ $fraction ||= 0;
- my $num = join($commodity->{dchar}, commify($whole, $commodity->{gchar}), $fraction);
+ my $num = commify($whole, $commodity->{gchar});
+ if ($commodity->{frac}) {
+ $num .= $commodity->{dchar} . $fraction;
+ }
+
+ my $symbol = $commodity->{symbol};
+ $symbol = $self->_quote_string($symbol) if $symbol =~ /[0-9\s]/;
- $num = $commodity->{syprf} ? "$commodity->{symbol} $num" : "$num $commodity->{symbol}";
+ $num = $commodity->{syprf} ? "$symbol $num" : "$num $symbol";
return $num;
}
=head1 VERSION
-version 0.003
+version 0.007
=head1 DESCRIPTION
This is a formatter for L<Ledger|https://www.ledger-cli.org/>.
+=head1 METHODS
+
+=head2 format_header
+
+ @lines = $formatter->format_header;
+
+Get formatted header. For example,
+
+ ; Name: My Finances
+ ; File: path/to/finances.xhb
+
+=head2 format_accounts
+
+ @lines = $formatter->format_accounts($ledger);
+
+Get formatted accounts. For example,
+
+ account Assets:Bank:Credit Union:Savings
+ account Assets:Bank:Credit Union:Checking
+ ...
+
+=head2 format_commodities
+
+ @lines = $formatter->format_commodities($ledger);
+
+Get formattted commodities. For example,
+
+ commodity $
+ note US Dollar
+ format $ 1,000.00
+ alias USD
+ ...
+
+=head2 format_payees
+
+ @lines = $formatter->format_payees($ledger);
+
+Get formatted payees. For example,
+
+ payee 180 Tacos
+ ...
+
+=head2 format_tags
+
+ @lines = $formatter->format_tags($ledger);
+
+Get formatted tags. For example,
+
+ tag yapc
+ ...
+
+=head2 format_transactions
+
+ @lines = $formatter->format_transactions($ledger);
+
+Get formatted transactions. For example,
+
+ 2003-02-14 * Opening Balance
+ Assets:Bank:Credit Union:Savings $ 458.21
+ Assets:Bank:Credit Union:Checking $ 194.17
+ Equity:Opening Balances
+
+ ...
+
=head1 SEE ALSO
L<App::HomeBank2Ledger::Formatter>