hledger-lib-1.50.3: A library providing the core functionality of hledger

Safe Haskell | None
Language | GHC2021

Hledger.Read.RulesReader

Contents

- Reader
- Misc.
- Tests
- Orphan instances

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 :: forall (m :: Type -> Type). MonadIO m => Reader m
- dataFileFor :: FilePath -> Maybe FilePath
- rulesFileFor :: FilePath -> FilePath
- getRulesFile :: FilePath -> Maybe FilePath -> FilePath
- readRules :: FilePath -> ExceptT String IO CsvRules
- rulesEncoding :: CsvRules -> ExceptT String IO (Maybe DynEncoding)
- readJournalFromCsv :: CsvRules -> FilePath -> Text -> Maybe SepFormat -> ExceptT String IO Journal
- parseBalanceAssertionType :: String -> Maybe (Bool, Bool)
- tests_RulesReader :: TestTree

# Reader

reader :: forall (m :: Type -> Type). MonadIO m => Reader m Source #

# Misc.

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.)

getRulesFile :: FilePath -> Maybe FilePath -> FilePath Source #

Return the given rules file path, or if none is given, the default rules file for the given csv file; or if the csv file is "-", raise an error.

readRules :: FilePath -> ExceptT String IO CsvRules Source #

An exception-throwing IO action that reads and validates the specified CSV rules file (which may include other rules files).

rulesEncoding :: CsvRules -> ExceptT String IO (Maybe DynEncoding) Source #

Read the encoding specified by the `encoding` rule, if any. Or throw an error if an unrecognised encoding is specified.

readJournalFromCsv :: CsvRules -> FilePath -> Text -> 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:

1. 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.
2. Parse the CSV data using the rules, or throw an error.
3. Convert the CSV records to hledger transactions using the rules.
4. Return the transactions as a Journal.

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.

# Tests

tests_RulesReader :: TestTree Source #

# Orphan instances

ShowErrorComponent String Source # |
Instance details Methods showErrorComponent :: String -> String Source # errorComponentLen :: String -> Int Source #