phx

package module
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: MIT Imports: 24 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions 

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 

func PrintLogoEmbedded(fs embed.FS, path string)

PrintLogo takes a embedded filesystem and file path and prints your fancy ascii logo. It will fail if your file is not found.

func Redirect 

func Redirect(to string) func() Handler

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) ChangeLanguage added in v0.0.25 

func (ctx *Context) ChangeLanguage(to string)

func (*Context) CreateSessionCookie added in v0.0.28 

func (r *Context) CreateSessionCookie(user session.User)

func (*Context) DestroySession added in v0.0.28 

func (r *Context) DestroySession() error

func (*Context) GetCurrentLanguage added in v0.0.18 

func (ctx *Context) GetCurrentLanguage() string

func (*Context) GetLocalizer added in v0.1.2 

func (ctx *Context) GetLocalizer(file string) localizer.Localizer

func (*Context) GetQueryParam added in v0.0.45 

func (ctx *Context) GetQueryParam(name string) string

func (*Context) GetUrlParam added in v0.0.45 

func (ctx *Context) GetUrlParam(name string) string

func (*Context) GetUser added in v0.0.15 

func (ctx *Context) GetUser() session.User

func (*Context) HaveSession added in v0.1.1 

func (ctx *Context) HaveSession() bool

func (*Context) Json added in v0.0.15 

func (ctx *Context) Json(status int, data interface{})

func (*Context) JsonOK added in v0.0.38 

func (ctx *Context) JsonOK(data interface{})

func (*Context) Localize added in v0.1.1 

func (ctx *Context) Localize(file, key string) string

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 (ctx *Context) LocalizeWithoutShared(file, key string) string

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, float32, float64, bool and string

func (*Context) ParseJson added in v0.0.26 

func (ctx *Context) ParseJson(dst any) error

func (*Context) ReadSessionCookie added in v0.0.28 

func (r *Context) ReadSessionCookie() (session.User, error)

func (*Context) Redirect added in v0.0.15 

func (ctx *Context) Redirect(to string)

func (*Context) RedirectCode added in v0.0.18 

func (ctx *Context) RedirectCode(to string, code int)

func (*Context) Render added in v0.0.15 

func (ctx *Context) Render(status int, parsed string, vm interface{})

func (*Context) RenderOK added in v0.0.38 

func (ctx *Context) RenderOK(parsed string, vm interface{})

func (*Context) RenderWithErrors added in v0.0.15 

func (ctx *Context) RenderWithErrors(status int, parsed string, vm interface{}, formErrors map[string]string)

func (*Context) String added in v0.0.18 

func (ctx *Context) String(status int, data string, a ...any)

func (*Context) StringOK added in v0.0.38 

func (ctx *Context) StringOK(data string, a ...any)

func (*Context) Validate added in v0.0.25 

func (ctx *Context) Validate(s any) map[string]string

type CorsConfig added in v0.0.15 

type CorsConfig struct {
	AllowMethods string
	AllowOrigin  string
}

type Handler added in v0.0.15 

type Handler func(c *Context)

func HttpLogMiddleware added in v0.0.35 

func HttpLogMiddleware(next Handler) Handler

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 NewInjector 

func NewInjector() *Injector

NewInjector with default values

func (Injector) Add 

func (injector Injector) Add(builder Builder)

Add a builder to the dependency injector.

func (Injector) CallBuilder 

func (injector Injector) CallBuilder(builder Builder) interface{}

CallBuilder injecting all parameters with provided builders. If some parameter type cannot be found, it will panic

func (Injector) Get 

func (injector Injector) Get(name interface{}) interface{}

Get returns a builded dependency

func (Injector) GetByType 

func (injector Injector) GetByType(name reflect.Type) interface{}

GetByType returns a builded dependency identified by type

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 

func (injector Injector) ResolveHandler(builder Builder) Handler

ResolveHandler created by a builder

func (Injector) ShowAvailableBuilders 

func (injector Injector) ShowAvailableBuilders()

ShowAvailableBuilders prints all registered builders.

type Middleware 

type Middleware func(Handler) Handler

type Router added in v0.0.15 

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

func NewRouter added in v0.0.15 

func NewRouter() *Router

func NewRouterFromOther added in v0.0.15 

func NewRouterFromOther(r *Router) *Router

func (*Router) Add added in v0.0.15 

func (r *Router) Add(builder Builder)

func (*Router) AddDefaultTemplateFunctions added in v0.0.15 

func (r *Router) AddDefaultTemplateFunctions()

func (*Router) Admin added in v0.0.28 

func (r *Router) Admin() Middleware

func (*Router) Authorize added in v0.0.28 

func (r *Router) Authorize() Middleware

func (*Router) AuthorizeRoles added in v0.0.28 

func (r *Router) AuthorizeRoles(roles []core.Role) Middleware

func (*Router) Bootstrap added in v0.0.15 

func (r *Router) Bootstrap()

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) Parse added in v0.0.15 

func (r *Router) Parse(name, main string, patterns ...string)

func (*Router) ParsePartial added in v0.0.15 

func (r *Router) ParsePartial(name string, patterns ...string)

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) Run added in v0.0.15 

func (r Router) Run(address string)

func (*Router) ShowAvailableBuilders added in v0.0.15 

func (r *Router) ShowAvailableBuilders()

func (*Router) ShowAvailableTemplates added in v0.0.22 

func (r *Router) ShowAvailableTemplates()

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)

func (*Router) UseCors added in v0.0.19 

func (r *Router) UseCors(methods, origin string)

func (*Router) UseCsrf added in v0.0.19 

func (r *Router) UseCsrf(expires time.Duration)

func (*Router) UseLocalization added in v0.0.19 

func (r *Router) UseLocalization(files embed.FS, sharedKey, errorsKey string)

func (*Router) UseSession added in v0.0.27 

func (r *Router) UseSession(provider session.SessionStore, duration time.Duration)

func (*Router) UseSessionAuth added in v0.0.28 

func (r *Router) UseSessionAuth()

func (*Router) UseSessionAuthWithRedirection added in v0.0.28 

func (r *Router) UseSessionAuthWithRedirection(redirectUrl string)

func (*Router) UseSessionInMemory added in v0.0.27 

func (r *Router) UseSessionInMemory(duration time.Duration)

func (*Router) UseSessionPostgres added in v0.0.27 

func (r *Router) UseSessionPostgres(db *sqlx.DB, duration time.Duration)

func (*Router) UseStatic added in v0.0.19 

func (r *Router) UseStatic(path string)

func (*Router) UseStaticEmbedded added in v0.0.42 

func (r *Router) UseStaticEmbedded(fs embed.FS)

func (*Router) UseTemplate added in v0.0.19 

func (r *Router) UseTemplate(fs embed.FS)

type ViewModel 

type ViewModel struct {
	Model      interface{}
	Localizer  localizer.Localizer
	FormErrors map[string]string
	CsrfToken  string
}

func (ViewModel) GetFormError 

func (vm ViewModel) GetFormError(key string) string

func (ViewModel) HaveFormError 

func (vm ViewModel) HaveFormError(key string) bool

func (ViewModel) Localize 

func (vm ViewModel) Localize(key string) string

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.