journal

package

Go to main page

Versions in this module

v0

v0.1.1

Apr 7, 2023

Changes in this version

+ func CompareAccounts(a1, a2 *Account) compare.Order

+ func CompareDays(d *Day, d2 *Day) compare.Order

+ func ComparePostings(p, p2 *Posting) compare.Order

+ func CompareTransactions(t *Transaction, t2 *Transaction) compare.Order

+ func FilterAccount(r []*regexp.Regexp) filter.Filter[Key]

+ func FilterCommodity(rx []*regexp.Regexp) filter.Filter[Key]

+ func FilterDates(f filter.Filter[time.Time]) filter.Filter[Key]

+ func FilterOther(r []*regexp.Regexp) filter.Filter[Key]

+ func NoOp(_ T) error

+ func RemapAccount(jctx Context, rs regex.Regexes) mapper.Mapper[*Account]

+ func ShortenAccount(jctx Context, m AccountMapping) mapper.Mapper[*Account]

type Account

+ func (a Account) IsIE() bool

+ type AccountMapping []Rule

+ func (m AccountMapping) String() string

type Accounts

+ func (as *Accounts) NthParent(a *Account, n int) *Account

+ func (as *Accounts) SwapType(a *Account) *Account

+ type Accrual struct

+ Account *Account

+ Interval date.Interval

+ Period date.Period

+ func (a Accrual) Expand(t *Transaction) []*Transaction

+ type Amounts map[Key]decimal.Decimal

+ func (am Amounts) Add(k Key, d decimal.Decimal)

+ func (am Amounts) Amount(k Key) decimal.Decimal

+ func (am Amounts) Clone() Amounts

+ func (am Amounts) Commodities() set.Set[*Commodity]

+ func (am Amounts) CommoditiesSorted() []*Commodity

+ func (am Amounts) Dates() set.Set[time.Time]

+ func (am Amounts) DatesSorted() []time.Time

+ func (am Amounts) Index(cmp compare.Compare[Key]) []Key

+ func (am Amounts) Minus(a Amounts) Amounts

+ func (am Amounts) Plus(a Amounts) Amounts

+ func (am Amounts) SumBy(f func(k Key) bool, m func(k Key) Key) Amounts

+ func (am Amounts) SumIntoBy(as Amounts, f func(k Key) bool, m func(k Key) Key)

+ func (am Amounts) SumOver(f func(k Key) bool) decimal.Decimal

+ type Assertion struct

+ Account *Account

+ Amount decimal.Decimal

+ Commodity *Commodity

+ Date time.Time

+ type Close struct

+ Account *Account

+ Date time.Time

+ type Collection interface

+ Insert func(k Key, v decimal.Decimal)

type Commodity

+ func (c Commodity) Name() string

+ type Currency struct

+ Date time.Time

+ type Day struct

+ Assertions []*Assertion

+ Closings []*Close

+ Date time.Time

+ Normalized NormalizedPrices

+ Openings []*Open

+ Performance *Performance

+ Prices []*Price

+ Transactions []*Transaction

+ Values []*Value

+ type DayFn = func(*Day) error

+ func Balance(jctx Context, v *Commodity) DayFn

+ func CloseAccounts(j *Journal, enable bool, ds []time.Time) DayFn

+ func ComputePrices(v *Commodity) DayFn

+ func Query(f filter.Filter[Key], m mapper.Mapper[Key], v *Commodity, c Collection) DayFn

+ func Sort() DayFn

+ type Directive interface

+ Position func() Range

+ type Error struct

+ func (be Error) Error() string

+ type Include struct

+ Path string

type Journal

+ Context Context

+ Days map[time.Time]*Day

+ func FromPath(ctx context.Context, jctx Context, path string) (*Journal, error)

+ func New(ctx Context) *Journal

+ func (j *Journal) AddAssertion(a *Assertion)

+ func (j *Journal) AddClose(c *Close)

+ func (j *Journal) AddOpen(o *Open)

+ func (j *Journal) AddPrice(p *Price)

+ func (j *Journal) AddTransaction(t *Transaction)

+ func (j *Journal) AddValue(v *Value)

