diff --git a/DEVELOPMENT.rst b/DEVELOPMENT.rst new file mode 100644 --- /dev/null +++ b/DEVELOPMENT.rst @@ -0,0 +1,100 @@ +--- +title: hledger development +--- +hledger development +=================== + +**Techie intro** + +hledger_ is a remix, in haskell_, of John Wiegley's excellent ledger_ accounting tool. +It reads a plain text journal_ or timelog_ file describing your transactions +and displays reports via command line, curses or web interfaces. + +The hledger project aims to produce: + +- a practical, accessible, dependable tool for end users +- a useful library and toolbox for finance-minded haskell programmers +- a successful, time-and-money-solvent project within a thriving ecosystem of financial software projects. + +hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. + +**Learn** + news_, manual_, screenshots_, `some extra tips`_ + +**Download** + ``cabal install hledger``, + or try these ready-to-run binaries_, + or see the `installing docs `_ + +**Develop** + ``darcs get http://joyful.com/repos/hledger``, + `browse the repo`_, + `hackage page`_, + `hledger haddock docs`_, + benchmark_\/profile_\/heap_\/coverage_ reports, + `developer notes`_ + + .. `hledger-lib sourcegraph report`_, + .. `hledger sourcegraph report`_, + +.. raw:: html + + + +**Support** + +- chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_ +- report problems at `bugs.hledger.org `_ (`grid `_) +- share and test journal snippets at paste . hledger.org +- .. raw:: html + +
+ join the hledger mail list at list.hledger.org. Your email: + +
+ +**Related projects** + +- John Wiegley's ledger_ inspired hledger, and we try to stay compatible. You can often use both tools on the same journal file. +- Uwe Hollerbach's umm_ is another haskell tool inspired by h/ledger. +- Tim Docker's ledger-reports_ uses hledger as a library to generate `html reports`_. +- I have a few older bits and pieces `here `_. + +.. raw:: html + + + + + +.. _hledger: README.html +.. _journal: http://joyful.com/repos/hledger/data/sample.journal +.. _timelog: http://joyful.com/repos/hledger/data/sample.timelog +.. _command line: SCREENSHOTS.html#hledger-screen-1 +.. _curses: SCREENSHOTS.html#sshot +.. _web interface: http://demo.hledger.org +.. _mail list: http://list.hledger.org +.. _issue tracker: http://bugs.hledger.org +.. _binaries: http://hledger.org/binaries/ +.. _manual: MANUAL.html +.. _news: NEWS.html +.. _screenshots: SCREENSHOTS.html +.. _hledger haddock docs: http://hledger.org/api-doc/ +.. _hledger-lib sourcegraph report: http://joyful.com/repos/hledger/hledger-lib/SourceGraph/hledger-lib.html +.. _hledger sourcegraph report: http://joyful.com/repos/hledger/SourceGraph/hledger.html +.. _developer notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES +.. _benchmark: http://hledger.org/profs/latest.bench +.. _profile: http://hledger.org/profs/latest.prof +.. _heap: http://hledger.org/profs/latest.ps +.. _coverage: http://hledger.org/profs/coverage/hpc_index_fun.html +.. _browse the repo: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger +.. _email me: mailto:simon@joyful.com?subject=hledger: +.. _Simon Michael: http://joyful.com +.. _co.: http://hledger.org/CONTRIBUTORS.html +.. _hackage page: http://hackage.haskell.org/package/hledger +.. _#ledger: irc://irc.freenode.net/#ledger +.. _haskell: http://haskell.org +.. _ledger: http://wiki.github.com/jwiegley/ledger +.. _umm: http://www.korgwal.com/umm/ +.. _ledger-reports: http://dockerz.net/repos/ledger-reports +.. _html reports: http://dockerz.net/software/hledger_report_sample/report.html +.. _some extra tips: http://podcastle.org/2009/10/09/pc-miniature-38-accounting-for-dragons/ diff --git a/Hledger/Cli/Commands/Add.hs b/Hledger/Cli/Commands/Add.hs --- a/Hledger/Cli/Commands/Add.hs +++ b/Hledger/Cli/Commands/Add.hs @@ -10,7 +10,7 @@ import Hledger.Data import Hledger.Read.Journal (someamount) import Hledger.Cli.Options -import Hledger.Cli.Commands.Register (showRegisterReport) +import Hledger.Cli.Commands.Register (registerReport, registerReportAsText) #if __GLASGOW_HASKELL__ <= 610 import Prelude hiding (putStr, putStrLn, getLine, appendFile) import System.IO.UTF8 @@ -44,7 +44,7 @@ getAndAddTransactions :: Journal -> [Opt] -> [String] -> Day -> IO () getAndAddTransactions j opts args defaultDate = do (t, d) <- getTransaction j opts args defaultDate - j <- journalAddTransaction j t + j <- journalAddTransaction j opts t getAndAddTransactions j opts args d -- | Read a transaction from the command line, with history-aware prompting. @@ -134,11 +134,12 @@ -- | Append this transaction to the journal's file. Also, to the journal's -- transaction list, but we don't bother updating the other fields - this -- is enough to include new transactions in the history matching. -journalAddTransaction :: Journal -> Transaction -> IO Journal -journalAddTransaction j@Journal{jtxns=ts} t = do +journalAddTransaction :: Journal -> [Opt] -> Transaction -> IO Journal +journalAddTransaction j@Journal{jtxns=ts} opts t = do appendToJournalFile j $ showTransaction t - putStrLn $ printf "\nAdded transaction to %s:" (filepath j) - putStrLn =<< registerFromString (show t) + when (Debug `elem` opts) $ do + putStrLn $ printf "\nAdded transaction to %s:" (filepath j) + putStrLn =<< registerFromString (show t) return j{jtxns=ts++[t]} -- | Append data to the journal's file, ensuring proper separation from @@ -160,7 +161,7 @@ registerFromString s = do now <- getCurrentLocalTime l <- readJournalWithOpts [] s - return $ showRegisterReport opts (optsToFilterSpec opts [] now) l + return $ registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] now) l where opts = [Empty] -- | Return a similarity measure, from 0 to 1, for two strings. diff --git a/Hledger/Cli/Commands/All.hs b/Hledger/Cli/Commands/All.hs --- a/Hledger/Cli/Commands/All.hs +++ b/Hledger/Cli/Commands/All.hs @@ -23,8 +23,6 @@ #endif #if defined(WEB) module Hledger.Cli.Commands.Web, -#elif defined(WEB610) - module Hledger.Cli.Commands.Web610, #endif tests_Hledger_Commands ) @@ -44,8 +42,6 @@ #endif #if defined(WEB) import Hledger.Cli.Commands.Web -#elif defined(WEB610) -import Hledger.Cli.Commands.Web610 #endif import Test.HUnit (Test(TestList)) @@ -68,6 +64,4 @@ -- #endif -- #if defined(WEB) -- ,Hledger.Cli.Commands.Web.tests_Web --- #elif defined(WEB610) --- ,Hledger.Cli.Commands.Web610.tests_Web -- #endif diff --git a/Hledger/Cli/Commands/Balance.hs b/Hledger/Cli/Commands/Balance.hs --- a/Hledger/Cli/Commands/Balance.hs +++ b/Hledger/Cli/Commands/Balance.hs @@ -95,8 +95,14 @@ -} -module Hledger.Cli.Commands.Balance -where +module Hledger.Cli.Commands.Balance ( + BalanceReport + ,BalanceReportItem + ,balance + ,balanceReport + ,balanceReportAsText + -- ,tests_Balance +) where import Hledger.Data.Utils import Hledger.Data.Types import Hledger.Data.Amount @@ -110,46 +116,70 @@ #endif +-- | A balance report is a chart of accounts with balances, and their grand total. +type BalanceReport = ([BalanceReportItem] -- line items, one per account + ,MixedAmount -- total balance of all accounts + ) + +-- | The data for a single balance report line item, representing one account. +type BalanceReportItem = (AccountName -- full account name + ,AccountName -- account name elided for display: the leaf name, + -- prefixed by any boring parents immediately above + ,Int -- account depth within this report, excludes boring parents + ,MixedAmount) -- account balance, includes subs unless --flat is present + -- | Print a balance report. balance :: [Opt] -> [String] -> Journal -> IO () balance opts args j = do t <- getCurrentLocalTime - putStr $ showBalanceReport opts (optsToFilterSpec opts args t) j + putStr $ balanceReportAsText opts $ balanceReport opts (optsToFilterSpec opts args t) j --- | Generate a balance report with the specified options for this journal. -showBalanceReport :: [Opt] -> FilterSpec -> Journal -> String -showBalanceReport opts filterspec j = acctsstr ++ totalstr - where - l = journalToLedger filterspec j - acctsstr = unlines $ map showacct interestingaccts - where - showacct = showInterestingAccount opts l interestingaccts - interestingaccts = filter (isInteresting opts l) acctnames - acctnames = sort $ tail $ flatten $ treemap aname accttree - accttree = ledgerAccountTree (fromMaybe 99999 $ depthFromOpts opts) l - totalstr | NoTotal `elem` opts = "" - | otherwise = printf "--------------------\n%s\n" $ padleft 20 $ showMixedAmountWithoutPrice total - where - total = sum $ map abalance $ ledgerTopAccounts l +-- | Render a balance report as plain text suitable for console output. +balanceReportAsText :: [Opt] -> BalanceReport -> String +balanceReportAsText opts (items,total) = + unlines $ + map (balanceReportItemAsText opts) items + ++ + if NoTotal `elem` opts + then [] + else ["--------------------" + ,padleft 20 $ showMixedAmountWithoutPrice total + ] --- | Display one line of the balance report with appropriate indenting and eliding. -showInterestingAccount :: [Opt] -> Ledger -> [AccountName] -> AccountName -> String -showInterestingAccount opts l interestingaccts a = concatTopPadded [amt, " ", name] +-- | Render one balance report line item as plain text. +balanceReportItemAsText :: [Opt] -> BalanceReportItem -> String +balanceReportItemAsText opts (a, adisplay, adepth, abal) = concatTopPadded [amt, " ", name] where - amt = padleft 20 $ showMixedAmountWithoutPrice bal - bal | Flat `elem` opts = exclusiveBalance acct - | otherwise = abalance acct - acct = ledgerAccount l a + amt = padleft 20 $ showMixedAmountWithoutPrice abal name | Flat `elem` opts = accountNameDrop (dropFromOpts opts) a - | otherwise = depthspacer ++ partialname - parents = parentAccountNames a - interestingparents = filter (`elem` interestingaccts) parents - depthspacer = replicate (indentperlevel * length interestingparents) ' ' + | otherwise = depthspacer ++ adisplay + depthspacer = replicate (indentperlevel * adepth) ' ' indentperlevel = 2 - -- the partial name is the account's leaf name, prefixed by the - -- names of any boring parents immediately above - partialname = accountNameFromComponents $ reverse (map accountLeafName ps) ++ [accountLeafName a] - where ps = takeWhile boring parents where boring = not . (`elem` interestingparents) + +-- | Get a balance report with the specified options for this journal. +balanceReport :: [Opt] -> FilterSpec -> Journal -> BalanceReport +balanceReport opts filterspec j = (items, total) + where + items = map mkitem interestingaccts + interestingaccts = filter (isInteresting opts l) acctnames + acctnames = sort $ tail $ flatten $ treemap aname accttree + accttree = ledgerAccountTree (fromMaybe 99999 $ depthFromOpts opts) l + total = sum $ map abalance $ ledgerTopAccounts l + l = journalToLedger filterspec j + -- | Get data for one balance report line item. + mkitem :: AccountName -> BalanceReportItem + mkitem a = (a, adisplay, indent, abal) + where + adisplay | Flat `elem` opts = a + | otherwise = accountNameFromComponents $ reverse (map accountLeafName ps) ++ [accountLeafName a] + where ps = takeWhile boring parents where boring = not . (`elem` interestingparents) + indent | Flat `elem` opts = 0 + | otherwise = length interestingparents + interestingparents = filter (`elem` interestingaccts) parents + parents = parentAccountNames a + abal | Flat `elem` opts = exclusiveBalance acct + | otherwise = abalance acct + where acct = ledgerAccount l a exclusiveBalance :: Account -> MixedAmount exclusiveBalance = sumPostings . apostings diff --git a/Hledger/Cli/Commands/Chart.hs b/Hledger/Cli/Commands/Chart.hs --- a/Hledger/Cli/Commands/Chart.hs +++ b/Hledger/Cli/Commands/Chart.hs @@ -44,7 +44,7 @@ parseSize :: String -> (Int,Int) parseSize str = (read w, read h) where - x = fromMaybe (error "Size should be in WIDTHxHEIGHT format") $ findIndex (=='x') str + x = fromMaybe (error' "Size should be in WIDTHxHEIGHT format") $ findIndex (=='x') str (w,_:h) = splitAt x str -- | Generate pie chart diff --git a/Hledger/Cli/Commands/Convert.hs b/Hledger/Cli/Commands/Convert.hs --- a/Hledger/Cli/Commands/Convert.hs +++ b/Hledger/Cli/Commands/Convert.hs @@ -7,7 +7,7 @@ import Hledger.Cli.Options (Opt(Debug)) import Hledger.Cli.Version (versionstr) import Hledger.Data.Types (Journal,AccountName,Transaction(..),Posting(..),PostingType(..)) -import Hledger.Data.Utils (strip, spacenonewline, restofline, parseWithCtx, assertParse, assertParseEqual) +import Hledger.Data.Utils (strip, spacenonewline, restofline, parseWithCtx, assertParse, assertParseEqual, error') import Hledger.Read.Common (emptyCtx) import Hledger.Read.Journal (someamount,ledgeraccountname) import Hledger.Data.Amount (nullmixedamt) @@ -71,11 +71,11 @@ -- using/creating a .rules file. convert :: [Opt] -> [String] -> Journal -> IO () convert opts args _ = do - when (null args) $ error "please specify a csv data file." + when (null args) $ error' "please specify a csv data file." let csvfile = head args csvparse <- parseCSVFromFile csvfile let records = case csvparse of - Left e -> error $ show e + Left e -> error' $ show e Right rs -> reverse $ filter (/= [""]) rs let debug = Debug `elem` opts rulesfile = rulesFileFor csvfile @@ -85,7 +85,7 @@ writeFile rulesfile initialRulesFileContent else hPrintf stderr "using conversion rules file %s\n" rulesfile - rules <- liftM (either (error.show) id) $ parseCsvRulesFile rulesfile + rules <- liftM (either (error'.show) id) $ parseCsvRulesFile rulesfile when debug $ hPrintf stderr "rules: %s\n" (show rules) let requiredfields = max 2 (maxFieldIndex rules + 1) badrecords = take 1 $ filter ((< requiredfields).length) records diff --git a/Hledger/Cli/Commands/Print.hs b/Hledger/Cli/Commands/Print.hs --- a/Hledger/Cli/Commands/Print.hs +++ b/Hledger/Cli/Commands/Print.hs @@ -5,8 +5,13 @@ -} -module Hledger.Cli.Commands.Print -where +module Hledger.Cli.Commands.Print ( + JournalReport + ,JournalReportItem + ,print' + ,journalReport + ,showTransactions +) where import Hledger.Data import Hledger.Cli.Options #if __GLASGOW_HASKELL__ <= 610 @@ -15,6 +20,12 @@ #endif +-- | A "journal report" is just a list of transactions. +type JournalReport = [JournalReportItem] + +-- | The data for a single journal report item, representing one transaction. +type JournalReportItem = Transaction + -- | Print journal transactions in standard format. print' :: [Opt] -> [String] -> Journal -> IO () print' opts args j = do @@ -22,8 +33,11 @@ putStr $ showTransactions (optsToFilterSpec opts args t) j showTransactions :: FilterSpec -> Journal -> String -showTransactions filterspec j = - concatMap (showTransactionForPrint effective) $ sortBy (comparing tdate) txns - where - effective = EffectiveDate == whichdate filterspec - txns = jtxns $ filterJournalTransactions filterspec j +showTransactions fspec j = journalReportAsText [] fspec $ journalReport [] fspec j + +journalReportAsText :: [Opt] -> FilterSpec -> JournalReport -> String -- XXX unlike the others, this one needs fspec not opts +journalReportAsText _ fspec items = concatMap (showTransactionForPrint effective) items + where effective = EffectiveDate == whichdate fspec + +journalReport :: [Opt] -> FilterSpec -> Journal -> JournalReport +journalReport _ fspec j = sortBy (comparing tdate) $ jtxns $ filterJournalTransactions fspec j diff --git a/Hledger/Cli/Commands/Register.hs b/Hledger/Cli/Commands/Register.hs --- a/Hledger/Cli/Commands/Register.hs +++ b/Hledger/Cli/Commands/Register.hs @@ -6,9 +6,12 @@ -} module Hledger.Cli.Commands.Register ( - register - ,showRegisterReport - ,showPostingWithBalance + RegisterReport + ,RegisterReportItem + ,register + ,registerReport + ,registerReportAsText + ,showPostingWithBalanceForVty ,tests_Register ) where @@ -22,35 +25,83 @@ import Text.ParserCombinators.Parsec +-- | A register report is a list of postings to an account or set of +-- accounts, with a running total. Postings may be actual postings, or +-- virtual postings aggregated over a reporting interval. +type RegisterReport = [RegisterReportItem] -- line items, one per posting + +-- | The data for a single register report line item, representing one posting. +type RegisterReportItem = (Maybe (Day, String) -- transaction date and description if this is the first posting + ,Posting -- the posting + ,MixedAmount -- balance so far + ) + -- | Print a register report. register :: [Opt] -> [String] -> Journal -> IO () register opts args j = do t <- getCurrentLocalTime - putStr $ showRegisterReport opts (optsToFilterSpec opts args t) j + putStr $ registerReportAsText opts $ registerReport opts (optsToFilterSpec opts args t) j --- | Generate the register report, which is a list of postings with transaction --- info and a running balance. -showRegisterReport :: [Opt] -> FilterSpec -> Journal -> String -showRegisterReport opts filterspec j = showPostingsWithBalance ps nullposting startbal +-- | Render a register report as plain text suitable for console output. +registerReportAsText :: [Opt] -> RegisterReport -> String +registerReportAsText opts = unlines . map (registerReportItemAsText opts) + +-- | Render one register report line item as plain text. Eg: +-- @ +-- date (10) description (20) account (22) amount (11) balance (12) +-- DDDDDDDDDD dddddddddddddddddddd aaaaaaaaaaaaaaaaaaaaaa AAAAAAAAAAA AAAAAAAAAAAA +-- ^ displayed for first postings^ +-- only, otherwise blank +-- @ +registerReportItemAsText :: [Opt] -> RegisterReportItem -> String +registerReportItemAsText _ (dd, p, b) = concatTopPadded [datedesc, pstr, " ", bal] where + datedesc = case dd of Nothing -> replicate datedescwidth ' ' + Just (da, de) -> printf "%s %s " date desc + where + date = showDate da + desc = printf ("%-"++(show descwidth)++"s") $ elideRight descwidth de :: String + where + descwidth = datedescwidth - datewidth - 2 + datedescwidth = 32 + datewidth = 10 + pstr = showPostingForRegister p + bal = padleft 12 (showMixedAmountOrZeroWithoutPrice b) + +showPostingWithBalanceForVty showtxninfo p b = registerReportItemAsText [] $ mkitem showtxninfo p b + +-- | Get a register report with the specified options for this journal. +registerReport :: [Opt] -> FilterSpec -> Journal -> RegisterReport +registerReport opts fspec j = getitems ps nullposting startbal + where ps | interval == NoInterval = displayableps - | otherwise = summarisePostings interval depth empty filterspan displayableps + | otherwise = summarisePostingsByInterval interval depth empty filterspan displayableps + (precedingps, displayableps, _) = postingsMatchingDisplayExpr (displayExprFromOpts opts) + $ depthClipPostings depth + $ journalPostings + $ filterJournalPostings fspec{depth=Nothing} j startbal = sumPostings precedingps - (precedingps,displayableps,_) = - postingsMatchingDisplayExpr (displayExprFromOpts opts) $ journalPostings $ filterJournalPostings filterspec j + filterspan = datespan fspec (interval, depth, empty) = (intervalFromOpts opts, depthFromOpts opts, Empty `elem` opts) - filterspan = datespan filterspec --- | Convert a list of postings into summary postings, one per interval. -summarisePostings :: Interval -> Maybe Int -> Bool -> DateSpan -> [Posting] -> [Posting] -summarisePostings interval depth empty filterspan ps = concatMap summarisespan $ splitSpan interval reportspan +-- | Generate register report line items. +getitems :: [Posting] -> Posting -> MixedAmount -> [RegisterReportItem] +getitems [] _ _ = [] +getitems (p:ps) pprev b = i:(getitems ps p b') where - summarisespan s = summarisePostingsInDateSpan s depth empty (postingsinspan s) - postingsinspan s = filter (isPostingInDateSpan s) ps - dataspan = postingsDateSpan ps - reportspan | empty = filterspan `orDatesFrom` dataspan - | otherwise = dataspan + i = mkitem isfirst p b' + isfirst = ptransaction p /= ptransaction pprev + b' = b + pamount p +-- | Generate one register report line item, from a flag indicating +-- whether to include transaction info, a posting, and the current running +-- balance. +mkitem :: Bool -> Posting -> MixedAmount -> RegisterReportItem +mkitem False p b = (Nothing, p, b) +mkitem True p b = (ds, p, b) + where ds = case ptransaction p of Just (Transaction{tdate=da,tdescription=de}) -> Just (da,de) + Nothing -> Just (nulldate,"") + -- | Date-sort and split a list of postings into three spans - postings matched -- by the given display expression, and the preceding and following postings. postingsMatchingDisplayExpr :: Maybe String -> [Posting] -> ([Posting],[Posting],[Posting]) @@ -89,6 +140,19 @@ compareop = choice $ map (try . string) ["<=",">=","==","<","=",">"] -- XXX confusing, refactor + +-- | Convert a list of postings into summary postings. Summary postings +-- are one per account per interval and aggregated to the specified depth +-- if any. +summarisePostingsByInterval :: Interval -> Maybe Int -> Bool -> DateSpan -> [Posting] -> [Posting] +summarisePostingsByInterval interval depth empty filterspan ps = concatMap summarisespan $ splitSpan interval reportspan + where + summarisespan s = summarisePostingsInDateSpan s depth empty (postingsinspan s) + postingsinspan s = filter (isPostingInDateSpan s) ps + dataspan = postingsDateSpan ps + reportspan | empty = filterspan `orDatesFrom` dataspan + | otherwise = dataspan + -- | Given a date span (representing a reporting interval) and a list of -- postings within it: aggregate the postings so there is only one per -- account, and adjust their date/description so that they will render @@ -100,8 +164,8 @@ -- When a depth argument is present, postings to accounts of greater -- depth are aggregated where possible. -- --- The showempty flag forces the display of a zero-posting span --- and also zero-posting accounts within the span. +-- The showempty flag includes spans with no postings and also postings +-- with 0 amount. summarisePostingsInDateSpan :: DateSpan -> Maybe Int -> Bool -> [Posting] -> [Posting] summarisePostingsInDateSpan (DateSpan b e) depth showempty ps | null ps && (isNothing b || isNothing e) = [] @@ -124,44 +188,20 @@ balancetoshowfor a = (if isclipped a then inclbalof else exclbalof) (if null a then "top" else a) -{- | -Show postings one per line, plus transaction info for the first posting of -each transaction, and a running balance. Eg: +-- | Clip the account names to the specified depth in a list of postings. +depthClipPostings :: Maybe Int -> [Posting] -> [Posting] +depthClipPostings depth = map (depthClipPosting depth) -@ -date (10) description (20) account (22) amount (11) balance (12) -DDDDDDDDDD dddddddddddddddddddd aaaaaaaaaaaaaaaaaaaaaa AAAAAAAAAAA AAAAAAAAAAAA - aaaaaaaaaaaaaaaaaaaaaa AAAAAAAAAAA AAAAAAAAAAAA -@ --} -showPostingsWithBalance :: [Posting] -> Posting -> MixedAmount -> String -showPostingsWithBalance [] _ _ = "" -showPostingsWithBalance (p:ps) pprev bal = this ++ showPostingsWithBalance ps p bal' - where - this = showPostingWithBalance isfirst p bal' - isfirst = ptransaction p /= ptransaction pprev - bal' = bal + pamount p +-- | Clip a posting's account name to the specified depth. +depthClipPosting :: Maybe Int -> Posting -> Posting +depthClipPosting Nothing p = p +depthClipPosting (Just d) p@Posting{paccount=a} = p{paccount=clipAccountName d a} --- | Show one posting and running balance, with or without transaction info. -showPostingWithBalance :: Bool -> Posting -> MixedAmount -> String -showPostingWithBalance withtxninfo p b = concatTopPadded [txninfo, pstr, " ", bal] ++ "\n" - where - ledger3ishlayout = False - datedescwidth = if ledger3ishlayout then 34 else 32 - txninfo = if withtxninfo then printf "%s %s " date desc else replicate datedescwidth ' ' - date = showDate da - datewidth = 10 - descwidth = datedescwidth - datewidth - 2 - desc = printf ("%-"++(show descwidth)++"s") $ elideRight descwidth de :: String - pstr = showPostingForRegister p - bal = padleft 12 (showMixedAmountOrZeroWithoutPrice b) - (da,de) = case ptransaction p of Just (Transaction{tdate=da',tdescription=de'}) -> (da',de') - Nothing -> (nulldate,"") tests_Register :: Test tests_Register = TestList [ - "summarisePostings" ~: do - summarisePostings Quarterly Nothing False (DateSpan Nothing Nothing) [] ~?= [] + "summarisePostingsByInterval" ~: do + summarisePostingsByInterval Quarterly Nothing False (DateSpan Nothing Nothing) [] ~?= [] ] diff --git a/Hledger/Cli/Commands/Vty.hs b/Hledger/Cli/Commands/Vty.hs --- a/Hledger/Cli/Commands/Vty.hs +++ b/Hledger/Cli/Commands/Vty.hs @@ -117,13 +117,13 @@ posY a = scrollY a + cursorY a setCursorY, setScrollY, setPosY :: Int -> AppState -> AppState -setCursorY _ AppState{alocs=[]} = error "shouldn't happen" -- silence warnings +setCursorY _ AppState{alocs=[]} = error' "shouldn't happen" -- silence warnings setCursorY y a@AppState{alocs=(l:locs)} = a{alocs=(l':locs)} where l' = setLocCursorY y l -setScrollY _ AppState{alocs=[]} = error "shouldn't happen" -- silence warnings +setScrollY _ AppState{alocs=[]} = error' "shouldn't happen" -- silence warnings setScrollY y a@AppState{alocs=(l:locs)} = a{alocs=(l':locs)} where l' = setLocScrollY y l -setPosY _ AppState{alocs=[]} = error "shouldn't happen" -- silence warnings +setPosY _ AppState{alocs=[]} = error' "shouldn't happen" -- silence warnings setPosY y a@AppState{alocs=(l:locs)} = a{alocs=(l':locs)} where l' = setLocScrollY sy $ setLocCursorY cy l @@ -229,8 +229,8 @@ updateData :: LocalTime -> AppState -> AppState updateData t a@AppState{aopts=opts,ajournal=j} = case screen a of - BalanceScreen -> a{abuf=lines $ showBalanceReport opts fspec j} - RegisterScreen -> a{abuf=lines $ showRegisterReport opts fspec j} + BalanceScreen -> a{abuf=lines $ balanceReportAsText opts $ balanceReport opts fspec j} + RegisterScreen -> a{abuf=lines $ registerReportAsText opts $ registerReport opts fspec j} PrintScreen -> a{abuf=lines $ showTransactions fspec j} where fspec = optsToFilterSpec opts (currentArgs a) t @@ -289,7 +289,7 @@ where p = headDef nullposting $ filter ismatch $ journalPostings j ismatch p = postingDate p == parsedate (take 10 datedesc) - && take 70 (showPostingWithBalance False p nullmixedamt) == (datedesc ++ acctamt) + && take 70 (showPostingWithBalanceForVty False p nullmixedamt) == (datedesc ++ acctamt) datedesc = take 32 $ fromMaybe "" $ find (not . (" " `isPrefixOf`)) $ headDef "" rest : reverse above acctamt = drop 32 $ headDef "" rest (above,rest) = splitAt y buf diff --git a/Hledger/Cli/Commands/Web.hs b/Hledger/Cli/Commands/Web.hs --- a/Hledger/Cli/Commands/Web.hs +++ b/Hledger/Cli/Commands/Web.hs @@ -1,4 +1,5 @@ {-# LANGUAGE CPP, TypeFamilies, QuasiQuotes, TemplateHaskell #-} +{-# LANGUAGE TypeSynonymInstances, FlexibleInstances, MultiParamTypeClasses, FlexibleContexts #-} {-| A web-based UI. -} @@ -7,11 +8,15 @@ where import Control.Concurrent (forkIO, threadDelay) import Control.Applicative ((<$>), (<*>)) +import Control.Failure import Data.Either -import System.FilePath (()) +import System.FilePath ((), takeFileName) import System.IO.Storage (withStore, putValue, getValue) import Text.ParserCombinators.Parsec (parse) import Yesod +import Yesod.Helpers.Static +import Text.Hamlet +import Text.Hamlet.RT import Hledger.Cli.Commands.Add (journalAddTransaction) import Hledger.Cli.Commands.Balance @@ -19,7 +24,8 @@ import Hledger.Cli.Commands.Register import Hledger.Cli.Options hiding (value) import Hledger.Cli.Utils -import Hledger.Data +import Hledger.Cli.Version (version) +import Hledger.Data hiding (today) import Hledger.Read (journalFromPathAndString) import Hledger.Read.Journal (someamount) #ifdef MAKE @@ -29,17 +35,72 @@ #endif -defhost = "localhost" -defport = 5000 -defbaseurl = printf "http://%s:%d" defhost defport :: String +defhost = "localhost" +defport = 5000 browserstartdelay = 100000 -- microseconds -hledgerurl = "http://hledger.org" -manualurl = hledgerurl++"/MANUAL.html" +hledgerorgurl = "http://hledger.org" +manualurl = hledgerorgurl++"/MANUAL.html" +data HledgerWebApp = HledgerWebApp { + appRoot :: String + ,appDir :: FilePath + ,appOpts :: [Opt] + ,appArgs :: [String] + ,appJournal :: Journal + ,appStatic :: Static + } + +type Handler = GHandler HledgerWebApp HledgerWebApp + +mkYesod "HledgerWebApp" [$parseRoutes| +/static StaticR Static appStatic +/ IndexR GET +/journalonly JournalOnlyR GET POST +/registeronly RegisterOnlyR GET +/accounts AccountsOnlyR GET +/journal JournalR GET POST +/register RegisterR GET POST +/addformrt AddformRTR GET +|] + +style_css = StaticRoute ["style.css"] [] +hledger_js = StaticRoute ["hledger.js"] [] +jquery_js = StaticRoute ["jquery.js"] [] +jquery_url_js = StaticRoute ["jquery.url.js"] [] +dhtmlxcommon_js = StaticRoute ["dhtmlxcommon.js"] [] +dhtmlxcombo_js = StaticRoute ["dhtmlxcombo.js"] [] + +instance Yesod HledgerWebApp where approot = appRoot + +defaultroute = JournalR + +-- | A bundle of useful data passed to templates. +data TemplateData = TD { + here :: HledgerWebAppRoute -- ^ the current page's route + ,title :: String -- ^ page's title + ,msg :: Maybe Html -- ^ transient message + ,a :: String -- ^ a (acct/desc filter pattern) parameter + ,p :: String -- ^ p (period expression) parameter + ,j :: Journal -- ^ the current journal + ,today :: Day -- ^ the current day + } + +mktd = TD { + here = IndexR + ,title = "hledger" + ,msg = Nothing + ,a = "" + ,p = "" + ,j = nulljournal + ,today = ModifiedJulianDay 0 + } + +-- | The web command. web :: [Opt] -> [String] -> Journal -> IO () web opts args j = do - let baseurl = fromMaybe defbaseurl $ baseUrlFromOpts opts - port = fromMaybe defport $ portFromOpts opts + let host = defhost + port = fromMaybe defport $ portFromOpts opts + baseurl = fromMaybe (printf "http://%s:%d" host port) $ baseUrlFromOpts opts unless (Debug `elem` opts) $ forkIO (browser baseurl) >> return () server baseurl port opts args j @@ -53,249 +114,404 @@ server :: String -> Int -> [Opt] -> [String] -> Journal -> IO () server baseurl port opts args j = do printf "starting web server on port %d with base url %s\n" port baseurl - fp <- getDataFileName "web" + dir <- getDataFileName "web" let app = HledgerWebApp{ - appOpts=opts + appRoot=baseurl + ,appDir=dir + ,appStatic=fileLookupDir (dir "static") $ typeByExt -- ++[("hamlet","text/plain")] + ,appOpts=opts ,appArgs=args ,appJournal=j - ,appWebdir=fp - ,appRoot=baseurl } withStore "hledger" $ do putValue "hledger" "journal" j - basicHandler port app + basicHandler' port Nothing app -data HledgerWebApp = HledgerWebApp { - appOpts::[Opt] - ,appArgs::[String] - ,appJournal::Journal - ,appWebdir::FilePath - ,appRoot::String - } +-- | Gather all the stuff we want for a typical hledger web request handler. +getHandlerParameters :: Handler + (String, String, [Opt], FilterSpec, Journal, Maybe Html, HledgerWebAppRoute) +getHandlerParameters = do + Just here <- getCurrentRoute + (a, p, opts, fspec) <- getReportParameters + (j, err) <- getLatestJournal opts + msg <- getMessage' err + return (a, p, opts, fspec, j, msg, here) + where + -- | Get current report parameters for this request. + getReportParameters :: Handler (String, String, [Opt], FilterSpec) + getReportParameters = do + app <- getYesod + t <- liftIO $ getCurrentLocalTime + a <- fromMaybe "" <$> lookupGetParam "x" + p <- fromMaybe "" <$> lookupGetParam "p" + let opts = appOpts app ++ [Period p] + args = appArgs app ++ [a] + fspec = optsToFilterSpec opts args t + return (a, p, opts, fspec) -mkYesod "HledgerWebApp" [$parseRoutes| -/ IndexPage GET -/style.css StyleCss GET -/journal JournalPage GET POST -/edit EditPage GET POST -/register RegisterPage GET -/balance BalancePage GET -|] + -- | Update our copy of the journal if the file changed. If there is an + -- error while reloading, keep the old one and return the error, and set a + -- ui message. + getLatestJournal :: [Opt] -> Handler (Journal, Maybe String) + getLatestJournal opts = do + j <- liftIO $ fromJust `fmap` getValue "hledger" "journal" + (jE, changed) <- liftIO $ journalReloadIfChanged opts j + if not changed + then return (j,Nothing) + else case jE of + Right j' -> do liftIO $ putValue "hledger" "journal" j' + return (j',Nothing) + Left e -> do setMessage $ string "error while reading" {- ++ ": " ++ e-} + return (j, Just e) -instance Yesod HledgerWebApp where approot = appRoot + -- | Helper to work around a yesod feature (can't set and get a message in the same request.) + getMessage' :: Maybe String -> Handler (Maybe Html) + getMessage' newmsgstr = do + oldmsg <- getMessage + return $ maybe oldmsg (Just . string) newmsgstr -getIndexPage :: Handler HledgerWebApp () -getIndexPage = redirect RedirectTemporary JournalPage +---------------------------------------------------------------------- +-- handlers & templates -getStyleCss :: Handler HledgerWebApp () -getStyleCss = do - app <- getYesod - let dir = appWebdir app - sendFile "text/css" $ dir "style.css" +getIndexR :: Handler () +getIndexR = redirect RedirectTemporary defaultroute -getJournalPage :: Handler HledgerWebApp RepHtml -getJournalPage = withLatestJournalRender (const showTransactions) +---------------------------------------------------------------------- -getRegisterPage :: Handler HledgerWebApp RepHtml -getRegisterPage = withLatestJournalRender showRegisterReport +-- | A combined accounts and journal view. +getJournalR :: Handler RepHtml +getJournalR = do + (a, p, opts, fspec, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + -- app <- getYesod + -- t <- liftIO $ getCurrentLocalTime + let -- args = appArgs app + -- fspec' = optsToFilterSpec opts args t + br = balanceReportAsHtml opts td $ balanceReport opts fspec j + jr = journalReportAsHtml opts td $ journalReport opts fspec j + td = mktd{here=here, title="hledger journal", msg=msg, a=a, p=p, j=j, today=today} + editform' = editform td $ jtext j + hamletToRepHtml $ pageLayout td [$hamlet| +%div.ledger + %div.accounts!style=float:left; ^br^ + ^navlinks.td^ + ^addform.td^ + ^editform'^ + ^importform^ + %div#transactions.journal + ^filterform.td^ + ^jr^ +|] -getBalancePage :: Handler HledgerWebApp RepHtml -getBalancePage = withLatestJournalRender showBalanceReport +postJournalR :: Handler RepPlain +postJournalR = postJournalOnlyR -withLatestJournalRender :: ([Opt] -> FilterSpec -> Journal -> String) -> Handler HledgerWebApp RepHtml -withLatestJournalRender reportfn = do - app <- getYesod - t <- liftIO $ getCurrentLocalTime - a <- fromMaybe "" <$> lookupGetParam "a" - p <- fromMaybe "" <$> lookupGetParam "p" - let opts = appOpts app ++ [Period p] - args = appArgs app ++ [a] - fspec = optsToFilterSpec opts args t - -- reload journal if changed, displaying any error as a message - j <- liftIO $ fromJust `fmap` getValue "hledger" "journal" - (jE, changed) <- liftIO $ journalReloadIfChanged opts j - let (j', err) = either (\e -> (j,e)) (\j -> (j,"")) jE - when (changed && null err) $ liftIO $ putValue "hledger" "journal" j' - if (changed && not (null err)) then setMessage $ string "error while reading" - else return () - -- run the specified report using this request's params - let s = reportfn opts fspec j' - -- render the standard template - msg' <- getMessage - -- XXX work around a bug, can't get the message we set above - let msg = if null err then msg' else Just $ string $ printf "Error while reading %s" (filepath j') - Just here <- getCurrentRoute - hamletToRepHtml $ template here msg a p "hledger" s +---------------------------------------------------------------------- -template :: HledgerWebAppRoute -> Maybe (Html ()) -> String -> String - -> String -> String -> Hamlet HledgerWebAppRoute -template here msg a p title content = [$hamlet| -!!! -%html - %head - %title $string.title$ - %meta!http-equiv=Content-Type!content=$string.metacontent$ - %link!rel=stylesheet!type=text/css!href=@stylesheet@!media=all - %body - ^navbar'^ - #messages $m$ - ^addform'^ - #content - %pre $string.content$ +-- | A combined accounts and register view. +getRegisterR :: Handler RepHtml +getRegisterR = do + (a, p, opts, fspec, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + -- app <- getYesod + -- t <- liftIO $ getCurrentLocalTime + let -- args = appArgs app + -- opts' = Empty:opts + -- fspec' = optsToFilterSpec opts' args t + br = balanceReportAsHtml opts td $ balanceReport opts fspec j + rr = registerReportAsHtml opts td $ registerReport opts fspec j + td = mktd{here=here, title="hledger register", msg=msg, a=a, p=p, j=j, today=today} + editform' = editform td $ jtext j + hamletToRepHtml $ pageLayout td [$hamlet| +%div.ledger + %div.accounts!style=float:left; ^br^ + ^navlinks.td^ + ^addform.td^ + ^editform'^ + ^importform^ + %div#transactions.register + ^filterform.td^ + ^rr^ |] - where m = fromMaybe (string "") msg - navbar' = navbar here a p - addform' | here == JournalPage = addform - | otherwise = nulltemplate - stylesheet = StyleCss - metacontent = "text/html; charset=utf-8" -nulltemplate = [$hamlet||] +postRegisterR :: Handler RepPlain +postRegisterR = postJournalOnlyR -navbar :: HledgerWebAppRoute -> String -> String -> Hamlet HledgerWebAppRoute -navbar here a p = [$hamlet| - #navbar - %a.toprightlink!href=$string.hledgerurl$ hledger.org - \ $ - %a.toprightlink!href=$string.manualurl$ manual - \ $ - ^navlinks'^ - ^searchform'^ -|] - where navlinks' = navlinks here a p - searchform' = searchform here a p +---------------------------------------------------------------------- -navlinks :: HledgerWebAppRoute -> String -> String -> Hamlet HledgerWebAppRoute -navlinks here a p = [$hamlet| - #navlinks - ^journallink^ $ - (^editlink^) $ - | ^registerlink^ $ - | ^balancelink^ $ +-- | A simple accounts and balances view like hledger balance. +getAccountsOnlyR :: Handler RepHtml +getAccountsOnlyR = do + (a, p, opts, fspec, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + let td = mktd{here=here, title="hledger accounts", msg=msg, a=a, p=p, j=j, today=today} + hamletToRepHtml $ pageLayout td $ balanceReportAsHtml opts td $ balanceReport opts fspec j + +-- | Render a balance report as HTML. +balanceReportAsHtml :: [Opt] -> TemplateData -> BalanceReport -> Hamlet HledgerWebAppRoute +balanceReportAsHtml _ td@TD{here=here,a=a,p=p} (items,total) = [$hamlet| +%table.balancereport + %tr + %td + ^accountsheading^ + $forall items i + ^itemAsHtml' i^ + %tr.totalrule + %td!colspan=2 + %tr + %td + %td!align=right $mixedAmountAsHtml.total$ |] where - journallink = navlink here "journal" JournalPage - editlink = navlink here "edit" EditPage - registerlink = navlink here "register" RegisterPage - balancelink = navlink here "balance" BalancePage - navlink here s dest = [$hamlet|%a.$style$!href=@?u@ $string.s$|] - where u = (dest, concat [(if null a then [] else [("a", a)]) - ,(if null p then [] else [("p", p)])]) - style | here == dest = string "navlinkcurrent" - | otherwise = string "navlink" + accountsheading = [$hamlet| + accounts + \ $ + %span#showmoreaccounts ^showmore^ ^showall^ +
+
+ |] + where + filteringaccts = not $ null a + showmore = case (filteringaccts, items) of + -- cunning parent account logic + (True, ((acct, _, _, _):_)) -> + let a' = if isAccountRegex a then a else acct + a'' = accountNameToAccountRegex $ parentAccountName $ accountRegexToAccountName a' + parenturl = (here, [("y",a''), ("p",p)]) + in [$hamlet| + \ | $ + %a!href=@?parenturl@ show more ↑ + |] + _ -> nulltemplate + showall = if filteringaccts + then [$hamlet| + \ | $ + %a!href=@?allurl@ show all + |] + else nulltemplate + where allurl = (here, [("p",p)]) + itemAsHtml' = itemAsHtml td + itemAsHtml :: TemplateData -> BalanceReportItem -> Hamlet HledgerWebAppRoute + itemAsHtml TD{p=p} (acct, adisplay, adepth, abal) = [$hamlet| + %tr.item.$current$ + %td.account + $indent$ + %a!href=$aurl$ $adisplay$ + %td.balance!align=right $mixedAmountAsHtml.abal$ + |] where + current = "" -- if not (null a) && containsRegex a acct then "current" else "" + indent = preEscapedString $ concat $ replicate (2 * adepth) " " + aurl = printf ".?a=%s%s" (accountNameToAccountRegex acct) p' :: String + p' = if null p then "" else printf "&p=%s" p -searchform :: HledgerWebAppRoute -> String -> String -> Hamlet HledgerWebAppRoute -searchform here a p = [$hamlet| - %form#searchform!method=GET - filter by: $ - %input!name=a!size=20!value=$string.a$ - ^ahelp^ $ - in period: $ - %input!name=p!size=20!value=$string.p$ - ^phelp^ $ - %input!type=submit!value=filter - ^resetlink^ +accountNameToAccountRegex :: String -> String +accountNameToAccountRegex "" = "" +accountNameToAccountRegex a = printf "^%s(:|$)" a + +accountRegexToAccountName :: String -> String +accountRegexToAccountName = gsubRegexPR "^\\^(.*?)\\(:\\|\\$\\)$" "\\1" + +isAccountRegex :: String -> Bool +isAccountRegex s = take 1 s == "^" && (take 5 $ reverse s) == ")$|:(" + +---------------------------------------------------------------------- + +-- | A basic journal view, like hledger print, with editing. +getJournalOnlyR :: Handler RepHtml +getJournalOnlyR = do + (a, p, opts, fspec, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + let td = mktd{here=here, title="hledger journal", msg=msg, a=a, p=p, j=j, today=today} + editform' = editform td $ jtext j + txns = journalReportAsHtml opts td $ journalReport opts fspec j + hamletToRepHtml $ pageLayout td [$hamlet| +%div.journal + %div.nav2 + %a#addformlink!href!onclick="return addformToggle()" add one transaction + \ | $ + %a#editformlink!href!onclick="return editformToggle()" edit the whole journal + ^addform.td^ + ^editform'^ + #transactions ^txns^ |] - where - ahelp = helplink "filter-patterns" "?" - phelp = helplink "period-expressions" "?" - resetlink - | null a && null p = nulltemplate - | otherwise = [$hamlet|%span#resetlink $ - %a!href=@here@ reset|] -helplink topic label = [$hamlet|%a!href=$string.u$ $string.label$|] - where u = manualurl ++ if null topic then "" else '#':topic +-- | Render a journal report as HTML. +journalReportAsHtml :: [Opt] -> TemplateData -> JournalReport -> Hamlet HledgerWebAppRoute +journalReportAsHtml _ td items = [$hamlet| +%table.journalreport + $forall number.items i + ^itemAsHtml' i^ +|] + where + number = zip [1..] + itemAsHtml' = itemAsHtml td + itemAsHtml :: TemplateData -> (Int, JournalReportItem) -> Hamlet HledgerWebAppRoute + itemAsHtml _ (n, t) = [$hamlet| + %tr.item.$evenodd$ + %td.transaction + %pre $txn$ + |] where + evenodd = if even n then "even" else "odd" + txn = trimnl $ showTransaction t where trimnl = reverse . dropWhile (=='\n') . reverse -addform :: Hamlet HledgerWebAppRoute -addform = [$hamlet| - %form!method=POST - %table.form#addform!cellpadding=0!cellspacing=0!border=0 - %tr.formheading - %td!colspan=4 - %span#formheading Add a transaction: +addform :: TemplateData -> Hamlet HledgerWebAppRoute +addform td = [$hamlet| +%script!type=text/javascript + $$(document).ready(function() { + /* dhtmlxcombo setup */ + window.dhx_globalImgPath="../static/images/"; + var desccombo = new dhtmlXCombo("description"); + var acct1combo = new dhtmlXCombo("account1"); + var acct2combo = new dhtmlXCombo("account2"); + desccombo.enableFilteringMode(true); + acct1combo.enableFilteringMode(true); + acct2combo.enableFilteringMode(true); + desccombo.setSize(300); + acct1combo.setSize(300); + acct2combo.setSize(300); + /* desccombo.enableOptionAutoHeight(true, 20); */ + /* desccombo.setOptionHeight(200); */ + }); +%form#addform!method=POST!style=display:none; + %table.form %tr %td!colspan=4 - %table!cellpadding=0!cellspacing=0!border=0 + %table %tr#descriptionrow %td Date: %td - %input!size=15!name=date!value=$string.date$ - %td + %input.textinput!size=15!name=date!value=$date$ + %td!style=padding-left:1em; Description: %td - %input!size=35!name=description!value=$string.desc$ + %select!id=description!name=description + %option + $forall descriptions d + %option!value=$d$ $d$ %tr.helprow %td %td - #help $string.datehelp$ ^datehelplink^ $ + .help $datehelp$ $ %td %td - #help $string.deschelp$ - ^transactionfields1^ - ^transactionfields2^ + .help $deschelp$ + ^postingsfields.td^ %tr#addbuttonrow %td!colspan=4 - %input!type=submit!value=$string.addlabel$ + %input!type=hidden!name=action!value=add + %input!type=submit!name=submit!value="add transaction" |] where - datehelplink = helplink "dates" "..." - datehelp = "eg: 7/20, 2010/1/1, " + -- datehelplink = helplink "dates" "..." + datehelp = "eg: 2010/7/20" deschelp = "eg: supermarket (optional)" - addlabel = "add transaction" date = "today" - desc = "" - transactionfields1 = transactionfields 1 - transactionfields2 = transactionfields 2 + descriptions = sort $ nub $ map tdescription $ jtxns $ j td --- transactionfields :: Int -> Hamlet String -transactionfields n = [$hamlet| +postingsfields :: TemplateData -> Hamlet HledgerWebAppRoute +postingsfields td = [$hamlet| + ^p1^ + ^p2^ +|] + where + p1 = postingfields td 1 + p2 = postingfields td 2 + +postingfields :: TemplateData -> Int -> Hamlet HledgerWebAppRoute +postingfields td n = [$hamlet| %tr#postingrow - %td!align=right - $string.label$: + %td!align=right $acctlabel$: %td - %input!size=35!name=$string.acctvar$!value=$string.acct$ + %select!id=$acctvar$!name=$acctvar$ + %option + $forall acctnames a + %option!value=$a$ $a$ ^amtfield^ %tr.helprow %td %td - #help $string.accthelp$ + .help $accthelp$ %td %td - #help $string.amthelp$ + .help $amthelp$ |] where - label | n == 1 = "To account" - | otherwise = "From account" - accthelp | n == 1 = "eg: expenses:food" - | otherwise = "eg: assets:bank:checking" - amtfield | n == 1 = [$hamlet| - %td + numbered = (++ show n) + acctvar = numbered "account" + amtvar = numbered "amount" + acctnames = sort $ journalAccountNamesUsed $ j td + (acctlabel, accthelp, amtfield, amthelp) + | n == 1 = ("To account" + ,"eg: expenses:food" + ,[$hamlet| + %td!style=padding-left:1em; Amount: %td - %input!size=15!name=$string.amtvar$!value=$string.amt$ + %input.textinput!size=15!name=$amtvar$!value="" |] - | otherwise = nulltemplate - amthelp | n == 1 = "eg: 5, $6, €7.01" - | otherwise = "" - acct = "" - amt = "" - numbered = (++ show n) - acctvar = numbered "accountname" - amtvar = numbered "amount" + ,"eg: $6" + ) + | otherwise = ("From account" + ,"eg: assets:bank:checking" + ,nulltemplate + ,"" + ) -postJournalPage :: Handler HledgerWebApp RepPlain -postJournalPage = do +editform :: TemplateData -> String -> Hamlet HledgerWebAppRoute +editform _ content = [$hamlet| + %form#editform!method=POST!style=display:none; + %table.form#editform + %tr + %td!colspan=2 + %textarea!name=text!rows=30!cols=80 + $content$ + %tr#addbuttonrow + %td + %span.help ^formathelp^ + %td!align=right + %span.help Are you sure ? This will overwrite the journal. $ + %input!type=hidden!name=action!value=edit + %input!type=submit!name=submit!value="save journal" + \ or $ + %a!href!onclick="return editformToggle()" cancel +|] + where + formathelp = helplink "file-format" "file format help" + +importform :: Hamlet HledgerWebAppRoute +importform = [$hamlet| + %form#importform!method=POST!style=display:none; + %table.form + %tr + %td + %input!type=file!name=file + %input!type=hidden!name=action!value=import + %input!type=submit!name=submit!value="import from file" + \ or $ + %a!href!onclick="return importformToggle()" cancel +|] + +postJournalOnlyR :: Handler RepPlain +postJournalOnlyR = do + action <- runFormPost' $ maybeStringInput "action" + case action of Just "edit" -> postEditForm + Just "import" -> postImportForm + _ -> postAddForm + +-- | Handle a journal add form post. +postAddForm :: Handler RepPlain +postAddForm = do + (_, _, opts, _, _, _, _) <- getHandlerParameters today <- liftIO getCurrentDay -- get form input values. M means a Maybe value. (dateM, descM, acct1M, amt1M, acct2M, amt2M) <- runFormPost' $ (,,,,,) <$> maybeStringInput "date" <*> maybeStringInput "description" - <*> maybeStringInput "accountname1" + <*> maybeStringInput "account1" <*> maybeStringInput "amount1" - <*> maybeStringInput "accountname2" + <*> maybeStringInput "account2" <*> maybeStringInput "amount2" -- supply defaults and parse date and amounts, or get errors. let dateE = maybe (Left "date required") (either (\e -> Left $ showDateParseError e) Right . fixSmartDateStrEither today) dateM @@ -330,81 +546,18 @@ Left errs -> do -- save current form values in session setMessage $ string $ intercalate "; " errs - redirect RedirectTemporary JournalPage + redirect RedirectTemporary RegisterR Right t -> do let t' = txnTieKnot t -- XXX move into balanceTransaction j <- liftIO $ fromJust `fmap` getValue "hledger" "journal" - liftIO $ journalAddTransaction j t' + liftIO $ journalAddTransaction j opts t' setMessage $ string $ printf "Added transaction:\n%s" (show t') - redirect RedirectTemporary JournalPage - -getEditPage :: Handler HledgerWebApp RepHtml -getEditPage = do - -- app <- getYesod - -- t <- liftIO $ getCurrentLocalTime - a <- fromMaybe "" <$> lookupGetParam "a" - p <- fromMaybe "" <$> lookupGetParam "p" - -- opts = appOpts app ++ [Period p] - -- args = appArgs app ++ [a] - -- fspec = optsToFilterSpec opts args t - -- reload journal's text, without parsing, if changed - j <- liftIO $ fromJust `fmap` getValue "hledger" "journal" - changed <- liftIO $ journalFileIsNewer j - -- XXX readFile may throw an error - s <- liftIO $ if changed then readFile (filepath j) else return (jtext j) - -- render the page - msg <- getMessage - Just here <- getCurrentRoute - hamletToRepHtml $ template' here msg a p "hledger" s - -template' here msg a p title content = [$hamlet| -!!! -%html - %head - %title $string.title$ - %meta!http-equiv=Content-Type!content=$string.metacontent$ - %link!rel=stylesheet!type=text/css!href=@stylesheet@!media=all - %body - ^navbar'^ - #messages $m$ - ^editform'^ -|] - where m = fromMaybe (string "") msg - navbar' = navbar here a p - stylesheet = StyleCss - metacontent = "text/html; charset=utf-8" - editform' = editform content - -editform :: String -> Hamlet HledgerWebAppRoute -editform t = [$hamlet| - %form!method=POST - %table.form#editform!cellpadding=0!cellspacing=0!border=0 - %tr.formheading - %td!colspan=2 - %span!style=float:right; ^formhelp^ - %span#formheading Edit journal: - %tr - %td!colspan=2 - %textarea!name=text!rows=30!cols=80 - $string.t$ - %tr#addbuttonrow - %td - %a!href=@JournalPage@ cancel - %td!align=right - %input!type=submit!value=$string.submitlabel$ - %tr.helprow - %td - %td!align=right - #help $string.edithelp$ -|] - where - submitlabel = "save journal" - formhelp = helplink "file-format" "file format help" - edithelp = "Are you sure ? All previous data will be replaced" + redirect RedirectTemporary RegisterR -postEditPage :: Handler HledgerWebApp RepPlain -postEditPage = do +-- | Handle a journal edit form post. +postEditForm :: Handler RepPlain +postEditForm = do -- get form input values, or basic validation errors. E means an Either value. textM <- runFormPost' $ maybeStringInput "text" let textE = maybe (Left "No value provided") Right textM @@ -413,7 +566,7 @@ Left errs -> do -- XXX should save current form values in session setMessage $ string errs - redirect RedirectTemporary JournalPage + redirect RedirectTemporary JournalR Right t' -> do -- try to avoid unnecessary backups or saving invalid data @@ -427,16 +580,311 @@ if not changed then do setMessage $ string $ "No change" - redirect RedirectTemporary EditPage + redirect RedirectTemporary JournalR else do jE <- liftIO $ journalFromPathAndString Nothing f tnew either (\e -> do setMessage $ string e - redirect RedirectTemporary EditPage) + redirect RedirectTemporary JournalR) (const $ do liftIO $ writeFileWithBackup f tnew setMessage $ string $ printf "Saved journal %s\n" (show f) - redirect RedirectTemporary JournalPage) + redirect RedirectTemporary JournalR) jE + +-- | Handle an import page post. +postImportForm :: Handler RepPlain +postImportForm = do + setMessage $ string $ "can't handle file upload yet" + redirect RedirectTemporary JournalR + -- -- get form input values, or basic validation errors. E means an Either value. + -- fileM <- runFormPost' $ maybeFileInput "file" + -- let fileE = maybe (Left "No file provided") Right fileM + -- -- display errors or import transactions + -- case fileE of + -- Left errs -> do + -- setMessage $ string errs + -- redirect RedirectTemporary JournalR + + -- Right s -> do + -- setMessage $ string $ s + -- redirect RedirectTemporary JournalR + +---------------------------------------------------------------------- + +-- | A simple postings view like hledger register. +getRegisterOnlyR :: Handler RepHtml +getRegisterOnlyR = do + (a, p, opts, fspec, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + let td = mktd{here=here, title="hledger register", msg=msg, a=a, p=p, j=j, today=today} + hamletToRepHtml $ pageLayout td $ registerReportAsHtml opts td $ registerReport opts fspec j + +-- | Render a register report as HTML. +registerReportAsHtml :: [Opt] -> TemplateData -> RegisterReport -> Hamlet HledgerWebAppRoute +registerReportAsHtml _ td items = [$hamlet| +%table.registerreport + %tr.headings + ^headings^ + $forall number.items i + ^itemAsHtml' i^ +|] + where + number = zip [1..] + headings = [$hamlet| + %th.date!align=left Date + %th.description!align=left Description + %th.account!align=left Account + %th.amount!align=right Amount + %th.balance!align=right Balance + |] + itemAsHtml' = itemAsHtml td + itemAsHtml :: TemplateData -> (Int, RegisterReportItem) -> Hamlet HledgerWebAppRoute + itemAsHtml TD{p=p} (n, (ds, posting, b)) = [$hamlet| + %tr.item.$evenodd$.$firstposting$ + %td.date $date$ + %td.description $desc$ + %td.account + %a!href=$aurl$ $acct$ + %td.amount!align=right $mixedAmountAsHtml.pamount.posting$ + %td.balance!align=right $mixedAmountAsHtml.b$ + |] where + evenodd = if even n then "even" else "odd" + (firstposting, date, desc) = case ds of Just (da, de) -> ("firstposting", show da, de) + Nothing -> ("", "", "") + acct = paccount posting + aurl = printf ".?a=%s%s" (accountNameToAccountRegex acct) p' :: String + p' = if null p then "" else printf "&p=%s" p + +mixedAmountAsHtml b = preEscapedString $ addclass $ intercalate "
" $ lines $ show b + where addclass = printf "%s" c + c = case isNegativeMixedAmount b of Just True -> "negative amount" + _ -> "positive amount" + +---------------------------------------------------------------------- + +-- | A standalone journal edit form page. +getEditR :: Handler RepHtml +getEditR = do + (a, p, _, _, _, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + -- reload journal's text without parsing, if changed -- XXX are we doing this right ? + j <- liftIO $ fromJust `fmap` getValue "hledger" "journal" + changed <- liftIO $ journalFileIsNewer j + s <- liftIO $ if changed then readFile (filepath j) else return (jtext j) -- XXX readFile may throw an error + let td = mktd{here=here, title="hledger journal edit", msg=msg, a=a, p=p, j=j, today=today} + hamletToRepHtml $ pageLayout td $ editform td s + +---------------------------------------------------------------------- + +-- | Get the add form from template files reloaded at run-time. +getAddformRTR :: Handler RepHtml +getAddformRTR = do + (a, p, _, _, j, msg, here) <- getHandlerParameters + today <- liftIO getCurrentDay + let td = mktd{here=here, title="hledger add transaction", msg=msg, a=a, p=p, j=j, today=today} + descriptions = sort $ nub $ map tdescription $ jtxns j + acctnames = sort $ journalAccountNamesUsed j + postingData n = [ + (["acctlabel"], hdstring acctlabel) + ,(["acctvar"], hdstring acctvar) + ,(["acctnames"], hdstringlist acctnames) + ,(["amtfield"], HDHtml $ renderHamlet' amtfield) + ,(["accthelp"], hdstring accthelp) + ,(["amthelp"], hdstring amthelp) + ] :: HamletMap HledgerWebAppRoute + where + numbered = (++ show n) + acctvar = numbered "account" + amtvar = numbered "amount" + (acctlabel, accthelp, amtfield, amthelp) + | n == 1 = ("To account" + ,"eg: expenses:food" + ,[$hamlet| + %td!style=padding-left:1em; + Amount: + %td + %input.textinput!size=15!name=$amtvar$!value="" + |] + ,"eg: $6" + ) + | otherwise = ("From account" + ,"eg: assets:bank:checking" + ,nulltemplate + ,"" + ) + pfields1 <- renderHamletFile "addformpostingfields.hamlet" (postingData 1) + pfields2 <- renderHamletFile "addformpostingfields.hamlet" (postingData 2) + addform <- renderHamletFile "addform.hamlet" ([ + (["date"], hdstring "today") + ,(["desc"], hdstring "") + ,(["descriptions"], hdstringlist descriptions) + ,(["datehelp"], hdstring "eg: 2010/7/20") + ,(["deschelp"], hdstring "eg: supermarket (optional)") + ,(["postingfields1"], HDHtml pfields1) + ,(["postingfields2"], HDHtml pfields2) + ] :: HamletMap HledgerWebAppRoute) + hamletToRepHtml $ pageLayout td $ htmlAsHamlet addform + +-- | Convert a string to a hamlet HDHtml data item. +hdstring :: String -> HamletData HledgerWebAppRoute +hdstring = HDHtml . string + +-- | Convert a simple list of strings to hamlet's complicated HDList type. +hdstringlist :: [String] -> HamletData HledgerWebAppRoute +hdstringlist ss = HDList [ [([], hdstring s)] | s <- ss ] + +instance Failure HamletException Handler + where failure = error' . show + +renderHamletFile :: FilePath -> HamletMap HledgerWebAppRoute -> Handler Html +renderHamletFile hfile hmap = do + hrt <- readHamletFile hfile >>= parseHamletRT defaultHamletSettings + renderHamletRT hrt hmap renderurlwithparams + +renderurlwithparams u [] = show u +renderurlwithparams u ps = show u ++ "?" ++ intercalate "&" [k++"="++v | (k,v) <- ps] + +readHamletFile :: FilePath -> Handler String +readHamletFile hfile = do + dir <- (( "templates") . appDir) `fmap` getYesod + liftIO $ readFile $ dir hfile + +htmlAsHamlet :: Html -> Hamlet HledgerWebAppRoute +htmlAsHamlet h = [$hamlet|$h$|] + +parseHamletRT' :: Failure HamletException m => String -> m HamletRT +parseHamletRT' s = parseHamletRT defaultHamletSettings s + +renderHamletRT' :: Failure HamletException m => HamletMap HledgerWebAppRoute -> HamletRT -> m Html +renderHamletRT' m h = renderHamletRT h m renderurlwithparams + +renderHamlet' :: Hamlet HledgerWebAppRoute -> Html +renderHamlet' h = h renderurlwithparams + +-- hamletToHamletRT :: Failure HamletException m => Hamlet HledgerWebAppRoute -> m HamletRT +-- hamletToHamletRT h = stringToHamletRT $ show $ unsafeByteString $ renderHamlet show h + +---------------------------------------------------------------------- + +-- | Wrap a template with the standard hledger web ui page layout. +pageLayout :: TemplateData -> Hamlet HledgerWebAppRoute -> Hamlet HledgerWebAppRoute +pageLayout td@TD{title=basetitle, msg=msg, p=p, j=j, today=today} content = [$hamlet| +!!! +%html + %head + %title $title'$ + %meta!http-equiv=Content-Type!content=$metacontent$ + %script!type=text/javascript!src=@StaticR.jquery_js@ + %script!type=text/javascript!src=@StaticR.jquery_url_js@ + %script!type=text/javascript!src=@StaticR.dhtmlxcommon_js@ + %script!type=text/javascript!src=@StaticR.dhtmlxcombo_js@ + %script!type=text/javascript!src=@StaticR.hledger_js@ + %link!rel=stylesheet!type=text/css!media=all!href=@StaticR.style_css@ + %body + ^navbar.td^ + #messages $m$ + #content + ^content^ +|] + where m = fromMaybe (string "") msg + metacontent = "text/html; charset=utf-8" + (journaltitle, _) = journalTitleInfo j p today + title' = basetitle ++ " - " ++ journaltitle + +navbar :: TemplateData -> Hamlet HledgerWebAppRoute +navbar TD{p=p,j=j,today=today} = [$hamlet| + #navbar + %a.topleftlink!href=$hledgerorgurl$ + hledger +
+ $version$ + %a.toprightlink!href=$manualurl$!target=hledgerhelp manual + %h1 $journaltitle$ + \ $ + %span#journalinfo $journalinfo$ +|] + where (journaltitle, journalinfo) = journalTitleInfo j p today + +-- | Generate journal- and context-specific title and info strings for display. +journalTitleInfo :: Journal -> String -> Day -> (String, String) +journalTitleInfo j p today = (journaltitle, journalinfo) + where + journaltitle = printf "%s" (takeFileName $ filepath j) :: String + journalinfo = printf "%s" (showspan span) :: String + span = either (const $ DateSpan Nothing Nothing) snd (parsePeriodExpr today p) + showspan (DateSpan Nothing Nothing) = "" + showspan s = " (" ++ dateSpanAsText s ++ ")" + +navlinks :: TemplateData -> Hamlet HledgerWebAppRoute +navlinks td = [$hamlet| + #navlinks + ^accountsjournallink^ + \ | $ + ^accountsregisterlink^ + \ | $ + %a#addformlink!href!onclick="return addformToggle()" add transaction + %a#importformlink!href!onclick="return importformToggle()"!style=display:none; import transactions + \ | $ + %a#editformlink!href!onclick="return editformToggle()" edit journal +|] +-- \ | $ + where + accountsjournallink = navlink td "journal" JournalR + accountsregisterlink = navlink td "register" RegisterR + +navlink :: TemplateData -> String -> HledgerWebAppRoute -> Hamlet HledgerWebAppRoute +navlink TD{here=here,a=a,p=p} s dest = [$hamlet|%a#$s$link.$style$!href=@?u@ $s$|] + where u = (dest, concat [(if null a then [] else [("z", a)]) + ,(if null p then [] else [("p", p)])]) + style | dest == here = "navlinkcurrent" + | otherwise = "navlink" + +filterform :: TemplateData -> Hamlet HledgerWebAppRoute +filterform TD{here=here,a=a,p=p} = [$hamlet| + #filterformdiv + %form#filterform.form!method=GET!style=display:$visible$; + %table.form + %tr.$filteringperiodclass$ + %td + filter by period: + \ $ + %td + %input!name=p!size=60!value=$p$ + ^phelp^ + \ $ + %td!align=right + ^stopfilteringperiod^ + %tr.$filteringclass$ + %td + filter by account/description: + \ $ + %td + %input!name=a!size=60!value=$a$ + ^ahelp^ + \ $ + %input!type=submit!value=filter $ + \ $ + %td!align=right + ^stopfiltering^ +|] + where + ahelp = helplink "filter-patterns" "?" + phelp = helplink "period-expressions" "?" + filtering = not $ null a + filteringperiod = not $ null p + visible = "block" + filteringclass = if filtering then "filtering" else "" + filteringperiodclass = if filteringperiod then "filtering" else "" + stopfiltering = if filtering then [$hamlet|%a#stopfilterlink!href=@?u@ stop filtering acct/desc|] else nulltemplate + where u = (here, if filteringperiod then [("p", p)] else []) + stopfilteringperiod = if filteringperiod then [$hamlet|%a#stopfilterlink!href=@?u@ stop filtering period|] else nulltemplate + where u = (here, if filtering then [("q", a)] else []) + +helplink :: String -> String -> Hamlet HledgerWebAppRoute +helplink topic label = [$hamlet|%a!href=$u$!target=hledgerhelp $label$|] + where u = manualurl ++ if null topic then "" else '#':topic + +nulltemplate = [$hamlet||] diff --git a/Hledger/Cli/Commands/Web610.hs b/Hledger/Cli/Commands/Web610.hs deleted file mode 100644 --- a/Hledger/Cli/Commands/Web610.hs +++ /dev/null @@ -1,316 +0,0 @@ -{-# LANGUAGE CPP, FlexibleContexts, FlexibleInstances, MultiParamTypeClasses #-} -{-# OPTIONS_GHC -F -pgmFtrhsx #-} -{-| -A web-based UI. --} - -module Hledger.Cli.Commands.Web610 -where -import Codec.Binary.UTF8.String (decodeString) -import Control.Applicative.Error (Failing(Success,Failure)) -import Control.Concurrent -import Control.Monad.Reader (ask) -import Data.IORef (newIORef, atomicModifyIORef) -import System.IO.Storage (withStore, putValue, getValue) -import Text.ParserCombinators.Parsec (parse) - -import Hack.Contrib.Constants (_TextHtmlUTF8) -import Hack.Contrib.Response (set_content_type) -import qualified Hack (Env, http) -import qualified Hack.Contrib.Request (inputs, params, path) -import qualified Hack.Contrib.Response (redirect) -import Hack.Handler.SimpleServer (run) - -import Network.Loli (loli, io, get, post, html, text, public) -import Network.Loli.Type (AppUnit) -import Network.Loli.Utils (update) - -import HSP hiding (Request,catch) -import qualified HSP (Request(..)) - -import Hledger.Cli.Commands.Add (journalAddTransaction) -import Hledger.Cli.Commands.Balance -import Hledger.Cli.Commands.Histogram -import Hledger.Cli.Commands.Print -import Hledger.Cli.Commands.Register -import Hledger.Data -import Hledger.Read.Journal (someamount) -import Hledger.Cli.Options hiding (value) -#ifdef MAKE -import Paths_hledger_make (getDataFileName) -#else -import Paths_hledger (getDataFileName) -#endif -import Hledger.Cli.Utils - - -tcpport = 5000 :: Int -homeurl = printf "http://localhost:%d/" tcpport -browserdelay = 100000 -- microseconds - -web :: [Opt] -> [String] -> Journal -> IO () -web opts args j = do - unless (Debug `elem` opts) $ forkIO browser >> return () - server opts args j - -browser :: IO () -browser = putStrLn "starting web browser" >> threadDelay browserdelay >> openBrowserOn homeurl >> return () - -server :: [Opt] -> [String] -> Journal -> IO () -server opts args j = - -- server initialisation - withStore "hledger" $ do -- IO () - printf "starting web server on port %d\n" tcpport - t <- getCurrentLocalTime - webfiles <- getDataFileName "web" - putValue "hledger" "journal" j - run tcpport $ -- (Env -> IO Response) -> IO () - \env -> do -- IO Response - -- general request handler - let opts' = opts ++ [Period $ unwords $ map decodeString $ reqParamUtf8 env "p"] - args' = args ++ map decodeString (reqParamUtf8 env "a") - j' <- fromJust `fmap` getValue "hledger" "journal" - (jE, changed) <- io $ journalReloadIfChanged opts j' - let (j''', err) = either (\e -> (j',e)) (\j'' -> (j'',"")) jE - when (changed && null err) $ putValue "hledger" "journal" j''' - when (changed && not (null err)) $ printf "error while reading %s\n" (filepath j') - -- declare path-specific request handlers - let command :: [String] -> ([Opt] -> FilterSpec -> Journal -> String) -> AppUnit - command msgs f = string msgs $ f opts' (optsToFilterSpec opts' args' t) j''' - (loli $ -- State Loli () -> (Env -> IO Response) - do - get "/balance" $ command [] showBalanceReport -- String -> ReaderT Env (StateT Response IO) () -> State Loli () - get "/register" $ command [] showRegisterReport - get "/histogram" $ command [] showHistogram - get "/transactions" $ journalpage [] j''' (showTransactions (optsToFilterSpec opts' args' t)) - post "/transactions" $ handleAddform j''' - get "/env" $ getenv >>= (text . show) - get "/params" $ getenv >>= (text . show . Hack.Contrib.Request.params) - get "/inputs" $ getenv >>= (text . show . Hack.Contrib.Request.inputs) - public (Just webfiles) ["/style.css"] - get "/" $ redirect ("transactions") Nothing - ) env - -getenv = ask -response = update -redirect u c = response $ Hack.Contrib.Response.redirect u c - -reqParamUtf8 :: Hack.Env -> String -> [String] -reqParamUtf8 env p = map snd $ filter ((==p).fst) $ Hack.Contrib.Request.params env - -journalpage :: [String] -> Journal -> (Journal -> String) -> AppUnit -journalpage msgs j f = do - env <- getenv - (jE, _) <- io $ journalReloadIfChanged [] j - let (j'', _) = either (\e -> (j,e)) (\j' -> (j',"")) jE - hsp msgs $ const
<% addform env %>
<% f j'' %>
- --- | A loli directive to serve a string in pre tags within the hledger web --- layout. -string :: [String] -> String -> AppUnit -string msgs s = hsp msgs $ const 
<% s %>
- --- | A loli directive to serve a hsp template wrapped in the hledger web --- layout. The hack environment is passed in to every hsp template as an --- argument, since I don't see how to get it within the hsp monad. --- A list of messages is also passed, eg for form errors. -hsp :: [String] -> (Hack.Env -> HSP XML) -> AppUnit -hsp msgs f = do - env <- getenv - let contenthsp = f env - pagehsp = hledgerpage env msgs title contenthsp - html =<< (io $ do - hspenv <- hackEnvToHspEnv env - (_,xml) <- runHSP html4Strict pagehsp hspenv - return $ addDoctype $ renderAsHTML xml) - response $ set_content_type _TextHtmlUTF8 - where - title = "" - addDoctype = ("\n" ++) - hackEnvToHspEnv :: Hack.Env -> IO HSPEnv - hackEnvToHspEnv env = do - x <- newIORef 0 - let req = HSP.Request (reqParamUtf8 env) (Hack.http env) - num = NumberGen (atomicModifyIORef x (\a -> (a+1,a))) - return $ HSPEnv req num - --- htmlToHsp :: Html -> HSP XML --- htmlToHsp h = return $ cdata $ showHtml h - --- views - -hledgerpage :: Hack.Env -> [String] -> String -> HSP XML -> HSP XML -hledgerpage env msgs title content = - - - - - <% title %> - - - <% navbar env %> -
<% intercalate ", " msgs %>
-
<% content %>
- - - -navbar :: Hack.Env -> HSP XML -navbar env = - - -getParamOrNull p = (decodeString . fromMaybe "") `fmap` getParam p - -navlinks :: Hack.Env -> HSP XML -navlinks _ = do - a <- getParamOrNull "a" - p <- getParamOrNull "p" - let addparams=(++(printf "?a=%s&p=%s" a p)) - link s = <% s %> - - -searchform :: Hack.Env -> HSP XML -searchform env = do - a <- getParamOrNull "a" - p <- getParamOrNull "p" - let resetlink | null a && null p = - | otherwise = <% nbsp %>reset - where u = dropWhile (=='/') $ Hack.Contrib.Request.path env -
- <% nbsp %>search for:<% nbsp %><% help "filter-patterns" - %><% nbsp %><% nbsp %>in reporting period:<% nbsp %><% help "period-expressions" - %> - <% resetlink %> -
- -addform :: Hack.Env -> HSP XML -addform env = do - today <- io $ liftM showDate $ getCurrentDay - let inputs = Hack.Contrib.Request.inputs env - date = decodeString $ fromMaybe today $ lookup "date" inputs - desc = decodeString $ fromMaybe "" $ lookup "desc" inputs -
-
-
- - - - - <% transactionfields 1 env %> - <% transactionfields 2 env %> - -
- Date: <% help "dates" %><% nbsp %> - Description: <% nbsp %> -
<% help "file-format" %>
-
-
-
-
- -help :: String -> HSP XML -help topic = ? - where u = printf "http://hledger.org/MANUAL.html%s" l :: String - l | null topic = "" - | otherwise = '#':topic - -transactionfields :: Int -> Hack.Env -> HSP XML -transactionfields n env = do - let inputs = Hack.Contrib.Request.inputs env - acct = decodeString $ fromMaybe "" $ lookup acctvar inputs - amt = decodeString $ fromMaybe "" $ lookup amtvar inputs - - - <% nbsp %><% nbsp %> - Account: <% nbsp %> - Amount: <% nbsp %> - - - where - numbered = (++ show n) - acctvar = numbered "acct" - amtvar = numbered "amt" - -handleAddform :: Journal -> AppUnit -handleAddform j = do - env <- getenv - d <- io getCurrentDay - t <- io getCurrentLocalTime - handle t $ validate env d - where - validate :: Hack.Env -> Day -> Failing Transaction - validate env today = - let inputs = Hack.Contrib.Request.inputs env - date = decodeString $ fromMaybe "today" $ lookup "date" inputs - desc = decodeString $ fromMaybe "" $ lookup "desc" inputs - acct1 = decodeString $ fromMaybe "" $ lookup "acct1" inputs - amt1 = decodeString $ fromMaybe "" $ lookup "amt1" inputs - acct2 = decodeString $ fromMaybe "" $ lookup "acct2" inputs - amt2 = decodeString $ fromMaybe "" $ lookup "amt2" inputs - validateDate "" = ["missing date"] - validateDate _ = [] - validateDesc "" = ["missing description"] - validateDesc _ = [] - validateAcct1 "" = ["missing account 1"] - validateAcct1 _ = [] - validateAmt1 "" = ["missing amount 1"] - validateAmt1 _ = [] - validateAcct2 "" = ["missing account 2"] - validateAcct2 _ = [] - validateAmt2 _ = [] - amt1' = either (const missingamt) id $ parse someamount "" amt1 - amt2' = either (const missingamt) id $ parse someamount "" amt2 - (date', dateparseerr) = case fixSmartDateStrEither today date of - Right d -> (d, []) - Left e -> ("1900/01/01", [showDateParseError e]) - t = Transaction { - tdate = parsedate date' -- date' must be parseable - ,teffectivedate=Nothing - ,tstatus=False - ,tcode="" - ,tdescription=desc - ,tcomment="" - ,tpostings=[ - Posting False acct1 amt1' "" RegularPosting (Just t') - ,Posting False acct2 amt2' "" RegularPosting (Just t') - ] - ,tpreceding_comment_lines="" - } - (t', balanceerr) = case balanceTransaction t of - Right t'' -> (t'', []) - Left e -> (t, [head $ lines e]) -- show just the error not the transaction - errs = concat [ - validateDate date - ,dateparseerr - ,validateDesc desc - ,validateAcct1 acct1 - ,validateAmt1 amt1 - ,validateAcct2 acct2 - ,validateAmt2 amt2 - ,balanceerr - ] - in - case null errs of - False -> Failure errs - True -> Success t' - - handle :: LocalTime -> Failing Transaction -> AppUnit - handle _ (Failure errs) = hsp errs addform - handle ti (Success t) = do - io $ journalAddTransaction j t >>= journalReload - journalpage [msg] j (showTransactions (optsToFilterSpec [] [] ti)) - where msg = printf "Added transaction:\n%s" (show t) - -nbsp :: XML -nbsp = cdata " " diff --git a/Hledger/Cli/Main.hs b/Hledger/Cli/Main.hs --- a/Hledger/Cli/Main.hs +++ b/Hledger/Cli/Main.hs @@ -39,7 +39,7 @@ -} module Hledger.Cli.Main where -#if defined(WEB) || defined(WEB610) +#if defined(WEB) import System.Info (os) #endif #if __GLASGOW_HASKELL__ <= 610 @@ -76,7 +76,7 @@ #ifdef VTY | cmd `isPrefixOf` "vty" = withJournalDo opts args cmd vty #endif -#if defined(WEB) || defined(WEB610) +#if defined(WEB) | cmd `isPrefixOf` "web" = withJournalDo opts args cmd web #endif #ifdef CHART @@ -86,7 +86,7 @@ | otherwise = putStr help1 -- in a web-enabled build on windows, run the web ui by default -#if defined(WEB) || defined(WEB610) +#if defined(WEB) defaultcmd | os=="mingw32" = Just web | otherwise = Nothing #else diff --git a/Hledger/Cli/Options.hs b/Hledger/Cli/Options.hs --- a/Hledger/Cli/Options.hs +++ b/Hledger/Cli/Options.hs @@ -42,10 +42,10 @@ " (DISABLED, install with -fvty)\n" ++ #endif " web - run a simple web-based UI" ++ -#if defined(WEB) || defined(WEB610) +#if defined(WEB) "\n" ++ #else - " (DISABLED, install with -fweb or -fweb610)\n" ++ + " (DISABLED, install with -fweb)\n" ++ #endif " chart - generate balances pie charts" ++ #ifdef CHART @@ -87,6 +87,7 @@ ,Option "" ["flat"] (NoArg Flat) "balance: show full account names, unindented" ,Option "" ["drop"] (ReqArg Drop "N") "balance: with --flat, elide first N account name components" ,Option "" ["no-total"] (NoArg NoTotal) "balance: hide the final total" + ,Option "D" ["daily"] (NoArg DailyOpt) "register, stats: report by day" ,Option "W" ["weekly"] (NoArg WeeklyOpt) "register, stats: report by week" ,Option "M" ["monthly"] (NoArg MonthlyOpt) "register, stats: report by month" ,Option "Q" ["quarterly"] (NoArg QuarterlyOpt) "register, stats: report by quarter" @@ -131,6 +132,7 @@ Drop {value::String} | NoTotal | SubTotal | + DailyOpt | WeeklyOpt | MonthlyOpt | QuarterlyOpt | @@ -177,7 +179,7 @@ case (as,es) of (cmd:args,[]) -> return (os'',cmd,args) ([],[]) -> return (os'',"",[]) - (_,errs) -> ioError (userError (concat errs ++ help1)) + (_,errs) -> ioError (userError' (concat errs ++ help1)) -- | Convert any fuzzy dates within these option values to explicit ones, -- based on today's date. @@ -198,7 +200,9 @@ -- others are ignored. dateSpanFromOpts :: Day -> [Opt] -> DateSpan dateSpanFromOpts refdate opts - | not $ null popts = snd $ parsePeriodExpr refdate $ last popts + | not (null popts) = case parsePeriodExpr refdate $ last popts of + Right (_, s) -> s + Left e -> parseerror e | otherwise = DateSpan lastb laste where popts = optValuesForConstructor Period opts @@ -214,7 +218,10 @@ intervalFromOpts :: [Opt] -> Interval intervalFromOpts opts = case (periodopts, intervalopts) of - ((p:_), _) -> fst $ parsePeriodExpr d p where d = parsedate "0001/01/01" -- unused + ((p:_), _) -> case parsePeriodExpr (parsedate "0001/01/01") p of + Right (i, _) -> i + Left e -> parseerror e + (_, (DailyOpt:_)) -> Daily (_, (WeeklyOpt:_)) -> Weekly (_, (MonthlyOpt:_)) -> Monthly (_, (QuarterlyOpt:_)) -> Quarterly @@ -222,7 +229,7 @@ (_, _) -> NoInterval where periodopts = reverse $ optValuesForConstructor Period opts - intervalopts = reverse $ filter (`elem` [WeeklyOpt,MonthlyOpt,QuarterlyOpt,YearlyOpt]) opts + intervalopts = reverse $ filter (`elem` [DailyOpt,WeeklyOpt,MonthlyOpt,QuarterlyOpt,YearlyOpt]) opts -- | Get the value of the (last) depth option, if any. depthFromOpts :: [Opt] -> Maybe Int diff --git a/Hledger/Cli/Tests.hs b/Hledger/Cli/Tests.hs --- a/Hledger/Cli/Tests.hs +++ b/Hledger/Cli/Tests.hs @@ -12,10 +12,10 @@ hledger's doctests are shell tests defined in literal blocks in haddock documentation in the source, run by doing @make doctest@ in the hledger -source tree. They are no longer used, but here is an example: +source tree. They hardly used, but here is an example: @ -$ hledger -f sample.journal balance o +$ hledger -f data/sample.journal balance o $1 expenses:food $-2 income $-1 gifts @@ -61,8 +61,8 @@ tests_Hledger_Commands, "account directive" ~: - let sameParse str1 str2 = do j1 <- readJournal Nothing str1 >>= either error return - j2 <- readJournal Nothing str2 >>= either error return + let sameParse str1 str2 = do j1 <- readJournal Nothing str1 >>= either error' return + j2 <- readJournal Nothing str2 >>= either error' return j1 `is` j2{filereadtime=filereadtime j1, jtext=jtext j1} in TestList [ @@ -109,7 +109,7 @@ let (opts,args) `gives` es = do l <- samplejournalwithopts opts args t <- getCurrentLocalTime - showBalanceReport opts (optsToFilterSpec opts args t) l `is` unlines es + balanceReportAsText opts (balanceReport opts (optsToFilterSpec opts args t) l) `is` unlines es in TestList [ @@ -243,9 +243,9 @@ ,"2008/1/1 test " ," a:b 10h @ $50" ," c:d " - ]) >>= either error return + ]) >>= either error' return let j' = journalCanonicaliseAmounts $ journalConvertAmountsToCost j -- enable cost basis adjustment - showBalanceReport [] nullfilterspec j' `is` + balanceReportAsText [] (balanceReport [] nullfilterspec j') `is` unlines [" $500 a:b" ," $-500 c:d" @@ -260,7 +260,7 @@ ," test:a 1" ," test:b" ]) - showBalanceReport [] nullfilterspec l `is` + balanceReportAsText [] (balanceReport [] nullfilterspec l) `is` unlines [" 1 test:a" ," -1 test:b" @@ -292,7 +292,7 @@ (Mixed [dollars (-1)]) (case e of Right e' -> (pamount $ last $ tpostings e') - Left _ -> error "should not happen") + Left _ -> error' "should not happen") ,"journalCanonicaliseAmounts" ~: "use the greatest precision" ~: @@ -323,6 +323,7 @@ ,"intervalFromOpts" ~: do let gives = is . intervalFromOpts [] `gives` NoInterval + [DailyOpt] `gives` Daily [WeeklyOpt] `gives` Weekly [MonthlyOpt] `gives` Monthly [QuarterlyOpt] `gives` Quarterly @@ -384,7 +385,7 @@ "assets:bank" `isSubAccountNameOf` "my assets" `is` False ,"default year" ~: do - rl <- readJournal Nothing defaultyear_journal_str >>= either error return + rl <- readJournal Nothing defaultyear_journal_str >>= either error' return tdate (head $ jtxns rl) `is` fromGregorian 2009 1 1 return () @@ -458,7 +459,7 @@ "register report with no args" ~: do l <- samplejournal - showRegisterReport [] (optsToFilterSpec [] [] t1) l `is` unlines + (registerReportAsText [] $ registerReport [] (optsToFilterSpec [] [] t1) l) `is` unlines ["2008/01/01 income assets:bank:checking $1 $1" ," income:salary $-1 0" ,"2008/06/01 gift assets:bank:checking $1 $1" @@ -476,7 +477,7 @@ do let opts = [Cleared] l <- readJournalWithOpts opts sample_journal_str - showRegisterReport opts (optsToFilterSpec opts [] t1) l `is` unlines + (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` unlines ["2008/06/03 eat & shop expenses:food $1 $1" ," expenses:supplies $1 $2" ," assets:cash $-2 0" @@ -488,7 +489,7 @@ do let opts = [UnCleared] l <- readJournalWithOpts opts sample_journal_str - showRegisterReport opts (optsToFilterSpec opts [] t1) l `is` unlines + (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` unlines ["2008/01/01 income assets:bank:checking $1 $1" ," income:salary $-1 0" ,"2008/06/01 gift assets:bank:checking $1 $1" @@ -508,19 +509,19 @@ ," e 1" ," f" ] - registerdates (showRegisterReport [] (optsToFilterSpec [] [] t1) l) `is` ["2008/01/01","2008/02/02"] + registerdates (registerReportAsText [] $ registerReport [] (optsToFilterSpec [] [] t1) l) `is` ["2008/01/01","2008/02/02"] ,"register report with account pattern" ~: do l <- samplejournal - showRegisterReport [] (optsToFilterSpec [] ["cash"] t1) l `is` unlines + (registerReportAsText [] $ registerReport [] (optsToFilterSpec [] ["cash"] t1) l) `is` unlines ["2008/06/03 eat & shop assets:cash $-2 $-2" ] ,"register report with account pattern, case insensitive" ~: do l <- samplejournal - showRegisterReport [] (optsToFilterSpec [] ["cAsH"] t1) l `is` unlines + (registerReportAsText [] $ registerReport [] (optsToFilterSpec [] ["cAsH"] t1) l) `is` unlines ["2008/06/03 eat & shop assets:cash $-2 $-2" ] @@ -528,7 +529,7 @@ do l <- samplejournal let gives displayexpr = - (registerdates (showRegisterReport opts (optsToFilterSpec opts [] t1) l) `is`) + (registerdates (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is`) where opts = [Display displayexpr] "d<[2008/6/2]" `gives` ["2008/01/01","2008/06/01"] "d<=[2008/6/2]" `gives` ["2008/01/01","2008/06/01","2008/06/02"] @@ -541,7 +542,7 @@ l <- samplejournal let periodexpr `gives` dates = do l' <- samplejournalwithopts opts [] - registerdates (showRegisterReport opts (optsToFilterSpec opts [] t1) l') `is` dates + registerdates (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l') `is` dates where opts = [Period periodexpr] "" `gives` ["2008/01/01","2008/06/01","2008/06/02","2008/06/03","2008/12/31"] "2008" `gives` ["2008/01/01","2008/06/01","2008/06/02","2008/06/03","2008/12/31"] @@ -550,7 +551,7 @@ "monthly" `gives` ["2008/01/01","2008/06/01","2008/12/01"] "quarterly" `gives` ["2008/01/01","2008/04/01","2008/10/01"] let opts = [Period "yearly"] - showRegisterReport opts (optsToFilterSpec opts [] t1) l `is` unlines + (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` unlines ["2008/01/01 - 2008/12/31 assets:bank:saving $1 $1" ," assets:cash $-2 $-1" ," expenses:food $1 0" @@ -560,9 +561,9 @@ ," liabilities:debts $1 0" ] let opts = [Period "quarterly"] - registerdates (showRegisterReport opts (optsToFilterSpec opts [] t1) l) `is` ["2008/01/01","2008/04/01","2008/10/01"] + registerdates (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` ["2008/01/01","2008/04/01","2008/10/01"] let opts = [Period "quarterly",Empty] - registerdates (showRegisterReport opts (optsToFilterSpec opts [] t1) l) `is` ["2008/01/01","2008/04/01","2008/07/01","2008/10/01"] + registerdates (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` ["2008/01/01","2008/04/01","2008/07/01","2008/10/01"] ] @@ -570,13 +571,18 @@ do l <- samplejournal let opts = [Depth "2"] - showRegisterReport opts (optsToFilterSpec opts [] t1) l `is` unlines - ["2008/01/01 income income:salary $-1 $-1" - ,"2008/06/01 gift income:gifts $-1 $-2" - ,"2008/06/03 eat & shop expenses:food $1 $-1" - ," expenses:supplies $1 0" - ," assets:cash $-2 $-2" - ,"2008/12/31 pay off liabilities:debts $1 $-1" + (registerReportAsText opts $ registerReport opts (optsToFilterSpec opts [] t1) l) `is` unlines + ["2008/01/01 income assets:bank $1 $1" + ," income:salary $-1 0" + ,"2008/06/01 gift assets:bank $1 $1" + ," income:gifts $-1 0" + ,"2008/06/02 save assets:bank $1 $1" + ," assets:bank $-1 0" + ,"2008/06/03 eat & shop expenses:food $1 $1" + ," expenses:supplies $1 $2" + ," assets:cash $-2 0" + ,"2008/12/31 pay off liabilities:debts $1 $1" + ," assets:bank $-1 0" ] ,"show dollars" ~: show (dollars 1) ~?= "$1.00" @@ -586,7 +592,7 @@ ,"unicode in balance layout" ~: do l <- readJournalWithOpts [] "2009/01/01 * медвежья шкура\n расходы:покупки 100\n актив:наличные\n" - showBalanceReport [] (optsToFilterSpec [] [] t1) l `is` unlines + balanceReportAsText [] (balanceReport [] (optsToFilterSpec [] [] t1) l) `is` unlines [" -100 актив:наличные" ," 100 расходы:покупки" ,"--------------------" @@ -596,7 +602,7 @@ ,"unicode in register layout" ~: do l <- readJournalWithOpts [] "2009/01/01 * медвежья шкура\n расходы:покупки 100\n актив:наличные\n" - showRegisterReport [] (optsToFilterSpec [] [] t1) l `is` unlines + (registerReportAsText [] $ registerReport [] (optsToFilterSpec [] [] t1) l) `is` unlines ["2009/01/01 медвежья шкура расходы:покупки 100 100" ," актив:наличные -100 0"] diff --git a/Hledger/Cli/Utils.hs b/Hledger/Cli/Utils.hs --- a/Hledger/Cli/Utils.hs +++ b/Hledger/Cli/Utils.hs @@ -38,7 +38,7 @@ -- We kludgily read the file before parsing to grab the full text, unless -- it's stdin, or it doesn't exist and we are adding. We read it strictly -- to let the add command work. - journalFilePathFromOpts opts >>= readJournalFile Nothing >>= either error runcmd + journalFilePathFromOpts opts >>= readJournalFile Nothing >>= either (error'.trace "BBB") runcmd where costify = (if CostBasis `elem` opts then journalConvertAmountsToCost else id) runcmd = cmd opts args . costify @@ -46,7 +46,7 @@ -- | Get a journal from the given string and options, or throw an error. readJournalWithOpts :: [Opt] -> String -> IO Journal readJournalWithOpts opts s = do - j <- readJournal Nothing s >>= either error return + j <- readJournal Nothing s >>= either error' return return $ (if cost then journalConvertAmountsToCost else id) j where cost = CostBasis `elem` opts diff --git a/Hledger/Cli/Version.hs b/Hledger/Cli/Version.hs --- a/Hledger/Cli/Version.hs +++ b/Hledger/Cli/Version.hs @@ -10,7 +10,7 @@ import Hledger.Data.Utils -- version and PATCHLEVEL are set by the makefile -version = "0.11.1" +version = "0.12.0" #ifdef PATCHLEVEL patchlevel = "." ++ show PATCHLEVEL -- must be numeric ! @@ -41,8 +41,8 @@ prettify (major:minor:bugfix:[]) = prettify [major,minor,bugfix,"0"] prettify (major:minor:[]) = prettify [major,minor,"0","0"] prettify (major:[]) = prettify [major,"0","0","0"] - prettify [] = error "VERSION is empty, please fix" - prettify _ = error "VERSION has too many components, please fix" + prettify [] = error' "VERSION is empty, please fix" + prettify _ = error' "VERSION has too many components, please fix" versionstr = prettify $ splitAtElement '.' buildversion :: String where @@ -70,8 +70,6 @@ ,"vty" #endif #if defined(WEB) - ,"web (using yesod/hamlet/simpleserver)" -#elif defined(WEB610) - ,"web (using loli/hsp/simpleserver)" + ,"web" #endif ] diff --git a/MANUAL.markdown b/MANUAL.markdown --- a/MANUAL.markdown +++ b/MANUAL.markdown @@ -4,7 +4,7 @@ # hledger manual -This is the official hledger manual, for version 0.11.1. You may also +This is the official hledger manual, for version 0.12.0. You may also want to visit the rest of [hledger.org](http://hledger.org), and for background, [c++ ledger's manual](http://joyful.com/repos/ledger/doc/ledger.html). @@ -43,52 +43,57 @@ ### Installing -hledger works on all major platforms; here are the [release -notes](http://hledger.org/NEWS.html). One of these pre-built -[binaries](http://hledger.org/binaries/) might work for you, but at -present these are not very up-to-date, so the usual thing is to build -with the cabal-install tool: +hledger works on all major platforms. Here are the [release +notes](http://hledger.org/NEWS.html), and pre-built +[binaries](http://hledger.org/binaries/) you should be able to +download and run. If not, or if you prefer an up-to-date build, +open a shell/terminal/command window and: -1. If you don't already have the Glasgow Haskell Compiler and - cabal-install, download and install the - [Haskell Platform](http://hackage.haskell.org/platform/). Or, you may - be able to use platform packages; eg on Ubuntu Lucid, do `apt-get - install ghc6 cabal-install happy`. +1. **ensure you have GHC (6.10 or newer) and cabal-install** -2. Install hledger with cabal-install. Make sure ~/.cabal/bin is in your - path; this is required while installing some cabal packages. Eg: + $ ghc --version + $ cabal --version - export PATH=$PATH:~/.cabal/bin - cabal update - cabal install hledger + If not, download and install the [Haskell + Platform](http://hackage.haskell.org/platform/). Or, you may be + able to use your platform's packaging system, eg on ubuntu lucid + do `apt-get install ghc6 cabal-install zlib1g-dev`. Also make + sure `~/.cabal/bin` is in your PATH. - You can add the following options to the install command to build - extra features (if you're new to cabal, I recommend you get the basic - install working first, then add these one at a time): +2. **install hledger with cabal-install** - - `-fchart` builds the [chart](#chart) command, enabling simple - balance pie chart generation. This requires additional GTK/GHC - integration libraries (on ubuntu: `apt-get install libghc6-gtk-dev`) - and possibly other things - see the - [gtk2hs install docs](http://code.haskell.org/gtk2hs/INSTALL). - At present this add a lot of build complexity for not much gain. + $ cabal update + $ cabal install hledger - - `-fvty` builds the [vty](#vty) command, enabling a basic - curses-style user interface. This does not work on microsoft - windows, unless possibly with cygwin. +#### Install options - - `-fweb` builds the [web](#web) command, enabling a web-based user - interface. This requires GHC 6.12. If you are stuck with GHC 6.10, - you can use `-fweb610` instead, to build an older version of the web - interface. +You can add the following options to the basic `cabal install hledger` +command to build extra features. I recommend you get the basic install +working first, then try these one at a time: -If you have any trouble, proceed at once to [Troubleshooting](#troubleshooting) for help! +- `-fweb` builds the [web](#web) command, enabling a web-based user + interface. This requires GHC 6.12. If you are stuck with GHC 6.10, + you can use `-fweb610` instead, to build an older version of the web + interface. +- `-fvty` builds the [vty](#vty) command, enabling a basic + curses-style user interface. This does not work on microsoft + windows, unless possibly with cygwin. + +- `-fchart` builds the [chart](#chart) command, enabling rudimentary + pie chart generation. This requires additional GTK-related libraries + (on ubuntu: `apt-get install libghc6-gtk-dev`) and possibly [other + things](http://code.haskell.org/gtk2hs/INSTALL). + +#### If you have trouble.. + +proceed to [Troubleshooting](#troubleshooting) for help! + ### Basic usage Basic usage is: - hledger [OPTIONS] [COMMAND [PATTERNS]] + $ hledger [OPTIONS] [COMMAND [PATTERNS]] [OPTIONS](#overview) may appear anywhere on the command line. [COMMAND](#commands) is one of: add, balance, chart, convert, histogram, @@ -107,31 +112,42 @@ enter a few transactions. Now you can try some of these commands, or read on: - hledger --help # show command-line help - hledger balance # all accounts with aggregated balances - hledger bal --depth 1 # only top-level accounts - hledger register # transaction register - hledger reg income # transactions to/from an income account - hledger reg checking # checking transactions - hledger reg desc:shop # transactions with shop in the description - hledger histogram # transactions per day, or other interval - hledger add # add some new transactions to the journal file - hledger vty # curses ui, if installed with -fvty - hledger web # web ui, if installed with -fweb or -fweb610 - hledger chart # make a balance chart, if installed with -fchart + $ hledger --help # show command-line help + $ hledger balance # all accounts with aggregated balances + $ hledger bal --depth 1 # only top-level accounts + $ hledger register # transaction register + $ hledger reg income # transactions to/from an income account + $ hledger reg checking # checking transactions + $ hledger reg desc:shop # transactions with shop in the description + $ hledger histogram # transactions per day, or other interval + $ hledger add # add some new transactions to the journal file + $ hledger vty # curses ui, if installed with -fvty + $ hledger web # web ui, if installed with -fweb or -fweb610 + $ hledger chart # make a balance chart, if installed with -fchart You'll find more examples below. -### Journal file +#### Journal file -hledger's data file, aka the journal, is a standard accounting -[general journal](http://en.wikipedia.org/wiki/General_journal) in a plain -text format. It contains a number of transactions, each describing a -transfer of money (or another commodity) between two or more named -accounts. Here's an example: +hledger reads data from a plain text file, called a *journal* because +it represents a standard accounting [general +journal](http://en.wikipedia.org/wiki/General_journal). It contains a +number of transactions, each describing a transfer of money (or +any commodity) between two or more named accounts, in a simple +format readable by both hledger and humans. +You can use hledger without learning any more about this file; just +use the [add](#add) or [web](#web) commands. + +Many users, though, edit the journal file directly with a text +editor. This is a distinguishing feature of hledger (and c++ ledger.) +You can even do this while the web interface is running, and see the +changes right away. + +Here's an example: + ; A sample journal file. This is a comment. 2008/01/01 income ; <- transaction's first line starts in column 0, contains date and description @@ -156,8 +172,8 @@ assets:bank:checking Each transaction has a date, optional description, and two or more -postings (of some amount to some account) which must balance to 0. As a -convenience, one posting's amount may be left blank and will be inferred. +postings, of some amount to some account. The amounts within a transaction must balance, +ie add up to 0. Or, you can leave one amount blank and it will be inferred. Note that account names may contain single spaces, while the amount must be separated from the account name by at least two spaces. @@ -168,9 +184,9 @@ the minus sign next to the number (`$-1`), but it may also go before the currency symbol/commodity name (`-$1`). -hledger's file format aims to be compatible with c++ ledger, so you can -use both tools. For more details, see -[File format compatibility](#file-format-compatibility). +hledger's file format aims to be compatible with c++ ledger, so you +can use both tools on your journal. For more details, see [File format +compatibility](#file-format-compatibility). ## Reference @@ -224,7 +240,7 @@ -C --cleared report only on cleared transactions -U --uncleared report only on uncleared transactions -B --cost, --basis report cost of commodities - --depth=N hide accounts/transactions deeper than this + --depth=N hide sub-accounts deeper than this -d EXPR --display=EXPR show only transactions matching EXPR (where EXPR is 'dOP[DATE]' and OP is <, <=, =, >=, >) --effective use transactions' effective dates, if any @@ -233,6 +249,7 @@ --flat balance: show full account names, unindented --drop=N balance: with --flat, elide first N account name components --no-total balance: hide the final total + -D --daily register, stats: report by day -W --weekly register, stats: report by week -M --monthly register, stats: report by month -Q --quarterly register, stats: report by quarter @@ -267,18 +284,25 @@ ##### register -The register command displays postings, one per line, and their running -total. With a [reporting interval](#reporting-interval) it will aggregate -similar postings within each interval. - -Examples: +The register command displays postings, one per line, and their running total. +With no [filter patterns](#filter-patterns), this is not all that different from [print](#print): $ hledger register - $ hledger register --monthly -E rent -Note `--depth` doesn't work too well with `register` currently; -it hides deeper postings rather than aggregating them. +More typically, use it to see a specific account's activity: + $ hledger register assets:bank:checking + +The `--depth` option limits the amount of sub-account detail displayed: + + $ hledger register assets:bank:checking --depth 2 + +With a [reporting interval](#reporting-interval) it shows aggregated +summary postings within each interval: + + $ hledger register --monthly rent + $ hledger register --monthly -E food --depth 4 + ##### balance The balance command displays accounts and their balances, indented to show the account hierarchy. @@ -551,49 +575,7 @@ > `2010/01/31` or `2010/1/31` or `2010-1-31` or `2010.1.31` -The [add](#add) command and the [web](#web) add form, as well as some -other places, accept [smart dates](#smart-dates) - more about those below. - -##### Default year - -You can set a default year with a `Y` directive in the journal, then -subsequent dates may be written as month/day. Eg: - - Y2009 - - 12/15 ... - - Y2010 - - 1/31 ... - -##### Actual/effective dates - -Real-life transactions sometimes have two (or more) dates of interest. -For example, you might buy a movie ticket on friday with a debit or credit -card, and the transaction might appear in your bank account on monday. -When you don't care about this, just record one date. When you do care, -you can record two dates separated by `=`: the *actual date* on the left -and the *effective date* on the right. Here's how hledger and ledger users -use these terms: - - ; The ticket purchase took EFFECT on friday 19th, - ; but ACTUALly appeared in bank statement on monday 23rd. - ; The effective date is often the earlier one, but it goes on the right. - ; - ; ACTUAL=EFFECTIVE - 2010/2/23=2010/2/19 movie ticket - expenses:cinema $10 - assets:bank:checking $-10 - -You can use the `--effective` flag to prefer the effective date in -reports. This can be useful, eg, to adjust your transaction dates to -match the ones in your bank statement for easier reconciling. - -The year may optionally be omitted in the second date. - -hledger does not allow separate dates for individual postings, unlike c++ -ledger. +The year is optional if you define a [default year](#default-year). ##### Smart dates @@ -610,13 +592,74 @@ - `last week` (the monday of the week before this one) - `today`, `yesterday`, `tomorrow` -Spaces are optional, so eg: `-p lastmonth` is valid. +Spaces are optional, so eg: `-b lastmonth` is valid. +##### Actual & effective dates + +Real-life transactions sometimes have more than one date. For +example, you might buy a movie ticket on friday with a bank debit +card, and the transaction might appear in your bank account on monday. +hledger and ledger users call these the *effective date* and *actual +date* respectively. We say: + +> *"The ticket purchase took EFFECT on friday, but ACTUALly appeared in my bank balance on monday."* + +You can often think of effective date as "my date" and actual date as "bank's date". + +When these dates differ, as in the example above, hledger's daily +balances will not exactly match your bank's. But exact daily +reconciling can be quite useful, to see precisely when disagreements +arise. There are several ways you can handle this: + +1. don't bother with exact daily reconciling; accept temporary + disagreements between hledger and bank balances. + +2. adjust manually recorded transactions to actual bank dates when necessary. + Your hledger balance will match your bank's exactly, but you no longer have + a record of when transactions *really* happened. + +3. record both dates separated by an equals sign: the *actual date* on + the left and the *effective date* on the right. The year is + optional in the second date. + +Here's an example of the last approach: on friday 19 you record: + + 2010/2/19 movie + expenses:cinema $10 + assets:checking + +hledger shows $10 less in your checking account through saturday and +sunday.. but your online bank statement does not. It shows the +transaction clearing a few days later, on monday 23. So you then +insert that actual date: + + ; ACTUAL=EFFECTIVE + 2010/2/23=2010/2/19 movie + expenses:cinema $10 + assets:checking + +Now your hledger reports match your bank's daily balance exactly, +since they use the actual date by preference. To report based on +effective dates instead, use the `--effective` flag. + +##### Default year + +You can set a default year with a `Y` directive in the journal, then +subsequent dates may be written as month/day. Eg: + + Y2009 + + 12/15 ; <- equivalent to 2009/12/15 + + Y2010 + + 1/31 ; <- equivalent to 2010/1/31 + #### Period expressions hledger supports flexible "period expressions" with the `-p/--period` -option to select transactions within a period of time (like 2009) and/or -with a reporting interval (like weekly). hledger period expressions are +option to select transactions within a period of time (eg in 2009) and/or +with a reporting interval (eg weekly). hledger period expressions are similar but not identical to c++ ledger's. Here is a basic period expression specifying the first quarter of 2009 @@ -638,7 +681,7 @@ -p "this year to 4/1" If you specify only one date, the missing start or end date will be the -earliest or latest transaction in your journal data: +earliest or latest transaction in your journal: -p "from 2009/1/1" (everything after january 1, 2009) -p "from 2009/1" (the same) @@ -652,6 +695,9 @@ -p "2009/1" (the month of jan; equivalent to "2009/1/1 to 2009/2/1") -p "2009/1/1" (just that day; equivalent to "2009/1/1 to 2009/1/2") +The `-b/--begin` and `-e/--end` options may be used as a shorthand for +`-p 'from ...'` and `-p 'to ...'` respectively. But note [-p overrides other flags](#p-overrides-other-flags). + ##### Reporting interval You can also specify a reporting interval, which causes the "register" @@ -664,13 +710,14 @@ -p "monthly from 2008" -p "quarterly" -A reporting interval may also be specified with the -W/--weekly, --M/--monthly, -Q/--quarterly, and -Y/--yearly options. However.. +A reporting interval may also be specified with the `-D/--daily`, +`-W/--weekly`, `-M/--monthly`, `-Q/--quarterly`, and `-Y/--yearly` +options. But note... ##### -p overrides other flags -Note: any period option on the command line will override the -b, -e, -W, --Q and -Y flags. +A `-p/--period` option on the command line will cause any +`-b`/`-e`/`-D`/`-W`/`-M`/`-Q`/`-Y` flags to be ignored. #### Display expressions @@ -680,27 +727,17 @@ to be used for calculation). hledger currently supports a very small subset of c++ ledger's display -expressions, namely: transactions before or after a date. This is useful -for displaying your recent check register with an accurate running -total. Note the use of \>= here to include the first of the month: +expressions, namely: transactions before or after a date. This is +useful for displaying a portion of your checking register with an +accurate running total. Eg, to show the balance since the first of the month: - $ hledger register -d "d>=[this month]" + $ hledger register -d "d>=[1]" #### Depth limiting With the `--depth N` option, reports will show only the uppermost accounts -in the account tree, down to level N. This is most useful with -[balance](#balance) (and [chart](#chart)). For example: - - $ hledger balance --depth 2 - -shows a more concise balance report displaying only the top two levels of -accounts. This example with [register](#register): - - $ hledger register --depth 1 - -would show only the postings to top-level accounts, which usually means -none. +in the account tree, down to level N. See the [balance](#balance), +[register](#register) and [chart](#chart) examples. #### Prices @@ -755,7 +792,7 @@ You can pull in the content of additional journal files, by writing lines like this: - !include other/file.journal + !include path/to/file.journal The `!include` directive may only be used in journal files, and currently it may only include other journal files (eg, not timelog files.) @@ -793,7 +830,7 @@ hledger will also read timelog files in timeclock.el format. As a convenience, if you invoke hledger via an "hours" symlink or copy, it uses -your timelog file (\~/.timelog or $TIMELOG) by default, rather than your +your timelog file (`~/.timelog` or `$TIMELOG`) by default, rather than your journal. Timelog entries look like this: @@ -845,6 +882,9 @@ and c++ledger if you avoid the more esoteric syntax. Occasionally you'll need to make small edits to restore compatibility for one or the other. +hledger does not allow separate dates for individual postings, unlike c++ +ledger. + #### Features not supported c++ ledger features not currently supported include: modifier and periodic @@ -910,23 +950,28 @@ - hledger recognises description and negative patterns by "desc:" and "not:" prefixes, unlike ledger 3's free-form parser + - hledger doesn't require a space before command-line option - values, you can write -f- + values, eg either `-f-` or `-f -` is fine + - hledger's weekly reporting intervals always start on mondays + - hledger shows start and end dates of the intervals requested, not just the span containing data + - hledger period expressions don't support "biweekly", "bimonthly", or "every N days/weeks/..." + - hledger always shows timelog balances in hours + - hledger splits multi-day timelog sessions at midnight + - hledger doesn't track the value of commodities with varying price; prices are fixed as of the transaction date + - hledger print shows amounts for all postings, and shows unit - prices for amounts which have them -- hledger assumes a transaction's actual date comes first, and is - required, while the optional effective date comes second (cf - [Actual and effective dates](#actual-and-effective-dates)) -- hledger does not support per-posting actual or effective dates + prices for amounts which have them. (This currently means that + it does not print multi-commodity transactions in valid journal format.) ### More examples and recipes @@ -952,7 +997,7 @@ Eg: join the #hledger channel with your IRC client and type: "sm: I did ... and ... happened", then leave that window open until you get helped. -- **Did you cabal update ?** If you didn't already, ``cabal update`` and try again. +- **Did you cabal update ?** If you didn't already, `cabal update` and try again. - **Do you have a new enough version of GHC ?** hledger supports GHC 6.10 and 6.12. Building with the `-fweb` flag requires 6.12 or greater. @@ -969,12 +1014,15 @@ then try installing hledger again. - **Could not run trhsx.** - You are installing with `-fweb610`, which needs to run the ``trhsx`` executable. - It is installed by the hsx package in ~/.cabal/bin, which needs to be in - your path. + You are installing with `-fweb610`, which needs to run the `trhsx` executable. + It is installed by the hsx package in `~/.cabal/bin`, which needs to be in + your path. Do something like: + $ echo 'export PATH=$PATH:~/.cabal/bin' >> ~/.bash_profile; source ~/.bash_profile + + - **Could not run happy.** - A package (eg haskell-src-exts) needs to run the ``happy`` executable. + A package (eg haskell-src-exts) needs to run the `happy` executable. If not using the haskell platform, install the appropriate platform package which provides it (eg apt-get install happy). @@ -1008,21 +1056,36 @@ error. You could try installing the [previous version](http://hackage.haskell.org/package/hledger): - cabal install hledger-0.x + $ cabal install hledger-0.x or (preferably) the latest development version: install [darcs](http://darcs.net) and then: - darcs get --lazy http://joyful.com/repos/hledger - cd hledger/hledger-lib - cabal install - cd .. - cabal install [-f...] + $ darcs get --lazy http://joyful.com/repos/hledger + $ cd hledger/hledger-lib + $ cabal install + $ cd .. + $ cabal install [-f...] - **An error while building non-hledger packages.** Resolve these problem packages one at a time. Eg, cabal install pkg1. Look for the cause of the failure near the end of the output. If it's not apparent, try again with `-v2` or `-v3` for more verbose output. + +- **This package indirectly depends on multiple versions of the same package.** + You may have previously installed some of hledger's dependencies + depending on different versions of (eg) parsec. Then cabal install hledger gives + an error like this: + + Warning: This package indirectly depends on multiple versions of the same + package. This is highly likely to cause a compile failure. + package yesod-0.5.0.3 requires parsec-2.1.0.1 + package csv-0.1.1 requires parsec-3.1.0 + ... + + The above example could be resolved by, eg: + + $ cabal install yesod --reinstall --constraint 'parsec == 3.1.0" - **cabal fails to resolve dependencies.** It's possible for cabal to get confused, eg if you have diff --git a/NEWS.markdown b/NEWS.markdown new file mode 100644 --- /dev/null +++ b/NEWS.markdown @@ -0,0 +1,443 @@ +--- +title: hledger news +--- + +# hledger news + +## 2010/9/5 hledger 0.12 + + * installing: fix a build error with parsec 3 (#22) + * installing: require exactly matching hledger-lib version for more robust builds + * installing: explicit data-object dependency to ensure hledger and hledger-lib use the same time version + * installing: build threaded and with warnings + * installing: drop -fweb610 flag + * installing: add gtk2hs-buildtools dependency needed to build with -fchart + * add -D/--daily flag + * register: with --depth, clip account names or aggregate postings rather than excluding them + * web: new, better web ui; accounts are now a permanent sidebar; add form uses auto-completing combo fields + * fix !include with deeply nested directories (#21) + * fix obscured date parse errors with parsec 3 + * handle unicode better in errors + * fix a ghc 6.12.3 error when running interpreted + +## 2010/07/17 hledger 0.11.1 + + * fix --version output + +## 2010/07/17 hledger 0.11 + + * split --help, adding --help-options and --help-all/-H, and make + it the default command + * use "journal" instead of "ledger file"; default suffix is + .journal, default file is \~/.journal + * auto-create missing journal files rather than giving an error + * new format-detecting file reader (mixed journal transactions + and timelog entries are no longer supported) + * work around for first real-world rounding issue (test zero to 8 + decimal places instead of 10) + * when reporting a balancing error, convert the error amount to + cost + * parsing: support double-quoted commodity symbols, containing + anything but a newline or double quote + * parsing: allow minus sign before commodity symbol as well as + after (also fixes a convert bug) + * parsing: fix wrong parse error locations within postings + * parsing: don't let trailing whitespace in a timelog description + mess up account names + * add: allow blank descriptions + * balance: --flat provides a simple non-hierarchical format + * balance: --drop removes leading account name components from a + --flat report + * print, register, balance: fix layout issues with + mixed-commodity amounts + * print: display non-simple commodity names with double-quotes + * stats: layout tweaks, add payee/description count + * stats: don't break on an empty file + * stats: -p/--period support; a reporting interval generates + multiple reports + * test: drop verbose test runner and testpack dependency + * web: a new web ui based on yesod, requires ghc 6.12; old ghc + 6.10-compatible version remains as -fweb610 + * web: allow wiki-like journal editing + * web: warn and keep running if reloading the journal gives an + error + * web: --port and --base-url options set the webserver's tcp port + and base url + * web: slightly better browser opening on microsoft windows, + should find a standard firefox install now + * web: in a web-enabled build on microsoft windows, run the web + ui by default + +Stats: 55 days and 136 commits since last release. Now at 5552 +lines of code with 132 tests and 54% unit test coverage. + +## 2010/05/23 hledger 0.10 + + * fix too-loose testpack dependency, missing safe dependency + * fix ghc 6.12 compatibility with -fweb + * fix handling of non-ascii arguments with ghc 6.12 + * fix "0.8" in --version output + * fix an occasional stack overflow error due to infinite + recursion in Posting/Transaction equality tests + * the -fwebhappstack build flag is gone for now, to avoid a cabal + problem + * parsing: if there is no description, don't require a space + after the transaction date + * parsing: balance balanced-virtual postings separately, allow + them to have an implicit amount + * parsing: timelog entries now generate balanced transactions, + using virtual postings + * parsing: simpler high-level parse error message + * parsing: clearer bad date errors + * add: fix wrongful program exit on bad dates + * print: negative account patterns now exclude transactions + containing any posting to a matched account + * vty: rename the ui command to vty for consistency + * vty: fix restricted account scope when backing up to top level + * web: fix non-ascii handling with ghc 6.12 + * web: fix a bug possibly affecting reload-on-change + * consolidate module namespace under Hledger, api cleanups + +Stats: 44 days, 81 commits since last release. Now at 4904 lines of +code including tests, 144 tests, 53% coverage. + +## 2010/04/10 hledger 0.9 + + * ghc 6.12 support + * split off hledger-lib package, containing core types & utils + * parsing: ignore D, C, N, tag, end tag directives; we should now + accept any ledger 2.6 file + * parsing: allow numbers in commodities if double-quoted, like + ledger + * parsing: allow transactions with empty descriptions + * parsing: show a better error for illegal month/day numbers in + dates + * parsing: don't ignore trailing junk in a smart date, eg in web + add form + * parsing: don't ignore unparsed text following an amount + * parsing: @ was being treated as a currency symbol + * add: fix precision handling in default amounts (\#19) + * add: elide last amount in added transactions + * convert: keep original description by default, allow + backreferences in replace pattern + * convert: basic csv file checking, warn instead of dying when it + looks wrong + * convert: allow blank/comment lines at end of rules file + * print: always show zero amounts as 0, hiding any + commodity/decimal places/price, like ledger + * register: fix bad layout with years < 1000 + * register: fix a Prelude.head error with reporting interval, + --empty, and --depth + * register: fix a regression, register should not show posting + comments + * register: with --empty, intervals should continue to ends of + the specified period + * stats: better output when last transaction is in the future + * stats: show commodity symbols, account tree depth, reorder + slightly + * web: -fweb now builds with simpleserver; to get happstack, use + -fwebhappstack instead + * web: pre-fill the add form with today's date + * web: help links, better search form wording + * web: show a proper error for a bad date in add form (\#17) + * web: fix for unicode search form values + * web: fix stack overflow caused by regexpr, and handle requests + faster (\#14) + * web: look for more-generic browser executables + * web: more robust browser starting (\#6) + * error message cleanups + * more tests, refactoring, docs + +Stats: 58 days, 2 contributors, 102 commits since last release. Now +at 3983 lines of non-test code, 139 tests, 53% coverage. + +## 2010/02/11 hledger 0.8 + + * parsing: in date=date2, use first date's year as a default for + the second + * add: ctrl-d doesn't work on windows, suggest ctrl-c instead + * add: --no-new-accounts option disallows new accounts (Roman + Cheplyaka) + * add: re-use the previous transaction's date as default (Roman + Cheplyaka) + * add: a command-line argument now filters by account during + history matching (Roman Cheplyaka) + * chart: new command, generates balances pie chart (requires + -fchart flag, gtk2hs) (Roman Cheplyaka, Simon Michael) + * register: make reporting intervals honour a display expression + (\#18) + * web: fix help link + * web: use today as default when adding with a blank date + * web: re-enable account/period fields, they seem to be fixed, + along with file re-reading (\#16) + * web: get static files from the cabal data dir, or the current + dir when using make (\#13) + * web: preserve encoding during add, assuming it's utf-8 (\#15) + * fix some non-utf8-aware file handling (\#15) + * filter ledger again for each command, not just once at program + start + * refactoring, clearer data types + +Stats: 62 days, 2 contributors, 76 commits since last release. Now +at 3464 lines of non-test code, 97 tests, 53% test coverage. + +## 2009/12/11 hledger 0.7 + + * price history support (first cut): P directives now work, + though differently from c++ ledger. Each posting amount takes its + fixed unit price from the price history (or + @) when available. This is simple and useful for things like + foreign currency expenses (but not investment tracking). Like + ledger, balance and register don't show amount prices any more, and + don't separate differently-priced amounts. Unlike ledger, print + shows all amount prices, and supports -B. + * --effective option, will use transactions' effective dates if + any + * convert: new rules file format, find/create rules file + automatically, more robust parsing, more useful --debug output + * print: always sort by date, fix long account name truncation, + align amounts, show end of line comments, show all amounts for + clarity (don't elide the final balancing amount) + * ui: use vty 4, fixes non-ascii and gnome terminal problems + (issues \#3, \#4) + * web: allow data entry, react to data file changes, better + layout, help links, remove histogram command and filter fields for + now, fix bad localhost redirect, filter form did not work in eg + firefox (issue \#7), reset link did not work in all browsers + * parsing: require whitespace between date and status code, allow + (and ignore) a time in price records, better error messages, + non-zero exit code on parse failure + * display non-ascii error messages properly (issue \#5) + * fix an arithmetic bug that occasionally rejected valid + transactions + * fix a regex bug in showtree + * don't break if HOME is undefined + * --debug now implies --verbose + * add functional tests like ledger's, use test-framework for + speedy running, release shelltestrunner as a separate package + * many hlint cleanups (Marko Kocić) + * many site and documentation updates + +Stats: 60 days, 1 contributor, 50 commits since last release. Now +at 3377 lines of non-test code, 97 tests, 53% test coverage. + +## 2009/06/22 hledger 0.6.1 + + * avoid use of exitSuccess which was breaking ghc 6.8/base 3 + compatibility (issue \#2) + +## 2009/06/13 hledger 0.6 + + * now cabal-installable on unix, mac, and windows, with Haskell + Platform + * provide experimental platform binaries + * parsing: fix a silly failure to open ledger file paths + containing \~ + * parsing: show better errors for unbalanced transaction and + missing default year + * parsing: allow parentheses and brackets inside account names, + as ledger does + * parsing: fail on empty account name components, don't just + ignore + * add: description passed as arguments now affects first + transaction only + * add: better handling of virtual postings and default amounts + * print, register: show virtual accounts bracketed/parenthesised + * web: improved web ui supporting full patterns & period + expressions + * new "stats" command reports some ledger statistics + * many dev/doc/deployment infrastructure improvements + * move website into darcs repo, update home page + * move issue tracker to google code + +Release stats: + + * Contributors: Simon Michael + * Days since last release: 21 + * Commits: 94 + * Lines of non-test code: 2865 + * Tests: 82 + * Test coverage: 53% expressions + * Known errors: 3 (inconsistent eliding, vty-related failures) + * Performance: similar + (http://hledger.org/profs/200906131120.bench) + +## 2009/05/23 hledger 0.5.1 + + * two fixes: really disable vty flag by default, and include + ConvertCommand in cabal file + +## 2009/05/23 hledger 0.5 + + * the vty flag is disabled by default again, to ease installation + on windows + * use ledger 3 terminology: a ledger contains transactions which + contain postings + * new "add" command prompts for transactions interactively and + adds them to the ledger + * new "convert" command transforms bank CSV exports to ledger + format, with rule-based cleanup + * new "histogram" command shows transaction counts per day or + other reporting interval + * most commands now work properly with UTF8-encoded text (Sergey + Astanin) + * invoking as "hours" is now less different: it just uses your + timelog, not your ledger + * ..quarterly/-Q option summarises by quarter + * ..uncleared/-U option looks only at uncleared transactions + * be more accurate about checking balanced amounts, don't rely on + display precision + * enforce balancing for bracketed virtual postings + * fix bug in eliding of posting amounts + * don't show trailing spaces on amountless postings + * parse null input as an empty ledger + * don't treat comments as part of transaction descriptions + * require some postings in ledger transactions + * require a non-empty description in ledger transactions + * don't fail when matching an empty pattern, as in "not:" + * make the web server handle the null path + * code, api and documentation updates + * add a contributor agreement/list + +Release stats: + + * Contributors: Simon Michael, Sergey Astanin + * Days since last release: 51 + * Commits: 101 + * Lines of non-test code: 2795 + * Tests: 76 + * Known errors: 0 + +## 2009/04/03 hledger 0.4 + + * new "web" command serves reports in a web browser (install with + -f happs to build this) + * make the vty-based curses ui a cabal build option, which will + be ignored on MS windows + * drop the ..options-anywhere flag, that is now the default + * patterns now use not: and desc: prefixes instead of \^ and \^\^ + * patterns are now case-insensitive, like ledger + * !include directives are now relative to the including file (Tim + Docker) + * "Y2009" default year directives are now supported, allowing m/d + dates in ledger + * individual transactions now have a cleared status + * unbalanced entries now cause a proper warning + * balance report now passes all ledger compatibility tests + * balance report now shows subtotals by default, like ledger 3 + * balance report shows the final zero total when -E is used + * balance report hides the final total when ..no-total is used + * ..depth affects print and register reports (aggregating with a + reporting interval, filtering otherwise) + * register report sorts transactions by date + * register report shows zero-amount transactions when -E is used + * provide more convenient timelog querying when invoked as + "hours" + * multi-day timelog sessions are split at midnight + * unterminated timelog sessions are now counted. Accurate time + reports at last! + * the test command gives better ..verbose output + * ..version gives more detailed version numbers including + patchlevel for dev builds + * new make targets include: ghci, haddocktest, doctest, unittest, + view-api-docs + * a doctest-style framework for functional/shell tests has been + added + +Release stats: + + * Contributors: Simon Michael, Tim Docker; thanks to the HAppS, + happstack and testpack developers + * Days since release: 76 + * Commits: 144 + * Lines of non-test code: 2367 + * Tests: 56 + * Known errors: 0 + +## 2009/01/17 hledger 0.3 + + * count timelog sessions on the day they end, like ledger, for + now + * when options are repeated, use the last instead of the first + * builds with ghc 6.10 as well as 6.8 + * a simple ui for interactive report browsing: hledger ui + * accept smart dates everywhere (YYYYMMDD, Y/M/D, Y, M/D, D, jan, + today, last week etc.) + * ..period/-p flag accepting period expressions like "in 2008", + "weekly from last month".. + * -W/-M/-Y convenience flags to summarise register weekly, + monthly, yearly + * ..depth and -E flags also affect summarised register reports + (including depth=0) + * ..display/-d flag supporting date predicates (like "d<[DATE]", + "d\>=[DATE]") + * !include directive to include additional ledger files + * !account directive to set a default parent account + * Added support for reading historical prices from files + * timelog and ledger entries can be intermixed in one file + * modifier and periodic entries can appear anywhere (but are + still ignored) + * help and readme improvements + * runs much faster than 0.2 + +Release stats: + + * Contributors: Simon Michael, Nick Ingolia, Tim Docker; thanks + to Corey O'Connor & the vty team + * Lines of non-test code: 2123 + * Tests: 58 + * Known errors: 1 + +## 2008/11/23 hledger 0.2 + + * fix balance report totals when filtering by account + * fix balance report selection of accounts when filtering by + account + * fix a bug with account name eliding in balance report + * if we happen to be showing a not-yet-auto-balanced entry, hide + the AUTO marker + * fix print command filtering by account + * omit transactions with zero amount from register report + * Fix bug in parsing of timelogs + * rename ..showsubs to ..subtotal, like ledger + * drop ..usage flag + * don't require quickcheck + * priced amounts (eg "10h @ $50") and ..basis/..cost/-B flag to + show them with cost basis + * easy ..depth option, equivalent to c++ ledger's -d 'l<=N' + * smarter y/m/d date parsing for -b and -e (any number of digits, + month and day default to 1, separator can be / - or .) + * -n flag for balance command + * ..empty/-E flag + * build a library, as well as the exe + * new home page url (http://joyful.com/hledger) + * publish html and pdf versions of README + * detect display preferences for each commodity like c++ ledger + * support amounts with multiple currencies/commodities + * support ..real/-R flag + * support -C/..cleared flag to filter by entry status (not + transaction status) + * support virtual and balanced virtual transactions + * parse comment lines beginning with a space, as from M-; in + emacs ledger-mode + * allow any non-whitespace in account names, perhaps avoiding + misleading missing amounts errors + * clearer error message when we can't balance an entry + * when we fail because of more than one missing amount in an + entry, show the full entry + * document the built-in test runner in ..help + * add a ..verbose/-v flag, use it to show more test-running + detail + +Release stats: + + * Contributors: Simon Michael, Tim Docker + * Lines of non-test code: 1350 + * Tests: 43 + * Known errors: 0 + +## 2008/10/15 hledger 0.1 + +Release stats: + + * Contributors: Simon Michael diff --git a/NEWS.rst b/NEWS.rst deleted file mode 100644 --- a/NEWS.rst +++ /dev/null @@ -1,380 +0,0 @@ ---- -title: hledger news ---- -hledger news -============ - -2010/07/17 hledger 0.11.1 -......................... - - * fix --version output - -2010/07/17 hledger 0.11 -........................ - - * split --help, adding --help-options and --help-all/-H, and make it the default command - * use "journal" instead of "ledger file"; default suffix is .journal, default file is ~/.journal - * auto-create missing journal files rather than giving an error - * new format-detecting file reader (mixed journal transactions and timelog entries are no longer supported) - * work around for first real-world rounding issue (test zero to 8 decimal places instead of 10) - * when reporting a balancing error, convert the error amount to cost - * parsing: support double-quoted commodity symbols, containing anything but a newline or double quote - * parsing: allow minus sign before commodity symbol as well as after (also fixes a convert bug) - * parsing: fix wrong parse error locations within postings - * parsing: don't let trailing whitespace in a timelog description mess up account names - * add: allow blank descriptions - * balance: --flat provides a simple non-hierarchical format - * balance: --drop removes leading account name components from a --flat report - * print, register, balance: fix layout issues with mixed-commodity amounts - * print: display non-simple commodity names with double-quotes - * stats: layout tweaks, add payee/description count - * stats: don't break on an empty file - * stats: -p/--period support; a reporting interval generates multiple reports - * test: drop verbose test runner and testpack dependency - * web: a new web ui based on yesod, requires ghc 6.12; old ghc 6.10-compatible version remains as -fweb610 - * web: allow wiki-like journal editing - * web: warn and keep running if reloading the journal gives an error - * web: --port and --base-url options set the webserver's tcp port and base url - * web: slightly better browser opening on microsoft windows, should find a standard firefox install now - * web: in a web-enabled build on microsoft windows, run the web ui by default - - Stats: 55 days and 136 commits since last release. Now at 5552 lines of code with 132 tests and 54% unit test coverage. - -2010/05/23 hledger 0.10 -........................ - - * fix too-loose testpack dependency, missing safe dependency - * fix ghc 6.12 compatibility with -fweb - * fix handling of non-ascii arguments with ghc 6.12 - * fix "0.8" in --version output - * fix an occasional stack overflow error due to infinite recursion in Posting/Transaction equality tests - * the -fwebhappstack build flag is gone for now, to avoid a cabal problem - * parsing: if there is no description, don't require a space after the transaction date - * parsing: balance balanced-virtual postings separately, allow them to have an implicit amount - * parsing: timelog entries now generate balanced transactions, using virtual postings - * parsing: simpler high-level parse error message - * parsing: clearer bad date errors - * add: fix wrongful program exit on bad dates - * print: negative account patterns now exclude transactions containing any posting to a matched account - * vty: rename the ui command to vty for consistency - * vty: fix restricted account scope when backing up to top level - * web: fix non-ascii handling with ghc 6.12 - * web: fix a bug possibly affecting reload-on-change - * consolidate module namespace under Hledger, api cleanups - - Stats: - 44 days, 81 commits since last release. - Now at 4904 lines of code including tests, 144 tests, 53% coverage. - -2010/04/10 hledger 0.9 -...................... - - * ghc 6.12 support - * split off hledger-lib package, containing core types & utils - * parsing: ignore D, C, N, tag, end tag directives; we should now accept any ledger 2.6 file - * parsing: allow numbers in commodities if double-quoted, like ledger - * parsing: allow transactions with empty descriptions - * parsing: show a better error for illegal month/day numbers in dates - * parsing: don't ignore trailing junk in a smart date, eg in web add form - * parsing: don't ignore unparsed text following an amount - * parsing: @ was being treated as a currency symbol - * add: fix precision handling in default amounts (#19) - * add: elide last amount in added transactions - * convert: keep original description by default, allow backreferences in replace pattern - * convert: basic csv file checking, warn instead of dying when it looks wrong - * convert: allow blank/comment lines at end of rules file - * print: always show zero amounts as 0, hiding any commodity/decimal places/price, like ledger - * register: fix bad layout with years < 1000 - * register: fix a Prelude.head error with reporting interval, --empty, and --depth - * register: fix a regression, register should not show posting comments - * register: with --empty, intervals should continue to ends of the specified period - * stats: better output when last transaction is in the future - * stats: show commodity symbols, account tree depth, reorder slightly - * web: -fweb now builds with simpleserver; to get happstack, use -fwebhappstack instead - * web: pre-fill the add form with today's date - * web: help links, better search form wording - * web: show a proper error for a bad date in add form (#17) - * web: fix for unicode search form values - * web: fix stack overflow caused by regexpr, and handle requests faster (#14) - * web: look for more-generic browser executables - * web: more robust browser starting (#6) - * error message cleanups - * more tests, refactoring, docs - - Stats: - 58 days, 2 contributors, 102 commits since last release. - Now at 3983 lines of non-test code, 139 tests, 53% coverage. - -2010/02/11 hledger 0.8 -...................... - - * parsing: in date=date2, use first date's year as a default for the second - * add: ctrl-d doesn't work on windows, suggest ctrl-c instead - * add: --no-new-accounts option disallows new accounts (Roman Cheplyaka) - * add: re-use the previous transaction's date as default (Roman Cheplyaka) - * add: a command-line argument now filters by account during history matching (Roman Cheplyaka) - * chart: new command, generates balances pie chart (requires -fchart flag, gtk2hs) (Roman Cheplyaka, Simon Michael) - * register: make reporting intervals honour a display expression (#18) - * web: fix help link - * web: use today as default when adding with a blank date - * web: re-enable account/period fields, they seem to be fixed, along with file re-reading (#16) - * web: get static files from the cabal data dir, or the current dir when using make (#13) - * web: preserve encoding during add, assuming it's utf-8 (#15) - * fix some non-utf8-aware file handling (#15) - * filter ledger again for each command, not just once at program start - * refactoring, clearer data types - - Stats: - 62 days, 2 contributors, 76 commits since last release. - Now at 3464 lines of non-test code, 97 tests, 53% test coverage. - -2009/12/11 hledger 0.7 -........................ - - * price history support (first cut): - P directives now work, though differently from c++ ledger. Each - posting amount takes its fixed unit price from the price history (or - @) when available. This is simple and useful for things like foreign - currency expenses (but not investment tracking). Like ledger, balance - and register don't show amount prices any more, and don't separate - differently-priced amounts. Unlike ledger, print shows all amount - prices, and supports -B. - * --effective option, will use transactions' effective dates if any - * convert: new rules file format, find/create rules file automatically, - more robust parsing, more useful --debug output - * print: always sort by date, fix long account name truncation, align - amounts, show end of line comments, show all amounts for clarity - (don't elide the final balancing amount) - * ui: use vty 4, fixes non-ascii and gnome terminal problems (issues #3, #4) - * web: allow data entry, react to data file changes, better layout, help - links, remove histogram command and filter fields for now, fix bad - localhost redirect, filter form did not work in eg firefox (issue #7), - reset link did not work in all browsers - * parsing: require whitespace between date and status code, allow (and - ignore) a time in price records, better error messages, non-zero exit - code on parse failure - * display non-ascii error messages properly (issue #5) - * fix an arithmetic bug that occasionally rejected valid transactions - * fix a regex bug in showtree - * don't break if HOME is undefined - * --debug now implies --verbose - * add functional tests like ledger's, use test-framework for speedy - running, release shelltestrunner as a separate package - * many hlint cleanups (Marko Kocić) - * many site and documentation updates - - Stats: - 60 days, 1 contributor, 50 commits since last release. - Now at 3377 lines of non-test code, 97 tests, 53% test coverage. - -2009/06/22 hledger 0.6.1 -........................ - - * avoid use of exitSuccess which was breaking ghc 6.8/base 3 compatibility (issue #2) - -2009/06/13 hledger 0.6 -...................... - - * now cabal-installable on unix, mac, and windows, with Haskell Platform - * provide experimental platform binaries - * parsing: fix a silly failure to open ledger file paths containing ~ - * parsing: show better errors for unbalanced transaction and missing default year - * parsing: allow parentheses and brackets inside account names, as ledger does - * parsing: fail on empty account name components, don't just ignore - * add: description passed as arguments now affects first transaction only - * add: better handling of virtual postings and default amounts - * print, register: show virtual accounts bracketed/parenthesised - * web: improved web ui supporting full patterns & period expressions - * new "stats" command reports some ledger statistics - * many dev/doc/deployment infrastructure improvements - * move website into darcs repo, update home page - * move issue tracker to google code - -Release stats: - - * Contributors: Simon Michael - * Days since last release: 21 - * Commits: 94 - * Lines of non-test code: 2865 - * Tests: 82 - * Test coverage: 53% expressions - * Known errors: 3 (inconsistent eliding, vty-related failures) - * Performance: similar (http://hledger.org/profs/200906131120.bench) - -2009/05/23 hledger 0.5.1 -................................. - - * two fixes: really disable vty flag by default, and include ConvertCommand in cabal file - -2009/05/23 hledger 0.5 -............................... - - * the vty flag is disabled by default again, to ease installation on windows - * use ledger 3 terminology: a ledger contains transactions which contain postings - * new "add" command prompts for transactions interactively and adds them to the ledger - * new "convert" command transforms bank CSV exports to ledger format, with rule-based cleanup - * new "histogram" command shows transaction counts per day or other reporting interval - * most commands now work properly with UTF8-encoded text (Sergey Astanin) - * invoking as "hours" is now less different: it just uses your timelog, not your ledger - * ..quarterly/-Q option summarises by quarter - * ..uncleared/-U option looks only at uncleared transactions - * be more accurate about checking balanced amounts, don't rely on display precision - * enforce balancing for bracketed virtual postings - * fix bug in eliding of posting amounts - * don't show trailing spaces on amountless postings - * parse null input as an empty ledger - * don't treat comments as part of transaction descriptions - * require some postings in ledger transactions - * require a non-empty description in ledger transactions - * don't fail when matching an empty pattern, as in "not:" - * make the web server handle the null path - * code, api and documentation updates - * add a contributor agreement/list - -Release stats: - - * Contributors: Simon Michael, Sergey Astanin - * Days since last release: 51 - * Commits: 101 - * Lines of non-test code: 2795 - * Tests: 76 - * Known errors: 0 - -.. - * Performance: - || hledger-0.4 | hledger-0.5 | ledger - =========================++=============+=============+======= - -f sample.ledger balance || 0.01 | 0.01 | 0.06 - -f 1000.ledger balance || 1.33 | 1.46 | 0.53 - -f 10000.ledger balance || 15.28 | 16.35 | 4.67 - - -2009/04/03 hledger 0.4 -............................... - - * new "web" command serves reports in a web browser (install with -f happs to build this) - * make the vty-based curses ui a cabal build option, which will be ignored on MS windows - * drop the ..options-anywhere flag, that is now the default - * patterns now use not: and desc: prefixes instead of ^ and ^^ - * patterns are now case-insensitive, like ledger - * !include directives are now relative to the including file (Tim Docker) - * "Y2009" default year directives are now supported, allowing m/d dates in ledger - * individual transactions now have a cleared status - * unbalanced entries now cause a proper warning - * balance report now passes all ledger compatibility tests - * balance report now shows subtotals by default, like ledger 3 - * balance report shows the final zero total when -E is used - * balance report hides the final total when ..no-total is used - * ..depth affects print and register reports (aggregating with a reporting interval, filtering otherwise) - * register report sorts transactions by date - * register report shows zero-amount transactions when -E is used - * provide more convenient timelog querying when invoked as "hours" - * multi-day timelog sessions are split at midnight - * unterminated timelog sessions are now counted. Accurate time reports at last! - * the test command gives better ..verbose output - * ..version gives more detailed version numbers including patchlevel for dev builds - * new make targets include: ghci, haddocktest, doctest, unittest, view-api-docs - * a doctest-style framework for functional/shell tests has been added - -Release stats: - - * Contributors: Simon Michael, Tim Docker; thanks to the HAppS, happstack and testpack developers - * Days since release: 76 - * Commits: 144 - * Lines of non-test code: 2367 - * Tests: 56 - * Known errors: 0 - -.. - * Performance: - || hledger-0.3 | hledger-0.4 | ledger-0.3 - ==============================++=============+=============+=========== - -f sample.ledger balance || 0.02 | 0.01 | 0.07 - -f sample1000.ledger balance || 1.02 | 1.39 | 0.53 - -f sample10000.ledger balance || 12.72 | 14.97 | 4.63 - - -2009/01/17 hledger 0.3 -............................... - - * count timelog sessions on the day they end, like ledger, for now - * when options are repeated, use the last instead of the first - * builds with ghc 6.10 as well as 6.8 - * a simple ui for interactive report browsing: hledger ui - * accept smart dates everywhere (YYYYMMDD, Y/M/D, Y, M/D, D, jan, today, last week etc.) - * ..period/-p flag accepting period expressions like "in 2008", "weekly from last month".. - * -W/-M/-Y convenience flags to summarise register weekly, monthly, yearly - * ..depth and -E flags also affect summarised register reports (including depth=0) - * ..display/-d flag supporting date predicates (like "d<[DATE]", "d>=[DATE]") - * !include directive to include additional ledger files - * !account directive to set a default parent account - * Added support for reading historical prices from files - * timelog and ledger entries can be intermixed in one file - * modifier and periodic entries can appear anywhere (but are still ignored) - * help and readme improvements - * runs much faster than 0.2 - -Release stats: - - * Contributors: Simon Michael, Nick Ingolia, Tim Docker; thanks to Corey O'Connor & the vty team - * Lines of non-test code: 2123 - * Tests: 58 - * Known errors: 1 - -.. - * Performance: - $ bench hledger-0.2 hledger ledger - || hledger-0.2 | hledger | ledger - ==================================++=============+=========+======= - -f 2008.ledger -s balance || 2.59 | 0.26 | 0.11 - -f 10000entries.ledger -s balance || 566.68 | 2.72 | 0.96 - - -2008/11/23 hledger 0.2 -............................... - - * fix balance report totals when filtering by account - * fix balance report selection of accounts when filtering by account - * fix a bug with account name eliding in balance report - * if we happen to be showing a not-yet-auto-balanced entry, hide the AUTO marker - * fix print command filtering by account - * omit transactions with zero amount from register report - * Fix bug in parsing of timelogs - * rename ..showsubs to ..subtotal, like ledger - * drop ..usage flag - * don't require quickcheck - * priced amounts (eg "10h @ $50") and ..basis/..cost/-B flag to show them with cost basis - * easy ..depth option, equivalent to c++ ledger's -d 'l<=N' - * smarter y/m/d date parsing for -b and -e - (any number of digits, month and day default to 1, separator can be / - or .) - * -n flag for balance command - * ..empty/-E flag - * build a library, as well as the exe - * new home page url (http://joyful.com/hledger) - * publish html and pdf versions of README - * detect display preferences for each commodity like c++ ledger - * support amounts with multiple currencies/commodities - * support ..real/-R flag - * support -C/..cleared flag to filter by entry status (not transaction status) - * support virtual and balanced virtual transactions - * parse comment lines beginning with a space, as from M-; in emacs ledger-mode - * allow any non-whitespace in account names, perhaps avoiding misleading missing amounts errors - * clearer error message when we can't balance an entry - * when we fail because of more than one missing amount in an entry, show the full entry - * document the built-in test runner in ..help - * add a ..verbose/-v flag, use it to show more test-running detail - -Release stats: - - * Contributors: Simon Michael, Tim Docker - * Lines of non-test code: 1350 - * Tests: 43 - * Known errors: 0 - - -2008/10/15 hledger 0.1 -............................... - -Release stats: - - * Contributors: Simon Michael diff --git a/README.rst b/README.rst --- a/README.rst +++ b/README.rst @@ -8,6 +8,7 @@ commodities, using standard accounting principles. It is quite limited in features, but reliable. For some, it is a bare-bones, less complex, less expensive alternative to Quicken or Microsoft Money. +hledger is available for free under the GNU General Public License. hledger aims to help both computer experts and every-day users gain clarity in their finances and time management. I use it every day to: @@ -17,23 +18,17 @@ - get accurate numbers for client billing and tax filing - track invoices -Here is a demo_ of the web interface. - -Here are ready-to-run binaries_ for mac, windows and gnu/linux. -They are not the `current release`_, sorry about that. +The manual_ and screenshots_ will explain more. There's also a demo_ of hledger's web interface. +To get started tracking your own numbers, download_ a copy. -Here is the manual_. For support and more technical info, see `development`_ or `email me`_. +I appreciate feedback on all aspects of hledger. Thanks! -.. (If you're reading this in plain text, see also README2, MANUAL etc., or http://hledger.org) -.. _development: README2.html -.. _manual: MANUAL.html -.. _demo: http://demo.hledger.org -.. _binaries: http://hledger.org/binaries/ -.. _hledger for mac: http://hledger.org/binaries/hledger-0.6-mac-i386.gz -.. _hledger for windows: http://hledger.org/binaries/hledger-0.6-win-i386.zip -.. _32 bit intel: http://hledger.org/binaries/hledger-0.6.1+9-linux-i386.gz -.. _64 bit intel: http://hledger.org/binaries/hledger-0.6-linux-x86_64.gz -.. _email me: mailto:simon@joyful.com -.. _current release: http://hledger.org/MANUAL.html#installing +.. _manual: MANUAL.html +.. _screenshots: SCREENSHOTS.html +.. _demo: http://demo.hledger.org +.. _web interface: MANUAL.html#web +.. _download: DOWNLOAD.html +.. _development: DEVELOPMENT.html +.. _email me: mailto:simon@joyful.com?subject=hledger: diff --git a/README2.rst b/README2.rst deleted file mode 100644 --- a/README2.rst +++ /dev/null @@ -1,101 +0,0 @@ ---- -title: hledger development ---- -hledger development -=================== - -**Techie intro** - -hledger_ is a remix, in haskell_, of John Wiegley's excellent ledger_ accounting tool. -It reads a plain text journal_ or timelog_ file describing your transactions -and displays reports via command line, curses or web interfaces. - -The hledger project aims to produce: - -- a practical, accessible, dependable tool for end users -- a useful library and toolbox for finance-minded haskell programmers -- a successful, time-and-money-solvent project within a thriving ecosystem of financial software projects. - -hledger is free software by `Simon Michael`_ & `co.`_, released under GNU GPLv3. - -**Learn** - news_, manual_, screenshots_, `some extra tips`_ - -**Download** - ``cabal install hledger``, - or try these ready-to-run binaries_, - or see the `installing docs `_ - -**Develop** - ``darcs get http://joyful.com/repos/hledger``, - `browse the repo`_, - `hackage page`_, - `hledger-lib api docs`_, - `hledger api docs`_, - `hledger-lib sourcegraph report`_, - `hledger sourcegraph report`_, - benchmark_\/profile_\/heap_\/coverage_ reports, - `developer notes`_ - -.. raw:: html - - - -**Support** - -- chat Simon (sm) on the `#ledger`_ irc channel which we share, or `email me`_ -- report problems at `bugs.hledger.org `_ -- share and test journal snippets at paste . hledger.org -- .. raw:: html - -
- join the hledger mail list at list.hledger.org. Your email: - -
- -**Related projects** - -- John Wiegley's ledger_ inspired hledger, and we try to stay compatible. You can often use both tools on the same journal file. -- Uwe Hollerbach's umm_ is another haskell tool inspired by h/ledger. -- Tim Docker's ledger-reports_ uses hledger as a library to generate `html reports`_. -- I have a few older bits and pieces `here `_. - -.. raw:: html - - - - - -.. _hledger: README.html -.. _journal: http://joyful.com/repos/hledger/data/sample.journal -.. _timelog: http://joyful.com/repos/hledger/data/sample.timelog -.. _command line: SCREENSHOTS.html#hledger-screen-1 -.. _curses: SCREENSHOTS.html#sshot -.. _web interface: http://demo.hledger.org -.. _mail list: http://list.hledger.org -.. _issue tracker: http://bugs.hledger.org -.. _binaries: http://hledger.org/binaries/ -.. _manual: MANUAL.html -.. _news: NEWS.html -.. _screenshots: SCREENSHOTS.html -.. _hledger-lib api docs: http://joyful.com/repos/hledger/hledger-lib/dist/doc/html/hledger-lib/index.html -.. _hledger api docs: http://joyful.com/repos/hledger/dist/doc/html/hledger/index.html -.. _hledger-lib sourcegraph report: http://joyful.com/repos/hledger/hledger-lib/SourceGraph/hledger-lib.html -.. _hledger sourcegraph report: http://joyful.com/repos/hledger/SourceGraph/hledger.html -.. _developer notes: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger;a=plainblob;f=/NOTES -.. _benchmark: http://hledger.org/profs/latest.bench -.. _profile: http://hledger.org/profs/latest.prof -.. _heap: http://hledger.org/profs/latest.ps -.. _coverage: http://hledger.org/profs/coverage/hpc_index_fun.html -.. _browse the repo: http://joyful.com/darcsweb/darcsweb.cgi?r=hledger -.. _email me: mailto:simon@joyful.com -.. _Simon Michael: http://joyful.com -.. _co.: http://hledger.org/CONTRIBUTORS.html -.. _hackage page: http://hackage.haskell.org/package/hledger -.. _#ledger: irc://irc.freenode.net/#ledger -.. _haskell: http://haskell.org -.. _ledger: http://wiki.github.com/jwiegley/ledger -.. _umm: http://www.korgwal.com/umm/ -.. _ledger-reports: http://dockerz.net/repos/ledger-reports -.. _html reports: http://dockerz.net/software/hledger_report_sample/report.html -.. _some extra tips: http://podcastle.org/2009/10/09/pc-miniature-38-accounting-for-dragons/ diff --git a/data/web/static/dhtmlxcombo.js b/data/web/static/dhtmlxcombo.js new file mode 100644 --- /dev/null +++ b/data/web/static/dhtmlxcombo.js @@ -0,0 +1,1359 @@ +//v.2.6 build 100722 + +/* +Copyright DHTMLX LTD. http://www.dhtmlx.com +You allowed to use this component or parts of it under GPL terms +To use it on other terms or get Professional edition of the component please contact us at sales@dhtmlx.com +*/ + +/*_TOPICS_ +@0:Initialization +@1:Selection control +@2:Add/delete +@3:Reserved +@4:Methods of Option object +*/ + +/** +* Build combobox from existing select control. +* +* +* @param parent {string} id of existing select control +* @param size {int } size of control, optional +* @return {object} combobox object +* @type public +* @topic 0 +* +*/ + +function dhtmlXComboFromSelect(parent,size){ + if (typeof(parent)=="string") + parent=document.getElementById(parent); + + + size=size||parent.getAttribute("width")||(window.getComputedStyle?window.getComputedStyle(parent,null)["width"]:(parent.currentStyle?parent.currentStyle["width"]:0)); + if ((!size)||(size=="auto")) + size=parent.offsetWidth||100; + + var z=document.createElement("SPAN"); + + + + parent.parentNode.insertBefore(z,parent); + parent.style.display='none'; + + var s_type = parent.getAttribute('opt_type'); + + var w= new dhtmlXCombo(z,parent.name,size,s_type,parent.tabIndex); + + var x=new Array(); + var sel=0; + for (var i=0; i= 48 && ev.keyCode <= 57)||(ev.keyCode >= 65 && ev.keyCode <= 90)){ + for(var i=0; i15 && ev<19) return true; //shift,alt,ctrl + if (ev==27) return; + if ((that.DOMlist.style.display!="block")&&(ev!="13")&&(ev!="9")&&((!that._filter)||(that._filterAny))) + that.DOMelem.onclick(e||event); + + if ((ev!="13")&&(ev!="9")){ + window.setTimeout(function(){ that._onKeyB(ev); },1); + if (ev=="40" || ev=="38") + return false; + } + else if (ev==9){ + that.closeAll(); + (e||event).cancelBubble=false; + } + } + dhtmlXCombo.prototype._onKeyB = function(ev) + { + if (ev=="40"){ //down + var z=this.selectNext(1); + } else if (ev=="38"){ //up + this.selectNext(-1); + } else{ + this.callEvent("onKeyPressed",[ev]) + if (this._filter) return this.filterSelf((ev==8)||(ev==46)); + for(var i=0; i=0; i--) + this.DOMlist.removeChild(this.DOMlist.childNodes[i]); + for(var i=0; i0) this.DOMlist.scrollTop+=corr; + corr=this.DOMlist.scrollTop-this._selOption.content.offsetTop; + if (corr>0) this.DOMlist.scrollTop-=corr; + var data=this._selOption.data(); + + if (conf){ + this.setComboText(data[1]); + this._confirmSelection(data[0],false); + + if ((this._autoxml)&&((ind+1)==this._lastLength)) + this._fetchOptions(ind+1,this._lasttext||""); + } + + if (filter){ + var text=this.getComboText(); + if (text!=data[1]){ + this.setComboText(data[1]); + dhtmlXRange(this.DOMelem_input,text.length+1,data[1].length); + } + } + else + this.setComboText(data[1]); + this._selOption.RedrawHeader(this); + + /*Event*/ + this.callEvent("onSelectionChange",[]); + } +/** +* @desc: option on select handler +* @type: private +* @topic: 2 +*/ + dhtmlXCombo.prototype._selectOption = function(e) + { + (e||event).cancelBubble = true; + var node=(_isIE?event.srcElement:e.target); + var that=this.combo; + while (!node._self) { + node = node.parentNode; + if (!node) + return; + } + + var i=0; + for (i; i0) this.DOMlist.scrollTop+=corr; + corr=this.DOMlist.scrollTop-this._selOption.content.offsetTop; + if (corr>0) this.DOMlist.scrollTop-=corr; + } + /* if (this.autoOptionSize){ + var x=this.DOMlist.offsetWidth; + + for ( var i=0; i x= "+ x); + if (this.DOMlist.childNodes[i].scrollWidth > x) + x=this.DOMlist.childNodes[i].scrollWidth; + } + + this.DOMlist.style.width=x+"px"; + }*/ + + + if (_isIE) this._IEFix(true); + this.DOMelem_input.focus(); + + if (this._filter) this.filterSelf(); + } +/** +* @desc: open(close) list +* @type: private +* @topic: 2 +*/ + dhtmlXCombo.prototype._toggleSelect = function(e) + { + var that=this.combo; + if ( that.DOMlist.style.display == "block" ) { + that.closeAll(); + } else { + that.openSelect(); + } + (e||event).cancelBubble = true; + } + + dhtmlXCombo.prototype._fetchOptions=function(ind,text){ + if (text=="") { this.closeAll(); return this.clearAll(); } + var url=this._xml+((this._xml.indexOf("?")!=-1)?"&":"?")+"pos="+ind+"&mask="+encodeURIComponent(text); + this._lasttext=text; + if (this._load) this._load=url; + else { + if (!this.callEvent("onDynXLS",[text,ind])) return; + this.loadXML(url); + } + } +/** +* @desc: filter list of options +* @type: private +* @topic: 2 +*/ + dhtmlXCombo.prototype.filterSelf = function(mode) + { + var text=this.getComboText(); + if (this._xml){ + this._lkmode=mode; + this._fetchOptions(0,text); + } + try{ var filter=new RegExp("^"+text,"i"); } catch (e){ var filter=new RegExp("^"+text.replace(/([\[\]\{\}\(\)\+\*\\])/g,"\\$1")); } + this.filterAny=false; + for(var i=0; i