X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;ds=sidebyside;f=lib%2FApp%2FHomeBank2Ledger%2FFormatter%2FLedger.pm;h=4cf72cb895d169abaa1523139203374396c4270b;hb=7e41aec36980b1a053b9e54cfd6119a38dd819a3;hp=f9abb48050da1fb97040c93086f47f3416fe960f;hpb=661b30e1693328acbd3aa6730777a0568738b55b;p=chaz%2Fhomebank2ledger
diff --git a/lib/App/HomeBank2Ledger/Formatter/Ledger.pm b/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
index f9abb48..4cf72cb 100644
--- a/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
+++ b/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
@@ -2,6 +2,7 @@ package App::HomeBank2Ledger::Formatter::Ledger;
# ABSTRACT: Ledger formatter
+use v5.10.1; # defined-or
use warnings;
use strict;
@@ -9,7 +10,7 @@ use App::HomeBank2Ledger::Util qw(commify rtrim);
use parent 'App::HomeBank2Ledger::Formatter';
-our $VERSION = '0.003'; # VERSION
+our $VERSION = '0.005'; # VERSION
my %STATUS_SYMBOLS = (
cleared => '*',
@@ -23,18 +24,19 @@ sub format {
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;
@@ -42,16 +44,17 @@ sub _format_header {
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;
@@ -63,7 +66,8 @@ sub _format_accounts {
return @out;
}
-sub _format_commodities {
+
+sub format_commodities {
my $self = shift;
my $ledger = shift;
@@ -81,7 +85,8 @@ sub _format_commodities {
return @out;
}
-sub _format_payees {
+
+sub format_payees {
my $self = shift;
my $ledger = shift;
@@ -93,7 +98,8 @@ sub _format_payees {
return @out;
}
-sub _format_tags {
+
+sub format_tags {
my $self = shift;
my $ledger = shift;
@@ -105,7 +111,8 @@ sub _format_tags {
return @out;
}
-sub _format_transactions {
+
+sub format_transactions {
my $self = shift;
my $ledger = shift;
@@ -161,16 +168,39 @@ sub _format_transaction {
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);
+ 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).':';
}
}
@@ -186,6 +216,13 @@ sub _format_string {
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;
@@ -196,7 +233,10 @@ sub _format_amount {
my $num = join($commodity->{dchar}, commify($whole, $commodity->{gchar}), $fraction);
- $num = $commodity->{syprf} ? "$commodity->{symbol} $num" : "$num $commodity->{symbol}";
+ my $symbol = $commodity->{symbol};
+ $symbol = $self->_quote_string($symbol) if $symbol =~ /[0-9\s]/;
+
+ $num = $commodity->{syprf} ? "$symbol $num" : "$num $symbol";
return $num;
}
@@ -215,12 +255,76 @@ App::HomeBank2Ledger::Formatter::Ledger - Ledger formatter
=head1 VERSION
-version 0.003
+version 0.005
=head1 DESCRIPTION
This is a formatter for L.
+=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