+ func (j *Journal) Day(d time.Time) *Day

+ func (j *Journal) Max() time.Time

+ func (j *Journal) Min() time.Time

+ func (j *Journal) Period() date.Period

+ func (j *Journal) Process(fs ...func(*Day) error) (*Ledger, error)

+ func (j *Journal) ToLedger() *Ledger

+ type Key struct

+ Account *Account

+ Commodity *Commodity

+ Date time.Time

+ Description string

+ Other *Account

+ Valuation *Commodity

+ func AccountCommodityKey(a *Account, c *Commodity) Key

+ func AccountKey(a *Account) Key

+ func CommodityKey(c *Commodity) Key

+ func DateCommodityKey(d time.Time, c *Commodity) Key

+ func DateKey(d time.Time) Key

+ type KeyMapper struct

+ Account mapper.Mapper[*Account]

+ Commodity mapper.Mapper[*Commodity]

+ Date mapper.Mapper[time.Time]

+ Description mapper.Mapper[string]

+ Other mapper.Mapper[*Account]

+ Valuation mapper.Mapper[*Commodity]

+ func (km KeyMapper) Build() mapper.Mapper[Key]

+ type Ledger struct

+ Context Context

+ Days []*Day

+ type Lot struct

+ Commodity *Commodity

+ Date time.Time

+ Label string

+ Price float64

type NormalizedPrices

+ func NewNormalizedPrices() NormalizedPrices

+ type Open struct

+ Account *Account

+ Date time.Time

+ type Parser struct

+ func ParserFromPath(ctx Context, path string) (*Parser, func() error, error)

+ func (p *Parser) Next() (Directive, error)

+ type Performance struct

+ Inflow map[*Commodity]float64

+ InternalInflow map[*Commodity]float64

+ InternalOutflow map[*Commodity]float64

+ Outflow map[*Commodity]float64

+ PortfolioInflow float64

+ PortfolioOutflow float64

+ V0 map[*Commodity]float64

+ V1 map[*Commodity]float64

+ type Posting struct

+ Account *Account

+ Amount decimal.Decimal

+ Commodity *Commodity

+ Lot *Lot

+ Other *Account

+ Targets []*Commodity

+ Value decimal.Decimal

+ type PostingBuilder struct

+ Amount decimal.Decimal

+ Commodity *Commodity

+ Credit *Account

+ Debit *Account

+ Lot *Lot

+ Targets []*Commodity

+ Value decimal.Decimal

+ func (pb PostingBuilder) Build() []*Posting

+ type PostingBuilders []PostingBuilder

+ func (pbs PostingBuilders) Build() []*Posting

+ type Price struct

+ Commodity *Commodity

+ Date time.Time

+ Price decimal.Decimal

+ Target *Commodity

+ type Printer struct

+ Padding int

+ func NewPrinter() *Printer

+ func (p *Printer) Initialize(directive []Directive)

+ func (p *Printer) PrintLedger(w io.Writer, l *Ledger) (int, error)

+ func (p Printer) PrintDirective(w io.Writer, directive Directive) (n int, err error)

+ type Range struct

+ End scanner.Location

+ Path string

+ Start scanner.Location

+ func (r Range) Position() Range

+ type RecursiveParser struct

+ Context Context

+ File string

+ func (rp *RecursiveParser) Parse(ctx context.Context) <-chan any

+ type Tag string

+ type Transaction struct

+ Accrual *Accrual

+ Date time.Time

+ Description string

+ Postings []*Posting

+ Range Range

+ Tags []Tag

+ func (t Transaction) Position() Range

+ type TransactionBuilder struct

+ Accrual *Accrual

+ Date time.Time

+ Description string

+ Postings []*Posting

+ Range Range

+ Tags []Tag

+ func (tb TransactionBuilder) Build() *Transaction

+ type Value struct

+ Account *Account

+ Amount decimal.Decimal

+ Commodity *Commodity

+ Date time.Time

v0.0.16

Sep 8, 2022

Changes in this version

+ func Compare(a1, a2 *Account) compare.Order

+ func CompareAccountTypes(t1, t2 AccountType) compare.Order

