Skip to content

Commit

Permalink
hugolib: Add /layouts/SECTION/list.html to template lookup
Browse files Browse the repository at this point in the history 
Fixes #3116
  • Loading branch information
@bep
bep committed Mar 2, 2017
1 parent 7acec3c commit 8203fc5
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 19 deletions.
2 changes: 1 addition & 1 deletion hugolib/page.go
View file
Expand Up @@ -642,7 +642,7 @@ func (p *Page) layouts(l ...string) []string {
return p.s.appendThemeTemplates([]string{"index.html", "_default/list.html"})
case KindSection:
section := p.sections[0]
return p.s.appendThemeTemplates([]string{"section/" + section + ".html", "_default/section.html", "_default/list.html", "indexes/" + section + ".html", "_default/indexes.html"})
return p.s.appendThemeTemplates([]string{"section/" + section + ".html", section + "/list.html", "_default/section.html", "_default/list.html", "indexes/" + section + ".html", "_default/indexes.html"})
case KindTaxonomy:
singular := p.s.taxonomiesPluralSingular[p.sections[0]]
return p.s.appendThemeTemplates([]string{"taxonomy/" + singular + ".html", "indexes/" + singular + ".html", "_default/taxonomy.html", "_default/list.html"})
Expand Down
62 changes: 44 additions & 18 deletions hugolib/template_test.go
View file
Expand Up @@ -14,6 +14,7 @@
package hugolib

import (
"fmt"
"path/filepath"
"testing"

Expand All @@ -23,32 +24,32 @@ import (
"github.com/spf13/viper"
)

func TestBaseGoTemplate(t *testing.T) {
func TestTemplateLookupOrder(t *testing.T) {
t.Parallel()
var (
fs *hugofs.Fs
cfg *viper.Viper
th testHelper
)

// Variants:
// Variants base templates:
// 1. <current-path>/<template-name>-baseof.<suffix>, e.g. list-baseof.<suffix>.
// 2. <current-path>/baseof.<suffix>
// 3. _default/<template-name>-baseof.<suffix>, e.g. list-baseof.<suffix>.
// 4. _default/baseof.<suffix>
for _, this := range []struct {
for i, this := range []struct {
setup func(t *testing.T)
assert func(t *testing.T)
}{
{
// Variant 1
func(t *testing.T) {
writeSource(t, fs, filepath.Join("layouts", "section", "sect-baseof.html"), `Base: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect.html"), `{{define "main"}}sect{{ end }}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect1-baseof.html"), `Base: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`)

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base: sect")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: sect")
},
},
{
Expand All @@ -70,7 +71,7 @@ func TestBaseGoTemplate(t *testing.T) {

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base: list")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list")
},
},
{
Expand All @@ -81,32 +82,32 @@ func TestBaseGoTemplate(t *testing.T) {

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base: list")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list")
},
},
{
// Variant 1, theme, use project's base
func(t *testing.T) {
cfg.Set("theme", "mytheme")
writeSource(t, fs, filepath.Join("layouts", "section", "sect-baseof.html"), `Base: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect1-baseof.html"), `Base: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect-baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect.html"), `{{define "main"}}sect{{ end }}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`)

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base: sect")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: sect")
},
},
{
// Variant 1, theme, use theme's base
func(t *testing.T) {
cfg.Set("theme", "mytheme")
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect-baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect.html"), `{{define "main"}}sect{{ end }}`)
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect1-baseof.html"), `Base Theme: {{block "main" .}}block{{end}}`)
writeSource(t, fs, filepath.Join("layouts", "section", "sect1.html"), `{{define "main"}}sect{{ end }}`)

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base Theme: sect")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base Theme: sect")
},
},
{
Expand All @@ -119,7 +120,7 @@ func TestBaseGoTemplate(t *testing.T) {

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base: list")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base: list")
},
},
{
Expand All @@ -131,23 +132,48 @@ func TestBaseGoTemplate(t *testing.T) {

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect", "index.html"), "Base Theme: list")
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "Base Theme: list")
},
},
{
// Test section list and single template selection.
// Issue #3116
func(t *testing.T) {
cfg.Set("theme", "mytheme")

// Both single and list template in /SECTION/
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "sect1", "list.html"), `sect list`)
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "list.html"), `default list`)
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "sect1", "single.html"), `sect single`)
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "_default", "single.html"), `default single`)

// sect2 with list template in /section
writeSource(t, fs, filepath.Join("themes", "mytheme", "layouts", "section", "sect2.html"), `sect2 list`)

},
func(t *testing.T) {
th.assertFileContent(filepath.Join("public", "sect1", "index.html"), "sect list")
th.assertFileContent(filepath.Join("public", "sect1", "page1", "index.html"), "sect single")
th.assertFileContent(filepath.Join("public", "sect2", "index.html"), "sect2 list")
},
},
} {

cfg, fs = newTestCfg()
th = testHelper{cfg, fs, t}

writeSource(t, fs, filepath.Join("content", "sect", "page.md"), `---
for i := 1; i <= 3; i++ {
writeSource(t, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", i)), `---
title: Template test
---
Some content
`)
}

this.setup(t)

buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{})

t.Log("Template Lookup test", i)
this.assert(t)

}
Expand Down

0 comments on commit 8203fc5

Please sign in to comment.