slaesvuo/hledger
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

"balance" parser for csv reader (#537)

Browse Source 
* "balance" parser for csv reader

* Some docs for
This commit is contained in:
Dmitry Astapov 2017-04-14 22:52:03 +01:00 committed by Simon Michael
parent f9ad13b1c1
commit 451f9d7307
3 changed files with 26 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
hledger-lib/Hledger/Read/CsvReader.hs
View File

@ -513,6 +513,7 @@ journalfieldnames =
,"account1" ,"account1"
,"account2" ,"account2"
,"comment" ,"comment"
,"balance"
] ]
assignmentseparatorp :: CsvRulesParser () assignmentseparatorp :: CsvRulesParser ()
@ -663,6 +664,17 @@ transactionFromCsvRecord sourcepos rules record = t
_ -> "expenses:unknown" _ -> "expenses:unknown"
account1 = T.pack $ maybe "" render (mfieldtemplate "account1") `or` defaccount1 account1 = T.pack $ maybe "" render (mfieldtemplate "account1") `or` defaccount1
account2 = T.pack $ maybe "" render (mfieldtemplate "account2") `or` defaccount2 account2 = T.pack $ maybe "" render (mfieldtemplate "account2") `or` defaccount2
balance = maybe Nothing parsebalance $ mfieldtemplate "balance"
parsebalance "" = Nothing
parsebalance str = Just $ either (balanceerror str) id $ runParser (evalStateT (amountp <* eof) mempty) "" $ T.pack $ (currency++) $ negateIfParenthesised $ render str
balanceerror str err = error' $ unlines
["error: could not parse \""++str++"\" as balance amount"
,showRecord record
,"the balance rule is: "++(fromMaybe "" $ mfieldtemplate "balance")
,"the currency rule is: "++(fromMaybe "unspecified" $ mfieldtemplate "currency")
,"the default-currency is: "++fromMaybe "unspecified" mdefaultcurrency
,"the parse error is: "++show err
]
-- build the transaction -- build the transaction
t = nulltransaction{ t = nulltransaction{
@ -676,7 +688,7 @@ transactionFromCsvRecord sourcepos rules record = t
tpreceding_comment_lines = T.pack precomment, tpreceding_comment_lines = T.pack precomment,
tpostings = tpostings =
[posting {paccount=account2, pamount=amount2, ptransaction=Just t} [posting {paccount=account2, pamount=amount2, ptransaction=Just t}
,posting {paccount=account1, pamount=amount1, ptransaction=Just t} ,posting {paccount=account1, pamount=amount1, ptransaction=Just t, pbalanceassertion=balance}
] ]
} }

4
hledger-lib/doc/hledger_csv.5.m4.md
View File

@ -84,7 +84,7 @@ date-format %-m/%-d/%Y %l:%M %p
This (a) names the CSV fields, in order (names may not contain whitespace; uninteresting names may be left blank), This (a) names the CSV fields, in order (names may not contain whitespace; uninteresting names may be left blank),
and (b) assigns them to journal entry fields if you use any of these standard field names: and (b) assigns them to journal entry fields if you use any of these standard field names:
`date`, `date2`, `status`, `code`, `description`, `comment`, `account1`, `account2`, `amount`, `amount-in`, `amount-out`, `currency`. `date`, `date2`, `status`, `code`, `description`, `comment`, `account1`, `account2`, `amount`, `amount-in`, `amount-out`, `currency`, `balance`.
Eg: Eg:
```rules ```rules
# use the 1st, 2nd and 4th CSV fields as the entry's date, description and amount, # use the 1st, 2nd and 4th CSV fields as the entry's date, description and amount,
@ -172,3 +172,5 @@ If an amount value is parenthesised, it will be de-parenthesised and sign-flippe
The generated journal entries will be sorted by date. The generated journal entries will be sorted by date.
The original order of same-day entries will be preserved, usually. The original order of same-day entries will be preserved, usually.
<!-- (by reversing the CSV entries if they seem to be in reverse date order). --> <!-- (by reversing the CSV entries if they seem to be in reverse date order). -->
If you assign anything to the `balance` pseudo field, it would become an assertion of the balance of `account1`. If you assign empty string to it, no assertion will be generated (this can be used to omit balance assertions on some transactions).

10
tests/csv/read.test
View File

@ -58,3 +58,13 @@
# $-1,001.00 income:unknown # $-1,001.00 income:unknown
# $1,001.00 unknown # $1,001.00 unknown
#>>>=0 #>>>=0
# 6. read CSV with balance field
rm -rf t.rules$$; printf 'fields date, description, amount, balance\ndate-format %%d/%%Y/%%m\ncurrency $\naccount1 assets:myacct\n' >t.rules$$; echo '10/2009/09,Flubber Co,50,123' | hledger -f- print --rules-file t.rules$$; rm -rf t.rules$$
>>>
2009/09/10 Flubber Co
income:unknown $-50
assets:myacct $50 = $123
>>>2 /using conversion rules file.*t.rules/
>>>=0