+ func CompareCommodities(c1, c2 *Commodity) compare.Order

+ func CompareWeighted(jctx Context, w map[*Account]float64) compare.Compare[*Account]

+ func MapAccount(jctx Context, m Mapping) func(*Account) *Account

+ func MapCommodity(t bool) func(*Commodity) *Commodity

type Account

+ func (a *Account) Less(a2 *Account) bool

type Accounts

+ func (as *Accounts) Ancestors(a *Account) []*Account

+ func (as *Accounts) Children(a *Account) []*Account

+ func (as *Accounts) Map(a *Account, m Mapping) *Account

+ func (as *Accounts) Parent(a *Account) *Account

type Commodities

+ func (cs *Commodities) All() []*Commodity

v0.0.15

Apr 7, 2022

v0.0.14

Jan 19, 2022

Changes in this version

+ var AccountTypes = []AccountType

+ type Account struct

+ func (a *Account) Map(m Mapping) *Account

+ func (a *Account) Split() []string

+ func (a Account) Children() []*Account

+ func (a Account) Descendents() []*Account

+ func (a Account) IsAL() bool

+ func (a Account) Level() int

+ func (a Account) Name() string

+ func (a Account) Parent() *Account

+ func (a Account) Segment() string

+ func (a Account) String() string

+ func (a Account) Type() AccountType

+ func (a Account) WriteTo(w io.Writer) (int64, error)

+ type AccountType int

+ const ASSETS

+ const EQUITY

+ const EXPENSES

+ const INCOME

+ const LIABILITIES

+ func (t AccountType) String() string

+ type Accounts struct

+ func NewAccounts() *Accounts

+ func (as *Accounts) Get(name string) (*Account, error)

+ func (as *Accounts) PostOrder() []*Account

+ func (as *Accounts) PreOrder() []*Account

+ func (as *Accounts) SortedPreOrder(weights map[*Account]float64) []*Account

+ type Commodities struct

+ func NewCommodities() *Commodities

+ func (cs *Commodities) Enumerate() <-chan *Commodity

+ func (cs *Commodities) Get(name string) (*Commodity, error)

+ func (cs *Commodities) TagCurrency(name string) error

+ type Commodity struct

+ IsCurrency bool

+ func (c Commodity) MarshalJSON() ([]byte, error)

+ func (c Commodity) String() string

+ type Context struct

+ func NewContext() Context

+ func (ctx Context) Account(name string) *Account

+ func (ctx Context) Accounts() *Accounts

+ func (ctx Context) Commodities() *Commodities

+ func (ctx Context) Commodity(name string) *Commodity

+ func (ctx Context) GetAccount(name string) (*Account, error)

+ func (ctx Context) GetCommodity(name string) (*Commodity, error)

+ func (ctx Context) TBDAccount() *Account

+ func (ctx Context) ValuationAccount() *Account

+ func (ctx Context) ValuationAccountFor(a *Account) *Account

+ type Filter struct

+ Accounts *regexp.Regexp

+ Commodities *regexp.Regexp

+ func (b Filter) MatchAccount(a *Account) bool

+ func (b Filter) MatchCommodity(c *Commodity) bool

+ type Mapping []Rule

+ func (m Mapping) String() string

+ type NormalizedPrices map[*Commodity]decimal.Decimal

+ func (n NormalizedPrices) Valuate(c *Commodity, a decimal.Decimal) (decimal.Decimal, error)

+ type Prices map[*Commodity]map[*Commodity]decimal.Decimal

+ func (p Prices) Insert(commodity *Commodity, price decimal.Decimal, target *Commodity)

+ func (p Prices) Normalize(c *Commodity) NormalizedPrices

+ type Rule struct

+ Level int

+ Regex *regexp.Regexp

+ func (r Rule) String() string

v0.0.12

Aug 24, 2021

v0.0.11

Jul 31, 2021

v0.0.10

Feb 10, 2021

v0.0.9

Feb 10, 2021

v0.0.8

Jan 25, 2021

Changes in this version

+ type Journal struct

+ File string

+ func (j *Journal) Parse() chan interface{}

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL