mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-29 17:22:10 -05:00
c6d650c8c8
This more or less completes the simplification of the template handling code in Hugo started in v0.62. The main motivation was to fix a long lasting issue about a crash in HTML content files without front matter. But this commit also comes with a big functional improvement. As we now have moved the base template evaluation to the build stage we now use the same lookup rules for `baseof` as for `list` etc. type of templates. This means that in this simple example you can have a `baseof` template for the `blog` section without having to duplicate the others: ``` layouts ├── _default │ ├── baseof.html │ ├── list.html │ └── single.html └── blog └── baseof.html ``` Also, when simplifying code, you often get rid of some double work, as shown in the "site building" benchmarks below. These benchmarks looks suspiciously good, but I have repeated the below with ca. the same result. Compared to master: ``` name old time/op new time/op delta SiteNew/Bundle_with_image-16 13.1ms ± 1% 10.5ms ± 1% -19.34% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 13.0ms ± 0% 10.7ms ± 1% -18.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 46.4ms ± 2% 43.1ms ± 1% -7.15% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 52.2ms ± 2% 47.8ms ± 1% -8.30% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 77.9ms ± 1% 70.9ms ± 1% -9.01% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 43.0ms ± 0% 37.2ms ± 1% -13.54% (p=0.029 n=4+4) SiteNew/Page_collections-16 58.2ms ± 1% 52.4ms ± 1% -9.95% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Bundle_with_image-16 3.81MB ± 0% 2.22MB ± 0% -41.70% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 3.60MB ± 0% 2.01MB ± 0% -44.20% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 19.3MB ± 1% 14.1MB ± 0% -26.91% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 70.7MB ± 0% 69.0MB ± 0% -2.40% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 37.1MB ± 0% 31.2MB ± 0% -15.94% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 17.6MB ± 0% 10.6MB ± 0% -39.92% (p=0.029 n=4+4) SiteNew/Page_collections-16 25.9MB ± 0% 21.2MB ± 0% -17.99% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Bundle_with_image-16 52.3k ± 0% 26.1k ± 0% -50.18% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 52.3k ± 0% 26.1k ± 0% -50.16% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 336k ± 1% 269k ± 0% -19.90% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 422k ± 0% 395k ± 0% -6.43% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 401k ± 0% 313k ± 0% -21.79% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 247k ± 0% 143k ± 0% -42.17% (p=0.029 n=4+4) SiteNew/Page_collections-16 282k ± 0% 207k ± 0% -26.55% (p=0.029 n=4+4) ``` Fixes #6716 Fixes #6760 Fixes #6768 Fixes #6778
195 lines
4.8 KiB
Go
195 lines
4.8 KiB
Go
// Copyright 2019 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package hugolib
|
|
|
|
import (
|
|
"testing"
|
|
)
|
|
|
|
func TestSitesRebuild(t *testing.T) {
|
|
|
|
configFile := `
|
|
baseURL = "https://example.com"
|
|
title = "Rebuild this"
|
|
contentDir = "content"
|
|
enableInlineShortcodes = true
|
|
|
|
|
|
`
|
|
|
|
var (
|
|
contentFilename = "content/blog/page1.md"
|
|
dataFilename = "data/mydata.toml"
|
|
)
|
|
|
|
createSiteBuilder := func(t testing.TB) *sitesBuilder {
|
|
b := newTestSitesBuilder(t).WithConfigFile("toml", configFile).Running()
|
|
|
|
b.WithSourceFile(dataFilename, `hugo = "Rocks!"`)
|
|
|
|
b.WithContent("content/_index.md", `---
|
|
title: Home, Sweet Home!
|
|
---
|
|
|
|
`)
|
|
|
|
b.WithContent(contentFilename, `
|
|
---
|
|
title: "Page 1"
|
|
summary: "Initial summary"
|
|
paginate: 3
|
|
---
|
|
|
|
Content.
|
|
|
|
{{< badge.inline >}}
|
|
Data Inline: {{ site.Data.mydata.hugo }}
|
|
{{< /badge.inline >}}
|
|
`)
|
|
|
|
// For .Page.Render tests
|
|
b.WithContent("prender.md", `---
|
|
title: Page 1
|
|
---
|
|
|
|
Content for Page 1.
|
|
|
|
{{< dorender >}}
|
|
|
|
`)
|
|
|
|
b.WithTemplatesAdded(
|
|
"layouts/shortcodes/dorender.html", `
|
|
{{ $p := .Page }}
|
|
Render {{ $p.RelPermalink }}: {{ $p.Render "single" }}
|
|
|
|
`)
|
|
|
|
b.WithTemplatesAdded("index.html", `
|
|
{{ range (.Paginate .Site.RegularPages).Pages }}
|
|
* Page Paginate: {{ .Title }}|Summary: {{ .Summary }}|Content: {{ .Content }}
|
|
{{ end }}
|
|
{{ range .Site.RegularPages }}
|
|
* Page Pages: {{ .Title }}|Summary: {{ .Summary }}|Content: {{ .Content }}
|
|
{{ end }}
|
|
Content: {{ .Content }}
|
|
Data: {{ site.Data.mydata.hugo }}
|
|
`)
|
|
|
|
b.WithTemplatesAdded("layouts/partials/mypartial1.html", `Mypartial1`)
|
|
b.WithTemplatesAdded("layouts/partials/mypartial2.html", `Mypartial2`)
|
|
b.WithTemplatesAdded("layouts/partials/mypartial3.html", `Mypartial3`)
|
|
b.WithTemplatesAdded("_default/single.html", `{{ define "main" }}Single Main: {{ .Title }}|Mypartial1: {{ partial "mypartial1.html" }}{{ end }}`)
|
|
b.WithTemplatesAdded("_default/list.html", `{{ define "main" }}List Main: {{ .Title }}{{ end }}`)
|
|
b.WithTemplatesAdded("_default/baseof.html", `Baseof:{{ block "main" . }}Baseof Main{{ end }}|Mypartial3: {{ partial "mypartial3.html" }}:END`)
|
|
|
|
return b
|
|
}
|
|
|
|
t.Run("Refresh paginator on edit", func(t *testing.T) {
|
|
b := createSiteBuilder(t)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", "* Page Paginate: Page 1|Summary: Initial summary|Content: <p>Content.</p>")
|
|
|
|
b.EditFiles(contentFilename, `
|
|
---
|
|
title: "Page 1 edit"
|
|
summary: "Edited summary"
|
|
---
|
|
|
|
Edited content.
|
|
|
|
`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", "* Page Paginate: Page 1 edit|Summary: Edited summary|Content: <p>Edited content.</p>")
|
|
// https://github.com/gohugoio/hugo/issues/5833
|
|
b.AssertFileContent("public/index.html", "* Page Pages: Page 1 edit|Summary: Edited summary|Content: <p>Edited content.</p>")
|
|
})
|
|
|
|
// https://github.com/gohugoio/hugo/issues/6768
|
|
t.Run("Edit data", func(t *testing.T) {
|
|
b := createSiteBuilder(t)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Data: Rocks!
|
|
Data Inline: Rocks!
|
|
`)
|
|
|
|
b.EditFiles(dataFilename, `hugo = "Rules!"`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Data: Rules!
|
|
Data Inline: Rules!`)
|
|
|
|
})
|
|
|
|
t.Run("Page.Render, edit baseof", func(t *testing.T) {
|
|
b := createSiteBuilder(t)
|
|
|
|
b.WithTemplatesAdded("index.html", `
|
|
{{ $p := site.GetPage "prender.md" }}
|
|
prender: {{ $p.Title }}|{{ $p.Content }}
|
|
|
|
`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Render /prender/: Baseof:Single Main: Page 1|Mypartial1: Mypartial1|Mypartial3: Mypartial3:END
|
|
`)
|
|
|
|
b.EditFiles("layouts/_default/baseof.html", `Baseof Edited:{{ block "main" . }}Baseof Main{{ end }}:END`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Render /prender/: Baseof Edited:Single Main: Page 1|Mypartial1: Mypartial1:END
|
|
`)
|
|
|
|
})
|
|
|
|
t.Run("Page.Render, edit partial in baseof", func(t *testing.T) {
|
|
b := createSiteBuilder(t)
|
|
|
|
b.WithTemplatesAdded("index.html", `
|
|
{{ $p := site.GetPage "prender.md" }}
|
|
prender: {{ $p.Title }}|{{ $p.Content }}
|
|
|
|
`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Render /prender/: Baseof:Single Main: Page 1|Mypartial1: Mypartial1|Mypartial3: Mypartial3:END
|
|
`)
|
|
|
|
b.EditFiles("layouts/partials/mypartial3.html", `Mypartial3 Edited`)
|
|
|
|
b.Build(BuildCfg{})
|
|
|
|
b.AssertFileContent("public/index.html", `
|
|
Render /prender/: Baseof:Single Main: Page 1|Mypartial1: Mypartial1|Mypartial3: Mypartial3 Edited:END
|
|
`)
|
|
|
|
})
|
|
|
|
}
|