Skip to content

Commit

Permalink
Revert " Fix handling of taxonomy terms containing slashes"
Browse files Browse the repository at this point in the history
See #4090
See #5571

This reverts commit fff1325.
  • Loading branch information
bep committed Dec 30, 2018
1 parent 0584432 commit 4bae8b0
Show file tree
Hide file tree
Showing 8 changed files with 50 additions and 94 deletions.
11 changes: 0 additions & 11 deletions helpers/path.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,17 +77,6 @@ func (filepathBridge) Separator() string {

var fpb filepathBridge

// segmentReplacer replaces some URI-reserved characters in a path segments.
var segmentReplacer = strings.NewReplacer("/", "-", "#", "-")

// MakeSegment returns a copy of string s that is appropriate for a path
// segment. MakeSegment is similar to MakePath but disallows the '/' and
// '#' characters because of their reserved meaning in URIs.
func (p *PathSpec) MakeSegment(s string) string {
return p.MakePathSanitized(segmentReplacer.Replace(s))

}

// MakePath takes a string with any characters and replace it
// so the string could be used in a path.
// It does so by creating a Unicode-sanitized string, with the spaces replaced,
Expand Down
33 changes: 0 additions & 33 deletions helpers/path_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,39 +36,6 @@ import (
"github.com/spf13/viper"
)

func TestMakeSegment(t *testing.T) {
tests := []struct {
input string
expected string
}{
{" FOO bar ", "foo-bar"},
{"Foo.Bar/fOO_bAr-Foo", "foo.bar-foo_bar-foo"},
{"FOO,bar:FooBar", "foobarfoobar"},
{"foo/BAR.HTML", "foo-bar.html"},
{"трям/трям", "трям-трям"},
{"은행", "은행"},
{"Say What??", "say-what"},
{"Your #1 Fan", "your-1-fan"},
{"Red & Blue", "red-blue"},
{"double//slash", "double-slash"},
{"triple///slash", "triple-slash"},
{"-my/way-", "my-way"},
}

for _, test := range tests {
v := newTestCfg()

l := langs.NewDefaultLanguage(v)
p, err := NewPathSpec(hugofs.NewMem(v), l)
require.NoError(t, err)

output := p.MakeSegment(test.input)
if output != test.expected {
t.Errorf("Expected %#v, got %#v\n", test.expected, output)
}
}
}

func TestMakePath(t *testing.T) {
tests := []struct {
input string
Expand Down
2 changes: 1 addition & 1 deletion hugolib/hugo_sites.go
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ func (h *HugoSites) createMissingPages() error {
origKey := key

if s.Info.preserveTaxonomyNames {
key = s.PathSpec.MakeSegment(key)
key = s.PathSpec.MakePathSanitized(key)
}
for _, p := range taxonomyPages {
// Some people may have /authors/MaxMustermann etc. as paths.
Expand Down
8 changes: 1 addition & 7 deletions hugolib/page_paths.go
Original file line number Diff line number Diff line change
Expand Up @@ -197,13 +197,7 @@ func createTargetPath(d targetPathDescriptor) string {
if d.ExpandedPermalink != "" {
pagePath = filepath.Join(pagePath, d.ExpandedPermalink)
} else {
pagePath = ""
for i, section := range d.Sections {
if i > 0 {
pagePath += helpers.FilePathSeparator
}
pagePath += d.PathSpec.MakeSegment(section)
}
pagePath = filepath.Join(d.Sections...)
}
needsBase = false
}
Expand Down
7 changes: 0 additions & 7 deletions hugolib/page_paths_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -151,13 +151,6 @@ func TestPageTargetPath(t *testing.T) {
BaseName: "mypage",
Addends: "c/d/e",
Type: output.HTMLFormat}, "/a/b/mypage/c/d/e/index.html"},
{
"Unclean Taxonomy Term", targetPathDescriptor{
Kind: KindTaxonomy,
BaseName: "_index",
Sections: []string{"tags", "x/y"},
Type: output.HTMLFormat,
Addends: "page/3"}, "/tags/x-y/page/3/index.html"},
}

for i, test := range tests {
Expand Down
10 changes: 4 additions & 6 deletions hugolib/page_taxonomy_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import (
)

var pageYamlWithTaxonomiesA = `---
tags: ['a', 'B', 'c', 'x/y']
tags: ['a', 'B', 'c']
categories: 'd'
---
YAML frontmatter with tags and categories taxonomy.`
Expand All @@ -30,7 +30,6 @@ tags:
- "a"
- "B"
- "c"
- "x/y"
categories: 'd'
---
YAML frontmatter with tags and categories taxonomy.`
Expand All @@ -46,14 +45,13 @@ var pageJSONWithTaxonomies = `{
"tags": [
"a",
"b",
"c",
"x/y"
"c"
]
}
JSON Front Matter with tags and categories`

var pageTomlWithTaxonomies = `+++
tags = [ "a", "B", "c", "x/y" ]
tags = [ "a", "B", "c" ]
categories = "d"
+++
TOML Front Matter with tags and categories`
Expand All @@ -77,7 +75,7 @@ func TestParseTaxonomies(t *testing.T) {
param := p.getParamToLower("tags")

if params, ok := param.([]string); ok {
expected := []string{"a", "b", "c", "x/y"}
expected := []string{"a", "b", "c"}
if !reflect.DeepEqual(params, expected) {
t.Errorf("Expected %s: got: %s", expected, params)
}
Expand Down
30 changes: 7 additions & 23 deletions hugolib/permalinks.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,13 +152,9 @@ func pageToPermalinkDate(p *Page, dateField string) (string, error) {

// pageToPermalinkTitle returns the URL-safe form of the title
func pageToPermalinkTitle(p *Page, _ string) (string, error) {
if p.Kind == KindTaxonomy {
// Taxonomies are allowed to have '/' characters, so don't normalize
// them with MakeSegment.
return p.s.PathSpec.MakePathSanitized(p.title), nil
}

return p.s.PathSpec.MakeSegment(p.title), nil
// Page contains Node which has Title
// (also contains URLPath which has Slug, sometimes)
return p.s.PathSpec.URLize(p.title), nil
}

// pageToPermalinkFilename returns the URL-safe form of the filename
Expand All @@ -170,7 +166,7 @@ func pageToPermalinkFilename(p *Page, _ string) (string, error) {
_, name = filepath.Split(dir)
}

return p.s.PathSpec.MakeSegment(name), nil
return p.s.PathSpec.URLize(name), nil
}

// if the page has a slug, return the slug, else return the title
Expand All @@ -185,30 +181,18 @@ func pageToPermalinkSlugElseTitle(p *Page, a string) (string, error) {
if strings.HasSuffix(p.Slug, "-") {
p.Slug = p.Slug[0 : len(p.Slug)-1]
}
return p.s.PathSpec.MakeSegment(p.Slug), nil
return p.s.PathSpec.URLize(p.Slug), nil
}
return pageToPermalinkTitle(p, a)
}

func pageToPermalinkSection(p *Page, _ string) (string, error) {
// Page contains Node contains URLPath which has Section
return p.s.PathSpec.MakeSegment(p.Section()), nil
return p.s.PathSpec.URLize(p.Section()), nil
}

func pageToPermalinkSections(p *Page, _ string) (string, error) {
// TODO(bep) we have some superflous URLize in this file, but let's
// deal with that later.

cs := p.CurrentSection()
if cs == nil {
return "", errors.New("\":sections\" attribute requires parent page but is nil")
}

sections := make([]string, len(cs.sections))
for i := range cs.sections {
sections[i] = p.s.PathSpec.MakeSegment(cs.sections[i])
}
return path.Join(sections...), nil
return path.Join(p.CurrentSection().sections...), nil
}

func init() {
Expand Down
43 changes: 37 additions & 6 deletions hugolib/taxonomy_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,8 @@ func TestByCountOrderOfTaxonomies(t *testing.T) {
st = append(st, t.Name)
}

expect := []string{"a", "b", "c", "x/y"}
if !reflect.DeepEqual(st, expect) {
t.Fatalf("ordered taxonomies do not match %v. Got: %s", expect, st)
if !reflect.DeepEqual(st, []string{"a", "b", "c"}) {
t.Fatalf("ordered taxonomies do not match [a, b, c]. Got: %s", st)
}
}

Expand All @@ -69,18 +68,15 @@ func doTestTaxonomiesWithAndWithoutContentFile(t *testing.T, preserveTaxonomyNam
baseURL = "http://example.com/blog"
preserveTaxonomyNames = %t
uglyURLs = %t
paginate = 1
defaultContentLanguage = "en"
[Taxonomies]
tag = "tags"
category = "categories"
other = "others"
empty = "empties"
permalinked = "permalinkeds"
subcats = "subcats"
[permalinks]
permalinkeds = "/perma/:slug/"
subcats = "/subcats/:slug/"
Expand Down Expand Up @@ -243,3 +239,38 @@ subcats:
th.assertFileContent(pathFunc("public/empties/index.html"), "Terms List", "Empties")

}

// https://github.com/gohugoio/hugo/issues/5513
func TestTaxonomyPathSeparation(t *testing.T) {
t.Parallel()

config := `
baseURL = "https://example.com"
[taxonomies]
"news/tag" = "news/tags"
"news/category" = "news/categories"
`

pageContent := `
+++
title = "foo"
"news/categories" = ["a", "b", "c"]
+++
Content.
`

b := newTestSitesBuilder(t)
b.WithConfigFile("toml", config)
b.WithContent("page.md", pageContent)
b.WithContent("news/categories/b/_index.md", `
---
title: "This is B"
---
`)

b.CreateSites().Build(BuildCfg{})

b.AssertFileContent("public/news/categories/index.html", "Taxonomy Term Page 1|News/Categories|Hello|https://example.com/news/categories/|")
b.AssertFileContent("public/news/categories/a/index.html", "Taxonomy List Page 1|A|Hello|https://example.com/news/categories/a/|")
b.AssertFileContent("public/news/categories/b/index.html", "Taxonomy List Page 1|This is B|Hello|https://example.com/news/categories/b/|")
}

0 comments on commit 4bae8b0

Please sign in to comment.