cromberbus

README

Cromberbus

Cromberbus is a simple command bus written in Go

License

Cromberbus is free and released under the MIT License

Authors

• Eduardo R. Golding
• Jose I. Ortiz de Galisteo

About Jacobo Cromberger

Documentation

Index

• type Command
• type CommandBus
• type CommandCallable
• type CommandHandler
• type CommandHandlerResolver
• type CommandHandlerResolverMock
  • func (mock *CommandHandlerResolverMock) Resolve(command Command) (CommandHandler, error)
  • func (mock *CommandHandlerResolverMock) ResolveCalls() []struct{ ... }
• type CromberBus
  • func NewCromberBus(handlerResolver CommandHandlerResolver, middlewares ...Middleware) CromberBus
  • func (b CromberBus) Dispatch(command Command) error
• type MapHandlerResolver
  • func NewMapHandlerResolver() MapHandlerResolver
  • func (r MapHandlerResolver) AddHandler(command Command, handler CommandHandler)
  • func (r MapHandlerResolver) Resolve(command Command) (CommandHandler, error)
• type Middleware
• type MiddlewareList
  • func NewMiddlewareList(commandHandler commandHandlingMiddleware) MiddlewareList
  • func (m MiddlewareList) Queue(middleware ...Middleware) MiddlewareList

Types

type Command

type Command interface{}

type CommandBus

type CommandBus interface {
	Dispatch(command Command) error
}

type CommandCallable

type CommandCallable func(command Command) error

type CommandHandler

type CommandHandler interface {
	Handle(command Command) error
}

type CommandHandlerResolver

type CommandHandlerResolver interface {
	Resolve(command Command) (CommandHandler, error)
}

type CommandHandlerResolverMock

type CommandHandlerResolverMock struct {
	// ResolveFunc mocks the Resolve method.
	ResolveFunc func(command Command) (CommandHandler, error)
	// contains filtered or unexported fields
}

CommandHandlerResolverMock is a mock implementation of CommandHandlerResolver.

    func TestSomethingThatUsesCommandHandlerResolver(t *testing.T) {

        // make and configure a mocked CommandHandlerResolver
        mockedCommandHandlerResolver := &CommandHandlerResolverMock{
            ResolveFunc: func(command Command) (CommandHandler, error) {
	               panic("mock out the Resolve method")
            },
        }

        // use mockedCommandHandlerResolver in code that requires CommandHandlerResolver
        // and then make assertions.

    }

func (*CommandHandlerResolverMock) Resolve

func (mock *CommandHandlerResolverMock) Resolve(command Command) (CommandHandler, error)

Resolve calls ResolveFunc.

func (*CommandHandlerResolverMock) ResolveCalls

func (mock *CommandHandlerResolverMock) ResolveCalls() []struct {
	Command Command
}

ResolveCalls gets all the calls that were made to Resolve. Check the length with:

len(mockedCommandHandlerResolver.ResolveCalls())

type CromberBus

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

func NewCromberBus

func NewCromberBus(handlerResolver CommandHandlerResolver, middlewares ...Middleware) CromberBus

func (CromberBus) Dispatch

func (b CromberBus) Dispatch(command Command) error

type MapHandlerResolver

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

func NewMapHandlerResolver

func NewMapHandlerResolver() MapHandlerResolver

func (MapHandlerResolver) AddHandler

func (r MapHandlerResolver) AddHandler(command Command, handler CommandHandler)

func (MapHandlerResolver) Resolve

func (r MapHandlerResolver) Resolve(command Command) (CommandHandler, error)

type Middleware

type Middleware interface {
	Execute(command Command, next CommandCallable) error
}

type MiddlewareList

type MiddlewareList []Middleware

func NewMiddlewareList

func NewMiddlewareList(commandHandler commandHandlingMiddleware) MiddlewareList

func (MiddlewareList) Queue

func (m MiddlewareList) Queue(middleware ...Middleware) MiddlewareList