todos

README

todos

Contains domain related entities and business logic implementations. The business functionality should be exported using Service interface that contains necessary functions to work with the entity.

Every domain/client should have it's own testing package (todostest) that can be used to mock the functionality of this package, usualy generated using external tools like mockery.

Documentation

Index

• Variables
• type Filter
• type Service
  • func New(repository rel.Repository, scores scores.Service) Service
• type Todo
  • func (t Todo) MarshalJSON() ([]byte, error)
  • func (t Todo) Validate() error

Variables

var (
	// TodoURLPrefix to be returned when encoding todo.
	TodoURLPrefix = os.Getenv("URL") + "todos/"
	// ErrTodoTitleBlank validation error.
	ErrTodoTitleBlank = errors.New("Title can't be blank")
)

Types

type Filter

type Filter struct {
	Keyword   string
	Completed *bool
}

Filter for search.

type Service

type Service interface {
	Search(ctx context.Context, todos *[]Todo, filter Filter) error
	Create(ctx context.Context, todo *Todo) error
	Update(ctx context.Context, todo *Todo, changes rel.Changeset) error
	Delete(ctx context.Context, todo *Todo)
	Clear(ctx context.Context)
}

Service instance for todo's domain. Any operation done to any of object within this domain should use this service.

func New

func New(repository rel.Repository, scores scores.Service) Service

New Todos service.

type Todo

type Todo struct {
	ID        uint      `json:"id"`
	Title     string    `json:"title"`
	Order     int       `json:"order"`
	Completed bool      `json:"completed"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

Todo respresent a record stored in todos table.

func (Todo) MarshalJSON

func (t Todo) MarshalJSON() ([]byte, error)

MarshalJSON implement custom marshaller to marshal url.

func (Todo) Validate

func (t Todo) Validate() error

Validate todo.