register: date display refinements

- when showing multiple postings from a transaction, show their individual dates accurately
- with --date2, use that date for sorting

hledger-lib/Hledger/Reports.hs

@@ -160,10 +160,15 @@ clearedValueFromOpts ReportOpts{..} | cleared_   = Just True
 whichDateFromOpts :: ReportOpts -> WhichDate
 whichDateFromOpts ReportOpts{..} = if date2_ then SecondaryDate else PrimaryDate
 
--- | Select a Transaction date accessor based on --date2.
+-- | Select the Transaction date accessor based on --date2.
 transactionDateFn :: ReportOpts -> (Transaction -> Day)
 transactionDateFn ReportOpts{..} = if date2_ then transactionDate2 else tdate
 
+-- | Select the Posting date accessor based on --date2.
+postingDateFn :: ReportOpts -> (Posting -> Day)
+postingDateFn ReportOpts{..} = if date2_ then postingDate2 else postingDate
+
+
 -- | Convert this journal's postings' amounts to the cost basis amounts if
 -- specified by options.
 journalSelectingAmountFromOpts :: ReportOpts -> Journal -> Journal
@@ -244,9 +249,10 @@ tests_entriesReport = [
 type PostingsReport = (String               -- label for the running balance column XXX remove
                       ,[PostingsReportItem] -- line items, one per posting
                       )
-type PostingsReportItem = (Maybe (Day, String) -- posting date and description if this is the first posting
+type PostingsReportItem = (Maybe Day    -- posting date, if this is the first posting in a transaction or if it's different from the previous posting's date
-                          ,Posting             -- the posting, possibly with account name depth-clipped
+                          ,Maybe String -- transaction description, if this is the first posting in a transaction
-                          ,MixedAmount         -- the running total after this posting
+                          ,Posting      -- the posting, possibly with account name depth-clipped
+                          ,MixedAmount  -- the running total after this posting
                           )
 
 -- | Select postings from the journal and add running balance and other
@@ -261,7 +267,7 @@ postingsReport opts q j = -- trace ("q: "++show q++"\nq': "++show q') $
       wd = whichDateFromOpts opts
       -- delay depth filtering until the end
       (depth, q') = (queryDepth q, filterQuery (not . queryIsDepth) q)
-      (precedingps, displayableps, _) =   dbg "ps4" $ postingsMatchingDisplayExpr displayexpr
+      (precedingps, displayableps, _) =   dbg "ps4" $ postingsMatchingDisplayExpr displayexpr opts
                                         $ dbg "ps3" $ (if related_ opts then concatMap relatedPostings else id)
                                         $ dbg "ps2" $ filter (q' `matchesPosting`)
                                         $ dbg "ps1" $ journalPostings j'
@@ -280,7 +286,7 @@ postingsReport opts q j = -- trace ("q: "++show q++"\nq': "++show q') $
       periodspan = queryDateSpan secondarydate q
       secondarydate = whichDateFromOpts opts == SecondaryDate
       displayspan = postingsDateSpan ps
-          where (_,ps,_) = postingsMatchingDisplayExpr displayexpr $ journalPostings j'
+          where (_,ps,_) = postingsMatchingDisplayExpr displayexpr opts $ journalPostings j'
       matchedspan = postingsDateSpan displayableps
       reportspan | empty     = requestedspan `orDatesFrom` journalspan
                  | otherwise = requestedspan `spanIntersect` matchedspan
@@ -294,29 +300,32 @@ postingsReportItems :: [Posting] -> Posting -> WhichDate -> Int -> MixedAmount -
 postingsReportItems [] _ _ _ _ _ = []
 postingsReportItems (p:ps) pprev wd d b sumfn = i:(postingsReportItems ps p wd d b' sumfn)
     where
-      i = mkpostingsReportItem isfirstintxn wd p' b'
+      i = mkpostingsReportItem showdate showdesc wd p' b'
-      p' = p{paccount=clipAccountName d $ paccount p}
+      showdate = isfirstintxn || isdifferentdate
+      showdesc = isfirstintxn
       isfirstintxn = ptransaction p /= ptransaction pprev
+      isdifferentdate = case wd of PrimaryDate   -> postingDate p  /= postingDate pprev
+                                   SecondaryDate -> postingDate2 p /= postingDate2 pprev
+      p' = p{paccount=clipAccountName d $ paccount p}
       b' = b `sumfn` pamount p
 
--- | Generate one postings report line item, given a flag indicating
+-- | Generate one postings report line item, containing the posting,
--- whether to include transaction info, the posting, and the current
+-- the current running balance, and optionally the posting date and/or
--- running balance.
+-- the transaction description.
-mkpostingsReportItem :: Bool -> WhichDate -> Posting -> MixedAmount -> PostingsReportItem
+mkpostingsReportItem :: Bool -> Bool -> WhichDate -> Posting -> MixedAmount -> PostingsReportItem
-mkpostingsReportItem False _ p b = (Nothing, p, b)
+mkpostingsReportItem showdate showdesc wd p b = (if showdate then Just date else Nothing, if showdesc then Just desc else Nothing, p, b)
-mkpostingsReportItem True wd p b = (Just (date,desc), p, b)
     where
-      date = case wd of PrimaryDate    -> postingDate p
+      date = case wd of PrimaryDate   -> postingDate p
                         SecondaryDate -> postingDate2 p
       desc = maybe "" tdescription $ ptransaction p
 
 -- | Date-sort and split a list of postings into three spans - postings matched
 -- by the given display expression, and the preceding and following postings.
 -- XXX always sorts by primary date, should sort by secondary date if expression is about that
-postingsMatchingDisplayExpr :: Maybe String -> [Posting] -> ([Posting],[Posting],[Posting])
+postingsMatchingDisplayExpr :: Maybe String -> ReportOpts -> [Posting] -> ([Posting],[Posting],[Posting])
-postingsMatchingDisplayExpr d ps = (before, matched, after)
+postingsMatchingDisplayExpr d opts ps = (before, matched, after)
     where
-      sorted = sortBy (comparing postingDate) ps
+      sorted = sortBy (comparing (postingDateFn opts)) ps
       (before, rest) = break (displayExprMatches d) sorted
       (matched, after) = span (displayExprMatches d) rest
 

hledger/Hledger/Cli/Register.hs

@@ -52,7 +52,7 @@ tests_postingsReportAsText = [
 -- date and description are shown for the first posting of a transaction only.
 -- @
 postingsReportItemAsText :: CliOpts -> PostingsReportItem -> String
-postingsReportItemAsText opts (dd, p, b) =
+postingsReportItemAsText opts (mdate, mdesc, p, b) =
   concatTopPadded [date, "  ", desc, "  ", acct, "  ", amt, "  ", bal]
     where
       totalwidth = case widthFromOpts opts of
@@ -68,11 +68,8 @@ postingsReportItemAsText opts (dd, p, b) =
                              | otherwise = (r', r'+1)
         where r = remaining - 2
               r' = r `div` 2
-      (date, desc) = case dd of
+      date = maybe (replicate datewidth ' ') (printf ("%-"++show datewidth++"s") . showDate) mdate
-        Just (da, de) -> (printf ("%-"++show datewidth++"s") (showDate da)
+      desc = maybe (replicate descwidth ' ') (printf ("%-"++show descwidth++"s") . take descwidth . elideRight descwidth) mdesc
-                         ,printf ("%-"++show descwidth++"s") (take descwidth $ elideRight descwidth de :: String)
-                         )
-        Nothing -> (replicate datewidth ' ', replicate descwidth ' ')
       acct = printf ("%-"++(show acctwidth)++"s") a
         where
           a = bracket $ elideAccountName awidth $ paccount p