go-packages/iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-01-23 10:41:03 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

directly support embed.FS and fs.FS on view engines

Browse Source
This commit is contained in:
Gerasimos (Makis) Maropoulos 2022-09-21 23:26:12 +03:00
parent 5bc0796548
commit 95a8110f1e
No known key found for this signature in database
GPG Key ID: 403EEB7885C79503
12 changed files with 162 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
HISTORY.md
View File

@ -28,8 +28,10 @@ The codebase for Dependency Injection, Internationalization and localization and
## Fixes and Improvements ## Fixes and Improvements
- Support of direct embedded view templates with `embed.FS` or `fs.FS` (in addition to `string` and `http.FileSystem` types).
- Add `iris.Patches()` package-level function to customize Iris Request Context REST (and more to come) behavior. - Add `iris.Patches()` package-level function to customize Iris Request Context REST (and more to come) behavior.
- Add support for `embed.FS` on `app.HandleDir`. - Add support for `embed.FS` and `fs.FS` on `app.HandleDir`.
- Minor fixes. - Minor fixes.
- Enable setting a custom "go-redis" client through `SetClient` go redis driver method or `Client` struct field on sessions/database/redis driver as requested at [chat](https://chat.iris-go.com). - Enable setting a custom "go-redis" client through `SetClient` go redis driver method or `Client` struct field on sessions/database/redis driver as requested at [chat](https://chat.iris-go.com).

1
_examples/README.md
View File

@ -151,6 +151,7 @@
* [Inject Data Between Handlers](view/context-view-data/main.go) * [Inject Data Between Handlers](view/context-view-data/main.go)
* [Inject Engine Between Handlers](view/context-view-engine/main.go) * [Inject Engine Between Handlers](view/context-view-engine/main.go)
* [Embedding Templates Into App Executable File](view/embedding-templates-into-app/main.go) * [Embedding Templates Into App Executable File](view/embedding-templates-into-app/main.go)
* [Embedding Templates Into App Executable File (Bindata)](view/embedding-templates-into-app-bindata/main.go)
* [Write to a custom `io.Writer`](view/write-to) * [Write to a custom `io.Writer`](view/write-to)
* Parse a Template from Text * Parse a Template from Text
* [HTML, Pug and Ace](view/parse-parse/main.go) * [HTML, Pug and Ace](view/parse-parse/main.go)

0
_examples/view/embedding-templates-into-app/bindata.go → _examples/view/embedding-templates-into-app-bindata/bindata.go
View File

52
_examples/view/embedding-templates-into-app-bindata/main.go Normal file
View File

@ -0,0 +1,52 @@
package main
import "github.com/kataras/iris/v12"
func main() {
app := iris.New()
// $ go install github.com/go-bindata/go-bindata/v3/go-bindata@latest
// $ go-bindata -fs -prefix "templates" ./templates/...
// $ go run .
// html files are not used, you can delete the folder and run the example.
tmpl := iris.HTML(AssetFile(), ".html")
tmpl.Layout("layouts/layout.html")
tmpl.AddFunc("greet", func(s string) string {
return "Greetings " + s + "!"
})
app.RegisterView(tmpl)
app.Get("/", func(ctx iris.Context) {
if err := ctx.View("page1.html"); err != nil {
ctx.StatusCode(iris.StatusInternalServerError)
ctx.Writef(err.Error())
}
})
// remove the layout for a specific route
app.Get("/nolayout", func(ctx iris.Context) {
ctx.ViewLayout(iris.NoLayout)
if err := ctx.View("page1.html"); err != nil {
ctx.StatusCode(iris.StatusInternalServerError)
ctx.Writef(err.Error())
}
})
// set a layout for a party, .Layout should be BEFORE any Get or other Handle party's method
my := app.Party("/my").Layout("layouts/mylayout.html")
{ // both of these will use the layouts/mylayout.html as their layout.
my.Get("/", func(ctx iris.Context) {
ctx.View("page1.html")
})
my.Get("/other", func(ctx iris.Context) {
ctx.View("page1.html")
})
}
// http://localhost:8080
// http://localhost:8080/nolayout
// http://localhost:8080/my
// http://localhost:8080/my/other
app.Listen(":8080")
}

12
_examples/view/embedding-templates-into-app-bindata/templates/layouts/layout.html Normal file
View File

@ -0,0 +1,12 @@
<html>
<head>
<title>Layout</title>
</head>
<body>
<h1>This is the global layout</h1>
<br />
<!-- Render the current template here -->
{{ yield }}
</body>
</html>

12
_examples/view/embedding-templates-into-app-bindata/templates/layouts/mylayout.html Normal file
View File

@ -0,0 +1,12 @@
<html>
<head>
<title>my Layout</title>
</head>
<body>
<h1>This is the layout for the /my/ and /my/other routes only</h1>
<br />
<!-- Render the current template here -->
{{ yield }}
</body>
</html>

7
_examples/view/embedding-templates-into-app-bindata/templates/page1.html Normal file
View File

@ -0,0 +1,7 @@
<div style="background-color: black; color: blue">
<h1>Page 1 {{ greet "iris developer"}}</h1>
{{ render "partials/page1_partial1.html"}}
</div>

3
_examples/view/embedding-templates-into-app-bindata/templates/partials/page1_partial1.html Normal file
View File

@ -0,0 +1,3 @@
<div style="background-color: white; color: red">
<h1>Page 1's Partial 1</h1>
</div>

24
_examples/view/embedding-templates-into-app/main.go
View File

@ -1,15 +1,19 @@
package main package main
import "github.com/kataras/iris/v12" import (
"embed"
"github.com/kataras/iris/v12"
"github.com/kataras/iris/v12/x/errors"
)
//go:embed templates/*
var embeddedTemplatesFS embed.FS
func main() { func main() {
app := iris.New() app := iris.New()
// $ go install github.com/go-bindata/go-bindata/v3/go-bindata@latest tmpl := iris.HTML(embeddedTemplatesFS, ".html")
// $ go-bindata -fs -prefix "templates" ./templates/...
// $ go run .
// html files are not used, you can delete the folder and run the example.
tmpl := iris.HTML(AssetFile(), ".html")
tmpl.Layout("layouts/layout.html") tmpl.Layout("layouts/layout.html")
tmpl.AddFunc("greet", func(s string) string { tmpl.AddFunc("greet", func(s string) string {
return "Greetings " + s + "!" return "Greetings " + s + "!"
@ -19,8 +23,8 @@ func main() {
app.Get("/", func(ctx iris.Context) { app.Get("/", func(ctx iris.Context) {
if err := ctx.View("page1.html"); err != nil { if err := ctx.View("page1.html"); err != nil {
ctx.StatusCode(iris.StatusInternalServerError) errors.InvalidArgument.Err(ctx, err)
ctx.Writef(err.Error()) return
} }
}) })
@ -28,8 +32,8 @@ func main() {
app.Get("/nolayout", func(ctx iris.Context) { app.Get("/nolayout", func(ctx iris.Context) {
ctx.ViewLayout(iris.NoLayout) ctx.ViewLayout(iris.NoLayout)
if err := ctx.View("page1.html"); err != nil { if err := ctx.View("page1.html"); err != nil {
ctx.StatusCode(iris.StatusInternalServerError) errors.InvalidArgument.Err(ctx, err)
ctx.Writef(err.Error()) return
} }
}) })

7
aliases.go
View File

@ -805,6 +805,13 @@ func (cp *ContextPatches) SetCookieKVExpiration(patch time.Duration) {
context.SetCookieKVExpiration = patch context.SetCookieKVExpiration = patch
} }
// ResolveFS modifies the default way to resolve a filesystem by any type of value.
// It affects the view engine filesystem resolver
// and the Application's API Builder's `HandleDir` method.
func (cp *ContextPatches) ResolveFS(patchFunc func(fsOrDir interface{}) http.FileSystem) {
context.ResolveFS = patchFunc
}
// ContextWriterPatches features the context's writers patches. // ContextWriterPatches features the context's writers patches.
type ContextWriterPatches struct{} type ContextWriterPatches struct{}

46
context/context_fs.go Normal file
View File

@ -0,0 +1,46 @@
package context
import (
"embed"
"fmt"
"io/fs"
"net/http"
)
// ResolveFS accepts a single input argument of any type
// and tries to cast it to http.FileSystem.
//
// It affects the view engine filesystem resolver
// and the Application's API Builder's `HandleDir` method.
//
// This package-level variable can be modified on initialization.
var ResolveFS = func(fsOrDir interface{}) http.FileSystem {
var fileSystem http.FileSystem
switch v := fsOrDir.(type) {
case string:
fileSystem = http.Dir(v)
case http.FileSystem:
fileSystem = v
case embed.FS:
direEtries, err := v.ReadDir(".")
if err != nil {
panic(err)
}
if len(direEtries) == 0 {
panic("HandleDir: no directories found under the embedded file system")
}
subfs, err := fs.Sub(v, direEtries[0].Name())
if err != nil {
panic(err)
}
fileSystem = http.FS(subfs)
case fs.FS:
fileSystem = http.FS(v)
default:
panic(fmt.Sprintf(`unexpected "fsOrDir" argument type of %T (string or http.FileSystem or embed.FS or fs.FS)`, v))
}
return fileSystem
}

11
view/fs.go
View File

@ -7,6 +7,8 @@ import (
"path" "path"
"path/filepath" "path/filepath"
"sort" "sort"
"github.com/kataras/iris/v12/context"
) )
// walk recursively in "fs" descends "root" path, calling "walkFn". // walk recursively in "fs" descends "root" path, calling "walkFn".
@ -90,17 +92,14 @@ func getFS(fsOrDir interface{}) (fs http.FileSystem) {
return noOpFS{} return noOpFS{}
} }
switch v := fsOrDir.(type) { if v, ok := fsOrDir.(string); ok {
case string:
if v == "" { if v == "" {
fs = noOpFS{} fs = noOpFS{}
} else { } else {
fs = httpDirWrapper{http.Dir(v)} fs = httpDirWrapper{http.Dir(v)}
} }
case http.FileSystem: } else {
fs = v fs = context.ResolveFS(fsOrDir)
default:
panic(fmt.Errorf(`unexpected "fsOrDir" argument type of %T (string or http.FileSystem)`, v))
} }
return return