Buchhaltung.Add

Types

type AddT' env m = RWST (FullOptions env) () Journal (ErrorT m)

type AddOptions = FullOptions [Partner]

Monad Transformer used to describe the add program

The add specific environment, that can contain a partner user

type AddT m = AddT' [Partner] m

data Partner

Constructors

Partner

Fields

• pUser :: User
• partnerAccount :: AccountName

  partner's receivable/payable account in the user's ledger

• userAccount :: AccountName

  user's receivable/payable account in the partner's ledger

• partnerLedger :: FilePath

  partner's ledger

partners :: (MonadReader AddOptions m, MonadError Msg m) => m [Partner]

Extract partner information from the env and throw errors if there are any readPartner :: (MonadReader AddOptions m, MonadError Msg m) => (Partner -> a) -> m (Maybe a) readPartner f = reader $ fmap f . oEnv

Entry point

add :: AddT' [Username] IO ()

toPartner :: Monad m => User -> AddT' env m Partner

Convert given Username to Partner.

hello :: Monad m => AddT' env m String

Welcome message

mainLoop :: AddT IO ()

main user interaction loop

saveAndClear

Arguments

:: Maybe Transaction

matching transaction for clearing

-> Bool

clear the matching transactions

-> (Maybe Transaction, [(Partner, Transaction)])

transactioons to be saved: ((user's,other's),

-> AddT IO ()

Saves transaction into the designated ledgers files of each user, and clears the transaction tht was matched (conditional on a Bool argument)

clearSecondPosting :: Transaction -> (Transaction, Transaction)

infoNewTx

split :: [EditablePosting] -> ([Posting], [(Partner, E.NonEmpty Posting, MixedAmount)])

Split EditablePostings in User's Postings and (Partner, Postings, Open Balance)

finishTransaction

Arguments

:: (MonadIO m, MonadReader AddOptions m)

=> Bool

require balanced transactions

-> Maybe (Transaction, [EditablePosting])

the transaction and postings to be combined

-> m (Maybe Transaction, [(Partner, Transaction)])

(user's, partners') transactions

generate the main and possibly the other users' transactions

iso8601 :: UTCTime -> String

myJournalAddTransaction :: FilePath -> [Transaction] -> AddT IO Journal

add transaction to ledger file

clearNthPosting :: Int -> Transaction -> Transaction

Transaction suggestions

data Asserted a

Constructors

AA

Fields

• aComment :: Comment
• aAssertion :: Maybe Amount
• aAmount :: a

type AssertedAmount = Asserted MixedAmount

fromPosting :: Posting -> Asserted MixedAmount

showAssertedAmount :: Asserted MixedAmount -> T.Text

sugTrans :: AddT IO (AssertedAmount, Maybe Transaction)

Ask an amount, and return transactions matching the entered amount

data Choice

Constructors

Reenter

Manual

Choose Int

choose

Arguments

:: [String]

choices

-> IO Choice

user input: choose one from a list of choices

menup :: Int -> Parser Choice

stripP

Main editing loop

myEd :: EditorConf (AddT IO) EditablePosting Transaction

combines everything into an EditorConf

mainPrompt :: (ListLike m item, IsString m) => m

quiet :: Monad m => a -> m (Maybe a)

clearTrans :: Zipper EditablePosting -> Zipper EditablePosting

clear all postings

nextNotFirst :: EditablePosting -> EditablePosting

change user of current posting, but not for the first posting ReferenceA

balanceTransactionIfRequired :: Transaction -> Either String Transaction

data Balancing

Constructors

B

Fields

• possible :: Bool
• required :: Bool

balanceRequirement :: MonadError String m => [Posting] -> m Balancing

check, if the transaction should be passed through balanceTransaction to infer missing amounts

checkDone :: LState EditablePosting Transaction -> AddT IO (Maybe (LState EditablePosting Transaction))

Try to balance the transactions and present the final transactions

Asking (with completion)

askDescription

Arguments

:: Maybe T.Text

default

-> IO T.Text

askDate

Arguments

:: Maybe Day

default

-> IO (Day, T.Text)

uses dateandcodep

dateandcodep :: MP.Parser (SmartDate, T.Text)

HLedger's smartdate and code

myAskAccount

askAmount

Arguments

:: Maybe AssertedAmount

default value, if "" is entered

-> T.Text

prompt

-> Maybe T.Text

initial

-> AddT IO AssertedAmount

parseAmount :: Journal -> T.Text -> Either (ParseError Char Dec) AssertedAmount

_amountp2

nosymbolamountp2 :: Monad m => JournalStateParser m Amount

getDefaultCommodityAndStyle2 :: Journal -> Maybe (CommoditySymbol, AmountStyle)

askPercent :: IO Decimal

Posting and Suggestions

data EditablePosting

Type holding suggested or temporary postings

Constructors

EditablePosting

Fields

• epPosting :: Maybe Posting
• epFreq :: Maybe Int
• epAccount :: AccountName
• epNumber :: Int
• epUser :: Zipper (Either User Partner)

  zipper of possible user

type EditablePostings = Zipper EditablePosting

editablePosting

addPosting :: AccountName -> Maybe AssertedAmount -> EditablePosting -> EditablePosting

generate and add new Posting to EditablePosting

setMissing :: EditablePosting -> EditablePosting

removeAmount :: EditablePosting -> EditablePosting

jumpTo :: Int -> Zipper a -> Zipper a

jump to a certain element in a zipper

editDate :: LState a Transaction -> AddT IO (LState a Transaction)

editDescription :: LState a Transaction -> AddT IO (LState a Transaction)

editCurAmount :: EditablePostings -> AddT IO EditablePostings

edit the amount of the selected posting

modifyCurAmount

Arguments

:: (AssertedAmount -> AssertedAmount -> AssertedAmount)

oldAmout -> enteredAmount -> newAmount

-> Bool

Show old amound

-> EditablePostings

-> AddT IO EditablePostings

modfiy current amount by asking for a new amount, that is combined with the old to get a new amount (e.g. with (+))

replaceMissing :: MixedAmount -> MixedAmount

defNumSuggestedAccounts :: Int

Hardcoded default number of suggested accounts

suggestedPostings :: MonadIO m => AccountName -> Maybe AssertedAmount -> AddT m (E.NonEmpty EditablePosting)

retrieve a number of suggested contra postings for a given account, sort frequency of that contra account for the given account.

duplicate each posting for both users, but only if the other user's account is present in the suggestions.

next :: EditablePosting -> EditablePosting

change posting's user to the next user

roundP :: EditablePosting -> EditablePosting

assignOpenBalance :: Decimal -> EditablePostings -> EditablePostings

assign the Transaction's open balance to an empty EditablePosting

showEditablePosting :: EditablePostings -> T.Text

totalBalance :: [EditablePosting] -> MixedAmount

showAmount2 :: Amount -> T.Text

showMixedAmount2 :: MixedAmount -> T.Text

addNewPosting

Arguments

:: Bool

for next partner

-> EditablePostings

-> AddT IO EditablePostings

ask for new account (display old as default) and use existing posting, if same account without a posting/amount already exists or append.

moveToNextEmpty :: EditablePostings -> EditablePostings

move the focus to the next empty posting

Pretty Table Printer

data Align

Constructors

AlignLeft

AlignRight

AlignCenter

fillLeft

fillRight

fillCenter

renderTable :: ([Align], [Align], [T.Text]) -> [[T.Text]] -> Maybe [T.Text] -> T.Text