| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Hledger.Read.RulesReader
Contents
Description
A reader for a CSV rules file.
This reads the actual data from a file specified by a source rule
or from a similarly-named file in the same directory.
Most of the code for reading rules files and csv files is in this module.
Synopsis
- reader :: MonadIO m => Reader m
- readJournalFromCsv :: Maybe (Either CsvRules FilePath) -> FilePath -> Handle -> Maybe SepFormat -> ExceptT String IO Journal
- dataFileFor :: FilePath -> Maybe FilePath
- rulesFileFor :: FilePath -> FilePath
- parseBalanceAssertionType :: String -> Maybe (Bool, Bool)
- tests_RulesReader :: TestTree
Reader
Misc.
readJournalFromCsv :: Maybe (Either CsvRules FilePath) -> FilePath -> Handle -> Maybe SepFormat -> ExceptT String IO Journal Source #
Read a Journal from the given CSV data (and filename, used for error messages), or return an error. Proceed as follows:
- Conversion rules are provided, or they are parsed from the specified rules file, or from the default rules file for the CSV data file. If rules parsing fails, or the required rules file does not exist, throw an error.
- Parse the CSV data using the rules, or throw an error.
- Convert the CSV records to hledger transactions using the rules.
- Return the transactions as a Journal.
dataFileFor :: FilePath -> Maybe FilePath Source #
Given a rules file path, what would be the corresponding data file ? (Remove a .rules extension.)
rulesFileFor :: FilePath -> FilePath Source #
Given a csv file path, what would be the corresponding rules file ? (Add a .rules extension.)
parseBalanceAssertionType :: String -> Maybe (Bool, Bool) Source #
Detect from a balance assertion's syntax (=, ==, =*, ==*) whether it is (a) total (multi-commodity) and (b) subaccount-inclusive. Returns nothing if invalid syntax was provided.