changes

type ChainedLogger ¶

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

ChainedLogger implements Logger interface using an inner change logger. Multiple change loggers are chained together by prepending prefixes.

func NewChainedLogger(prefix Prefix, inner Logger) *ChainedLogger

func (c *ChainedLogger) Append(change Change)

func (c *ChainedLogger) ToString() []string

type Change ¶

type Change struct {
	Prefix    []Prefix  `json:"prefix,omitempty"`
	FieldName string    `json:"field_name,omitempty"`
	Operation Operation `json:"operation,omitempty"`
	OldValue  string    `json:"old_value,omitempty"`
	NewValue  string    `json:"new_value,omitempty"`
	Key       string    `json:"key,omitempty"`
}

Change represents a mutation applied to an object.

type DefaultFormatter ¶

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

DefaultFormatter provides basic change formatting functionality.

func NewDefaultFormatter(options ...func(*DefaultFormatter)) *DefaultFormatter

func (f *DefaultFormatter) Format(c *Change) string

type DefaultLogger ¶

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

DefaultLogger provides basic change logging functionality.

func NewDefaultLogger(prefix Prefix) *DefaultLogger

func (c *DefaultLogger) Append(change Change)

func (c *DefaultLogger) ToString() (result []string)

type FieldName ¶ added in v0.5.0

type FieldName string

FieldName defines a type for the field name enums used in prefixes.

var (
	// FieldNameEmpty is the empty prefix name for root level field changes.
	FieldNameEmpty FieldName = ""
)

type Formatter ¶

type Formatter interface {
	Format(c *Change) string
}

Formatter defines an interface for formatting changes to human readable string.

type Key ¶ added in v0.5.0

type Key interface {
	KeyForChanges() string
}

Key interface can be implemented for types so that the resulting string is used as the key in the prefix.

type Logger ¶

type Logger interface {
	Append(change Change)
	ToString() []string
}

Logger defines an interface for logging changes.

type Operation ¶

type Operation string

Operation defines a type used for change operation enums.

const (
	// OperationAdded is used for slice appends and map inserts.
	OperationAdded Operation = "added"
	// OperationRemoved is used for slice removals and map deletes.
	OperationRemoved Operation = "removed"
	// OperationUpdated is used for field updates.
	OperationUpdated Operation = "updated"
	// OperationSet is used for field sets.
	// Setting a whole slice/map, or setting a field which was previously unset.
	OperationSet Operation = "set"
	// OperationCleared is used for setting a field's value to its zero value.
	OperationCleared Operation = "cleared"
)

type Prefix ¶

type Prefix struct {
	Name FieldName
	Key  string
}

Prefix defines a type used for change prefix enums. Prefixes are used to identify the object's field that was changed. If a field is a map or slice, the key is also included in the prefix.

For example, if a FieldName "Foo" was added to a map with key "bar", the prefix would be {Name: "Foo", Key: "bar"}, and the default change logger would print "Foo[bar] added with value 'value'".

func NewPrefix(name FieldName) Prefix

func NewPrefixWithKey(name FieldName, key string) Prefix