cli: support for new layout bare-wide

Author: thielema

hledger-lib/Hledger/Reports/ReportOptions.hs

@@ -124,6 +124,7 @@ instance Default AccountListMode where def = ALFlat
 data Layout = LayoutWide (Maybe Int)
             | LayoutTall
             | LayoutBare
+            | LayoutBareWide
             | LayoutTidy
   deriving (Eq, Show)
 
@@ -432,6 +433,7 @@ layoutopt rawopts = fromMaybe (LayoutWide Nothing) $ layout <|> column
                      , ("tall", LayoutTall)
                      , ("bare", LayoutBare)
                      , ("tidy", LayoutTidy)
+                     , ("bare-wide", LayoutBareWide)
                      ]
         -- For `--layout=elided,n`, elide to the given width
         (s,n) = break (==',') $ map toLower opt
@@ -440,7 +442,7 @@ layoutopt rawopts = fromMaybe (LayoutWide Nothing) $ layout <|> column
               c | Just w' <- readMay c -> Just w'
               _ -> usageError "width in --layout=wide,WIDTH must be an integer"
 
-        err = usageError "--layout's argument should be \"wide[,WIDTH]\", \"tall\", \"bare\", or \"tidy\""
+        err = usageError "--layout's argument should be \"wide[,WIDTH]\", \"tall\", \"bare\", \"bare-wide\", or \"tidy\""
 
 -- Get the period specified by any -b/--begin, -e/--end and/or -p/--period
 -- options appearing in the command line.

hledger/Hledger/Cli/Commands/Balance.hs

@@ -308,7 +308,7 @@ import Hledger.Write.Ods (printFods)
 import Hledger.Write.Html (Html, styledTableHtml, htmlAsLazyText, toHtml)
 import Hledger.Write.Spreadsheet (rawTableContent, headerCell,
             addHeaderBorders, addRowSpanHeader,
-            cellFromMixedAmount, cellsFromMixedAmount)
+            cellFromMixedAmount, cellsFromMixedAmount, cellFromAmount)
 import Hledger.Write.Spreadsheet qualified as Ods
 
 
@@ -635,6 +635,9 @@ renderComponent topaligned oneline opts (acctname, dep, total) (FormatField ljus
                   }
 
 
+headerWithoutBorders :: [Ods.Cell () text] -> [Ods.Cell Ods.NumLines text]
+headerWithoutBorders = map (\c -> c {Ods.cellBorder = Ods.noBorder})
+
 simpleDateSpanCell :: PeriodTitles -> DateSpan -> Ods.Cell Ods.NumLines Text
 simpleDateSpanCell ph = Ods.defaultCell . renderPeriodHeading ph
 
@@ -663,8 +666,11 @@ balanceReportAsSpreadsheet fmt opts (items, total) =
     headers =
       addHeaderBorders $ map headerCell $
       "account" : case layout_ opts of
+        LayoutBareWide -> allCommodities
         LayoutBare -> ["commodity", "balance"]
         _          -> ["balance"]
+    allCommodities =
+        S.toAscList $ foldMap (\(_,_,_,ma) -> maCommodities ma) items
     rows ::
         RowClass -> BalanceReportItem ->
         [[Ods.Cell Ods.NumLines Text]]
@@ -678,6 +684,15 @@ balanceReportAsSpreadsheet fmt opts (items, total) =
                 Value -> renderBalanceAcct opts nbsp (name, dispName, dep) in
       addRowSpanHeader accountCell $
       case layout_ opts of
+      LayoutBareWide ->
+          let bopts =
+                machineFmt {
+                    displayCommodity = False,
+                    displayCommodityOrder = Just allCommodities
+                } in
+          [map (\bldAmt ->
+                fmap wbToText $ cellFromAmount bopts (amountClass rc, bldAmt)) $
+              showMixedAmountLinesPartsB bopts ma]
       LayoutBare ->
           map (\a -> [cell $ acommodity a, renderAmount rc $ mixedAmount a])
           . amounts $ mixedAmountStripCosts ma
