hugolib: Support regular pages in .Site.GetPage

Fixes #2844

hugolib/page_collections.go

@@ -13,6 +13,10 @@
 
 package hugolib
 
+import (
+	"path"
+)
+
 // PageCollections contains the page collections for a site.
 type PageCollections struct {
 	// Includes only pages of all types, and only pages in the current language.
@@ -51,21 +55,36 @@ func newPageCollectionsFromPages(pages Pages) *PageCollections {
 	return &PageCollections{rawAllPages: pages}
 }
 
-func (c *PageCollections) getFirstPageMatchIn(ps Pages, typ string, path ...string) *Page {
+func (c *PageCollections) getFirstPageMatchIn(pages Pages, typ string, pathElements ...string) *Page {
-	pages := c.findPagesByKindIn(typ, ps)
 
 	if len(pages) == 0 {
 		return nil
 	}
 
-	if len(path) == 0 && len(pages) == 1 {
+	var filename string
-		return pages[0]
+	if typ == KindPage {
+		filename = path.Join(pathElements...)
 	}
 
 	for _, p := range pages {
+		if p.Kind != typ {
+			continue
+		}
+
+		if typ == KindHome {
+			return p
+		}
+
+		if typ == KindPage {
+			if p.Source.Path() == filename {
+				return p
+			}
+			continue
+		}
+
 		match := false
-		for i := 0; i < len(path); i++ {
+		for i := 0; i < len(pathElements); i++ {
-			if len(p.sections) > i && path[i] == p.sections[i] {
+			if len(p.sections) > i && pathElements[i] == p.sections[i] {
 				match = true
 			} else {
 				match = false
@@ -81,11 +100,15 @@ func (c *PageCollections) getFirstPageMatchIn(ps Pages, typ string, path ...stri
 
 }
 
+func (c *PageCollections) getRegularPage(filename string) {
+
+}
+
 func (c *PageCollections) getPage(typ string, path ...string) *Page {
 	var pages Pages
 
 	if typ == KindPage {
-		pages = c.RegularPages
+		pages = c.AllPages
 	} else {
 		pages = c.indexPages
 	}

hugolib/page_collections_test.go

@@ -0,0 +1,145 @@
+// Copyright 2017 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 (
+	"fmt"
+	"math/rand"
+	"path"
+	"path/filepath"
+	"testing"
+	"time"
+
+	"github.com/spf13/hugo/deps"
+	"github.com/stretchr/testify/require"
+)
+
+const pageCollectionsPageTemplate = `---
+title: "%s"
+categories:
+- Hugo
+---
+# Doc
+`
+
+func BenchmarkGetPage(b *testing.B) {
+	var (
+		cfg, fs = newTestCfg()
+		r       = rand.New(rand.NewSource(time.Now().UnixNano()))
+	)
+
+	for i := 0; i < 10; i++ {
+		for j := 0; j < 100; j++ {
+			writeSource(b, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", j)), "CONTENT")
+		}
+	}
+
+	s := buildSingleSite(b, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{SkipRender: true})
+
+	pagePaths := make([]string, b.N)
+
+	for i := 0; i < b.N; i++ {
+		pagePaths[i] = fmt.Sprintf("sect%d", r.Intn(10))
+	}
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		home := s.getPage(KindHome)
+		if home == nil {
+			b.Fatal("Home is nil")
+		}
+
+		p := s.getPage(KindSection, pagePaths[i])
+		if p == nil {
+			b.Fatal("Section is nil")
+		}
+
+	}
+}
+
+func BenchmarkGetPageRegular(b *testing.B) {
+	var (
+		cfg, fs = newTestCfg()
+		r       = rand.New(rand.NewSource(time.Now().UnixNano()))
+	)
+
+	for i := 0; i < 10; i++ {
+		for j := 0; j < 100; j++ {
+			content := fmt.Sprintf(pageCollectionsPageTemplate, fmt.Sprintf("Title%d_%d", i, j))
+			writeSource(b, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", j)), content)
+		}
+	}
+
+	s := buildSingleSite(b, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{SkipRender: true})
+
+	pagePaths := make([]string, b.N)
+
+	for i := 0; i < b.N; i++ {
+		pagePaths[i] = path.Join(fmt.Sprintf("sect%d", r.Intn(10)), fmt.Sprintf("page%d.md", r.Intn(100)))
+	}
+
+	b.ResetTimer()
+	for i := 0; i < b.N; i++ {
+		page := s.getPage(KindPage, pagePaths[i])
+		require.NotNil(b, page)
+	}
+}
+
+func TestGetPage(t *testing.T) {
+
+	var (
+		assert  = require.New(t)
+		cfg, fs = newTestCfg()
+	)
+
+	for i := 0; i < 10; i++ {
+		for j := 0; j < 10; j++ {
+			content := fmt.Sprintf(pageCollectionsPageTemplate, fmt.Sprintf("Title%d_%d", i, j))
+			writeSource(t, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", j)), content)
+		}
+	}
+
+	s := buildSingleSite(t, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{SkipRender: true})
+
+	tests := []struct {
+		kind          string
+		path          []string
+		expectedTitle string
+	}{
+		{KindHome, []string{}, ""},
+		{KindSection, []string{"sect3"}, "Sect3s"},
+		{KindPage, []string{"sect3", "page1.md"}, "Title3_1"},
+		{KindPage, []string{"sect4/page2.md"}, "Title4_2"},
+		{KindPage, []string{filepath.FromSlash("sect5/page3.md")}, "Title5_3"},
+		// TODO(bep) section maybe support sect5/page2, aka relref.
+	}
+
+	for i, test := range tests {
+		errorMsg := fmt.Sprintf("Test %d", i)
+		page := s.getPage(test.kind, test.path...)
+		assert.NotNil(page, errorMsg)
+		assert.Equal(test.kind, page.Kind)
+		assert.Equal(test.expectedTitle, page.Title)
+	}
+
+	// TODO(bep) getPage:
+
+	// From RelRef:
+
+	// refPath := filepath.FromSlash(refURL.Path)
+	// if page.Source.Path() == refPath || page.Source.LogicalName() == refPath {
+	// We should consolidate and make that relref use GetPage.
+	// But note the AllRegularPages!
+
+}

hugolib/site_test.go

@@ -1105,33 +1105,3 @@ func TestSourceRelativeLinkFileing(t *testing.T) {
 		}
 	}
 }
-
-func BenchmarkGetPage(b *testing.B) {
-	var (
-		cfg, fs = newTestCfg()
-	)
-
-	for i := 0; i < 10; i++ {
-		for j := 0; j < 100; j++ {
-			writeSource(b, fs, filepath.Join("content", fmt.Sprintf("sect%d", i), fmt.Sprintf("page%d.md", j)), "CONTENT")
-		}
-	}
-
-	s := buildSingleSite(b, deps.DepsCfg{Fs: fs, Cfg: cfg}, BuildCfg{SkipRender: true})
-
-	b.ResetTimer()
-	for i := 0; i < b.N; i++ {
-		home := s.getPage(KindHome)
-		if home == nil {
-			b.Fatal("Home is nil")
-		}
-
-		for i := 0; i < 10; i++ {
-			sect := fmt.Sprintf("sect%d", i)
-			p := s.getPage(KindSection, sect)
-			if p == nil {
-				b.Fatal(fmt.Sprintf("Section %q is nil", sect))
-			}
-		}
-	}
-}