SwiftBeanCountCompassCardMapper

public struct SwiftBeanCountCompassCardMapper

Mapper to map downloaded accounts and transactions to BeanCoutModel objects

Show on GitHub

  • AccountName for the other leg of a transaction

    Declaration

    Swift

    public let defaultExpenseAccountName: AccountName
    Show on GitHub

  • AccountName for the other leg of a load transaction

    Declaration

    Swift

    public let defaultAssetAccountName: AccountName
    Show on GitHub

  • Creates a mapper

    Declaration

    Swift

    public init(ledger: Ledger)

    Parameters

    ledger

    Ledger which will be used to look up things like account names
    Show on GitHub

  • Creates a balance assertions from the downloaded string

    Declaration

    Swift

    public func createBalance(cardNumber: String, balance: String, date inputDate: Date? = nil) throws -> Balance

    Parameters

    cardNumber

    String with the compass card number
    balance

    String with the balance
    date

    Date to balance assertion should use, if nil defaults to tomorrow

    Return Value

    Array of Balances

    Show on GitHub

  • Creates Transactions from the downloaded CSV String

    Note: This method filters out transactions already existing in the ledger

    Declaration

    Swift

    public func createTransactions(cardNumber: String, transactions: String) throws -> [Transaction]

    Parameters

    cardNumber

    String with the compass card number
    transactions

    String of the transaction CSV

    Return Value

    Array of transactions

    Show on GitHub

  • Creates Transactions from a provided CSVReader

    Note: This method filters out transactions already existing in the ledger

    Declaration

    Swift

    public func createTransactions(account: AccountName, reader: CSVReader) throws -> [Transaction]

    Parameters

    account

    AccountName of asset account in the ledger
    reader

    CSVReader with the transaction CSV

    Return Value

    Array of transactions

    Show on GitHub

  • Gets the correct account for the Compass Card from the ledger based on the card number

    Declaration

    Swift

    public func ledgerCardAccountName(cardNumber: String) throws -> AccountName

    Parameters

    cardNumber

    Compass Card Number

    Return Value

    AccountName from the ledger

    Show on GitHub