ledger

Documentation

Index

• Constants
• func BalanceReport(iter RecordIterator, assets []*Account, output io.Writer)
• func ExpensesReport(iter RecordIterator, output io.Writer)
• func MonthlyBalanceReport(iter RecordIterator, assets []*Account, output io.Writer)
• func WeeklyExpensesReport(iter RecordIterator, assets []*Account, output io.Writer)
• type Account
  • func NewAccount(name string, asset bool) *Account
  • func (account *Account) String() string
• type AccountFilter
  • func (f *AccountFilter) Filter(r *Record) *Record
• type AmountFilter
  • func (f *AmountFilter) Filter(r *Record) *Record
• type Config
  • func LoadConfig(path string) (*Config, error)
• type DateRangeFilter
  • func (f *DateRangeFilter) Filter(r *Record) *Record
• type FilteredIterator
  • func NewFilteredIterator(iter RecordIterator, filters ...RecordFilter) *FilteredIterator
  • func (iter FilteredIterator) Next() *Record
• type LedgerIterator
  • func NewLedgerIterator(assets []*Account, ledgerDir string) *LedgerIterator
  • func (i *LedgerIterator) Next() *Record
• type Record
  • func (r *Record) FormatAmount() string
  • func (r *Record) RecordType() RecordType
  • func (r *Record) ToArray() []string
• type RecordFilter
• type RecordIterator
• type RecordType

Constants

const ISO8601Date = "2006-01-02"

Functions

func BalanceReport

func BalanceReport(iter RecordIterator, assets []*Account, output io.Writer)

func ExpensesReport

func ExpensesReport(iter RecordIterator, output io.Writer)

func MonthlyBalanceReport

func MonthlyBalanceReport(iter RecordIterator, assets []*Account, output io.Writer)

func WeeklyExpensesReport

func WeeklyExpensesReport(iter RecordIterator, assets []*Account, output io.Writer)

Types

type Account

type Account struct {
	Name  string
	Asset bool
}

func NewAccount

func NewAccount(name string, asset bool) *Account

func (*Account) String

func (account *Account) String() string

type AccountFilter

type AccountFilter struct {
	Credit string
	Debit  string
}

func (*AccountFilter) Filter

func (f *AccountFilter) Filter(r *Record) *Record

type AmountFilter

type AmountFilter struct {
	Min decimal.Decimal
	Max decimal.Decimal
}

func (*AmountFilter) Filter

func (f *AmountFilter) Filter(r *Record) *Record

type Config

type Config struct {
	Assets []*Account
}

func LoadConfig

func LoadConfig(path string) (*Config, error)

type DateRangeFilter

type DateRangeFilter struct {
	Since time.Time
	Until time.Time
}

func (*DateRangeFilter) Filter

func (f *DateRangeFilter) Filter(r *Record) *Record

type FilteredIterator

type FilteredIterator struct {
	// contains filtered or unexported fields
}

func NewFilteredIterator

func NewFilteredIterator(iter RecordIterator, filters ...RecordFilter) *FilteredIterator

func (FilteredIterator) Next

func (iter FilteredIterator) Next() *Record

type LedgerIterator

type LedgerIterator struct {
	// contains filtered or unexported fields
}

func NewLedgerIterator

func NewLedgerIterator(assets []*Account, ledgerDir string) *LedgerIterator

func (*LedgerIterator) Next

func (i *LedgerIterator) Next() *Record

type Record

type Record struct {
	Debit  *Account
	Credit *Account
	Date   time.Time
	Amount decimal.Decimal
}

func (*Record) FormatAmount

func (r *Record) FormatAmount() string

func (*Record) RecordType

func (r *Record) RecordType() RecordType

func (*Record) ToArray

func (r *Record) ToArray() []string

type RecordFilter

type RecordFilter func(*Record) *Record

type RecordIterator

type RecordIterator interface {
	Next() *Record
}

type RecordType

type RecordType int8