rules

package

v0.5.0 Latest Latest Go to latest Published: Aug 4, 2019 License: GPL-3.0 Imports: 10 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Rule interface {
	Match(ledger.Transaction) bool
	Apply(*ledger.Transaction)
}

Rule can match a transaction and apply a transformation to it

func NewCSVRule(account1, account2, comment string, conditions ...string) (Rule, error)

type Rules []Rule

Rules enables transformation of transactions across multiple, sequential rules

func NewCSVRulesFromReader(reader io.Reader) (Rules, error)

func (r Rules) Apply(txn *ledger.Transaction)

Apply runs a match and subsequent apply for each rule on the given transaction

func (r Rules) String() string

func (r *Rules) UnmarshalJSON(b []byte) error

UnmarshalJSON parses the given bytes into rules

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

Store enables manipulation of rules in memory

func NewStore(rules Rules) *Store

NewStore creates a rules store from the given rules

func (s *Store) Accounts() []string

Accounts returns account names (account2) for any CSV rules

func (s *Store) Apply(txn *ledger.Transaction)

Apply transforms the given transaction based on the current rules

func (s *Store) ApplyAll(txns []ledger.Transaction)

ApplyAll transforms the given transactions based on the current rules

func (s *Store) MarshalJSON() ([]byte, error)

MarshalJSON returns JSON-encoded rules

func (s *Store) Replace(newRules Rules)

Replace replaces the current rules with newRules

func (s *Store) String() string