refactor: clarify mixed amount normalising a bit

hledger-lib/Hledger/Data/Amount.hs

@@ -60,7 +60,7 @@ module Hledger.Data.Amount (
   nullmixedamt,
   missingamt,
   amounts,
-  normaliseMixedAmount,
+  normaliseMixedAmountPreservingFirstPrice,
   canonicaliseMixedAmountCommodity,
   mixedAmountWithCommodity,
   setMixedAmountPrecision,
@@ -262,7 +262,7 @@ instance Show MixedAmount where show = showMixedAmount
 instance Num MixedAmount where
     fromInteger i = Mixed [Amount (comm "") (fromInteger i) Nothing]
     negate (Mixed as) = Mixed $ map negate as
-    (+) (Mixed as) (Mixed bs) = normaliseMixedAmountPreservingPrice $ Mixed $ as ++ bs
+    (+) (Mixed as) (Mixed bs) = normaliseMixedAmountPreservingPrices $ Mixed $ as ++ bs
     (*)    = error' "programming error, mixed amounts do not support multiplication"
     abs    = error' "programming error, mixed amounts do not support abs"
     signum = error' "programming error, mixed amounts do not support signum"
@@ -275,11 +275,11 @@ nullmixedamt = Mixed []
 missingamt :: MixedAmount
 missingamt = Mixed [Amount unknown{symbol="AUTO"} 0 Nothing]
 
--- | Simplify a mixed amount's component amounts: combine amounts with the
+-- | Simplify a mixed amount's component amounts: combine amounts with
--- same commodity and price, remove any zero amounts, and replace an empty
+-- the same commodity and price. Also remove any zero amounts and
--- amount list with a single zero amount.
+-- replace an empty amount list with a single zero amount.
-normaliseMixedAmountPreservingPrice :: MixedAmount -> MixedAmount
+normaliseMixedAmountPreservingPrices :: MixedAmount -> MixedAmount
-normaliseMixedAmountPreservingPrice (Mixed as) = Mixed as''
+normaliseMixedAmountPreservingPrices (Mixed as) = Mixed as''
     where
       as'' = if null nonzeros then [nullamt] else nonzeros
       (_,nonzeros) = partition (\a -> isReallyZeroAmount a && Mixed [a] /= missingamt) as'
@@ -288,13 +288,13 @@ normaliseMixedAmountPreservingPrice (Mixed as) = Mixed as''
       group = groupBy (\a1 a2 -> sym a1 == sym a2 && price a1 == price a2)
       sym = symbol . commodity
 
--- | Simplify a mixed amount's component amounts: combine amounts with the
+-- | Simplify a mixed amount's component amounts: combine amounts with
--- same commodity, remove any zero amounts, and replace an empty amount
+-- the same commodity, using the first amount's price for subsequent
--- list with a single zero amount. Unlike normaliseMixedAmountPreservingPrice,
+-- amounts in each commodity (ie, this function alters the amount and
--- this one discards all but the first price encountered in each commodity.
+-- is best used as a rendering helper.). Also remove any zero amounts
--- (This is used more for display than arithmetic, but seems a bit odd. XXX)
+-- and replace an empty amount list with a single zero amount.
-normaliseMixedAmount :: MixedAmount -> MixedAmount
+normaliseMixedAmountPreservingFirstPrice :: MixedAmount -> MixedAmount
-normaliseMixedAmount (Mixed as) = Mixed as''
+normaliseMixedAmountPreservingFirstPrice (Mixed as) = Mixed as''
     where 
       as'' = if null nonzeros then [nullamt] else nonzeros
       (_,nonzeros) = partition (\a -> isReallyZeroAmount a && Mixed [a] /= missingamt) as'
@@ -303,6 +303,12 @@ normaliseMixedAmount (Mixed as) = Mixed as''
       group = groupBy (\a1 a2 -> sym a1 == sym a2)
       sym = symbol . commodity
 
+-- discardPrice :: Amount -> Amount
+-- discardPrice a = a{price=Nothing}
+
+-- discardPrices :: MixedAmount -> MixedAmount
+-- discardPrices (Mixed as) = Mixed $ map discardPrice as
+
 sumAmountsUsingFirstPrice [] = nullamt
 sumAmountsUsingFirstPrice as = (sum as){price=price $ head as}
 
@@ -323,15 +329,15 @@ divideMixedAmount (Mixed as) d = Mixed $ map (flip divideAmount d) as
 isNegativeMixedAmount :: MixedAmount -> Maybe Bool
 isNegativeMixedAmount m = case as of [a] -> Just $ isNegativeAmount a
                                      _   -> Nothing
-    where as = amounts $ normaliseMixedAmount m
+    where as = amounts $ normaliseMixedAmountPreservingFirstPrice m
 
 -- | Does this mixed amount appear to be zero when displayed with its given precision ?
 isZeroMixedAmount :: MixedAmount -> Bool
-isZeroMixedAmount = all isZeroAmount . amounts . normaliseMixedAmount
+isZeroMixedAmount = all isZeroAmount . amounts . normaliseMixedAmountPreservingFirstPrice
 
 -- | Is this mixed amount "really" zero ? See isReallyZeroAmount.
 isReallyZeroMixedAmount :: MixedAmount -> Bool
-isReallyZeroMixedAmount = all isReallyZeroAmount . amounts . normaliseMixedAmount
+isReallyZeroMixedAmount = all isReallyZeroAmount . amounts . normaliseMixedAmountPreservingFirstPrice
 
 -- | Is this mixed amount "really" zero, after converting to cost
 -- commodities where possible ?
@@ -349,14 +355,14 @@ mixedAmountWithCommodity c (Mixed as) = Amount c total Nothing
 -- -- For now, use this when cross-commodity zero equality is important.
 -- mixedAmountEquals :: MixedAmount -> MixedAmount -> Bool
 -- mixedAmountEquals a b = amounts a' == amounts b' || (isZeroMixedAmount a' && isZeroMixedAmount b')
---     where a' = normaliseMixedAmount a
+--     where a' = normaliseMixedAmountPreservingFirstPrice a
---           b' = normaliseMixedAmount b
+--           b' = normaliseMixedAmountPreservingFirstPrice b
 
 -- | Get the string representation of a mixed amount, showing each of
 -- its component amounts. NB a mixed amount can have an empty amounts
 -- list in which case it shows as \"\".
 showMixedAmount :: MixedAmount -> String
-showMixedAmount m = vConcatRightAligned $ map show $ amounts $ normaliseMixedAmount m
+showMixedAmount m = vConcatRightAligned $ map show $ amounts $ normaliseMixedAmountPreservingFirstPrice m
 
 -- | Set the display precision in the amount's commodities.
 setMixedAmountPrecision :: Int -> MixedAmount -> MixedAmount
@@ -367,19 +373,19 @@ setMixedAmountPrecision p (Mixed as) = Mixed $ map (setAmountPrecision p) as
 -- commoditys' display precision settings.
 showMixedAmountWithPrecision :: Int -> MixedAmount -> String
 showMixedAmountWithPrecision p m =
-    vConcatRightAligned $ map (showAmountWithPrecision p) $ amounts $ normaliseMixedAmount m
+    vConcatRightAligned $ map (showAmountWithPrecision p) $ amounts $ normaliseMixedAmountPreservingFirstPrice m
 
 -- | Get an unambiguous string representation of a mixed amount for debugging.
 showMixedAmountDebug :: MixedAmount -> String
 showMixedAmountDebug m = printf "Mixed [%s]" as
-    where as = intercalate "\n       " $ map showAmountDebug $ amounts $ normaliseMixedAmount m
+    where as = intercalate "\n       " $ map showAmountDebug $ amounts $ normaliseMixedAmountPreservingFirstPrice m
 
 -- | Get the string representation of a mixed amount, but without
 -- any \@ prices.
 showMixedAmountWithoutPrice :: MixedAmount -> String
 showMixedAmountWithoutPrice m = concat $ intersperse "\n" $ map showfixedwidth as
     where
-      (Mixed as) = normaliseMixedAmount $ stripPrices m
+      (Mixed as) = normaliseMixedAmountPreservingFirstPrice $ stripPrices m
       stripPrices (Mixed as) = Mixed $ map stripprice as where stripprice a = a{price=Nothing}
       width = maximum $ map (length . show) as
       showfixedwidth = printf (printf "%%%ds" width) . showAmountWithoutPrice
@@ -434,9 +440,9 @@ tests_Hledger_Data_Amount = TestList [
 
   -- MixedAmount
 
-  ,"normaliseMixedAmount" ~: do
+  ,"normaliseMixedAmountPreservingFirstPrice" ~: do
-    normaliseMixedAmount (Mixed []) `is` Mixed [nullamt]
+    normaliseMixedAmountPreservingFirstPrice (Mixed []) `is` Mixed [nullamt]
-    assertBool "" $ isZeroMixedAmount $ normaliseMixedAmount (Mixed [Amount {commodity=dollar, quantity=10,    price=Nothing}
+    assertBool "" $ isZeroMixedAmount $ normaliseMixedAmountPreservingFirstPrice (Mixed [Amount {commodity=dollar, quantity=10,    price=Nothing}
                                                                     ,Amount {commodity=dollar, quantity=10,    price=Just (TotalPrice (Mixed [Amount {commodity=euro, quantity=7, price=Nothing}]))}
                                                                     ,Amount {commodity=dollar, quantity=(-10), price=Nothing}
                                                                     ,Amount {commodity=dollar, quantity=(-10), price=Just (TotalPrice (Mixed [Amount {commodity=euro, quantity=7, price=Nothing}]))}

hledger/Hledger/Cli/Balance.hs

@@ -150,7 +150,7 @@ accountsReportItemAsText opts format (_, accountName, depth, Mixed amounts) =
     -- 'amounts' could contain several quantities of the same commodity with different price.
     -- In order to combine them into single value (which is expected) we take the first price and
     -- use it for the whole mixed amount. This could be suboptimal. XXX
-    let Mixed normAmounts = normaliseMixedAmount (Mixed amounts) in
+    let Mixed normAmounts = normaliseMixedAmountPreservingFirstPrice (Mixed amounts) in
     case normAmounts of
       [] -> []
       [a] -> [formatAccountsReportItem opts (Just accountName) depth a format]

tests/balancing-with-prices.test

@@ -7,21 +7,3 @@ bin/hledger -f - print
     c  $-30
 >>>2 !/could not balance/
 >>>= 0
-# 2. When commodity price is specified for the whole transaction, it should still be reported
-# in the balance as a single quantity even when prices change over time
-bin/hledger -f - balance
-<<<
-2011/01/01 conv1
-  expenses   10£ @@ 16$
-  cash       -16$
-
-2011/01/02 conv2
-  expenses   10£ @@ 15$
-  cash       -15$
->>>
-                -31$  cash
-                 20£  expenses
---------------------
-                -31$
-                 20£
->>>=0

tests/prices.test

@@ -170,3 +170,17 @@ bin/hledger -f - balance
   b  -16$
 >>>
 >>>=1
+
+# 13. Differently-priced lots of a commodity should be merged in balance report
+bin/hledger -f - balance
+<<<
+2011/1/1
+  (a)   £1 @ $2
+
+2011/1/1
+  (a)   £1 @ $3
+>>>
+                  £2  a
+--------------------
+                  £2
+>>>=0