Safe Haskell	None
Language	Haskell2010

Model

Contents

Helpers exported for easier testing

Synopsis

data Step
- = DateQuestion Comment
- | DescriptionQuestion Day Comment
- | AccountQuestion Transaction Comment
- | AmountQuestion AccountName Transaction Comment
- | FinalQuestion Transaction Duplicate
data MaybeStep
- = Finished Transaction
- | Step Step
data MatchAlgo
- = Fuzzy
- | Substrings
nextStep :: Journal -> DateFormat -> Either Text Text -> Step -> IO (Either Text MaybeStep)
undo :: Step -> Either Text Step
context :: Journal -> MatchAlgo -> DateFormat -> Text -> Step -> IO [Text]
suggest :: Journal -> DateFormat -> Step -> IO (Maybe Text)
setCurrentComment :: Comment -> Step -> Step
getCurrentComment :: Step -> Comment
setTransactionComment :: Comment -> Step -> Step
getTransactionComment :: Step -> Comment
accountsByFrequency :: Journal -> [AccountName]
isDuplicateTransaction :: Journal -> Transaction -> Bool
isSubsetTransaction :: Transaction -> Transaction -> Bool

Documentation

data Step Source #

Constructors

DateQuestion Comment
DescriptionQuestion Day Comment
AccountQuestion Transaction Comment
AmountQuestion AccountName Transaction Comment
FinalQuestion Transaction Duplicate

Instances

Instances details

Eq Step Source #
Instance details Defined in Model Methods (==) :: Step -> Step -> Bool # (/=) :: Step -> Step -> Bool #
Show Step Source #
Instance details Defined in Model Methods showsPrec :: Int -> Step -> ShowS # show :: Step -> String # showList :: [Step] -> ShowS #

data MaybeStep Source #

Constructors

Finished Transaction
Step Step

Instances

Instances details

Eq MaybeStep Source #
Instance details Defined in Model Methods (==) :: MaybeStep -> MaybeStep -> Bool # (/=) :: MaybeStep -> MaybeStep -> Bool #
Show MaybeStep Source #
Instance details Defined in Model Methods showsPrec :: Int -> MaybeStep -> ShowS # show :: MaybeStep -> String # showList :: [MaybeStep] -> ShowS #

data MatchAlgo Source #

Constructors

Fuzzy
Substrings

Instances

Instances details

Eq MatchAlgo Source #
Instance details Defined in Model Methods (==) :: MatchAlgo -> MatchAlgo -> Bool # (/=) :: MatchAlgo -> MatchAlgo -> Bool #
Show MatchAlgo Source #
Instance details Defined in Model Methods showsPrec :: Int -> MatchAlgo -> ShowS # show :: MatchAlgo -> String # showList :: [MatchAlgo] -> ShowS #

nextStep :: Journal -> DateFormat -> Either Text Text -> Step -> IO (Either Text MaybeStep) Source #

undo :: Step -> Either Text Step Source #

Reverses the last step.

Returns (Left errorMessage), if the step can't be reversed

context :: Journal -> MatchAlgo -> DateFormat -> Text -> Step -> IO [Text] Source #

suggest :: Journal -> DateFormat -> Step -> IO (Maybe Text) Source #

Suggest the initial text of the entry box for each step

For example, it suggests today for the date prompt

setCurrentComment :: Comment -> Step -> Step Source #

getCurrentComment :: Step -> Comment Source #

setTransactionComment :: Comment -> Step -> Step Source #

getTransactionComment :: Step -> Comment Source #

Helpers exported for easier testing

accountsByFrequency :: Journal -> [AccountName] Source #

All accounts occuring in the journal sorted in descending order of appearance.

isDuplicateTransaction :: Journal -> Transaction -> Bool Source #

Deterimine if a given transaction already occurs in the journal

This function ignores certain attributes of transactions, postings and amounts that are either artifacts of knot-tying or are purely for presentation.

See the various ...attributes functions in the where clause for details.

isSubsetTransaction :: Transaction -> Transaction -> Bool Source #

Returns True if the first transaction is a subset of the second one.

That means, all postings from the first transaction are present in the second one.