mirror of
https://github.com/gohugoio/hugo.git
synced 2024-05-11 05:54:58 +00:00
hugolib: Refactor/-work the permalink/target path logic
This is a pretty fundamental change in Hugo, but absolutely needed if we should have any hope of getting "multiple outputs" done. This commit's goal is to say: * Every file target path is created by `createTargetPath`, i.e. one function for all. * That function takes every page and site parameter into account, to avoid fragile string parsing to uglify etc. later on. * The path creation logic has full test coverage. * All permalinks, paginator URLs etc. are then built on top of that same logic. Fixes #1252 Fixes #2110 Closes #2374 Fixes #1885 Fixes #3102 Fixes #3179 Fixes #1641 Fixes #1989
This commit is contained in:
Bjørn Erik Pedersen
166
hugolib/page_paths_test.go
Normal file
166
hugolib/page_paths_test.go
Normal file
@@ -0,0 +1,166 @@
|
||||
// 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 (
|
||||
"path/filepath"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/hugo/output"
|
||||
)
|
||||
|
||||
func TestPageTargetPath(t *testing.T) {
|
||||
|
||||
pathSpec := newTestDefaultPathSpec()
|
||||
|
||||
for _, langPrefix := range []string{"", "no"} {
|
||||
t.Run(fmt.Sprintf("langPrefix=%q", langPrefix), func(t *testing.T) {
|
||||
for _, uglyURLs := range []bool{false, true} {
|
||||
t.Run(fmt.Sprintf("uglyURLs=%t", uglyURLs), func(t *testing.T) {
|
||||
|
||||
tests := []struct {
|
||||
name string
|
||||
d targetPathDescriptor
|
||||
expected string
|
||||
}{
|
||||
{"JSON home", targetPathDescriptor{Kind: KindHome, Type: output.JSONType}, "/index.json"},
|
||||
{"AMP home", targetPathDescriptor{Kind: KindHome, Type: output.AMPType}, "/amp/index.html"},
|
||||
{"HTML home", targetPathDescriptor{Kind: KindHome, BaseName: "_index", Type: output.HTMLType}, "/index.html"},
|
||||
{"HTML section list", targetPathDescriptor{
|
||||
Kind: KindSection,
|
||||
Sections: []string{"sect1"},
|
||||
BaseName: "_index",
|
||||
Type: output.HTMLType}, "/sect1/index.html"},
|
||||
{"HTML taxonomy list", targetPathDescriptor{
|
||||
Kind: KindTaxonomy,
|
||||
Sections: []string{"tags", "hugo"},
|
||||
BaseName: "_index",
|
||||
Type: output.HTMLType}, "/tags/hugo/index.html"},
|
||||
{"HTML taxonomy term", targetPathDescriptor{
|
||||
Kind: KindTaxonomy,
|
||||
Sections: []string{"tags"},
|
||||
BaseName: "_index",
|
||||
Type: output.HTMLType}, "/tags/index.html"},
|
||||
{
|
||||
"HTML page", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/a/b",
|
||||
BaseName: "mypage",
|
||||
Sections: []string{"a"},
|
||||
Type: output.HTMLType}, "/a/b/mypage/index.html"},
|
||||
{
|
||||
"HTML page with special chars", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/a/b",
|
||||
BaseName: "My Page!",
|
||||
Type: output.HTMLType}, "/a/b/My-Page/index.html"},
|
||||
{"RSS home", targetPathDescriptor{Kind: kindRSS, Type: output.RSSType}, "/index.xml"},
|
||||
{"RSS section list", targetPathDescriptor{
|
||||
Kind: kindRSS,
|
||||
Sections: []string{"sect1"},
|
||||
Type: output.RSSType}, "/sect1/index.xml"},
|
||||
{
|
||||
"AMP page", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/a/b/c",
|
||||
BaseName: "myamp",
|
||||
Type: output.AMPType}, "/amp/a/b/c/myamp/index.html"},
|
||||
{
|
||||
"AMP page with URL with suffix", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/sect/",
|
||||
BaseName: "mypage",
|
||||
URL: "/some/other/url.xhtml",
|
||||
Type: output.HTMLType}, "/some/other/url.xhtml"},
|
||||
{
|
||||
"JSON page with URL without suffix", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/sect/",
|
||||
BaseName: "mypage",
|
||||
URL: "/some/other/path/",
|
||||
Type: output.JSONType}, "/some/other/path/index.json"},
|
||||
{
|
||||
"JSON page with URL without suffix and no trailing slash", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/sect/",
|
||||
BaseName: "mypage",
|
||||
URL: "/some/other/path",
|
||||
Type: output.JSONType}, "/some/other/path/index.json"},
|
||||
{
|
||||
"HTML page with expanded permalink", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/a/b",
|
||||
BaseName: "mypage",
|
||||
ExpandedPermalink: "/2017/10/my-title",
|
||||
Type: output.HTMLType}, "/2017/10/my-title/index.html"},
|
||||
{
|
||||
"Paginated HTML home", targetPathDescriptor{
|
||||
Kind: KindHome,
|
||||
BaseName: "_index",
|
||||
Type: output.HTMLType,
|
||||
Addends: "page/3"}, "/page/3/index.html"},
|
||||
{
|
||||
"Paginated Taxonomy list", targetPathDescriptor{
|
||||
Kind: KindTaxonomy,
|
||||
BaseName: "_index",
|
||||
Sections: []string{"tags", "hugo"},
|
||||
Type: output.HTMLType,
|
||||
Addends: "page/3"}, "/tags/hugo/page/3/index.html"},
|
||||
{
|
||||
"Regular page with addend", targetPathDescriptor{
|
||||
Kind: KindPage,
|
||||
Dir: "/a/b",
|
||||
BaseName: "mypage",
|
||||
Addends: "c/d/e",
|
||||
Type: output.HTMLType}, "/a/b/mypage/c/d/e/index.html"},
|
||||
}
|
||||
|
||||
for i, test := range tests {
|
||||
test.d.PathSpec = pathSpec
|
||||
test.d.UglyURLs = uglyURLs
|
||||
test.d.LangPrefix = langPrefix
|
||||
test.d.Dir = filepath.FromSlash(test.d.Dir)
|
||||
isUgly := uglyURLs && !test.d.Type.NoUgly
|
||||
|
||||
expected := test.expected
|
||||
|
||||
// TODO(bep) simplify
|
||||
if test.d.Kind == KindHome && test.d.Type.Path != "" {
|
||||
} else if (!strings.HasPrefix(expected, "/index") || test.d.Addends != "") && test.d.URL == "" && isUgly {
|
||||
expected = strings.Replace(expected,
|
||||
"/"+test.d.Type.BaseName+"."+test.d.Type.MediaType.Suffix,
|
||||
"."+test.d.Type.MediaType.Suffix, -1)
|
||||
}
|
||||
|
||||
if test.d.LangPrefix != "" && !(test.d.Kind == KindPage && test.d.URL != "") {
|
||||
expected = "/" + test.d.LangPrefix + expected
|
||||
}
|
||||
|
||||
expected = filepath.FromSlash(expected)
|
||||
|
||||
pagePath := createTargetPath(test.d)
|
||||
|
||||
if pagePath != expected {
|
||||
t.Fatalf("[%d] [%s] targetPath expected %q, got: %q", i, test.name, expected, pagePath)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user