README
¶
🐦 Phx
A little, highly opinated framework to create complete web apps.
Demo:
package main
import (
"littlecash/locale"
"littlecash/static"
"littlecash/views"
"log"
"net/http"
"time"
"github.com/deltegui/phx"
"github.com/deltegui/phx/core"
"github.com/deltegui/phx/cypher"
"github.com/deltegui/phx/session"
)
func ParseAll(r *phx.Router) {
r.Parse(views.DemoIndex, "index.html", "demo/index.html")
r.Parse(views.Login, "layout.html", "account/layout.html", "account/login.html")
r.Parse(views.Arr, "arr.html", "demo/arr.html")
r.ShowAvailableTemplates()
}
func main() {
r := phx.NewRouter()
r.Bootstrap()
r.Add(func() core.Cypher {
csrfpass := "you can generate a password with the framework or let it be random"
return cypher.NewWithPasswordAsString(csrfpass)
})
r.ShowAvailableBuilders()
r.Use(phx.HttpLogMiddleware)
r.UseStaticEmbedded(static.Files)
r.UseTemplate(views.Files)
r.AddDefaultTemplateFunctions()
r.UseCsrf(15 * time.Minute)
r.UseLocalization(locale.Files, locale.Shared, locale.Errors)
r.UseSessionInMemory(1 * time.Hour)
r.UseSessionAuthWithRedirection("/login")
views.ParseAll(r)
r.Get("/", func() phx.Handler {
return func(ctx *phx.Context) {
ctx.StringOK("Hola mundo desde aqui")
}
})
r.Get("/demo", func() phx.Handler {
return func(ctx *phx.Context) {
ctx.Render(http.StatusOK, views.DemoIndex, struct{}{})
}
}, r.Authorize())
r.Get("/change/:lang", func() phx.Handler {
return func(ctx *phx.Context) {
from := ctx.GetCurrentLanguage()
to := ctx.GetUrlParam("lang")
if len(to) == 0 {
ctx.String(http.StatusBadRequest, "Nothing to change!")
return
}
ctx.ChangeLanguage(to)
ctx.StringOK("Changed from '%s' to '%s'", from, to)
}
})
r.Post("/demo", func(hasher core.Hasher) phx.Handler {
type f struct {
Name string `validate:"required,min=3,max=255"`
Password string `validate:"required,min=3,max=255"`
}
return func(ctx *phx.Context) {
var form f
ctx.ParseForm(&form)
errs := ctx.Validate(form)
if errs != nil {
ctx.RenderWithErrors(http.StatusBadRequest, views.DemoIndex, struct{}{}, errs)
return
}
form.Password = hasher.Hash(form.Password)
ctx.JsonOK(form)
}
}, r.Authorize())
r.Get("/login", func() phx.Handler {
return func(ctx *phx.Context) {
ctx.RenderOK(views.Login, AccountViewModel{})
}
})
r.Post("/login", func() phx.Handler {
return func(ctx *phx.Context) {
var vm AccountViewModel
ctx.ParseForm(&vm)
if errs := ctx.Validate(vm); errs != nil {
log.Println("MAL")
ctx.RenderWithErrors(http.StatusBadRequest, views.Login, vm, errs)
return
}
ctx.CreateSessionCookie(session.User{
Id: 0,
Name: vm.Name,
Role: core.RoleAdmin,
})
ctx.Redirect("/demo")
}
})
r.Get("/logout", func() phx.Handler {
return func(ctx *phx.Context) {
ctx.DestroySession()
ctx.Redirect("/login")
}
})
r.Get("/arr", func() phx.Handler {
return func(ctx *phx.Context) {
ctx.RenderOK(views.Arr, nil)
}
})
r.Post("/arr", func() phx.Handler {
return func(ctx *phx.Context) {
var names []string
if err := ctx.ParseJson(&names); err != nil {
ctx.String(http.StatusBadRequest, "Invalid JSON")
return
}
log.Println("OK")
ctx.JsonOK(names)
}
})
phx.PrintLogoEmbedded(views.Files, "banner.txt")
r.Run(":3000")
}
type AccountViewModel struct {
Name string `validate:"required,min=3,max=255"`
ErrorMessage string
HaveBeenLogout bool
}
Documentation
¶
Index ¶
- func PrintLogo(logoFile string)
- func PrintLogoEmbedded(fs embed.FS, path string)
- func Redirect(to string) func() Handler
- type Builder
- type Context
- func (ctx *Context) BadRequest(data string, a ...any) error
- func (ctx *Context) ChangeLanguage(to string)
- func (ctx *Context) CreateCookie(name, data string) error
- func (ctx *Context) CreateCookieOptions(opt CookieOptions) error
- func (ctx *Context) DeleteCookie(name string) error
- func (ctx *Context) Forbidden(data string, a ...any) error
- func (r *Context) Get(key any) any
- func (ctx *Context) GetCurrentLanguage() string
- func (ctx *Context) GetLocalizer(file string) localizer.Localizer
- func (ctx *Context) GetQueryParam(name string) string
- func (ctx *Context) GetUrlParam(name string) string
- func (ctx *Context) GetUser() session.User
- func (ctx *Context) HaveLocalizer() bool
- func (ctx *Context) HaveSession() bool
- func (ctx *Context) InternalServerError(data string, a ...any) error
- func (ctx *Context) Json(status int, data any) error
- func (ctx *Context) JsonOK(data interface{}) error
- func (ctx *Context) Localize(file, key string) string
- func (ctx *Context) LocalizeError(err core.UseCaseError) string
- func (ctx *Context) LocalizeWithoutShared(file, key string) string
- func (ctx *Context) NotContent() error
- func (ctx *Context) NotFound(data string, a ...any) error
- func (ctx *Context) OK(data string, a ...any) error
- func (ctx *Context) PaginationToVM(pag pagination.Pagination) pagination.ViewModel
- func (ctx *Context) ParseForm(dst interface{})
- func (ctx *Context) ParseJson(dst any) error
- func (ctx *Context) ReadCookie(name string) (string, error)
- func (ctx *Context) Redirect(to string) error
- func (ctx *Context) RedirectCode(to string, code int) error
- func (ctx *Context) Render(status int, parsed string, vm interface{}) error
- func (ctx *Context) RenderOK(parsed string, vm interface{}) error
- func (ctx *Context) RenderWithErrors(status int, parsed string, vm interface{}, formErrors map[string]string) error
- func (r *Context) Set(key, value any)
- func (ctx *Context) String(status int, data string, a ...any) error
- func (ctx *Context) Validate(s any) map[string]string
- type CookieOptions
- type Handler
- type Injector
- func (injector Injector) Add(builder Builder)
- func (injector Injector) CallBuilder(builder Builder) interface{}
- func (injector Injector) Get(name interface{}) (interface{}, error)
- func (injector Injector) GetByType(name reflect.Type) (interface{}, error)
- func (injector Injector) PopulateStruct(userStruct interface{})
- func (injector Injector) ResolveHandler(builder Builder) Handler
- func (injector Injector) Run(runner Runner)
- func (injector Injector) ShowAvailableBuilders()
- type Middleware
- type Renderer
- type Router
- func (r *Router) Add(builder Builder)
- func (r *Router) Delete(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Get(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Handle(method, pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Head(pattern string, builder Builder, middlewares ...Middleware)
- func (r Router) Listen(address string)
- func (r *Router) Options(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Patch(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) PopulateStruct(s interface{})
- func (r *Router) Post(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Put(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Run(runner Runner)
- func (r *Router) ShowAvailableBuilders()
- func (r *Router) Static(path string)
- func (r *Router) StaticEmbedded(fs embed.FS)
- func (r *Router) StaticMount(url, path string)
- func (r *Router) StaticMountEmbedded(url string, fs embed.FS)
- func (r *Router) Trace(pattern string, builder Builder, middlewares ...Middleware)
- func (r *Router) Use(middleware Middleware)
- func (r *Router) UseLocalization(files embed.FS, sharedKey, errorsKey string)
- type Runner
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func PrintLogo ¶
func PrintLogo(logoFile string)
PrintLogo takes a file path and prints your fancy ascii logo. It will fail if your file is not found.
func PrintLogoEmbedded ¶ added in v0.0.42
PrintLogo takes a embedded filesystem and file path and prints your fancy ascii logo. It will fail if your file is not found.
Types ¶
type Builder ¶
type Builder interface{}
Builder is a function that expects anything and retuns the type that builds. The type cant be func() interface{} cause some errors appears in runtime. So it's represented as an interface.
type Context ¶ added in v0.0.15
type Context struct {
Req *http.Request
Res http.ResponseWriter
// contains filtered or unexported fields
}
func (*Context) BadRequest ¶ added in v0.2.4
func (*Context) ChangeLanguage ¶ added in v0.0.25
func (*Context) CreateCookie ¶ added in v0.3.8
func (*Context) CreateCookieOptions ¶ added in v0.3.8
func (ctx *Context) CreateCookieOptions(opt CookieOptions) error
func (*Context) DeleteCookie ¶ added in v0.3.8
func (*Context) GetCurrentLanguage ¶ added in v0.0.18
func (*Context) GetLocalizer ¶ added in v0.1.2
func (*Context) GetQueryParam ¶ added in v0.0.45
func (*Context) GetUrlParam ¶ added in v0.0.45
func (*Context) HaveLocalizer ¶ added in v0.3.3
func (*Context) HaveSession ¶ added in v0.1.1
func (*Context) InternalServerError ¶ added in v0.2.4
func (*Context) LocalizeError ¶ added in v0.1.1
func (ctx *Context) LocalizeError(err core.UseCaseError) string
func (*Context) LocalizeWithoutShared ¶ added in v0.1.1
func (*Context) NotContent ¶ added in v0.3.4
func (*Context) PaginationToVM ¶ added in v0.1.2
func (ctx *Context) PaginationToVM(pag pagination.Pagination) pagination.ViewModel
func (*Context) ParseForm ¶ added in v0.0.18
func (ctx *Context) ParseForm(dst interface{})
ParseForm parses req.Form and then serializes the form data to the dst struct using reflection. The form names should match to the 'html' tag or, if its not setted, to the field name. ParseForm only supports serializing data to one-depth structs. Example, using this struct as target:
type MyStruct struct {
A bool,
B int `html:"pagination.currentPage"`
}
And having this serialized form:
"A=false&pagination.currentPage=2"
Calling ParseForm like this (NOTE THAT A POINTER TO THE STRUCT IS BEING PASSED):
var s MyStruct phx.ParseForm(req, &s)
It will result to this fullfilled struct:
{ A = false, B: 2 }
The supported field types are:
int, int8, int16, int32, int64
uint, uint8, uint16, uint32, uint64
float32, float64
bool
string
time.Time
func (*Context) ReadCookie ¶ added in v0.3.8
func (*Context) RedirectCode ¶ added in v0.0.18
func (*Context) RenderWithErrors ¶ added in v0.0.15
type CookieOptions ¶ added in v0.3.8
type CookieOptions struct {
Name string
Expires time.Duration
Value string
// Set if front scripts can access to cookie.
// If its true, front script cannot access.
// By default true.
HttpOnly bool
// Sets if cookies are only send through https.
// If its true means https only. By default false.
Secure bool
}
type Injector ¶
type Injector struct {
// contains filtered or unexported fields
}
Injector is an automated dependency injector inspired in Sping's DI. It will detect which builder to call using its return type. If the builder haver params, it will fullfill that params calling other builders that provides its types.
func (Injector) CallBuilder ¶
CallBuilder injecting all parameters with provided builders. If some parameter type cannot be found, it will panic
func (Injector) PopulateStruct ¶
func (injector Injector) PopulateStruct(userStruct interface{})
PopulateStruct fills a struct with the implementations that the injector can create. Make sure you pass a reference and not a value
func (Injector) ResolveHandler ¶
ResolveHandler created by a builder
func (Injector) Run ¶ added in v0.3.0
Run is a function that runs a Runner. Show Runner type for more information
func (Injector) ShowAvailableBuilders ¶
func (injector Injector) ShowAvailableBuilders()
ShowAvailableBuilders prints all registered builders.
type Middleware ¶
type Router ¶ added in v0.0.15
func NewRouterFromOther ¶ added in v0.0.15
func (*Router) Delete ¶ added in v0.0.15
func (r *Router) Delete(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Get ¶ added in v0.0.15
func (r *Router) Get(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Handle ¶ added in v0.0.15
func (r *Router) Handle(method, pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Head ¶ added in v0.0.15
func (r *Router) Head(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Options ¶ added in v0.0.15
func (r *Router) Options(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Patch ¶ added in v0.0.15
func (r *Router) Patch(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) PopulateStruct ¶ added in v0.0.15
func (r *Router) PopulateStruct(s interface{})
func (*Router) Post ¶ added in v0.0.15
func (r *Router) Post(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Put ¶ added in v0.0.15
func (r *Router) Put(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) ShowAvailableBuilders ¶ added in v0.0.15
func (r *Router) ShowAvailableBuilders()
func (*Router) StaticEmbedded ¶ added in v0.3.0
func (*Router) StaticMount ¶ added in v0.3.0
func (*Router) StaticMountEmbedded ¶ added in v0.3.0
func (*Router) Trace ¶ added in v0.0.15
func (r *Router) Trace(pattern string, builder Builder, middlewares ...Middleware)
func (*Router) Use ¶ added in v0.0.15
func (r *Router) Use(middleware Middleware)
type Runner ¶ added in v0.3.0
type Runner interface{}
Runner is any funtion that returns void. It is use as an easy way to ask to the injetor to provide dependencies to do something. For example, imagine that we have an interface called UserDao and we just want do something with it outside any builder or dependecy created using this injector. The UserDao is registered this way:
injector.Add(db.NewUserDao)
Then, you can ask for the dependency to the injector this way:
var userDao db.UserDao userDao = injector.GetByType(reflect.TypeOf(&userDao).Elem()).(db.UserDao)
Its pretty cumbersome huh? You have to do that because you know it is an interface. Using Runner you can just do this:
injector.Run(func(userDao db.UserDao) {
[... do whatever you want with userdDao ...]
})
The callback function will be exectued inmediatly.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.