hugo/hugolib/pagination_test.go
Bjørn Erik Pedersen 75dd596e6c Introduce HugoSites type
And a Hugo global variable which contains the site under build.

This is really needed to get some level of control of the "multiple languages" in play.

There are still work related to this scattered around, but that will come.

With this commit, the multilingual feature is starting to work.
2016-09-06 18:32:16 +03:00

486 lines
12 KiB
Go

// Copyright 2015 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"
"html/template"
"path/filepath"
"testing"
"github.com/spf13/hugo/source"
"github.com/spf13/viper"
"github.com/stretchr/testify/assert"
)
func TestSplitPages(t *testing.T) {
pages := createTestPages(21)
chunks := splitPages(pages, 5)
assert.Equal(t, 5, len(chunks))
for i := 0; i < 4; i++ {
assert.Equal(t, 5, chunks[i].Len())
}
lastChunk := chunks[4]
assert.Equal(t, 1, lastChunk.Len())
}
func TestSplitPageGroups(t *testing.T) {
pages := createTestPages(21)
groups, _ := pages.GroupBy("Weight", "desc")
chunks := splitPageGroups(groups, 5)
assert.Equal(t, 5, len(chunks))
firstChunk := chunks[0]
// alternate weight 5 and 10
if groups, ok := firstChunk.(PagesGroup); ok {
assert.Equal(t, 5, groups.Len())
for _, pg := range groups {
// first group 10 in weight
assert.Equal(t, 10, pg.Key)
for _, p := range pg.Pages {
assert.True(t, p.FuzzyWordCount%2 == 0) // magic test
}
}
} else {
t.Fatal("Excepted PageGroup")
}
lastChunk := chunks[4]
if groups, ok := lastChunk.(PagesGroup); ok {
assert.Equal(t, 1, groups.Len())
for _, pg := range groups {
// last should have 5 in weight
assert.Equal(t, 5, pg.Key)
for _, p := range pg.Pages {
assert.True(t, p.FuzzyWordCount%2 != 0) // magic test
}
}
} else {
t.Fatal("Excepted PageGroup")
}
}
func TestPager(t *testing.T) {
pages := createTestPages(21)
groups, _ := pages.GroupBy("Weight", "desc")
urlFactory := func(page int) string {
return fmt.Sprintf("page/%d/", page)
}
_, err := newPaginatorFromPages(pages, -1, urlFactory)
assert.NotNil(t, err)
_, err = newPaginatorFromPageGroups(groups, -1, urlFactory)
assert.NotNil(t, err)
pag, err := newPaginatorFromPages(pages, 5, urlFactory)
assert.Nil(t, err)
doTestPages(t, pag)
first := pag.Pagers()[0].First()
assert.NotEmpty(t, first.Pages())
assert.Empty(t, first.PageGroups())
pag, err = newPaginatorFromPageGroups(groups, 5, urlFactory)
assert.Nil(t, err)
doTestPages(t, pag)
first = pag.Pagers()[0].First()
assert.NotEmpty(t, first.PageGroups())
assert.Empty(t, first.Pages())
}
func doTestPages(t *testing.T, paginator *paginator) {
paginatorPages := paginator.Pagers()
assert.Equal(t, 5, len(paginatorPages))
assert.Equal(t, 21, paginator.TotalNumberOfElements())
assert.Equal(t, 5, paginator.PageSize())
assert.Equal(t, 5, paginator.TotalPages())
first := paginatorPages[0]
assert.Equal(t, template.HTML("page/1/"), first.URL())
assert.Equal(t, first, first.First())
assert.True(t, first.HasNext())
assert.Equal(t, paginatorPages[1], first.Next())
assert.False(t, first.HasPrev())
assert.Nil(t, first.Prev())
assert.Equal(t, 5, first.NumberOfElements())
assert.Equal(t, 1, first.PageNumber())
third := paginatorPages[2]
assert.True(t, third.HasNext())
assert.True(t, third.HasPrev())
assert.Equal(t, paginatorPages[1], third.Prev())
last := paginatorPages[4]
assert.Equal(t, template.HTML("page/5/"), last.URL())
assert.Equal(t, last, last.Last())
assert.False(t, last.HasNext())
assert.Nil(t, last.Next())
assert.True(t, last.HasPrev())
assert.Equal(t, 1, last.NumberOfElements())
assert.Equal(t, 5, last.PageNumber())
}
func TestPagerNoPages(t *testing.T) {
pages := createTestPages(0)
groups, _ := pages.GroupBy("Weight", "desc")
urlFactory := func(page int) string {
return fmt.Sprintf("page/%d/", page)
}
paginator, _ := newPaginatorFromPages(pages, 5, urlFactory)
doTestPagerNoPages(t, paginator)
first := paginator.Pagers()[0].First()
assert.Empty(t, first.PageGroups())
assert.Empty(t, first.Pages())
paginator, _ = newPaginatorFromPageGroups(groups, 5, urlFactory)
doTestPagerNoPages(t, paginator)
first = paginator.Pagers()[0].First()
assert.Empty(t, first.PageGroups())
assert.Empty(t, first.Pages())
}
func doTestPagerNoPages(t *testing.T, paginator *paginator) {
paginatorPages := paginator.Pagers()
assert.Equal(t, 1, len(paginatorPages))
assert.Equal(t, 0, paginator.TotalNumberOfElements())
assert.Equal(t, 5, paginator.PageSize())
assert.Equal(t, 0, paginator.TotalPages())
// pageOne should be nothing but the first
pageOne := paginatorPages[0]
assert.NotNil(t, pageOne.First())
assert.False(t, pageOne.HasNext())
assert.False(t, pageOne.HasPrev())
assert.Nil(t, pageOne.Next())
assert.Equal(t, 1, len(pageOne.Pagers()))
assert.Equal(t, 0, pageOne.Pages().Len())
assert.Equal(t, 0, pageOne.NumberOfElements())
assert.Equal(t, 0, pageOne.TotalNumberOfElements())
assert.Equal(t, 0, pageOne.TotalPages())
assert.Equal(t, 1, pageOne.PageNumber())
assert.Equal(t, 5, pageOne.PageSize())
}
func TestPaginationURLFactory(t *testing.T) {
viper.Reset()
defer viper.Reset()
viper.Set("PaginatePath", "zoo")
unicode := newPaginationURLFactory("новости проекта")
fooBar := newPaginationURLFactory("foo", "bar")
assert.Equal(t, "/%D0%BD%D0%BE%D0%B2%D0%BE%D1%81%D1%82%D0%B8-%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0/", unicode(1))
assert.Equal(t, "/foo/bar/", fooBar(1))
assert.Equal(t, "/%D0%BD%D0%BE%D0%B2%D0%BE%D1%81%D1%82%D0%B8-%D0%BF%D1%80%D0%BE%D0%B5%D0%BA%D1%82%D0%B0/zoo/4/", unicode(4))
assert.Equal(t, "/foo/bar/zoo/12345/", fooBar(12345))
}
func TestPaginator(t *testing.T) {
viper.Reset()
defer viper.Reset()
for _, useViper := range []bool{false, true} {
doTestPaginator(t, useViper)
}
}
func doTestPaginator(t *testing.T, useViper bool) {
viper.Reset()
defer viper.Reset()
pagerSize := 5
if useViper {
viper.Set("paginate", pagerSize)
} else {
viper.Set("paginate", -1)
}
pages := createTestPages(12)
s := newSiteDefaultLang()
n1 := s.newHomeNode()
n2 := s.newHomeNode()
n1.Data["Pages"] = pages
var paginator1 *Pager
var err error
if useViper {
paginator1, err = n1.Paginator()
} else {
paginator1, err = n1.Paginator(pagerSize)
}
assert.Nil(t, err)
assert.NotNil(t, paginator1)
assert.Equal(t, 3, paginator1.TotalPages())
assert.Equal(t, 12, paginator1.TotalNumberOfElements())
n2.paginator = paginator1.Next()
paginator2, err := n2.Paginator()
assert.Nil(t, err)
assert.Equal(t, paginator2, paginator1.Next())
n1.Data["Pages"] = createTestPages(1)
samePaginator, _ := n1.Paginator()
assert.Equal(t, paginator1, samePaginator)
p, _ := NewPage("test")
_, err = p.Paginator()
assert.NotNil(t, err)
}
func TestPaginatorWithNegativePaginate(t *testing.T) {
viper.Reset()
defer viper.Reset()
viper.Set("paginate", -1)
s := newSiteDefaultLang()
_, err := s.newHomeNode().Paginator()
assert.NotNil(t, err)
}
func TestPaginate(t *testing.T) {
viper.Reset()
defer viper.Reset()
for _, useViper := range []bool{false, true} {
doTestPaginate(t, useViper)
}
}
func doTestPaginate(t *testing.T, useViper bool) {
pagerSize := 5
if useViper {
viper.Set("paginate", pagerSize)
} else {
viper.Set("paginate", -1)
}
pages := createTestPages(6)
s := newSiteDefaultLang()
n1 := s.newHomeNode()
n2 := s.newHomeNode()
var paginator1, paginator2 *Pager
var err error
if useViper {
paginator1, err = n1.Paginate(pages)
} else {
paginator1, err = n1.Paginate(pages, pagerSize)
}
assert.Nil(t, err)
assert.NotNil(t, paginator1)
assert.Equal(t, 2, paginator1.TotalPages())
assert.Equal(t, 6, paginator1.TotalNumberOfElements())
n2.paginator = paginator1.Next()
if useViper {
paginator2, err = n2.Paginate(pages)
} else {
paginator2, err = n2.Paginate(pages, pagerSize)
}
assert.Nil(t, err)
assert.Equal(t, paginator2, paginator1.Next())
p, _ := NewPage("test")
_, err = p.Paginate(pages)
assert.NotNil(t, err)
}
func TestInvalidOptions(t *testing.T) {
s := newSiteDefaultLang()
n1 := s.newHomeNode()
_, err := n1.Paginate(createTestPages(1), 1, 2)
assert.NotNil(t, err)
_, err = n1.Paginator(1, 2)
assert.NotNil(t, err)
_, err = n1.Paginator(-1)
assert.NotNil(t, err)
}
func TestPaginateWithNegativePaginate(t *testing.T) {
viper.Reset()
defer viper.Reset()
viper.Set("paginate", -1)
s := newSiteDefaultLang()
_, err := s.newHomeNode().Paginate(createTestPages(2))
assert.NotNil(t, err)
}
func TestPaginatePages(t *testing.T) {
groups, _ := createTestPages(31).GroupBy("Weight", "desc")
for i, seq := range []interface{}{createTestPages(11), groups, WeightedPages{}, PageGroup{}, &Pages{}} {
v, err := paginatePages(seq, 11, "t")
assert.NotNil(t, v, "Val %d", i)
assert.Nil(t, err, "Err %d", i)
}
_, err := paginatePages(Site{}, 11, "t")
assert.NotNil(t, err)
}
// Issue #993
func TestPaginatorFollowedByPaginateShouldFail(t *testing.T) {
viper.Reset()
defer viper.Reset()
viper.Set("paginate", 10)
s := newSiteDefaultLang()
n1 := s.newHomeNode()
n2 := s.newHomeNode()
_, err := n1.Paginator()
assert.Nil(t, err)
_, err = n1.Paginate(createTestPages(2))
assert.NotNil(t, err)
_, err = n2.Paginate(createTestPages(2))
assert.Nil(t, err)
}
func TestPaginateFollowedByDifferentPaginateShouldFail(t *testing.T) {
viper.Reset()
defer viper.Reset()
viper.Set("paginate", 10)
s := newSiteDefaultLang()
n1 := s.newHomeNode()
n2 := s.newHomeNode()
p1 := createTestPages(2)
p2 := createTestPages(10)
_, err := n1.Paginate(p1)
assert.Nil(t, err)
_, err = n1.Paginate(p1)
assert.Nil(t, err)
_, err = n1.Paginate(p2)
assert.NotNil(t, err)
_, err = n2.Paginate(p2)
assert.Nil(t, err)
}
func TestProbablyEqualPageLists(t *testing.T) {
fivePages := createTestPages(5)
zeroPages := createTestPages(0)
zeroPagesByWeight, _ := createTestPages(0).GroupBy("Weight", "asc")
fivePagesByWeight, _ := createTestPages(5).GroupBy("Weight", "asc")
ninePagesByWeight, _ := createTestPages(9).GroupBy("Weight", "asc")
for i, this := range []struct {
v1 interface{}
v2 interface{}
expect bool
}{
{nil, nil, true},
{"a", "b", true},
{"a", fivePages, false},
{fivePages, "a", false},
{fivePages, createTestPages(2), false},
{fivePages, fivePages, true},
{zeroPages, zeroPages, true},
{fivePagesByWeight, fivePagesByWeight, true},
{zeroPagesByWeight, fivePagesByWeight, false},
{zeroPagesByWeight, zeroPagesByWeight, true},
{fivePagesByWeight, fivePages, false},
{fivePagesByWeight, ninePagesByWeight, false},
} {
result := probablyEqualPageLists(this.v1, this.v2)
if result != this.expect {
t.Errorf("[%d] got %t but expected %t", i, result, this.expect)
}
}
}
func TestPage(t *testing.T) {
urlFactory := func(page int) string {
return fmt.Sprintf("page/%d/", page)
}
fivePages := createTestPages(7)
fivePagesFuzzyWordCount, _ := createTestPages(7).GroupBy("FuzzyWordCount", "asc")
p1, _ := newPaginatorFromPages(fivePages, 2, urlFactory)
p2, _ := newPaginatorFromPageGroups(fivePagesFuzzyWordCount, 2, urlFactory)
f1 := p1.pagers[0].First()
f2 := p2.pagers[0].First()
page11, _ := f1.page(1)
page1Nil, _ := f1.page(3)
page21, _ := f2.page(1)
page2Nil, _ := f2.page(3)
assert.Equal(t, 1, page11.FuzzyWordCount)
assert.Nil(t, page1Nil)
assert.Equal(t, 1, page21.FuzzyWordCount)
assert.Nil(t, page2Nil)
}
func createTestPages(num int) Pages {
pages := make(Pages, num)
for i := 0; i < num; i++ {
pages[i] = &Page{
Node: Node{
URLPath: URLPath{
Section: "z",
URL: fmt.Sprintf("http://base/x/y/p%d.html", i),
},
Site: &SiteInfo{
BaseURL: "http://base/",
},
},
Source: Source{File: *source.NewFile(filepath.FromSlash(fmt.Sprintf("/x/y/p%d.md", i)))},
}
w := 5
if i%2 == 0 {
w = 10
}
pages[i].FuzzyWordCount = i
pages[i].Weight = w
}
return pages
}