slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

balance: make BalanceReport more like MultiBalanceReport, doc cleanups

Browse Source
This commit is contained in:
Simon Michael 2014-03-18 17:59:34 -07:00
parent a54e4d3c61
commit 4d8d0d9aa6
2 changed files with 78 additions and 93 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

169
hledger-lib/Hledger/Reports.hs
View File

@ -56,7 +56,7 @@ module Hledger.Reports (
BalanceReportItem, BalanceReportItem,
balanceReport, balanceReport,
MultiBalanceReport(..), MultiBalanceReport(..),
MultiBalanceReportItem, MultiBalanceReportRow,
RenderableAccountName, RenderableAccountName,
periodBalanceReport, periodBalanceReport,
cumulativeOrHistoricalBalanceReport, cumulativeOrHistoricalBalanceReport,
@ -77,7 +77,7 @@ import Data.Maybe
import Data.Ord import Data.Ord
import Data.Time.Calendar import Data.Time.Calendar
-- import Data.Tree -- import Data.Tree
import Safe (headMay, lastMay) import Safe ({- headDef, -} headMay, lastMay)
import System.Console.CmdArgs -- for defaults support import System.Console.CmdArgs -- for defaults support
import Test.HUnit import Test.HUnit
import Text.ParserCombinators.Parsec import Text.ParserCombinators.Parsec
@ -637,23 +637,24 @@ filterTransactionPostings m t@Transaction{tpostings=ps} = t{tpostings=filter (m
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
-- | A list of account names plus rendering info, along with their -- | A simple single-column balance report. It has:
-- balances as of the end of the reporting period, and the grand
-- total. Used for the balance command's single-column mode.
type BalanceReport = ([BalanceReportItem] -- line items, one per account
,MixedAmount -- total balance of all accounts
)
-- | * Full account name,
-- --
-- * short account name for display (the leaf name, prefixed by any boring parents immediately above), -- 1. a list of rows, each containing a renderable account name and a corresponding amount
-- --
-- * how many steps to indent this account (the 0-based account depth excluding boring parents, or 0 with --flat), -- 2. the final total of the amounts
type BalanceReport = ([BalanceReportItem], MixedAmount)
type BalanceReportItem = (RenderableAccountName, MixedAmount)
-- | A renderable account name includes some additional hints for rendering accounts in a balance report.
-- It has:
--
-- * The full account name
-- --
-- * account balance (including subaccounts (XXX unless --flat)). -- * The ledger-style short elided account name (the leaf name, prefixed by any boring parents immediately above)
type BalanceReportItem = (AccountName --
,AccountName -- * The number of indentation steps to use when rendering a ledger-style account tree
,Int -- (normally the 0-based depth of this account excluding boring parents, or 0 with --flat).
,MixedAmount) type RenderableAccountName = (AccountName, AccountName, Int)
-- | Select accounts, and get their balances at the end of the selected -- | Select accounts, and get their balances at the end of the selected
-- period, and misc. display information, for an accounts report. -- period, and misc. display information, for an accounts report.
@ -676,14 +677,9 @@ balanceReport opts q j = (items, total)
markboring | no_elide_ opts = id markboring | no_elide_ opts = id
| otherwise = markBoringParentAccounts | otherwise = markBoringParentAccounts
items = map (balanceReportItem opts) accts' items = map (balanceReportItem opts) accts'
total = sum [amt | (a,_,indent,amt) <- items, if flat_ opts then accountNameLevel a == 1 else indent == 0] total = sum [amt | ((a,_,indent),amt) <- items, if flat_ opts then accountNameLevel a == 1 else indent == 0]
-- XXX check account level == 1 is valid when top-level accounts excluded -- XXX check account level == 1 is valid when top-level accounts excluded
-- -- | Filter out parts of this accounts balance amounts which do not match the query.
-- filterAccountAmounts :: Query -> Account -> Account
-- filterAccountAmounts q acc@Account{..} =
-- acc{aebalance=filterMixedAmount q aebalance, aibalance=filterMixedAmount q aibalance}
-- | In an account tree with zero-balance leaves removed, mark the -- | In an account tree with zero-balance leaves removed, mark the
-- elidable parent accounts (those with one subaccount and no balance -- elidable parent accounts (those with one subaccount and no balance
-- of their own). -- of their own).
@ -695,55 +691,44 @@ markBoringParentAccounts = tieAccountParents . mapAccounts mark
balanceReportItem :: ReportOpts -> Account -> BalanceReportItem balanceReportItem :: ReportOpts -> Account -> BalanceReportItem
balanceReportItem opts a@Account{aname=name, aibalance=ibal} balanceReportItem opts a@Account{aname=name, aibalance=ibal}
| flat_ opts = (name, name, 0, ibal) | flat_ opts = ((name, name, 0), ibal)
| otherwise = (name, elidedname, indent, ibal) | otherwise = ((name, elidedname, indent), ibal)
where where
elidedname = accountNameFromComponents (adjacentboringparentnames ++ [accountLeafName name]) elidedname = accountNameFromComponents (adjacentboringparentnames ++ [accountLeafName name])
adjacentboringparentnames = reverse $ map (accountLeafName.aname) $ takeWhile aboring $ parents adjacentboringparentnames = reverse $ map (accountLeafName.aname) $ takeWhile aboring $ parents
indent = length $ filter (not.aboring) parents indent = length $ filter (not.aboring) parents
parents = init $ parentAccounts a parents = init $ parentAccounts a
-- -- the above using the newer multi balance report code:
-- balanceReport' opts q j = (items, total)
-- where
-- MultiBalanceReport (_,mbrrows,mbrtotals) = periodBalanceReport opts q j
-- items = [(a,a',n, headDef 0 bs) | ((a,a',n), bs) <- mbrrows]
-- total = headDef 0 mbrtotals
------------------------------------------------------------------------------- -------------------------------------------------------------------------------
-- | A multi(column) balance report is a list of accounts, each with a list of -- | A multi balance report is a balance report with one or more columns. It has:
-- balances corresponding to the report's column periods. The balances' meaning depends
-- on the type of balance report (see 'BalanceType' and "Hledger.Cli.Balance").
-- Also included are the overall total for each period, the date span for each period,
-- and some additional rendering info for the accounts.
-- --
-- * The date span for each report column, -- 1. a list of each column's date span
--
-- * line items (one per account),
--
-- * the final total for each report column.
newtype MultiBalanceReport = MultiBalanceReport
([DateSpan]
,[MultiBalanceReportItem]
,[MixedAmount]
)
-- | * The account name with rendering hints,
-- --
-- * the account's balance (per-period balance, cumulative ending -- 2. a list of rows, each containing a renderable account name and the amounts to show in each column
-- balance, or historical ending balance) in each of the report's --
-- periods. -- 3. a list of each column's final total
type MultiBalanceReportItem = --
(RenderableAccountName -- The meaning of the amounts depends on the type of balance report (see
,[MixedAmount] -- 'BalanceType' and "Hledger.Cli.Balance").
) newtype MultiBalanceReport = MultiBalanceReport ([DateSpan]
,[MultiBalanceReportRow]
,[MixedAmount]
)
-- | * Full account name, -- | A row in a multi balance report has
-- --
-- * ledger-style short account name (the leaf name, prefixed by any boring parents immediately above), -- * An account name, with rendering hints
-- --
-- * indentation steps to use when rendering a ledger-style account tree -- * A list of amounts to be shown in each of the report's columns.
-- (the 0-based depth of this account excluding boring parents; or with --flat, 0) type MultiBalanceReportRow = (RenderableAccountName, [MixedAmount])
type RenderableAccountName =
(AccountName
,AccountName
,Int
)
instance Show MultiBalanceReport where instance Show MultiBalanceReport where
-- use ppShow to break long lists onto multiple lines -- use ppShow to break long lists onto multiple lines
@ -836,7 +821,7 @@ cumulativeOrHistoricalBalanceReport opts q j = MultiBalanceReport (periodbalance
-- get starting balances and accounts from preceding txns -- get starting balances and accounts from preceding txns
precedingq = And [q', Date $ DateSpan Nothing (spanStart reportspan)] precedingq = And [q', Date $ DateSpan Nothing (spanStart reportspan)]
(startbalanceitems,_) = balanceReport opts{flat_=True,empty_=True} precedingq j (startbalanceitems,_) = balanceReport opts{flat_=True,empty_=True} precedingq j
startacctbals = dbg "startacctbals" $ map (\(a,_,_,b) -> (a,b)) startbalanceitems startacctbals = dbg "startacctbals" $ map (\((a,_,_),b) -> (a,b)) startbalanceitems
-- acctsWithStartingBalance = map fst $ filter (not . isZeroMixedAmount . snd) startacctbals -- acctsWithStartingBalance = map fst $ filter (not . isZeroMixedAmount . snd) startacctbals
startingBalanceFor a | balancetype_ opts == HistoricalBalance = fromMaybe nullmixedamt $ lookup a startacctbals startingBalanceFor a | balancetype_ opts == HistoricalBalance = fromMaybe nullmixedamt $ lookup a startacctbals
| otherwise = nullmixedamt | otherwise = nullmixedamt
@ -1070,36 +1055,36 @@ tests_balanceReport =
,"balanceReport with no args on sample journal" ~: do ,"balanceReport with no args on sample journal" ~: do
(defreportopts, samplejournal) `gives` (defreportopts, samplejournal) `gives`
([ ([
("assets","assets",0, mamountp' "$-1.00") (("assets","assets",0), mamountp' "$-1.00")
,("assets:bank:saving","bank:saving",1, mamountp' "$1.00") ,(("assets:bank:saving","bank:saving",1), mamountp' "$1.00")
,("assets:cash","cash",1, mamountp' "$-2.00") ,(("assets:cash","cash",1), mamountp' "$-2.00")
,("expenses","expenses",0, mamountp' "$2.00") ,(("expenses","expenses",0), mamountp' "$2.00")
,("expenses:food","food",1, mamountp' "$1.00") ,(("expenses:food","food",1), mamountp' "$1.00")
,("expenses:supplies","supplies",1, mamountp' "$1.00") ,(("expenses:supplies","supplies",1), mamountp' "$1.00")
,("income","income",0, mamountp' "$-2.00") ,(("income","income",0), mamountp' "$-2.00")
,("income:gifts","gifts",1, mamountp' "$-1.00") ,(("income:gifts","gifts",1), mamountp' "$-1.00")
,("income:salary","salary",1, mamountp' "$-1.00") ,(("income:salary","salary",1), mamountp' "$-1.00")
,("liabilities:debts","liabilities:debts",0, mamountp' "$1.00") ,(("liabilities:debts","liabilities:debts",0), mamountp' "$1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])
,"balanceReport with --depth=N" ~: do ,"balanceReport with --depth=N" ~: do
(defreportopts{depth_=Just 1}, samplejournal) `gives` (defreportopts{depth_=Just 1}, samplejournal) `gives`
([ ([
("assets", "assets", 0, mamountp' "$-1.00") (("assets", "assets", 0), mamountp' "$-1.00")
,("expenses", "expenses", 0, mamountp' "$2.00") ,(("expenses", "expenses", 0), mamountp' "$2.00")
,("income", "income", 0, mamountp' "$-2.00") ,(("income", "income", 0), mamountp' "$-2.00")
,("liabilities", "liabilities", 0, mamountp' "$1.00") ,(("liabilities", "liabilities", 0), mamountp' "$1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])
,"balanceReport with depth:N" ~: do ,"balanceReport with depth:N" ~: do
(defreportopts{query_="depth:1"}, samplejournal) `gives` (defreportopts{query_="depth:1"}, samplejournal) `gives`
([ ([
("assets", "assets", 0, mamountp' "$-1.00") (("assets", "assets", 0), mamountp' "$-1.00")
,("expenses", "expenses", 0, mamountp' "$2.00") ,(("expenses", "expenses", 0), mamountp' "$2.00")
,("income", "income", 0, mamountp' "$-2.00") ,(("income", "income", 0), mamountp' "$-2.00")
,("liabilities", "liabilities", 0, mamountp' "$1.00") ,(("liabilities", "liabilities", 0), mamountp' "$1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])
@ -1109,32 +1094,32 @@ tests_balanceReport =
Mixed [nullamt]) Mixed [nullamt])
(defreportopts{query_="edate:'in 2009'"}, samplejournal2) `gives` (defreportopts{query_="edate:'in 2009'"}, samplejournal2) `gives`
([ ([
("assets:bank:checking","assets:bank:checking",0,mamountp' "$1.00") (("assets:bank:checking","assets:bank:checking",0),mamountp' "$1.00")
,("income:salary","income:salary",0,mamountp' "$-1.00") ,(("income:salary","income:salary",0),mamountp' "$-1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])
,"balanceReport with desc:" ~: do ,"balanceReport with desc:" ~: do
(defreportopts{query_="desc:income"}, samplejournal) `gives` (defreportopts{query_="desc:income"}, samplejournal) `gives`
([ ([
("assets:bank:checking","assets:bank:checking",0,mamountp' "$1.00") (("assets:bank:checking","assets:bank:checking",0),mamountp' "$1.00")
,("income:salary","income:salary",0, mamountp' "$-1.00") ,(("income:salary","income:salary",0), mamountp' "$-1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])
,"balanceReport with not:desc:" ~: do ,"balanceReport with not:desc:" ~: do
(defreportopts{query_="not:desc:income"}, samplejournal) `gives` (defreportopts{query_="not:desc:income"}, samplejournal) `gives`
([ ([
("assets","assets",0, mamountp' "$-2.00") (("assets","assets",0), mamountp' "$-2.00")
,("assets:bank","bank",1, Mixed [nullamt]) ,(("assets:bank","bank",1), Mixed [nullamt])
,("assets:bank:checking","checking",2,mamountp' "$-1.00") ,(("assets:bank:checking","checking",2),mamountp' "$-1.00")
,("assets:bank:saving","saving",2, mamountp' "$1.00") ,(("assets:bank:saving","saving",2), mamountp' "$1.00")
,("assets:cash","cash",1, mamountp' "$-2.00") ,(("assets:cash","cash",1), mamountp' "$-2.00")
,("expenses","expenses",0, mamountp' "$2.00") ,(("expenses","expenses",0), mamountp' "$2.00")
,("expenses:food","food",1, mamountp' "$1.00") ,(("expenses:food","food",1), mamountp' "$1.00")
,("expenses:supplies","supplies",1, mamountp' "$1.00") ,(("expenses:supplies","supplies",1), mamountp' "$1.00")
,("income:gifts","income:gifts",0, mamountp' "$-1.00") ,(("income:gifts","income:gifts",0), mamountp' "$-1.00")
,("liabilities:debts","liabilities:debts",0, mamountp' "$1.00") ,(("liabilities:debts","liabilities:debts",0), mamountp' "$1.00")
], ],
Mixed [nullamt]) Mixed [nullamt])

2
hledger/Hledger/Cli/Balance.hs
View File

@ -310,7 +310,7 @@ This implementation turned out to be a bit convoluted but implements the followi
-} -}
-- | Render one balance report line item as plain text suitable for console output. -- | Render one balance report line item as plain text suitable for console output.
balanceReportItemAsText :: ReportOpts -> [OutputFormat] -> BalanceReportItem -> [String] balanceReportItemAsText :: ReportOpts -> [OutputFormat] -> BalanceReportItem -> [String]
balanceReportItemAsText opts format (_, accountName, depth, Mixed amounts) = balanceReportItemAsText opts format ((_, accountName, depth), Mixed amounts) =
-- 'amounts' could contain several quantities of the same commodity with different price. -- 'amounts' could contain several quantities of the same commodity with different price.
-- In order to combine them into single value (which is expected) we take the first price and -- In order to combine them into single value (which is expected) we take the first price and
-- use it for the whole mixed amount. This could be suboptimal. XXX -- use it for the whole mixed amount. This could be suboptimal. XXX