register: report intervals now include all postings in the interval

As with balance. For example, register -p 'weekly in jan' generates
these intervals: 2013/12/30-2014/01/05, 2014/01/06-2014/01/12,
2014/01/13-2014/01/19, 2014/01/20-2014/01/26, 2014/01/27-2014/02/02.
With this change, postings on 2013/12/30-31 and 2014/2/1-2 will be
included in the report, so all period totals are complete and
comparable.

hledger-lib/Hledger/Reports/PostingsReport.hs

@@ -21,7 +21,7 @@ import Data.List
 import Data.Maybe
 import Data.Ord
 import Data.Time.Calendar
-import Safe ({- headDef, -} headMay, lastMay)
+import Safe (headMay, lastMay)
 import Test.HUnit
 import Text.ParserCombinators.Parsec
 import Text.Printf
@@ -47,49 +47,42 @@ type PostingsReportItem = (Maybe Day    -- posting date, if this is the first po
 -- | Select postings from the journal and add running balance and other
 -- information to make a postings report. Used by eg hledger's register command.
 postingsReport :: ReportOpts -> Query -> Journal -> PostingsReport
-postingsReport opts q j = -- trace ("q: "++show q++"\nq': "++show q') $
+postingsReport opts q j = (totallabel, items)
-                          (totallabel, postingsReportItems ps nullposting wd depth startbal runningcalcfn 1)
     where
-      ps | interval == NoInterval = displayableps
+      -- figure out adjusted queries & spans like multiBalanceReport
-         | otherwise              = summarisePostingsByInterval interval wd depth empty reportspan displayableps
+      symq = dbg "symq"   $ filterQuery queryIsSym $ dbg "requested q" q
-      j' = journalSelectingAmountFromOpts opts j
+      depth = queryDepth q
-      wd = whichDateFromOpts opts
+      depthless = filterQuery (not . queryIsDepth)
-      -- delay depth filtering until the end
+      dateless = filterQuery (not . queryIsDate)
-      (depth, q') = (queryDepth q, filterQuery (not . queryIsDepth) q)
+      -- precedingq = dbg "precedingq" $ And [datelessq, Date $ DateSpan Nothing (spanStart reportspan)]
-      (precedingps, displayableps, _) =
+      requestedspan  = dbg "requestedspan"  $ queryDateSpan (date2_ opts) q                              -- span specified by -b/-e/-p options and query args
-          dbg "ps5" $
+      requestedspan' = dbg "requestedspan'" $ requestedspan `spanDefaultsFrom` journalDateSpan j         -- if open-ended, close it using the journal's end dates
-          postingsMatchingDisplayExpr displayexpr opts $ -- filter and group by the -d display expression
+      intervalspans  = dbg "intervalspans"  $ splitSpan (intervalFromOpts opts) requestedspan'           -- interval spans enclosing it
-          dbg "ps4" $
+      reportspan     = dbg "reportspan"     $ DateSpan (maybe Nothing spanStart $ headMay intervalspans) -- the requested span enlarged to a whole number of intervals
-          map (filterPostingAmount (filterQuery queryIsSym q)) $ -- remove amount parts which the query's sym: terms would exclude
+                                                       (maybe Nothing spanEnd   $ lastMay intervalspans)
-          dbg "ps3" $
+      reportq    = dbg "reportq" $ depthless $ And [dateless q, Date reportspan] -- user's query enlarged to whole intervals and with no depth limit
-          (if related_ opts then concatMap relatedPostings else id) $ -- with --related, replace each with its sibling postings
-          dbg "ps2" $ 
-          filter (q' `matchesPosting`) $ -- filter postings by the query, ignoring depth
-          dbg "ps1" $ 
-          journalPostings j'
 
-      -- to debug just this function without the noise of --debug, uncomment:
+      (precedingps, displayableps, _) =
-      -- dbg :: Show a => String -> a -> a
+          dbg "ps5" $ postingsMatchingDisplayExpr displayexpr opts $              -- filter and group by the -d display expression
-      -- dbg = lstrace
+          dbg "ps4" $ map (filterPostingAmount symq) $                            -- remove amount parts which the query's sym: terms would exclude
+          dbg "ps3" $ (if related_ opts then concatMap relatedPostings else id) $ -- with -r, replace each with its sibling postings
+          dbg "ps2" $ filter (reportq `matchesPosting`) $                         -- filter postings by the query, ignoring depth
+          dbg "ps1" $ journalPostings $ journalSelectingAmountFromOpts opts j
 
       empty = queryEmpty q
       displayexpr = display_ opts  -- XXX
       interval = intervalFromOpts opts -- XXX
-      journalspan = journalDateSpan j'
+
-      -- requestedspan should be the intersection of any span specified
+      whichdate = whichDateFromOpts opts
-      -- with period options and any span specified with display option.
+      ps | interval == NoInterval = displayableps
-      -- The latter is not easily available, fake it for now.
+         | otherwise              = summarisePostingsByInterval interval whichdate depth empty reportspan displayableps
-      requestedspan = periodspan `spanIntersect` displayspan
-      periodspan = queryDateSpan secondarydate q
-      secondarydate = wd == SecondaryDate
-      displayspan = postingsDateSpan ps
-          where (_,ps,_) = postingsMatchingDisplayExpr displayexpr opts $ journalPostings j'
-      matchedspan = postingsDateSpan displayableps
-      reportspan | empty     = requestedspan `spanDefaultsFrom` journalspan
-                 | otherwise = requestedspan `spanIntersect` matchedspan
       startbal = sumPostings precedingps
       runningcalcfn | average_ opts = \i avg amt -> avg + (amt - avg) `divideMixedAmount` (fromIntegral i)
                     | otherwise     = \_ bal amt -> bal + amt
+      items = postingsReportItems ps nullposting whichdate depth startbal runningcalcfn 1
+
+      dbg s = let p = "postingsReport" in Hledger.Utils.dbg (p++" "++s)  -- add prefix in debug output
+      -- dbg = const id  -- exclude from debug output
 
 totallabel = "Total"
 

tests/register-intervals.test

@@ -80,3 +80,21 @@ hledgerdev -f- register --monthly --date2
 2014/01/01 - 2014/01/31         a                                1             1
                                 b                                1             2
 >>>=0
+
+# 7. All matched postings in the displayed intervals should be reported on.
+hledgerdev -f- register -p 'monthly 2014/1/10-2014/2/20'
+<<<
+2014/1/5
+ (before)  1
+
+2014/2/1
+ (within)  1
+
+2014/2/25
+ (after)  1
+
+>>>
+2014/01/01 - 2014/01/31         before                           1             1
+2014/02/01 - 2014/02/28         after                            1             2
+                                within                           1             3
+>>>=0