print now always right-aligns the amounts in an entry, even when they are wider than 12 characters. If there is a price, it's considered part of the amount for right-alignment. Maybe it would be nicer to put amounts and prices in separate columns ? That will get a little complicated, needs more discussion/design. Also some cleanup of postingAsLines.
		
			
				
	
	
		
			579 lines
		
	
	
		
			26 KiB
		
	
	
	
		
			Haskell
		
	
	
	
	
	
			
		
		
	
	
			579 lines
		
	
	
		
			26 KiB
		
	
	
	
		
			Haskell
		
	
	
	
	
	
{-|
 | 
						|
 | 
						|
A 'Transaction' represents a movement of some commodity(ies) between two
 | 
						|
or more accounts. It consists of multiple account 'Posting's which balance
 | 
						|
to zero, a date, and optional extras like description, cleared status, and
 | 
						|
tags.
 | 
						|
 | 
						|
-}
 | 
						|
 | 
						|
module Hledger.Data.Transaction (
 | 
						|
  -- * Transaction
 | 
						|
  nullsourcepos,
 | 
						|
  nulltransaction,
 | 
						|
  txnTieKnot,
 | 
						|
  -- settxn,
 | 
						|
  -- * operations
 | 
						|
  showAccountName,
 | 
						|
  hasRealPostings,
 | 
						|
  realPostings,
 | 
						|
  virtualPostings,
 | 
						|
  balancedVirtualPostings,
 | 
						|
  transactionsPostings,
 | 
						|
  isTransactionBalanced,
 | 
						|
  -- nonzerobalanceerror,
 | 
						|
  -- * date operations
 | 
						|
  transactionDate2,
 | 
						|
  -- * arithmetic
 | 
						|
  transactionPostingBalances,
 | 
						|
  balanceTransaction,
 | 
						|
  -- * rendering
 | 
						|
  showTransaction,
 | 
						|
  showTransactionUnelided,
 | 
						|
  -- * misc.
 | 
						|
  tests_Hledger_Data_Transaction
 | 
						|
)
 | 
						|
where
 | 
						|
import Data.List
 | 
						|
import Data.Maybe
 | 
						|
import Data.Time.Calendar
 | 
						|
import Test.HUnit
 | 
						|
import Text.Printf
 | 
						|
import qualified Data.Map as Map
 | 
						|
 | 
						|
import Hledger.Utils
 | 
						|
import Hledger.Data.Types
 | 
						|
import Hledger.Data.Dates
 | 
						|
import Hledger.Data.Posting
 | 
						|
import Hledger.Data.Amount
 | 
						|
 | 
						|
instance Show Transaction where show = showTransactionUnelided
 | 
						|
 | 
						|
instance Show ModifierTransaction where
 | 
						|
    show t = "= " ++ mtvalueexpr t ++ "\n" ++ unlines (map show (mtpostings t))
 | 
						|
 | 
						|
instance Show PeriodicTransaction where
 | 
						|
    show t = "~ " ++ ptperiodicexpr t ++ "\n" ++ unlines (map show (ptpostings t))
 | 
						|
 | 
						|
nullsourcepos :: GenericSourcePos
 | 
						|
nullsourcepos = GenericSourcePos "" 1 1
 | 
						|
 | 
						|
nulltransaction :: Transaction
 | 
						|
nulltransaction = Transaction {
 | 
						|
                    tsourcepos=nullsourcepos,
 | 
						|
                    tdate=nulldate,
 | 
						|
                    tdate2=Nothing,
 | 
						|
                    tstatus=Uncleared,
 | 
						|
                    tcode="",
 | 
						|
                    tdescription="",
 | 
						|
                    tcomment="",
 | 
						|
                    ttags=[],
 | 
						|
                    tpostings=[],
 | 
						|
                    tpreceding_comment_lines=""
 | 
						|
                  }
 | 
						|
 | 
						|
{-|
 | 
						|
Show a journal transaction, formatted for the print command. ledger 2.x's
 | 
						|
standard format looks like this:
 | 
						|
 | 
						|
@
 | 
						|
yyyy/mm/dd[ *][ CODE] description.........          [  ; comment...............]
 | 
						|
    account name 1.....................  ...$amount1[  ; comment...............]
 | 
						|
    account name 2.....................  ..$-amount1[  ; comment...............]
 | 
						|
 | 
						|
pcodewidth    = no limit -- 10          -- mimicking ledger layout.
 | 
						|
pdescwidth    = no limit -- 20          -- I don't remember what these mean,
 | 
						|
pacctwidth    = 35 minimum, no maximum  -- they were important at the time.
 | 
						|
pamtwidth     = 11
 | 
						|
pcommentwidth = no limit -- 22
 | 
						|
@
 | 
						|
-}
 | 
						|
