skip posting payee if it matches transaction

[chaz/homebank2ledger] / lib / App / HomeBank2Ledger / Formatter / Ledger.pm

diff --git a/lib/App/HomeBank2Ledger/Formatter/Ledger.pm b/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
index 332be8ca9d6303386497d187693debf78cd0b40a..677facb02e72a5924617ca4e726424921d9497f7 100644 (file)
--- a/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
+++ b/lib/App/HomeBank2Ledger/Formatter/Ledger.pm
@@ -14,7 +14,7 @@ L<App::HomeBank2Ledger::Formatter>
 use warnings;
 use strict;
 
-use App::HomeBank2Ledger::Util qw(commify);
+use App::HomeBank2Ledger::Util qw(commify rtrim);
 
 use parent 'App::HomeBank2Ledger::Formatter';
 
@@ -25,40 +25,64 @@ my %STATUS_SYMBOLS = (
     pending => '!',
 );
 
+sub _croak { require Carp; Carp::croak(@_) }
+
 sub format {
     my $self   = shift;
     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($/, @out);
+    return join($/, map { rtrim($_) } @out);
 }
 
-sub _format_header {
+=method format_header
+
+    @lines = $formatter->format_header;
+
+Get formatted header. For example,
+
+    ; Converted from finances.xhb using homebank2ledger 0.001
+
+=cut
+
+sub format_header {
     my $self = shift;
 
     my @out;
 
-    my $file = $self->file;
-    push @out, "; Converted from $file using homebank2ledger ${VERSION}";
-
     if (my $name = $self->name) {
         push @out, "; Name: $name";
     }
 
+    my $file = $self->file;
+    push @out, "; Converted from ${file} using homebank2ledger ${VERSION}";
+
     push @out, '';
 
     return @out;
 }
 
-sub _format_accounts {
+=method format_accounts
+
+    @lines = $formatter->format_accounts($ledger);
+
+Get formatted accounts. For example,
+
+    account Assets:Bank:Credit Union:Savings
+    account Assets:Bank:Credit Union:Checking
+    ...
+
+=cut
+
+sub format_accounts {
     my $self   = shift;
     my $ledger = shift;
 
@@ -70,7 +94,21 @@ sub _format_accounts {
     return @out;
 }
 
-sub _format_commodities {
+=method format_commodities
+
+    @lines = $formatter->format_commodities($ledger);
+
+Get formattted commodities. For example,
+
+    commodity $
+        note US Dollar
+        format $  1,000.00
+        alias USD
+    ...
+
+=cut
+
+sub format_commodities {
     my $self   = shift;
     my $ledger = shift;
 
@@ -88,7 +126,18 @@ sub _format_commodities {
     return @out;
 }
 
-sub _format_payees {
+=method format_payees
+
+    @lines = $formatter->format_payees($ledger);
+
+Get formatted payees. For example,
+
+    payee 180 Tacos
+    ...
+
+=cut
+
+sub format_payees {
     my $self   = shift;
     my $ledger = shift;
 
@@ -100,7 +149,18 @@ sub _format_payees {
     return @out;
 }
 
-sub _format_tags {
+=method format_tags
+
+    @lines = $formatter->format_tags($ledger);
+
+Get formatted tags. For example,
+
+    tag yapc
+    ...
+
+=cut
+
+sub format_tags {
     my $self   = shift;
     my $ledger = shift;
 
@@ -112,7 +172,22 @@ sub _format_tags {
     return @out;
 }
 
-sub _format_transactions {
+=method 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
+
+    ...
+
+=cut
+
+sub format_transactions {
     my $self   = shift;
     my $ledger = shift;
 
@@ -133,8 +208,8 @@ sub _format_transaction {
 
     my $date        = $transaction->{date};
     my $status      = $transaction->{status};
-    my $payee       = $transaction->{payee} || 'No Payee TODO';
-    my $memo        = $transaction->{memo} || '';
+    my $payee       = $self->_format_string($transaction->{payee} || '');
+    my $memo        = $self->_format_string($transaction->{memo}  || '');
     my @postings    = @{$transaction->{postings}};
 
     my @out;
@@ -146,13 +221,16 @@ sub _format_transaction {
         if (keys(%posting_statuses) == 1) {
             my ($status) = keys %posting_statuses;
             $status_symbol = $STATUS_SYMBOLS{$status || 'none'} || '';
-            $status_symbol .= ' ' if $status_symbol;
         }
     }
 
-    my $symbol = $status_symbol ? "${status_symbol} " : '';
-    push @out, "${date} ${symbol}${payee}  ; $memo";
-    $out[-1] =~ s/\h+$//;
+    $payee =~ s/(?:  )|\t;/ ;/g;    # don't turn into a memo
+
+    push @out, sprintf('%s%s%s%s', $date,
+        $status_symbol && " ${status_symbol}",
+        $payee         && " $payee",
+        $memo          && "  ; $memo",
+    );
 
     for my $posting (@postings) {
         my @line;
@@ -168,14 +246,14 @@ sub _format_transaction {
         push @line, $self->_format_amount($posting->{amount}, $posting->{commodity}) if defined $posting->{amount};
 
         push @out, join('', @line);
-        $out[-1] =~ s/\h+$//;
 
-        if (my $payee = $posting->{payee}) {
-            push @out, "      ; Payee: $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).':';
         }
     }
 
@@ -184,12 +262,17 @@ sub _format_transaction {
     return @out;
 }
 
+sub _format_string {
+    my $self = shift;
+    my $str  = shift;
+    $str =~ s/\v//g;
+    return $str;
+}
+
 sub _format_amount {
     my $self      = shift;
     my $amount    = shift;
-    my $commodity = shift;
-
-    # _croak 'Must provide a valid currency' if !$commodity;
+    my $commodity = shift or _croak 'Must provide a valid currency';
 
     my $format = "\% .$commodity->{frac}f";
     my ($whole, $fraction) = split(/\./, sprintf($format, $amount));