96e1ca7ea1
Amount display style canonicalisation code and terminology has been clarified a bit. Individual amounts still have styles; from these we derive the standard "commodity styles". In user docs, we might call these "commodity formats" since a Ledger-compatible commodity directive would use the "format" keyword.
110 lines
4.6 KiB
Haskell
110 lines
4.6 KiB
Haskell
{-|
|
|
|
|
Print some statistics for the journal.
|
|
|
|
-}
|
|
|
|
module Hledger.Cli.Stats (
|
|
statsmode
|
|
,stats
|
|
)
|
|
where
|
|
|
|
import Data.List
|
|
import Data.Maybe
|
|
import Data.Ord
|
|
import Data.HashSet (size, fromList)
|
|
import Data.Text (pack)
|
|
import Data.Time.Calendar
|
|
import System.Console.CmdArgs.Explicit
|
|
import Text.Printf
|
|
import qualified Data.Map as Map
|
|
|
|
import Hledger
|
|
import Hledger.Cli.CliOptions
|
|
import Prelude hiding (putStr)
|
|
import Hledger.Cli.Utils (writeOutput)
|
|
|
|
|
|
statsmode = (defCommandMode $ ["stats"] ++ aliases) {
|
|
modeHelp = "show some journal statistics" `withAliases` aliases
|
|
,modeGroupFlags = Group {
|
|
groupUnnamed = [
|
|
flagReq ["output-file","o"] (\s opts -> Right $ setopt "output-file" s opts) "FILE[.FMT]" "write output to FILE instead of stdout. A recognised FMT suffix influences the format."
|
|
]
|
|
,groupHidden = []
|
|
,groupNamed = [generalflagsgroup1]
|
|
}
|
|
}
|
|
where aliases = []
|
|
|
|
-- like Register.summarisePostings
|
|
-- | Print various statistics for the journal.
|
|
stats :: CliOpts -> Journal -> IO ()
|
|
stats opts@CliOpts{reportopts_=reportopts_} j = do
|
|
d <- getCurrentDay
|
|
let q = queryFromOpts d reportopts_
|
|
l = ledgerFromJournal q j
|
|
reportspan = (ledgerDateSpan l) `spanDefaultsFrom` (queryDateSpan False q)
|
|
intervalspans = splitSpan (intervalFromOpts reportopts_) reportspan
|
|
showstats = showLedgerStats l d
|
|
s = intercalate "\n" $ map showstats intervalspans
|
|
writeOutput opts s
|
|
|
|
showLedgerStats :: Ledger -> Day -> DateSpan -> String
|
|
showLedgerStats l today span =
|
|
unlines $ map (\(label,value) -> concatBottomPadded [printf fmt1 label, value]) stats
|
|
where
|
|
fmt1 = "%-" ++ show w1 ++ "s: "
|
|
-- fmt2 = "%-" ++ show w2 ++ "s"
|
|
w1 = maximum $ map (length . fst) stats
|
|
-- w2 = maximum $ map (length . show . snd) stats
|
|
stats = [
|
|
("Main journal file" :: String, path) -- ++ " (from " ++ source ++ ")")
|
|
,("Included journal files", unlines $ drop 1 $ journalFilePaths j)
|
|
,("Transactions span", printf "%s to %s (%d days)" (start span) (end span) days)
|
|
,("Last transaction", maybe "none" show lastdate ++ showelapsed lastelapsed)
|
|
,("Transactions", printf "%d (%0.1f per day)" tnum txnrate)
|
|
,("Transactions last 30 days", printf "%d (%0.1f per day)" tnum30 txnrate30)
|
|
,("Transactions last 7 days", printf "%d (%0.1f per day)" tnum7 txnrate7)
|
|
,("Payees/descriptions", show $ size $ fromList $ map (pack . tdescription) ts)
|
|
,("Accounts", printf "%d (depth %d)" acctnum acctdepth)
|
|
,("Commodities", printf "%s (%s)" (show $ length cs) (intercalate ", " cs))
|
|
-- Transactions this month : %(monthtxns)s (last month in the same period: %(lastmonthtxns)s)
|
|
-- Uncleared transactions : %(uncleared)s
|
|
-- Days since reconciliation : %(reconcileelapsed)s
|
|
-- Days since last transaction : %(recentelapsed)s
|
|
]
|
|
where
|
|
j = ljournal l
|
|
path = journalFilePath j
|
|
ts = sortBy (comparing tdate) $ filter (spanContainsDate span . tdate) $ jtxns j
|
|
as = nub $ map paccount $ concatMap tpostings ts
|
|
cs = Map.keys $ commodityStylesFromAmounts $ concatMap amounts $ map pamount $ concatMap tpostings ts
|
|
lastdate | null ts = Nothing
|
|
| otherwise = Just $ tdate $ last ts
|
|
lastelapsed = maybe Nothing (Just . diffDays today) lastdate
|
|
showelapsed Nothing = ""
|
|
showelapsed (Just days) = printf " (%d %s)" days' direction
|
|
where days' = abs days
|
|
direction | days >= 0 = "days ago" :: String
|
|
| otherwise = "days from now"
|
|
tnum = length ts
|
|
start (DateSpan (Just d) _) = show d
|
|
start _ = ""
|
|
end (DateSpan _ (Just d)) = show d
|
|
end _ = ""
|
|
days = fromMaybe 0 $ daysInSpan span
|
|
txnrate | days==0 = 0
|
|
| otherwise = fromIntegral tnum / fromIntegral days :: Double
|
|
tnum30 = length $ filter withinlast30 ts
|
|
withinlast30 t = d >= addDays (-30) today && (d<=today) where d = tdate t
|
|
txnrate30 = fromIntegral tnum30 / 30 :: Double
|
|
tnum7 = length $ filter withinlast7 ts
|
|
withinlast7 t = d >= addDays (-7) today && (d<=today) where d = tdate t
|
|
txnrate7 = fromIntegral tnum7 / 7 :: Double
|
|
acctnum = length as
|
|
acctdepth | null as = 0
|
|
| otherwise = maximum $ map accountNameLevel as
|
|
|