showTransaction :: Transaction -> String
 | 
						|
showTransaction = showTransaction' True
 | 
						|
 | 
						|
showTransactionUnelided :: Transaction -> String
 | 
						|
showTransactionUnelided = showTransaction' False
 | 
						|
 | 
						|
tests_showTransactionUnelided = [
 | 
						|
   "showTransactionUnelided" ~: do
 | 
						|
    let t `gives` s = assertEqual "" s (showTransactionUnelided t)
 | 
						|
    nulltransaction `gives` "0000/01/01\n\n"
 | 
						|
    nulltransaction{
 | 
						|
      tdate=parsedate "2012/05/14",
 | 
						|
      tdate2=Just $ parsedate "2012/05/15",
 | 
						|
      tstatus=Uncleared,
 | 
						|
      tcode="code",
 | 
						|
      tdescription="desc",
 | 
						|
      tcomment="tcomment1\ntcomment2\n",
 | 
						|
      ttags=[("ttag1","val1")],
 | 
						|
      tpostings=[
 | 
						|
        nullposting{
 | 
						|
          pstatus=Cleared,
 | 
						|
          paccount="a",
 | 
						|
          pamount=Mixed [usd 1, hrs 2],
 | 
						|
          pcomment="\npcomment2\n",
 | 
						|
          ptype=RegularPosting,
 | 
						|
          ptags=[("ptag1","val1"),("ptag2","val2")]
 | 
						|
          }
 | 
						|
       ]
 | 
						|
      }
 | 
						|
      `gives` unlines [
 | 
						|
      "2012/05/14=2012/05/15 (code) desc    ; tcomment1",
 | 
						|
      "    ; tcomment2",
 | 
						|
      "                $1.00",
 | 
						|
      "    * a         2.00h",
 | 
						|
      "    ; pcomment2",
 | 
						|
      ""
 | 
						|
      ]
 | 
						|
 ]
 | 
						|
 | 
						|
-- cf showPosting
 | 
						|
showTransaction' :: Bool -> Transaction -> String
 | 
						|
showTransaction' elide t =
 | 
						|
    unlines $ [descriptionline]
 | 
						|
              ++ newlinecomments
 | 
						|
              ++ (postingsAsLines elide t (tpostings t))
 | 
						|
              ++ [""]
 | 
						|
    where
 | 
						|
      descriptionline = rstrip $ concat [date, status, code, desc, samelinecomment]
 | 
						|
      date = showDate (tdate t) ++ maybe "" (("="++) . showDate) (tdate2 t)
 | 
						|
      status | tstatus t == Cleared = " *"
 | 
						|
             | tstatus t == Pending = " !"
 | 
						|
             | otherwise            = ""
 | 
						|
      code = if length (tcode t) > 0 then printf " (%s)" $ tcode t else ""
 | 
						|
      desc = if null d then "" else " " ++ d where d = tdescription t
 | 
						|
      (samelinecomment, newlinecomments) =
 | 
						|
        case renderCommentLines (tcomment t) of []   -> ("",[])
 | 
						|
                                                c:cs -> (c,cs)
 | 
						|
 | 
						|
-- Render a transaction or posting's comment as indented, semicolon-prefixed comment lines.
 | 
						|
renderCommentLines :: String -> [String]
 | 
						|
renderCommentLines s  = case lines s of ("":ls) -> "":map commentprefix ls
 | 
						|
                                        ls      -> map commentprefix ls
 | 
						|
    where
 | 
						|
      commentprefix = indent . ("; "++)
 | 
						|
 | 
						|
-- -- Render a transaction or posting's comment as semicolon-prefixed comment lines -
 | 
						|
-- -- an inline (same-line) comment if it's a single line, otherwise multiple indented lines.
 | 
						|
-- commentLines' :: String -> (String, [String])
 | 
						|
-- commentLines' s
 | 
						|
--     | null s = ("", [])
 | 
						|
