mirror/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2025-09-08 23:40:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add data files support in themes

Browse Source 
If duplicate keys, the main data dir wins.

Fixes #892
This commit is contained in:
bep
2015-02-11 20:24:56 +01:00
parent 664fd99135
commit ebcc1e6699
5 changed files with 100 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
hugolib/site.go
View File

@@ -267,42 +267,46 @@ func (s *Site) addTemplate(name, data string) error {
return s.Tmpl.AddTemplate(name, data)
}
func (s *Site) loadData(fs source.Input) (err error) {
func (s *Site) loadData(sources []source.Input) (err error) {
s.Data = make(map[string]interface{})
var current map[string]interface{}
for _, r := range fs.Files() {
// Crawl in data tree to insert data
current = s.Data
for _, key := range strings.Split(r.Dir(), helpers.FilePathSeparator) {
if key != "" {
if _, ok := current[key]; !ok {
current[key] = make(map[string]interface{})
for _, currentSource := range sources {
for _, r := range currentSource.Files() {
// Crawl in data tree to insert data
current = s.Data
for _, key := range strings.Split(r.Dir(), helpers.FilePathSeparator) {
if key != "" {
if _, ok := current[key]; !ok {
current[key] = make(map[string]interface{})
}
current = current[key].(map[string]interface{})
}
current = current[key].(map[string]interface{})
}
}
data, err := readData(r)
if err != nil {
return fmt.Errorf("Failed to read data from %s: %s", filepath.Join(r.Path(), r.LogicalName()), err)
}
data, err := readData(r)
if err != nil {
return fmt.Errorf("Failed to read data from %s: %s", filepath.Join(r.Path(), r.LogicalName()), err)
}
// Copy content from current to data when needed
if _, ok := current[r.BaseFileName()]; ok {
data := data.(map[string]interface{})
// Copy content from current to data when needed
if _, ok := current[r.BaseFileName()]; ok {
data := data.(map[string]interface{})
for key, value := range current[r.BaseFileName()].(map[string]interface{}) {
if _, override := data[key]; override {
// filepath.Walk walks the files in lexical order, '/' comes before '.'
jww.ERROR.Printf("Data for key '%s' in path '%s' is overridden in subfolder", key, r.Path())
for key, value := range current[r.BaseFileName()].(map[string]interface{}) {
if _, override := data[key]; override {
// filepath.Walk walks the files in lexical order, '/' comes before '.'
// this warning could happen if
// 1. A theme uses the same key; the main data folder wins
// 2. A sub folder uses the same key: the sub folder wins
jww.WARN.Printf("Data for key '%s' in path '%s' is overridden in subfolder", key, r.Path())
}
data[key] = value
}
data[key] = value
}
}
// Insert data
current[r.BaseFileName()] = data
// Insert data
current[r.BaseFileName()] = data
}
}
return
@@ -329,7 +333,17 @@ func (s *Site) Process() (err error) {
s.Tmpl.PrintErrors()
s.timerStep("initialize & template prep")
if err = s.loadData(&source.Filesystem{Base: s.absDataDir()}); err != nil {
dataSources := make([]source.Input, 0, 2)
dataSources = append(dataSources, &source.Filesystem{Base: s.absDataDir()})
// have to be last - duplicate keys in earlier entries will win
themeStaticDir, err := helpers.GetThemeDataDirPath()
if err == nil {
dataSources = append(dataSources, &source.Filesystem{Base: themeStaticDir})
}
if err = s.loadData(dataSources); err != nil {
return
}
s.timerStep("load data")

29
hugolib/site_test.go
View File

@@ -760,7 +760,7 @@ func TestDataDirJson(t *testing.T) {
t.Fatalf("Error %s", err)
}
doTestDataDir(t, expected, sources)
doTestDataDir(t, expected, []source.Input{&source.InMemorySource{ByteSource: sources}})
}
func TestDataDirToml(t *testing.T) {
@@ -774,7 +774,7 @@ func TestDataDirToml(t *testing.T) {
t.Fatalf("Error %s", err)
}
doTestDataDir(t, expected, sources)
doTestDataDir(t, expected, []source.Input{&source.InMemorySource{ByteSource: sources}})
}
func TestDataDirYamlWithOverridenValue(t *testing.T) {
@@ -789,7 +789,24 @@ func TestDataDirYamlWithOverridenValue(t *testing.T) {
expected := map[string]interface{}{"a": map[string]interface{}{"a": 1},
"test": map[string]interface{}{"v1": map[string]interface{}{"v1-2": 2}, "v2": map[string]interface{}{"v2": []interface{}{2, 3}}}}
doTestDataDir(t, expected, sources)
doTestDataDir(t, expected, []source.Input{&source.InMemorySource{ByteSource: sources}})
}
// issue 892
func TestDataDirMultipleSources(t *testing.T) {
s1 := []source.ByteSource{
{filepath.FromSlash("test/first.toml"), []byte("[foo]\nbar = 1")},
}
s2 := []source.ByteSource{
{filepath.FromSlash("test/first.toml"), []byte("[foo]\nbar = 2")},
{filepath.FromSlash("test/second.toml"), []byte("[foo]\ntender = 2")},
}
expected := map[string]interface{}{"a": map[string]interface{}{"a": 1}}
doTestDataDir(t, expected, []source.Input{&source.InMemorySource{ByteSource: s1}, &source.InMemorySource{ByteSource: s2}})
}
func TestDataDirUnknownFormat(t *testing.T) {
@@ -797,15 +814,15 @@ func TestDataDirUnknownFormat(t *testing.T) {
{filepath.FromSlash("test.roml"), []byte("boo")},
}
s := &Site{}
err := s.loadData(&source.InMemorySource{ByteSource: sources})
err := s.loadData([]source.Input{&source.InMemorySource{ByteSource: sources}})
if err == nil {
t.Fatalf("Should return an error")
}
}
func doTestDataDir(t *testing.T, expected interface{}, sources []source.ByteSource) {
func doTestDataDir(t *testing.T, expected interface{}, sources []source.Input) {
s := &Site{}
err := s.loadData(&source.InMemorySource{ByteSource: sources})
err := s.loadData(sources)
if err != nil {
t.Fatalf("Error loading data: %s", err)
}