action.go

package box

import "net/http"

const HttpMethodAny = "*"

// An A stands for Action
type A struct {
	Attr
	HttpMethod string

	// Name is the name to identify the action AND the invocation to url suffix
	Name string

	// Bound is true if this action is not an extended action
	Bound bool

	// Interceptors is the list of actions that will be executed before executing handler
	Interceptors []I

	resource *R
	handler  interface{}
}

func Action(handler interface{}) *A {

	// TODO: introspect and change to "POST" if needed

	return &A{
		HttpMethod:   "GET",
		Attr:         Attr{},
		handler:      handler,
		Interceptors: []I{},
	}
}

func ActionPost(handler interface{}) *A {

	return &A{
		HttpMethod:   "POST",
		Attr:         Attr{},
		handler:      handler,
		Interceptors: []I{},
	}
}

func actionBound(handler interface{}, method string) *A {
	a := Action(handler)
	a.Bound = true
	a.HttpMethod = method
	return a
}

// Bind shortcuts:
func Get(handler interface{}) *A {
	return actionBound(handler, http.MethodGet)
}
func Head(handler interface{}) *A {
	return actionBound(handler, http.MethodHead)
}
func Post(handler interface{}) *A {
	return actionBound(handler, http.MethodPost)
}
func Put(handler interface{}) *A {
	return actionBound(handler, http.MethodPut)
}
func Patch(handler interface{}) *A {
	return actionBound(handler, http.MethodPatch)
}
func Delete(handler interface{}) *A {
	return actionBound(handler, http.MethodDelete)
}
func Connect(handler interface{}) *A {
	return actionBound(handler, http.MethodConnect)
}
func Options(handler interface{}) *A {
	return actionBound(handler, http.MethodOptions)
}
func Trace(handler interface{}) *A {
	return actionBound(handler, http.MethodTrace)
}
func AnyMethod(handler interface{}) *A {
	return actionBound(handler, HttpMethodAny)
}

// WithName overwrite default action name
func (a *A) WithName(name string) *A {
	a.Name = name
	return a
}

func (a *A) Bind(method string) *A {
	a.HttpMethod = method
	a.Bound = true
	return a
}

func (a *A) WithAttribute(key string, value interface{}) *A {
	a.SetAttribute(key, value)
	return a
}

func (a *A) WithInterceptors(interceptor ...I) *A {

	for _, i := range interceptor {
		a.Interceptors = append(a.Interceptors, i)
	}

	return a
}

// Use is an alias of WithInterceptors
func (a *A) Use(interceptor ...I) *A {
	return a.WithInterceptors(interceptor...)
}

// GetHandler overwrite default action name
func (a *A) GetHandler() any {
	return a.handler
}