--     | length ls == 1 = (prefix $ head ls, [])
 | 
						|
--     | otherwise = ("", (prefix $ head ls):(map prefix $ tail ls))
 | 
						|
--     where
 | 
						|
--       ls = lines s
 | 
						|
--       prefix = indent . (";"++)
 | 
						|
 | 
						|
postingsAsLines :: Bool -> Transaction -> [Posting] -> [String]
 | 
						|
postingsAsLines elide t ps
 | 
						|
    | elide && length ps > 1 && isTransactionBalanced Nothing t -- imprecise balanced check
 | 
						|
       = (concatMap (postingAsLines False ps) $ init ps) ++ postingAsLines True ps (last ps)
 | 
						|
    | otherwise = concatMap (postingAsLines False ps) ps
 | 
						|
 | 
						|
postingAsLines :: Bool -> [Posting] -> Posting -> [String]
 | 
						|
postingAsLines elideamount ps p =
 | 
						|
    postinglines
 | 
						|
    ++ newlinecomments
 | 
						|
  where
 | 
						|
    postinglines = map rstrip $ lines $ concatTopPadded [account, "  ", amount, samelinecomment]
 | 
						|
 | 
						|
    account =
 | 
						|
      indent $
 | 
						|
        showstatus p ++ fitString (Just acctwidth) Nothing False True (showAccountName Nothing (ptype p) (paccount p))
 | 
						|
        where
 | 
						|
          showstatus p = if pstatus p == Cleared then "* " else ""
 | 
						|
          acctwidth = maximum $ map (strWidth . paccount) ps
 | 
						|
 | 
						|
    -- currently prices are considered part of the amount string when right-aligning amounts
 | 
						|
    amount
 | 
						|
      | elideamount = ""
 | 
						|
      | otherwise   = fitStringMulti (Just amtwidth) Nothing False False $ showMixedAmount $ pamount p
 | 
						|
      where
 | 
						|
        amtwidth = maximum $ 12 : map (strWidth . showMixedAmount . pamount) ps  -- min. 12 for backwards compatibility
 | 
						|
 | 
						|
    (samelinecomment, newlinecomments) =
 | 
						|
      case renderCommentLines (pcomment p) of []   -> ("",[])
 | 
						|
                                              c:cs -> (c,cs)
 | 
						|
 | 
						|
tests_postingAsLines = [
 | 
						|
   "postingAsLines" ~: do
 | 
						|
    let p `gives` ls = assertEqual "" ls (postingAsLines False [p] p)
 | 
						|
    posting `gives` ["                 0"]
 | 
						|
    posting{
 | 
						|
      pstatus=Cleared,
 | 
						|
      paccount="a",
 | 
						|
      pamount=Mixed [usd 1, hrs 2],
 | 
						|
      pcomment="pcomment1\npcomment2\n  tag3: val3  \n",
 | 
						|
      ptype=RegularPosting,
 | 
						|
      ptags=[("ptag1","val1"),("ptag2","val2")]
 | 
						|
      }
 | 
						|
     `gives` [
 | 
						|
      "                $1.00",
 | 
						|
      "    * a         2.00h    ; pcomment1",
 | 
						|
      "    ; pcomment2",
 | 
						|
      "    ;   tag3: val3  "
 | 
						|
      ]
 | 
						|
 ]
 | 
						|
 | 
						|
indent :: String -> String
 | 
						|
indent = ("    "++)
 | 
						|
 | 
						|
-- | Show an account name, clipped to the given width if any, and
 | 
						|
-- appropriately bracketed/parenthesised for the given posting type.
 | 
						|
showAccountName :: Maybe Int -> PostingType -> AccountName -> String
 | 
						|
