mirror of
https://github.com/simonmichael/hledger.git
synced 2024-09-20 02:37:12 +03:00
122 lines
4.1 KiB
Haskell
122 lines
4.1 KiB
Haskell
{-|
|
|
An 'Amount' is some quantity of money, shares, or anything else.
|
|
|
|
A simple amount is a currency, quantity pair (where currency can be anything):
|
|
|
|
@
|
|
$1
|
|
£-50
|
|
EUR 3.44
|
|
GOOG 500
|
|
1.5h
|
|
90apples
|
|
0
|
|
@
|
|
|
|
A mixed amount (not yet implemented) is one or more simple amounts:
|
|
|
|
@
|
|
$50, EUR 3, AAPL 500
|
|
16h, $13.55, oranges 6
|
|
@
|
|
|
|
Currencies may be convertible or not (eg, currencies representing
|
|
non-money commodities). A mixed amount containing only convertible
|
|
currencies can be converted to a simple amount. Arithmetic examples:
|
|
|
|
@
|
|
$1 - $5 = $-4
|
|
$1 + EUR 0.76 = $2
|
|
EUR0.76 + $1 = EUR 1.52
|
|
EUR0.76 - $1 = 0
|
|
($5, 2h) + $1 = ($6, 2h)
|
|
($50, EUR 3, AAPL 500) + ($13.55, oranges 6) = $67.51, AAPL 500, oranges 6
|
|
($50, EUR 3) * $-1 = $-53.96
|
|
($50, AAPL 500) * $-1 = error
|
|
@
|
|
-}
|
|
|
|
module Ledger.Amount
|
|
where
|
|
import Test.HUnit
|
|
import Ledger.Utils
|
|
import Ledger.Types
|
|
import Ledger.Currency
|
|
|
|
|
|
amounttests = TestList [
|
|
show (dollars 1) ~?= "$1.00"
|
|
,show (hours 1) ~?= "h1.00" -- should be 1.0h
|
|
,"precision subtleties" ~: do
|
|
let a1 = Amount (getcurrency "$") 1.23 1
|
|
let a2 = Amount (getcurrency "$") (-1.23) 2
|
|
let a3 = Amount (getcurrency "$") (-1.23) 3
|
|
assertequal (Amount (getcurrency "$") 0 1) (a1 + a2)
|
|
assertequal (Amount (getcurrency "$") 0 1) (a1 + a3)
|
|
assertequal (Amount (getcurrency "$") (-2.46) 2) (a2 + a3)
|
|
assertequal (Amount (getcurrency "$") (-2.46) 3) (a3 + a3)
|
|
-- sum adds 0, with Amount fromIntegral's default precision of 2
|
|
assertequal (Amount (getcurrency "$") 0 1) (sum [a1,a2])
|
|
assertequal (Amount (getcurrency "$") (-2.46) 2) (sum [a2,a3])
|
|
assertequal (Amount (getcurrency "$") (-2.46) 2) (sum [a3,a3])
|
|
]
|
|
|
|
instance Show Amount where show = showAmountRounded
|
|
|
|
-- | Get the string representation of an amount, rounded to its native precision.
|
|
-- Unlike ledger, we show the decimal digits even if they are all 0, and
|
|
-- we always show currency symbols on the left.
|
|
showAmountRounded :: Amount -> String
|
|
showAmountRounded (Amount c q p) =
|
|
(symbol c) ++ ({-punctuatethousands $ -}printf ("%."++show p++"f") q)
|
|
|
|
-- | Get the string representation of an amount, rounded, or showing just "0" if it's zero.
|
|
showAmountRoundedOrZero :: Amount -> String
|
|
showAmountRoundedOrZero a
|
|
| isZeroAmount a = "0"
|
|
| otherwise = showAmountRounded a
|
|
|
|
-- | is this amount zero, when displayed with its given precision ?
|
|
isZeroAmount :: Amount -> Bool
|
|
isZeroAmount a@(Amount c _ _) = nonzerodigits == ""
|
|
where
|
|
nonzerodigits = filter (flip notElem "-+,.0") quantitystr
|
|
quantitystr = withoutcurrency $ showAmountRounded a
|
|
withoutcurrency = drop (length $ symbol c)
|
|
|
|
punctuatethousands :: String -> String
|
|
punctuatethousands s =
|
|
sign ++ (punctuate int) ++ frac
|
|
where
|
|
(sign,num) = break isDigit s
|
|
(int,frac) = break (=='.') num
|
|
punctuate = reverse . concat . intersperse "," . triples . reverse
|
|
triples "" = []
|
|
triples s = [take 3 s] ++ (triples $ drop 3 s)
|
|
|
|
instance Num Amount where
|
|
abs (Amount c q p) = Amount c (abs q) p
|
|
signum (Amount c q p) = Amount c (signum q) p
|
|
fromInteger i = Amount (getcurrency "") (fromInteger i) defaultprecision
|
|
(+) = amountop (+)
|
|
(-) = amountop (-)
|
|
(*) = amountop (*)
|
|
|
|
-- amounts converted from integers will have a default precision, and the
|
|
-- null currency.
|
|
defaultprecision = 2
|
|
|
|
-- | Apply a binary arithmetic operator to two amounts, converting to the
|
|
-- second one's currency and adopting the lowest precision. (Using the
|
|
-- second currency means that folds (like sum [Amount]) will preserve the
|
|
-- currency.)
|
|
amountop :: (Double -> Double -> Double) -> Amount -> Amount -> Amount
|
|
amountop op a@(Amount ac aq ap) b@(Amount bc bq bp) =
|
|
Amount bc ((quantity $ toCurrency bc a) `op` bq) (min ap bp)
|
|
|
|
toCurrency :: Currency -> Amount -> Amount
|
|
toCurrency newc (Amount oldc q p) =
|
|
Amount newc (q * (conversionRate oldc newc)) p
|
|
|
|
nullamt = Amount (getcurrency "") 0 2
|