Merge pull request #316 from denovodavid/master

Add support for nested layouts to HTML template engine
gofiber · Jan 8, 2024 · fd5a1ab · fd5a1ab
2 parents 9dd46c8 + 4cbd251
commit fd5a1ab
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 12 deletions.
diff --git a/.github/workflows/gosec.yml b/.github/workflows/gosec.yml
@@ -38,6 +38,7 @@ jobs:
           json: true
           escape_json: false
           dir_names: true
+          dir_names_max_depth: '1'
           dir_names_exclude_current_dir: true
 
   gosec-scan:
@@ -61,4 +62,4 @@ jobs:
         run: go install github.com/securego/gosec/v2/cmd/gosec@latest
       - name: Run gosec
         working-directory: ${{ matrix.modules }}
-        run: gosec ./...
+        run: gosec ./...
diff --git a/html/README.md b/html/README.md
@@ -93,6 +93,13 @@ func main() {
 		}, "layouts/main")
 	})
 
+	app.Get("/layouts-nested", func(c *fiber.Ctx) error {
+		// Render index within layouts/nested/main within layouts/nested/base
+		return c.Render("index", fiber.Map{
+			"Title": "Hello, World!",
+		}, "layouts/nested/main", "layouts/nested/base")
+	})
+
 	log.Fatal(app.Listen(":3000"))
 }
 

diff --git a/html/html.go b/html/html.go
@@ -133,24 +133,34 @@ func (e *Engine) Render(out io.Writer, name string, binding interface{}, layout
 			return err
 		}
 	}
-
 	tmpl := e.Templates.Lookup(name)
 	if tmpl == nil {
 		return fmt.Errorf("render: template %s does not exist", name)
 	}
+	render := renderFuncCreate(e, out, binding, *tmpl, nil)
 	if len(layout) > 0 && layout[0] != "" {
-		lay := e.Templates.Lookup(layout[0])
-		if lay == nil {
-			return fmt.Errorf("render: LayoutName %s does not exist", layout[0])
-		}
 		e.Mutex.Lock()
 		defer e.Mutex.Unlock()
-		lay.Funcs(map[string]interface{}{
-			e.LayoutName: func() error {
-				return tmpl.Execute(out, binding)
-			},
+	}
+	// construct a nested render function to embed templates in layouts
+	for _, layName := range layout {
+		if layName == "" {
+			break
+		}
+		lay := e.Templates.Lookup(layName)
+		if lay == nil {
+			return fmt.Errorf("render: LayoutName %s does not exist", layName)
+		}
+		render = renderFuncCreate(e, out, binding, *lay, render)
+	}
+	return render()
+}
+
+func renderFuncCreate(e *Engine, out io.Writer, binding interface{}, tmpl template.Template, childRenderFunc func() error) func() error {
+	return func() error {
+		tmpl.Funcs(map[string]interface{}{
+			e.LayoutName: childRenderFunc,
 		})
-		return lay.Execute(out, binding)
+		return tmpl.Execute(out, binding)
 	}
-	return tmpl.Execute(out, binding)
 }
diff --git a/html/html_test.go b/html/html_test.go
@@ -193,6 +193,25 @@ func Test_Layout_Multi(t *testing.T) {
 	}
 }
 
+func Test_Layout_Nested(t *testing.T) {
+	t.Parallel()
+	engine := New("./views", ".html")
+
+	engine.AddFunc("isAdmin", func(user string) bool {
+		return user == admin
+	})
+	require.NoError(t, engine.Load())
+
+	var buf bytes.Buffer
+	err := engine.Render(&buf, "index", map[string]interface{}{
+		"Title": "Hello, World!",
+	}, "layouts/nested/main", "layouts/nested/base")
+	require.NoError(t, err)
+
+	result := trim(buf.String())
+	require.Equal(t, complexexpect, result)
+}
+
 func Test_FileSystem(t *testing.T) {
 	t.Parallel()
 	engine := NewFileSystem(http.Dir("./views"), ".html")

diff --git a/html/views/layouts/nested/base.html b/html/views/layouts/nested/base.html
@@ -0,0 +1,6 @@
+<!DOCTYPE html>
+<html>
+
+{{embed}}
+
+</html>
diff --git a/html/views/layouts/nested/main.html b/html/views/layouts/nested/main.html
@@ -0,0 +1,7 @@
+<head>
+  <title>Main</title>
+</head>
+
+<body>
+  {{embed}}
+</body>