@@ -701,29 +716,41 @@ balanceReportAsSpreadsheet fmt opts (items, total) =
 multiBalanceReportAsCsv :: ReportOpts -> MultiBalanceReport -> CSV
 multiBalanceReportAsCsv opts@ReportOpts{..} report =
     (if transpose_ then transpose else id) $
-    rawTableContent $ header : body ++ totals
+    rawTableContent $ header ++ body ++ totals
   where
     (header, body, totals) =
-        multiBalanceReportAsSpreadsheetParts machineFmt opts report
+        multiBalanceReportAsSpreadsheetParts machineFmt opts
+            (allCommoditiesFromPeriodicReport $ prRows report) report
 
 -- | Render the Spreadsheet table rows (CSV, ODS, HTML) for a MultiBalanceReport.
 -- Returns the heading row, 0 or more body rows, and the totals row if enabled.
 multiBalanceReportAsSpreadsheetParts ::
-    AmountFormat -> ReportOpts -> MultiBalanceReport ->
-    ([Ods.Cell Ods.NumLines Text],
+    AmountFormat -> ReportOpts ->
+    [CommoditySymbol] -> MultiBalanceReport ->
+    ([[Ods.Cell Ods.NumLines Text]],
      [[Ods.Cell Ods.NumLines Text]],
      [[Ods.Cell Ods.NumLines Text]])
-multiBalanceReportAsSpreadsheetParts fmt opts@ReportOpts{..} (PeriodicReport colspans items tr) =
-    (headers, concatMap fullRowAsTexts items, addTotalBorders totalrows)
+multiBalanceReportAsSpreadsheetParts fmt opts@ReportOpts{..}
+  allCommodities (PeriodicReport colspans items tr) =
+    (allHeaders, concatMap fullRowAsTexts items, addTotalBorders totalrows)
   where
     accountCell label =
         (Ods.defaultCell label) {Ods.cellClass = Ods.Class "account"}
     hCell cls label = (headerCell label) {Ods.cellClass = Ods.Class cls}
+    allHeaders =
+      case layout_ of
+      LayoutBareWide ->
+          [headerWithoutBorders $
+              Ods.emptyCell :
+              concatMap (Ods.horizontalSpan allCommodities) dateHeaders,
+           headers]
+      _ -> [headers]
     headers =
       addHeaderBorders $
       hCell "account" "account" :
       case layout_ of
       LayoutTidy -> map headerCell tidyColumnLabels
+      LayoutBareWide -> dateHeaders >> map headerCell allCommodities
       LayoutBare -> headerCell "commodity" : dateHeaders
       _          -> dateHeaders
     dateHeaders =
@@ -744,7 +771,7 @@ multiBalanceReportAsSpreadsheetParts fmt opts@ReportOpts{..} (PeriodicReport col
                 rowAsText Total (simpleDateSpanCell period_titles_) tr
     rowAsText rc dsCell =
         map (map (fmap wbToText)) .
-        multiBalanceRowAsCellBuilders fmt opts colspans rc dsCell
+        multiBalanceRowAsCellBuilders fmt opts colspans allCommodities rc dsCell
 
 tidyColumnLabels :: [Text]
 tidyColumnLabels =
@@ -764,10 +791,12 @@ multiBalanceReportAsSpreadsheet ::
   ((Int, Int), [[Ods.Cell Ods.NumLines Text]])
 multiBalanceReportAsSpreadsheet ropts mbr =
   let (header,body,total) =
-            multiBalanceReportAsSpreadsheetParts oneLineNoCostFmt ropts mbr
+            multiBalanceReportAsSpreadsheetParts oneLineNoCostFmt ropts
+                (allCommoditiesFromPeriodicReport $ prRows mbr) mbr
   in  (if transpose_ ropts then swap *** Ods.transpose else id) $
-      ((1, case layout_ ropts of LayoutWide _ -> 1; _ -> 0),
-            header : body ++ total)
+      ((case layout_ ropts of LayoutBareWide -> 2; _ -> 1,
+        case layout_ ropts of LayoutWide _ -> 1; _ -> 0),
+            header ++ body ++ total)
 
 
 -- | Render a multi-column balance report as plain text suitable for console output.
@@ -839,10 +868,20 @@ multiBalanceReportAsTable opts@ReportOpts{summary_only_, average_, balanceaccum_
      (Group multiColumnTableInterColumnBorder $ map Header colheadings)
      (concat rows)
   where
-    colheadings = ["Commodity" | layout_ opts == LayoutBare]
-                  ++ (if not summary_only_ then map (reportPeriodName (period_titles_ opts) balanceaccum_ spans) spans else [])
-                  ++ ["  Total" | multiBalanceHasTotalsColumn opts]
-                  ++ ["Average" | average_]
+    colheadings =
+      ["Commodity" | layout_ opts == LayoutBare]
+      ++ (if not summary_only_
+            then
+                let spanNames =
+                        map (reportPeriodName (period_titles_ opts) balanceaccum_ spans) spans in
+                case layout_ opts of
+                    LayoutBareWide ->
+                        liftA2 (\s c -> T.concat [s, " (", c, ")"]) spanNames allCommodities
+                    _ -> spanNames
+            else [])
+      ++ ["  Total" | multiBalanceHasTotalsColumn opts]
+      ++ ["Average" | average_]
+    allCommodities = allCommoditiesFromPeriodicReport items
     (accts, rows) = unzip $ fmap fullRowAsTexts items'
       where
         isLeaf rs row = not $ any (\r -> T.isPrefixOf (displayFull (prrName row) <> ":") (displayFull (prrName r))) rs
@@ -851,12 +890,12 @@ multiBalanceReportAsTable opts@ReportOpts{summary_only_, average_, balanceaccum_
                  else items
         fullRowAsTexts row = (replicate (length rs) (renderacct row), rs)
           where
-            rs = multiBalanceRowAsText opts row
+            rs = multiBalanceRowAsText opts allCommodities row
             renderacct row' = renderPeriodicAcct opts " " row'
     addtotalrow
       | no_total_ opts = id
       | otherwise =
-        let totalrows = multiBalanceRowAsText opts tr
+        let totalrows = multiBalanceRowAsText opts allCommodities tr
             rowhdrs = Group NoLine $ map Header $ totalRowHeadingText : replicate (length totalrows - 1) ""
             colhdrs = Header [] -- unused, concatTables will discard
         in (flip (concatTables SingleLine) $ Table rowhdrs colhdrs totalrows)
@@ -865,12 +904,17 @@ multiBalanceReportAsTable opts@ReportOpts{summary_only_, average_, balanceaccum_
     multiColumnTableInterRowBorder    = NoLine
     multiColumnTableInterColumnBorder = if pretty_ opts then SingleLine else NoLine
 
+allCommoditiesFromPeriodicReport ::
+    [PeriodicReportRow a MixedAmount] -> [CommoditySymbol]
+allCommoditiesFromPeriodicReport =
+    S.toAscList . foldMap (foldMap maCommodities . prrAmounts)
+
 multiBalanceRowAsCellBuilders ::
-    AmountFormat -> ReportOpts -> [DateSpan] ->
+    AmountFormat -> ReportOpts -> [DateSpan] -> [CommoditySymbol] ->
     RowClass -> (DateSpan -> Ods.Cell Ods.NumLines Text) ->
     PeriodicReportRow a MixedAmount ->
     [[Ods.Cell Ods.NumLines WideBuilder]]
-multiBalanceRowAsCellBuilders bopts ropts@ReportOpts{..} colspans
+multiBalanceRowAsCellBuilders bopts ropts@ReportOpts{..} colspans allCommodities
       rc renderDateSpanCell (PeriodicReportRow _acct as rowtot rowavg) =
     case layout_ of
       LayoutWide width -> [fmap (cellFromMixedAmount bopts{displayMaxWidth=width}) clsamts]
@@ -881,6 +925,8 @@ multiBalanceRowAsCellBuilders bopts ropts@ReportOpts{..} colspans
                            . transpose                         -- each row becomes a list of Text quantities
                            . map (cellsFromMixedAmount bopts{displayCommodity=False, displayCommodityOrder=Just cs, displayMinWidth=Nothing})
                            $ clsamts
+      LayoutBareWide   -> [concatMap (cellsFromMixedAmount bopts{displayCommodity=False, displayCommodityOrder=Just allCommodities, displayMinWidth=Nothing})
+                            $ clsamts]
       LayoutTidy       -> concat
                            . zipWith (map . addDateColumns) colspans
                            . map ( zipWith (\c a -> [wbCell c, a]) cs
@@ -923,16 +969,20 @@ multiBalanceHasTotalsColumn :: ReportOpts -> Bool
 multiBalanceHasTotalsColumn ropts =
     row_total_ ropts && balanceaccum_ ropts `notElem` [Cumulative, Historical]
 
-multiBalanceRowAsText :: ReportOpts -> PeriodicReportRow a MixedAmount -> [[WideBuilder]]
-multiBalanceRowAsText opts =
+multiBalanceRowAsText ::
+    ReportOpts -> [CommoditySymbol] -> PeriodicReportRow a MixedAmount -> [[WideBuilder]]
+multiBalanceRowAsText opts allCommodities =
     rawTableContent .
-    multiBalanceRowAsCellBuilders oneLineNoCostFmt{displayColour=color_ opts} opts []
+    multiBalanceRowAsCellBuilders oneLineNoCostFmt{displayColour=color_ opts}
+        opts [] allCommodities
         Value (simpleDateSpanCell $ period_titles_ opts)
 
-multiBalanceRowAsCsvText :: ReportOpts -> [DateSpan] -> PeriodicReportRow a MixedAmount -> [[T.Text]]
-multiBalanceRowAsCsvText opts colspans =
+multiBalanceRowAsCsvText ::
+    ReportOpts -> [DateSpan] -> [CommoditySymbol] ->
+    PeriodicReportRow a MixedAmount -> [[T.Text]]
+multiBalanceRowAsCsvText opts colspans allCommodities =
     map (map (wbToText . Ods.cellContent)) .
-    multiBalanceRowAsCellBuilders machineFmt opts colspans
+    multiBalanceRowAsCellBuilders machineFmt opts colspans allCommodities
         Value (simpleDateSpanCell $ period_titles_ opts)
 
 

hledger/Hledger/Cli/CompoundBalanceCommand.hs

@@ -22,6 +22,7 @@ import Data.List.NonEmpty (NonEmpty((:|)))
 import Data.Maybe (fromMaybe, mapMaybe, maybeToList)
 import Safe (atMay)
 import Data.Map qualified as Map
+import Data.Set qualified as Set
 import Data.List qualified as List
 import Data.List.NonEmpty qualified as NonEmpty
 import Data.Text qualified as T
@@ -310,12 +311,14 @@ compoundBalanceReportAsText ropts (CompoundPeriodicReport title _colspans subrep
           --   [COL1LINE1, COL2LINE1]
           --   [COL1LINE2, COL2LINE2]
           --  ]
-          coltotalslines = multiBalanceRowAsText ropts totalsrow
+          coltotalslines = multiBalanceRowAsText ropts allCommodities totalsrow
           totalstable = Table
             (Group NoLine $ map Header $ "Net:" : replicate (length coltotalslines - 1) "")  -- row headers
             (Header [])     -- column headers, concatTables will discard these
             coltotalslines  -- cell values         
 
+    allCommodities = allCommoditiesFromSubreports subreports
+
     -- | Convert a named multi balance report to a table suitable for
     -- concatenating with others to make a compound balance report table.
     -- An empty subreport title is omitted entirely (no title row above the data).
@@ -387,14 +390,24 @@ compoundBalanceReportAsSpreadsheet fmt accountLabel maybeBlank ropts cbr =
           _ -> []
     dataHeaders =
       (guard (layout_ ropts /= LayoutTidy) >>) $
-      map (Spr.headerCell . reportPeriodName (period_titles_ ropts) (balanceaccum_ ropts) colspans)
-      (if not (summary_only_ ropts) then colspans else []) ++
-      (guard (multiBalanceHasTotalsColumn ropts) >> [Spr.headerCell "Total"]) ++
-      (guard (average_   ropts) >> [Spr.headerCell "Average"])
+      map
+        (dataHeaderCell .
+            reportPeriodName
+                (period_titles_ ropts) (balanceaccum_ ropts) colspans)
+        (if not (summary_only_ ropts) then colspans else []) ++
+      (guard (multiBalanceHasTotalsColumn ropts) >> [dataHeaderCell "Total"]) ++
+      (guard (average_   ropts) >> [dataHeaderCell "Average"])
+    dataHeaderCell label =
+      (Spr.headerCell label) {Spr.cellSpan = Spr.SpanHorizontal numSubColumns}
     headerrow = leadingHeaders ++ dataHeaders
 
     blankrow =
       fmap (Spr.horizontalSpan headerrow . Spr.defaultCell) maybeBlank
+    numSubColumns =
+        case layout_ ropts of
+            LayoutBareWide -> length allCommodities
+            _ -> 1
+    allCommodities = allCommoditiesFromSubreports subreports
 
     -- Make rows for a subreport: its title row, not the headings row,
     -- the data rows, any totals row, and a blank row for whitespace.
@@ -403,15 +416,20 @@ compoundBalanceReportAsSpreadsheet fmt accountLabel maybeBlank ropts cbr =
     subreportrows (subreporttitle, mbr, _increasestotal) =
       let
         (_, bodyrows, mtotalsrows) =
-          multiBalanceReportAsSpreadsheetParts fmt ropts mbr
+          multiBalanceReportAsSpreadsheetParts fmt ropts allCommodities mbr
+        accountCell =
+            (Spr.defaultCell subreporttitle) {
+                Spr.cellStyle = Spr.Body Spr.Total,
+                Spr.cellClass = Spr.Class "account"
+            }
         titleRows
           | T.null subreporttitle = []
           | otherwise =
-              [Spr.horizontalSpan headerrow
-                ((Spr.defaultCell subreporttitle){
-                    Spr.cellStyle = Spr.Body Spr.Total,
-                    Spr.cellClass = Spr.Class "account"
-                })]
+              [case layout_ ropts of
+                  LayoutBareWide ->
+                      accountCell :
+                      map Spr.headerCell (dataHeaders >> allCommodities)
+                  _ -> Spr.horizontalSpan headerrow accountCell]
       in
         titleRows ++
         bodyrows ++
@@ -421,7 +439,7 @@ compoundBalanceReportAsSpreadsheet fmt accountLabel maybeBlank ropts cbr =
     totalrows =
       if no_total_ ropts || length subreports == 1 then []
       else
-        multiBalanceRowAsCellBuilders fmt ropts colspans
+        multiBalanceRowAsCellBuilders fmt ropts colspans allCommodities
             Total (simpleDateSpanCell $ period_titles_ ropts) totalrow
                              -- make a table of rendered lines of the report totals row
         & map (map (fmap wbToText))
@@ -433,3 +451,10 @@ compoundBalanceReportAsSpreadsheet fmt accountLabel maybeBlank ropts cbr =
   in  (title,
         ((1,1),
             headerrow :| concatMap subreportrows subreports ++ totalrows))
+
+allCommoditiesFromSubreports ::
+    [(text, PeriodicReport a MixedAmount, bool)] -> [CommoditySymbol]
+allCommoditiesFromSubreports =
+    Set.toAscList .
+    foldMap (\(_,mbr,_) ->
+                foldMap (foldMap maCommodities . prrAmounts) $ prRows mbr)