=cut
+use v5.10.1; # defined-or
use warnings;
use strict;
-use App::HomeBank2Ledger::Util qw(commify);
+use App::HomeBank2Ledger::Util qw(commify rtrim);
use parent 'App::HomeBank2Ledger::Formatter';
cleared => '*',
pending => '!',
);
+my $SYMBOL = qr![^\s\d.,;:?\!\-+*/^&|=\<\>\[\]\(\)\{\}\@]+!;
+
+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,
+
+ ; Name: My Finances
+ ; File: path/to/finances.xhb
+
+=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";
}
+ if (my $file = $self->file) {
+ push @out, "; File: $file";
+ }
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;
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;
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;
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;
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;
my $account_width = $self->account_width;
- my $date = $transaction->{date};
- my $status = $transaction->{status};
- my $payee = $transaction->{payee} || 'No Payee TODO';
- my $memo = $transaction->{memo} || '';
- my @postings = @{$transaction->{postings}};
+ my $date = $transaction->{date} or _croak 'Transaction date is required';
+ my $aux_date = $transaction->{aux_date} || $transaction->{effective_date} || '';
+ my $status = $transaction->{status} // '';
+ my $code = $transaction->{code};
+ my $payee = $self->_format_string($transaction->{payee});
+ my $note = $self->_format_string($transaction->{note} // $transaction->{memo});
+ my @postings = @{$transaction->{postings} || _croak 'At least one transaction posting is required'};
my @out;
# figure out the Ledger transaction status
- my $status_symbol = $STATUS_SYMBOLS{$status || ''};
+ my $status_symbol = $STATUS_SYMBOLS{$status};
if (!$status_symbol) {
my %posting_statuses = map { ($_->{status} || '') => 1 } @postings;
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+$//;
+ $aux_date = '' if $date eq $aux_date;
+ $code =~ s/[\(\)]+// if defined $code;
+ $payee =~ s/(?: )|\t;/ ;/g if defined $payee; # don't turn into a note
+
+ my $has_code = defined $code && $code ne '';
+ my $has_payee = defined $payee && $payee ne '';
+ my $has_note = defined $note && $note ne '';
+
+ push @out, join('', $date,
+ $aux_date && "=${aux_date}",
+ $status_symbol && " ${status_symbol}",
+ $has_code && " (${code})",
+ $has_payee && " ${payee}",
+ $has_note && $has_payee && " ; ${note}",
+ );
+ if ($has_note && !$has_payee) {
+ push @out, " ; ${note}";
+ }
+
+ 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});
+ my $lot = $posting->{lot} || {};
+ if (my $lot_price = $lot->{price} // $posting->{lot_price}) {
+ my $is_fixed = $lot_price->{fixed} // $posting->{lot_fixed};
+ my $fixed_symbol = $is_fixed ? '=' : '';
+ push @line, " {${fixed_symbol}",
+ $self->_format_amount($lot_price->{amount}, $lot_price->{commodity}),
+ '}';
+ }
+ if (my $lot_date = $lot->{date} // $posting->{lot_date}) {
+ push @line, " [${lot_date}]";
+ }
+ if (my $lot_note = $self->_format_string($lot->{note} // $posting->{lot_note} // '')) {
+ $lot_note =~ s/[\(\)]+//; # cleanup
+ $lot_note =~ s/^\@+//;
+ push @line, " (${lot_note})" if $lot_note;
+ }
+ 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});
+ }
+ }
+ my $posting_date = $posting->{date} || '';
+ my $posting_aux_date = $posting->{aux_date} || '';
+ my $posting_note = $self->_format_string($posting->{note} // $posting->{memo} // '');
+ $posting_date = '' if $posting_date eq $date;
+ $posting_aux_date = '' if $posting_aux_date eq $aux_date;
+ $posting_note = '' if $has_note && $posting_note eq $note;
+ my $has_posting_note = defined $posting_note && $posting_note ne '';
+ if ($posting_date || $posting_aux_date || $has_posting_note) {
+ if ($posting_date || $posting_aux_date) {
+ $posting_note = sprintf('[%s%s]%s',
+ $posting_date,
+ $posting_aux_date && "=${posting_aux_date}",
+ $has_posting_note && " ${posting_note}",
+ );
+ }
+ push @line, " ; ${posting_note}";
+ }
push @out, join('', @line);
- $out[-1] =~ s/\h+$//;
- if (my $payee = $posting->{payee}) {
- push @out, " ; Payee: $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 = $self->_format_string($posting->{payee} // '')) {
+ push @out, " ; Payee: $posting_payee" if !$has_payee || $posting_payee ne $payee;
}
if (my @tags = @{$posting->{tags} || []}) {
- push @out, " ; :".join(':', @tags).":";
+ push @out, ' ; :'.join(':', @tags).':';
}
}
return @out;
}
+sub _format_string {
+ my $self = shift;
+ my $str = shift // return;
+ $str =~ s/\v//g;
+ return $str;
+}
+
+sub _quote_string {
+ my $self = shift;
+ my $str = shift;
+ $str =~ s/"/\\"/g;
+ return "\"$str\"";
+}
+
+sub _format_symbol {
+ my $self = shift;
+ my $str = shift;
+ return $self->_quote_string($str) if $str !~ /^${SYMBOL}$/;
+ 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));
+ $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;
+ }
- $num = $commodity->{syprf} ? "$commodity->{symbol} $num" : "$num $commodity->{symbol}";
+ my $symbol = $self->_format_symbol($commodity->{symbol});
+ $num = $commodity->{syprf} ? "$symbol $num" : "$num $symbol";
return $num;
}
projects / chaz / homebank2ledger / blobdiff