changelog

Documentation

Index

• type ChangeLog
• type ErrUnauthorizedAction
  • func (e ErrUnauthorizedAction) Error() string
• type Persist
  • func NewPersist(keyGen keygen.KeyGenerator, timer timer.Timer, changeLog repository.ChangeLog, ...) Persist
  • func (p Persist) CreateChange(title string, summaryMarkdown *string, user entity.User) (entity.Change, error)
  • func (p Persist) DeleteChange(id string, user entity.User) error
  • func (p Persist) GetAllChanges(user entity.User) ([]entity.Change, error)
  • func (p Persist) GetChangeLog() ([]entity.Change, error)
  • func (p Persist) GetLastViewedAt(user entity.User) (*time.Time, error)
  • func (p Persist) UpdateChange(id string, title string, summaryMarkdown *string, user entity.User) (entity.Change, error)
  • func (p Persist) ViewChangeLog(user entity.User) (time.Time, error)

Types

type ChangeLog

type ChangeLog interface {
	GetChangeLog() ([]entity.Change, error)
	GetLastViewedAt(user entity.User) (*time.Time, error)
	ViewChangeLog(user entity.User) (time.Time, error)
	CreateChange(title string, summaryMarkdown *string, user entity.User) (entity.Change, error)
	GetAllChanges(user entity.User) ([]entity.Change, error)
	DeleteChange(id string, user entity.User) error
	UpdateChange(id string, title string, summaryMarkdown *string, user entity.User) (entity.Change, error)
}

ChangeLog retrieves change log and create changes.

type ErrUnauthorizedAction

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

ErrUnauthorizedAction represents unauthorized action error

func (ErrUnauthorizedAction) Error

func (e ErrUnauthorizedAction) Error() string

type Persist

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

Persist retrieves change log from and saves changes to persistent data store.

func NewPersist

func NewPersist(
	keyGen keygen.KeyGenerator,
	timer timer.Timer,
	changeLog repository.ChangeLog,
	userChangeLog repository.UserChangeLog,
	authorizer authorizer.Authorizer,
) Persist

NewPersist creates Persist

func (Persist) CreateChange

func (p Persist) CreateChange(title string, summaryMarkdown *string, user entity.User) (entity.Change, error)

CreateChange creates a new change in the data store.

func (Persist) DeleteChange

func (p Persist) DeleteChange(id string, user entity.User) error

DeleteChange removes the change with given id

func (Persist) GetAllChanges

func (p Persist) GetAllChanges(user entity.User) ([]entity.Change, error)

GetAllChanges retrieves all the changes from the persistent date store.

func (Persist) GetChangeLog

func (p Persist) GetChangeLog() ([]entity.Change, error)

GetChangeLog retrieves full ChangeLog from persistent data store.

func (Persist) GetLastViewedAt

func (p Persist) GetLastViewedAt(user entity.User) (*time.Time, error)

GetLastViewedAt retrieves the last time the user viewed the change log

func (Persist) UpdateChange

func (p Persist) UpdateChange(
	id string,
	title string,
	summaryMarkdown *string,
	user entity.User,
) (entity.Change, error)

UpdateChange updates an existing change with given id in data store.

func (Persist) ViewChangeLog

func (p Persist) ViewChangeLog(user entity.User) (time.Time, error)

ViewChangeLog records the time when the user viewed the change log