journal

Documentation

Index

• func CompareDays(d *Day, d2 *Day) compare.Order
• func FromModelStream(modelCh <-chan []model.Directive) (<-chan *Builder, func(context.Context) error)
• func Print(w io.Writer, j *Journal) error
• type Builder
  • func FromPath(ctx context.Context, reg *model.Registry, path string) (*Builder, error)
  • func New() *Builder
  • func (j *Builder) Add(d model.Directive) error
  • func (j *Builder) Build() *Journal
  • func (j *Builder) Day(d time.Time) *Day
  • func (j *Builder) Days(dates []time.Time) []*Day
  • func (j *Builder) Period() date.Period
• type Collection
• type Day
• type Journal
  • func (j *Journal) Process(ps ...*Processor) error
• type Performance
  • func (p Performance) String() string
• type Processor
  • func CloseAccounts(j *Builder, reg *model.Registry, enable bool, partition date.Partition) *Processor
  • func ComputePrices(v *model.Commodity) *Processor
  • func Filter(part date.Partition) *Processor
  • func Sort() *Processor
  • func Valuate(reg *model.Registry, valuation *model.Commodity) *Processor
  • func (proc *Processor) Process(d *Day) error
• type Query
  • func (query Query) Into(c Collection) *Processor

Functions

func CompareDays

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

Less establishes an ordering on Day.

func FromModelStream

func FromModelStream(modelCh <-chan []model.Directive) (<-chan *Builder, func(context.Context) error)

func Print

func Print(w io.Writer, j *Journal) error

PrintJournal prints a journal.

Types

type Builder

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

Builder represents an unprocessed

func FromPath

func FromPath(ctx context.Context, reg *model.Registry, path string) (*Builder, error)

func New

func New() *Builder

New creates a new Journal.

func (*Builder) Add

func (j *Builder) Add(d model.Directive) error

func (*Builder) Build

func (j *Builder) Build() *Journal

func (*Builder) Day

func (j *Builder) Day(d time.Time) *Day

Day returns the Day for the given date.

func (*Builder) Days

func (j *Builder) Days(dates []time.Time) []*Day

func (*Builder) Period

func (j *Builder) Period() date.Period

type Collection

type Collection interface {
	Insert(k amounts.Key, v decimal.Decimal)
}

type Day

type Day struct {
	Date         time.Time
	Prices       []*model.Price
	Assertions   []*model.Assertion
	Openings     []*model.Open
	Transactions []*model.Transaction
	Closings     []*model.Close

	Normalized price.NormalizedPrices

	Performance *Performance
}

Day groups all commands for a given date.

type Journal

type Journal struct {
	Days []*Day
}

func (*Journal) Process

func (j *Journal) Process(ps ...*Processor) error

type Performance

type Performance struct {
	V0, V1, Inflow, Outflow, InternalInflow, InternalOutflow map[*model.Commodity]float64
	PortfolioInflow, PortfolioOutflow                        float64
}

Performance holds aggregate information used to compute portfolio performance.

func (Performance) String

func (p Performance) String() string

type Processor

type Processor struct {
	DayStart    func(*Day) error
	Price       func(*model.Price) error
	Open        func(*model.Open) error
	Transaction func(*model.Transaction) error
	Posting     func(*model.Transaction, *model.Posting) error
	Assertion   func(*model.Assertion) error
	Balance     func(*model.Assertion, *model.Balance) error
	Close       func(*model.Close) error
	DayEnd      func(*Day) error
}

func CloseAccounts

func CloseAccounts(j *Builder, reg *model.Registry, enable bool, partition date.Partition) *Processor

Balance balances the journal.

func ComputePrices

func ComputePrices(v *model.Commodity) *Processor

ComputePrices updates prices.

func Filter

func Filter(part date.Partition) *Processor

func Sort

func Sort() *Processor

Sort sorts the directives in this day.

func Valuate

func Valuate(reg *model.Registry, valuation *model.Commodity) *Processor

Balance balances the journal.

func (*Processor) Process

func (proc *Processor) Process(d *Day) error

type Query

type Query struct {
	Select    mapper.Mapper[amounts.Key]
	Where     predicate.Predicate[amounts.Key]
	Valuation *model.Commodity
}

func (Query) Into

func (query Query) Into(c Collection) *Processor