feat: comments stay attached to each part of transaction

Comments will flow through and stay attached to the payee
or account they where attached to in the file, and printing keeps
the comments in same location. No longer bunch comments to before
the transaction.

Author: howeyc

ledger/cmd/print.go

@@ -144,14 +144,26 @@ func WriteTransaction(w io.Writer, trans *ledger.Transaction, columns int) {
 		return trans.AccountChanges[i].Name < trans.AccountChanges[j].Name
 	})
 
-	fmt.Fprintf(w, "%s %s\n", trans.Date.Format(transactionDateFormat), trans.Payee)
+	fmt.Fprintf(w, "%s %s", trans.Date.Format(transactionDateFormat), trans.Payee)
+	if len(trans.PayeeComment) > 0 {
+		spaceCount := columns - 10 - utf8.RuneCountInString(trans.Payee)
+		if spaceCount < 1 {
+			spaceCount = 1
+		}
+		fmt.Fprintf(w, "%s%s", strings.Repeat(" ", spaceCount), trans.PayeeComment)
+	}
+	fmt.Fprintln(w, "")
 	for _, accChange := range trans.AccountChanges {
 		outBalanceString := accChange.Balance.StringFixedBank()
 		spaceCount := columns - 4 - utf8.RuneCountInString(accChange.Name) - utf8.RuneCountInString(outBalanceString)
 		if spaceCount < 1 {
 			spaceCount = 1
 		}
-		fmt.Fprintf(w, "    %s%s%s\n", accChange.Name, strings.Repeat(" ", spaceCount), outBalanceString)
+		fmt.Fprintf(w, "    %s%s%s", accChange.Name, strings.Repeat(" ", spaceCount), outBalanceString)
+		if len(accChange.Comment) > 0 {
+			fmt.Fprintf(w, " %s", accChange.Comment)
+		}
+		fmt.Fprintln(w, "")
 	}
 	fmt.Fprintln(w, "")
 }

parse.go

@@ -97,15 +97,19 @@ func parseLedger(filename string, ledgerReader io.Reader, callback func(t *Trans
 		trimmedLine := strings.TrimSpace(line)
 		lp.lineCount++
 
+		var currentComment string
 		// handle comments
 		if commentIdx := strings.Index(trimmedLine, ";"); commentIdx >= 0 {
-			lp.comments = append(lp.comments, trimmedLine[commentIdx:])
+			currentComment = trimmedLine[commentIdx:]
 			trimmedLine = trimmedLine[:commentIdx]
 			trimmedLine = strings.TrimSpace(trimmedLine)
 		}
 
 		// Skip empty lines
 		if len(trimmedLine) == 0 {
+			if len(currentComment) > 0 {
+				lp.comments = append(lp.comments, currentComment)
+			}
 			continue
 		}
 
@@ -115,6 +119,9 @@ func parseLedger(filename string, ledgerReader io.Reader, callback func(t *Trans
 				fmt.Errorf("Unable to parse payee line: %s", line))) {
 				return true
 			}
+			if len(currentComment) > 0 {
+				lp.comments = append(lp.comments, currentComment)
+			}
 			continue
 		}
 		switch before {
@@ -138,7 +145,7 @@ func parseLedger(filename string, ledgerReader io.Reader, callback func(t *Trans
 				}
 			}
 		default:
-			trans, transErr := lp.parseTransaction(before, after)
+			trans, transErr := lp.parseTransaction(before, after, currentComment)
 			if transErr != nil {
 				if callback(nil, fmt.Errorf("%s:%d: Unable to parse transaction: %w", lp.filename, lp.lineCount, transErr)) {
 					return true
@@ -189,12 +196,12 @@ func (lp *parser) parseDate(dateString string) (transDate time.Time, err error)
 	return
 }
 
-func (lp *parser) parseTransaction(dateString, payeeString string) (trans *Transaction, err error) {
+func (lp *parser) parseTransaction(dateString, payeeString, payeeComment string) (trans *Transaction, err error) {
 	transDate, derr := lp.parseDate(dateString)
 	if derr != nil {
 		return nil, derr
 	}
-	trans = &Transaction{Payee: payeeString, Date: transDate}
+	trans = &Transaction{Payee: payeeString, Date: transDate, PayeeComment: payeeComment}
 
 	var line string
 	for lp.scanner.Scan() {
@@ -203,12 +210,14 @@ func (lp *parser) parseTransaction(dateString, payeeString string) (trans *Trans
 		trimmedLine := strings.TrimSpace(line)
 		lp.lineCount++
 
+		var currentComment string
 		// handle comments
 		if commentIdx := strings.Index(trimmedLine, ";"); commentIdx >= 0 {
-			lp.comments = append(lp.comments, trimmedLine[commentIdx:])
+			currentComment = trimmedLine[commentIdx:]
 			trimmedLine = trimmedLine[:commentIdx]
 			trimmedLine = strings.TrimSpace(trimmedLine)
 			if len(trimmedLine) == 0 {
+				lp.comments = append(lp.comments, currentComment)
 				continue
 			}
 		}
@@ -225,6 +234,7 @@ func (lp *parser) parseTransaction(dateString, payeeString string) (trans *Trans
 
 		var accChange Account
 		accChange.Name = trimmedLine
+		accChange.Comment = currentComment
 		if i := strings.LastIndexFunc(trimmedLine, unicode.IsSpace); i >= 0 {
 			acc := strings.TrimSpace(trimmedLine[:i])
 			amt := trimmedLine[i+1:]

parse_test.go

@@ -214,14 +214,16 @@ var testCases = []testCase{
 	},
 	{
 		"comment after payee",
-		`1970-01-01 Payee      ; payee comment
+		`; before trans
+1970-01-01 Payee      ; payee comment
 	Expense/test  123
 	Assets
 `,
 		[]*Transaction{
 			{
-				Payee: "Payee",
-				Date:  time.Unix(0, 0).UTC(),
+				Payee:        "Payee",
+				Date:         time.Unix(0, 0).UTC(),
+				PayeeComment: "; payee comment",
 				AccountChanges: []Account{
 					{
 						Name:    "Expense/test",
@@ -233,7 +235,7 @@ var testCases = []testCase{
 					},
 				},
 				Comments: []string{
-					"; payee comment",
+					"; before trans",
 				},
 			},
 		},
@@ -287,6 +289,7 @@ var testCases = []testCase{
 					{
 						Name:    "Assets",
 						Balance: decimal.NewFromFloat(-58),
+						Comment: "; comment in trans",
 					},
 					{
 						Name:    "Expense/unbalanced",
@@ -295,7 +298,6 @@ var testCases = []testCase{
 				},
 				Comments: []string{
 					"; comment",
-					"; comment in trans",
 				},
 			},
 		},

types.go

@@ -10,15 +10,17 @@ import (
 type Account struct {
 	Name    string
 	Balance decimal.Decimal
+	Comment string
 }
 
 // Transaction is the basis of a ledger. The ledger holds a list of transactions.
 // A Transaction has a Payee, Date (with no time, or to put another way, with
 // hours,minutes,seconds values that probably doesn't make sense), and a list of
 // Account values that hold the value of the transaction for each account.
 type Transaction struct {
-	Payee          string
 	Date           time.Time
+	Payee          string
+	PayeeComment   string
 	AccountChanges []Account
 	Comments       []string
 }