showAccountName w = fmt
 | 
						|
    where
 | 
						|
      fmt RegularPosting = take w'
 | 
						|
      fmt VirtualPosting = parenthesise . reverse . take (w'-2) . reverse
 | 
						|
      fmt BalancedVirtualPosting = bracket . reverse . take (w'-2) . reverse
 | 
						|
      w' = fromMaybe 999999 w
 | 
						|
      parenthesise s = "("++s++")"
 | 
						|
      bracket s = "["++s++"]"
 | 
						|
 | 
						|
hasRealPostings :: Transaction -> Bool
 | 
						|
hasRealPostings = not . null . realPostings
 | 
						|
 | 
						|
realPostings :: Transaction -> [Posting]
 | 
						|
realPostings = filter isReal . tpostings
 | 
						|
 | 
						|
virtualPostings :: Transaction -> [Posting]
 | 
						|
virtualPostings = filter isVirtual . tpostings
 | 
						|
 | 
						|
balancedVirtualPostings :: Transaction -> [Posting]
 | 
						|
balancedVirtualPostings = filter isBalancedVirtual . tpostings
 | 
						|
 | 
						|
transactionsPostings :: [Transaction] -> [Posting]
 | 
						|
transactionsPostings = concat . map tpostings
 | 
						|
 | 
						|
-- | Get the sums of a transaction's real, virtual, and balanced virtual postings.
 | 
						|
transactionPostingBalances :: Transaction -> (MixedAmount,MixedAmount,MixedAmount)
 | 
						|
transactionPostingBalances t = (sumPostings $ realPostings t
 | 
						|
                               ,sumPostings $ virtualPostings t
 | 
						|
                               ,sumPostings $ balancedVirtualPostings t)
 | 
						|
 | 
						|
-- | Is this transaction balanced ? A balanced transaction's real
 | 
						|
-- (non-virtual) postings sum to 0, and any balanced virtual postings
 | 
						|
-- also sum to 0.
 | 
						|
isTransactionBalanced :: Maybe (Map.Map Commodity AmountStyle) -> Transaction -> Bool
 | 
						|
isTransactionBalanced styles t =
 | 
						|
    -- isReallyZeroMixedAmountCost rsum && isReallyZeroMixedAmountCost bvsum
 | 
						|
    isZeroMixedAmount rsum' && isZeroMixedAmount bvsum'
 | 
						|
    where
 | 
						|
      (rsum, _, bvsum) = transactionPostingBalances t
 | 
						|
      rsum'  = canonicalise $ costOfMixedAmount rsum
 | 
						|
      bvsum' = canonicalise $ costOfMixedAmount bvsum
 | 
						|
      canonicalise = maybe id canonicaliseMixedAmount styles
 | 
						|
 | 
						|
-- | Ensure this transaction is balanced, possibly inferring a missing
 | 
						|
-- amount or conversion price(s), or return an error message.
 | 
						|
-- Balancing is affected by commodity display precisions, so those can
 | 
						|
-- (optionally) be provided.
 | 
						|
balanceTransaction :: Maybe (Map.Map Commodity AmountStyle) -> Transaction -> Either String Transaction
 | 
						|
balanceTransaction styles t =
 | 
						|
  case inferBalancingAmount t of
 | 
						|
    Left err -> Left err
 | 
						|
    Right t' -> let t'' = inferBalancingPrices t'
 | 
						|
                in if isTransactionBalanced styles t''
 | 
						|
                   then Right $ txnTieKnot t''
 | 
						|
                   else Left $ printerr $ nonzerobalanceerror t''
 | 
						|
     where
 | 
						|
      printerr s = intercalate "\n" [s, showTransactionUnelided t]
 | 
						|
      nonzerobalanceerror :: Transaction -> String
 | 
						|
      nonzerobalanceerror t = printf "could not balance this transaction (%s%s%s)" rmsg sep bvmsg
 | 
						|
          where
 | 
						|
            (rsum, _, bvsum) = transactionPostingBalances t
 | 
						|
            rmsg | isReallyZeroMixedAmountCost rsum = ""
 | 
						|
                 | otherwise = "real postings are off by " ++ showMixedAmount (costOfMixedAmount rsum)
 | 
						|
            bvmsg | isReallyZeroMixedAmountCost bvsum = ""
 | 
						|
                  | otherwise = "balanced virtual postings are off by " ++ showMixedAmount (costOfMixedAmount bvsum)
 | 
						|
            sep = if not (null rmsg) && not (null bvmsg) then "; " else "" :: String
 | 
						|
 | 
						|
-- | Infer up to one missing amount for this transactions's real postings, and
 | 
						|
-- likewise for its balanced virtual postings, if needed; or return an error
 | 
						|
-- message if we can't.
 | 
						|
--
 | 
						|
-- We can infer a missing amount when there are multiple postings and exactly
 | 
						|
-- one of them is amountless. If the amounts had price(s) the inferred amount
 | 
						|
-- have the same price(s), and will be converted to the price commodity.
 | 
						|
-- 
 | 
						|
inferBalancingAmount :: Transaction -> Either String Transaction
 | 
						|
inferBalancingAmount t@Transaction{tpostings=ps}
 | 
						|
  | length amountlessrealps > 1
 | 
						|
      = Left $ printerr "could not balance this transaction - can't have more than one real posting with no amount (remember to put 2 or more spaces before amounts)"
 | 
						|
  | length amountlessbvps > 1
 | 
						|
      = Left $ printerr "could not balance this transaction - can't have more than one balanced virtual posting with no amount (remember to put 2 or more spaces before amounts)"
 | 
						|
  | otherwise
 | 
						|
      = Right t{tpostings=map inferamount ps}
 | 
						|
  where
 | 
						|
    printerr s = intercalate "\n" [s, showTransactionUnelided t]
 | 
						|
    ((amountfulrealps, amountlessrealps), realsum) = (partition hasAmount (realPostings t), sum $ map pamount amountfulrealps)
 | 
						|
    ((amountfulbvps, amountlessbvps), bvsum)       = (partition hasAmount (balancedVirtualPostings t), sum $ map pamount amountfulbvps)
 | 
						|
    inferamount p@Posting{ptype=RegularPosting}         | not (hasAmount p) = p{pamount=costOfMixedAmount (-realsum)}
 | 
						|
    inferamount p@Posting{ptype=BalancedVirtualPosting} | not (hasAmount p) = p{pamount=costOfMixedAmount (-bvsum)}
 | 
						|
    inferamount p = p
 | 
						|
 | 
						|
-- | Infer prices for this transaction's posting amounts, if needed to make
 | 
						|
-- the postings balance, and if possible. This is done once for the real
 | 
						|
-- postings and again (separately) for the balanced virtual postings. When
 | 
						|
-- it's not possible, the transaction is left unchanged.
 | 
						|
-- 
 | 
						|
-- The simplest example is a transaction with two postings, each in a
 | 
						|
-- different commodity, with no prices specified. In this case we'll add a
 | 
						|
-- price to the first posting such that it can be converted to the commodity
 | 
						|
-- of the second posting (with -B), and such that the postings balance.
 | 
						|
-- 
 | 
						|
-- In general, we can infer a conversion price when the sum of posting amounts
 | 
						|
-- contains exactly two different commodities and no explicit prices.  Also
 | 
						|
-- all postings are expected to contain an explicit amount (no missing
 | 
						|
-- amounts) in a single commodity. Otherwise no price inferring is attempted.
 | 
						|
-- 
 | 
						|
-- The transaction itself could contain more than two commodities, and/or
 | 
						|
-- prices, if they cancel out; what matters is that the sum of posting amounts
 | 
						|
-- contains exactly two commodities and zero prices.
 | 
						|
-- 
 | 
						|
-- There can also be more than two postings in either of the commodities.
 | 
						|
-- 
 | 
						|
-- We want to avoid excessive display of digits when the calculated price is
 | 
						|
-- an irrational number, while hopefully also ensuring the displayed numbers
 | 
						|
-- make sense if the user does a manual calculation. This is (mostly) achieved
 | 
						|
-- in two ways:
 | 
						|
-- 
 | 
						|
-- - when there is only one posting in the "from" commodity, a total price
 | 
						|
--   (@@) is used, and all available decimal digits are shown
 | 
						|
-- 
 | 
						|
-- - otherwise, a suitable averaged unit price (@) is applied to the relevant
 | 
						|
--   postings, with display precision equal to the summed display precisions
 | 
						|
--   of the two commodities being converted between, or 2, whichever is larger.
 | 
						|
-- 
 | 
						|
-- (We don't always calculate a good-looking display precision for unit prices
 | 
						|
-- when the commodity display precisions are low, eg when a journal doesn't
 | 
						|
-- use any decimal places. The minimum of 2 helps make the prices shown by the
 | 
						|
-- print command a bit less surprising in this case. Could do better.)
 | 
						|
-- 
 | 
						|
inferBalancingPrices :: Transaction -> Transaction
 | 
						|
inferBalancingPrices t@Transaction{tpostings=ps} = t{tpostings=ps'}
 | 
						|
  where
 | 
						|
    ps' = map (priceInferrerFor t BalancedVirtualPosting) $
 | 
						|
          map (priceInferrerFor t RegularPosting) $
 | 
						|
          ps
 | 
						|
 | 
						|
-- | Generate a posting update function which assigns a suitable balancing
 | 
						|
-- price to the posting, if and as appropriate for the given transaction and
 | 
						|
-- posting type (real or balanced virtual).
 | 
						|
priceInferrerFor :: Transaction -> PostingType -> (Posting -> Posting)
 | 
						|
priceInferrerFor t pt = inferprice
 | 
						|
  where
 | 
						|
    postings       = filter ((==pt).ptype) $ tpostings t
 | 
						|
    pmixedamounts  = map pamount postings
 | 
						|
    pamounts       = concatMap amounts pmixedamounts
 | 
						|
    pcommodities   = map acommodity pamounts
 | 
						|
    sumamounts     = amounts $ sum pmixedamounts -- sum normalises to one amount per commodity & price
 | 
						|
    sumcommodities = map acommodity sumamounts
 | 
						|
    sumprices      = filter (/=NoPrice) $ map aprice sumamounts
 | 
						|
    caninferprices = length sumcommodities == 2 && null sumprices
 | 
						|
 | 
						|
    inferprice p@Posting{pamount=Mixed [a]}
 | 
						|
      | caninferprices && ptype p == pt && acommodity a == fromcommodity
 | 
						|
        = p{pamount=Mixed [a{aprice=conversionprice}]}
 | 
						|
      where
 | 
						|
        fromcommodity = head $ filter (`elem` sumcommodities) pcommodities -- these heads are ugly but should be safe
 | 
						|
        conversionprice
 | 
						|
          | fromcount==1 = TotalPrice $ abs toamount `withPrecision` maxprecision
 | 
						|
          | otherwise    = UnitPrice $ abs unitprice `withPrecision` unitprecision
 | 
						|
          where
 | 
						|
            fromcount     = length $ filter ((==fromcommodity).acommodity) pamounts
 | 
						|
            fromamount    = head $ filter ((==fromcommodity).acommodity) sumamounts
 | 
						|
            tocommodity   = head $ filter (/=fromcommodity) sumcommodities
 | 
						|
            toamount      = head $ filter ((==tocommodity).acommodity) sumamounts
 | 
						|
            unitprice     = toamount `divideAmount` (aquantity fromamount)
 | 
						|
            unitprecision = max 2 ((asprecision $ astyle $ toamount) + (asprecision $ astyle $ fromamount))
 | 
						|
    inferprice p = p
 | 
						|
 | 
						|
-- Get a transaction's secondary date, defaulting to the primary date.
 | 
						|
transactionDate2 :: Transaction -> Day
 | 
						|
transactionDate2 t = fromMaybe (tdate t) $ tdate2 t
 | 
						|
 | 
						|
-- | Ensure a transaction's postings refer back to it, so that eg
 | 
						|
-- relatedPostings works right.
 | 
						|
txnTieKnot :: Transaction -> Transaction
 | 
						|
txnTieKnot t@Transaction{tpostings=ps} = t{tpostings=map (settxn t) ps}
 | 
						|
 | 
						|
-- | Set a posting's parent transaction.
 | 
						|
settxn :: Transaction -> Posting -> Posting
 | 
						|
settxn t p = p{ptransaction=Just t}
 | 
						|
 | 
						|
tests_Hledger_Data_Transaction = TestList $ concat [
 | 
						|
  tests_postingAsLines,
 | 
						|
  tests_showTransactionUnelided,
 | 
						|
  [
 | 
						|
  "showTransaction" ~: do
 | 
						|
     assertEqual "show a balanced transaction, eliding last amount"
 | 
						|
       (unlines
 | 
						|
        ["2007/01/28 coopportunity"
 | 
						|
        ,"    expenses:food:groceries        $47.18"
 | 
						|
        ,"    assets:checking"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (let t = Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "coopportunity" "" []
 | 
						|
                [posting{paccount="expenses:food:groceries", pamount=Mixed [usd 47.18], ptransaction=Just t}
 | 
						|
                ,posting{paccount="assets:checking", pamount=Mixed [usd (-47.18)], ptransaction=Just t}
 | 
						|
                ] ""
 | 
						|
        in showTransaction t)
 | 
						|
 | 
						|
  ,"showTransaction" ~: do
 | 
						|
     assertEqual "show a balanced transaction, no eliding"
 | 
						|
       (unlines
 | 
						|
        ["2007/01/28 coopportunity"
 | 
						|
        ,"    expenses:food:groceries        $47.18"
 | 
						|
        ,"    assets:checking               $-47.18"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (let t = Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "coopportunity" "" []
 | 
						|
                [posting{paccount="expenses:food:groceries", pamount=Mixed [usd 47.18], ptransaction=Just t}
 | 
						|
                ,posting{paccount="assets:checking", pamount=Mixed [usd (-47.18)], ptransaction=Just t}
 | 
						|
                ] ""
 | 
						|
        in showTransactionUnelided t)
 | 
						|
 | 
						|
     -- document some cases that arise in debug/testing:
 | 
						|
  ,"showTransaction" ~: do
 | 
						|
     assertEqual "show an unbalanced transaction, should not elide"
 | 
						|
       (unlines
 | 
						|
        ["2007/01/28 coopportunity"
 | 
						|
        ,"    expenses:food:groceries        $47.18"
 | 
						|
        ,"    assets:checking               $-47.19"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (showTransaction
 | 
						|
        (txnTieKnot $ Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "coopportunity" "" []
 | 
						|
         [posting{paccount="expenses:food:groceries", pamount=Mixed [usd 47.18]}
 | 
						|
         ,posting{paccount="assets:checking", pamount=Mixed [usd (-47.19)]}
 | 
						|
         ] ""))
 | 
						|
 | 
						|
  ,"showTransaction" ~: do
 | 
						|
     assertEqual "show an unbalanced transaction with one posting, should not elide"
 | 
						|
       (unlines
 | 
						|
        ["2007/01/28 coopportunity"
 | 
						|
        ,"    expenses:food:groceries        $47.18"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (showTransaction
 | 
						|
        (txnTieKnot $ Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "coopportunity" "" []
 | 
						|
         [posting{paccount="expenses:food:groceries", pamount=Mixed [usd 47.18]}
 | 
						|
         ] ""))
 | 
						|
 | 
						|
  ,"showTransaction" ~: do
 | 
						|
     assertEqual "show a transaction with one posting and a missing amount"
 | 
						|
       (unlines
 | 
						|
        ["2007/01/28 coopportunity"
 | 
						|
        ,"    expenses:food:groceries"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (showTransaction
 | 
						|
        (txnTieKnot $ Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "coopportunity" "" []
 | 
						|
         [posting{paccount="expenses:food:groceries", pamount=missingmixedamt}
 | 
						|
         ] ""))
 | 
						|
 | 
						|
  ,"showTransaction" ~: do
 | 
						|
     assertEqual "show a transaction with a priced commodityless amount"
 | 
						|
       (unlines
 | 
						|
        ["2010/01/01 x"
 | 
						|
        ,"    a        1 @ $2"
 | 
						|
        ,"    b"
 | 
						|
        ,""
 | 
						|
        ])
 | 
						|
       (showTransaction
 | 
						|
        (txnTieKnot $ Transaction nullsourcepos (parsedate "2010/01/01") Nothing Uncleared "" "x" "" []
 | 
						|
         [posting{paccount="a", pamount=Mixed [num 1 `at` (usd 2 `withPrecision` 0)]}
 | 
						|
         ,posting{paccount="b", pamount= missingmixedamt}
 | 
						|
         ] ""))
 | 
						|
 | 
						|
  ,"balanceTransaction" ~: do
 | 
						|
     assertBool "detect unbalanced entry, sign error"
 | 
						|
                    (isLeft $ balanceTransaction Nothing
 | 
						|
                           (Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "test" "" []
 | 
						|
                            [posting{paccount="a", pamount=Mixed [usd 1]}
 | 
						|
                            ,posting{paccount="b", pamount=Mixed [usd 1]}
 | 
						|
                            ] ""))
 | 
						|
 | 
						|
     assertBool "detect unbalanced entry, multiple missing amounts"
 | 
						|
                    (isLeft $ balanceTransaction Nothing
 | 
						|
                           (Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "test" "" []
 | 
						|
                            [posting{paccount="a", pamount=missingmixedamt}
 | 
						|
                            ,posting{paccount="b", pamount=missingmixedamt}
 | 
						|
                            ] ""))
 | 
						|
 | 
						|
     let e = balanceTransaction Nothing (Transaction nullsourcepos (parsedate "2007/01/28") Nothing Uncleared "" "" "" []
 | 
						|
                           [posting{paccount="a", pamount=Mixed [usd 1]}
 | 
						|
                           ,posting{paccount="b", pamount=missingmixedamt}
 | 
						|
                           ] "")
 | 
						|
     assertBool "balanceTransaction allows one missing amount" (isRight e)
 | 
						|
     assertEqual "balancing amount is inferred"
 | 
						|
                     (Mixed [usd (-1)])
 | 
						|
                     (case e of
 | 
						|
                        Right e' -> (pamount $ last $ tpostings e')
 | 
						|
                        Left _ -> error' "should not happen")
 | 
						|
 | 
						|
     let e = balanceTransaction Nothing (Transaction nullsourcepos (parsedate "2011/01/01") Nothing Uncleared "" "" "" []
 | 
						|
                           [posting{paccount="a", pamount=Mixed [usd 1.35]}
 | 
						|
                           ,posting{paccount="b", pamount=Mixed [eur (-1)]}
 | 
						|
                           ] "")
 | 
						|
     assertBool "balanceTransaction can infer conversion price" (isRight e)
 | 
						|
     assertEqual "balancing conversion price is inferred"
 | 
						|
                     (Mixed [usd 1.35 @@ (eur 1 `withPrecision` maxprecision)])
 | 
						|
                     (case e of
 | 
						|
                        Right e' -> (pamount $ head $ tpostings e')
 | 
						|
                        Left _ -> error' "should not happen")
 | 
						|
 | 
						|
     assertBool "balanceTransaction balances based on cost if there are unit prices" (isRight $
 | 
						|
       balanceTransaction Nothing (Transaction nullsourcepos (parsedate "2011/01/01") Nothing Uncleared "" "" "" []
 | 
						|
                           [posting{paccount="a", pamount=Mixed [usd 1 `at` eur 2]}
 | 
						|
                           ,posting{paccount="a", pamount=Mixed [usd (-2) `at` eur 1]}
 | 
						|
                           ] ""))
 | 
						|
 | 
						|
     assertBool "balanceTransaction balances based on cost if there are total prices" (isRight $
 | 
						|
       balanceTransaction Nothing (Transaction nullsourcepos (parsedate "2011/01/01") Nothing Uncleared "" "" "" []
 | 
						|
                           [posting{paccount="a", pamount=Mixed [usd 1    @@ eur 1]}
 | 
						|
                           ,posting{paccount="a", pamount=Mixed [usd (-2) @@ eur 1]}
 | 
						|
                           ] ""))
 | 
						|
 | 
						|
  ,"isTransactionBalanced" ~: do
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ,posting{paccount="c", pamount=Mixed [usd (-1.00)], ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "detect balanced" (isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ,posting{paccount="c", pamount=Mixed [usd (-1.01)], ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "detect unbalanced" (not $ isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "detect unbalanced, one posting" (not $ isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 0], ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "one zero posting is considered balanced for now" (isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ,posting{paccount="c", pamount=Mixed [usd (-1.00)], ptransaction=Just t}
 | 
						|
             ,posting{paccount="d", pamount=Mixed [usd 100], ptype=VirtualPosting, ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "virtual postings don't need to balance" (isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ,posting{paccount="c", pamount=Mixed [usd (-1.00)], ptransaction=Just t}
 | 
						|
             ,posting{paccount="d", pamount=Mixed [usd 100], ptype=BalancedVirtualPosting, ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "balanced virtual postings need to balance among themselves" (not $ isTransactionBalanced Nothing t)
 | 
						|
     let t = Transaction nullsourcepos (parsedate "2009/01/01") Nothing Uncleared "" "a" "" []
 | 
						|
             [posting{paccount="b", pamount=Mixed [usd 1.00], ptransaction=Just t}
 | 
						|
             ,posting{paccount="c", pamount=Mixed [usd (-1.00)], ptransaction=Just t}
 | 
						|
             ,posting{paccount="d", pamount=Mixed [usd 100], ptype=BalancedVirtualPosting, ptransaction=Just t}
 | 
						|
             ,posting{paccount="3", pamount=Mixed [usd (-100)], ptype=BalancedVirtualPosting, ptransaction=Just t}
 | 
						|
             ] ""
 | 
						|
     assertBool "balanced virtual postings need to balance among themselves (2)" (isTransactionBalanced Nothing t)
 | 
						|
 | 
						|
  ]]
 |