mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-01 13:38:50 -05:00
90da7664bf
The main topic of this commit is that you can now index fragments (content heading identifiers) when calling `.Related`.
You can do this by:
* Configure one or more indices with type `fragments`
* The name of those index configurations maps to an (optional) front matter slice with fragment references. This allows you to link
page<->fragment and page<->page.
* This also will index all the fragments (heading identifiers) of the pages.
It's also possible to use type `fragments` indices in shortcode, e.g.:
```
{{ $related := site.RegularPages.Related .Page }}
```
But, and this is important, you need to include the shortcode using the `{{<` delimiter. Not doing so will create infinite loops and timeouts.
This commit also:
* Adds two new methods to Page: Fragments (can also be used to build ToC) and HeadingsFiltered (this is only used in Related Content with
index type `fragments` and `enableFilter` set to true.
* Consolidates all `.Related*` methods into one, which takes either a `Page` or an options map as its only argument.
* Add `context.Context` to all of the content related Page API. Turns out it wasn't strictly needed for this particular feature, but it will
soon become usefil, e.g. in #9339.
Closes #10711
Updates #9339
Updates #10725
139 lines
3.3 KiB
Go
139 lines
3.3 KiB
Go
// Copyright 2019 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 collections
|
|
|
|
import (
|
|
"errors"
|
|
"testing"
|
|
|
|
qt "github.com/frankban/quicktest"
|
|
)
|
|
|
|
var (
|
|
_ Slicer = (*tstSlicer)(nil)
|
|
_ Slicer = (*tstSlicerIn1)(nil)
|
|
_ Slicer = (*tstSlicerIn2)(nil)
|
|
_ testSlicerInterface = (*tstSlicerIn1)(nil)
|
|
_ testSlicerInterface = (*tstSlicerIn1)(nil)
|
|
)
|
|
|
|
type testSlicerInterface interface {
|
|
Name() string
|
|
}
|
|
|
|
type testSlicerInterfaces []testSlicerInterface
|
|
|
|
type tstSlicerIn1 struct {
|
|
TheName string
|
|
}
|
|
|
|
type tstSlicerIn2 struct {
|
|
TheName string
|
|
}
|
|
|
|
type tstSlicer struct {
|
|
TheName string
|
|
}
|
|
|
|
func (p *tstSlicerIn1) Slice(in any) (any, error) {
|
|
items := in.([]any)
|
|
result := make(testSlicerInterfaces, len(items))
|
|
for i, v := range items {
|
|
switch vv := v.(type) {
|
|
case testSlicerInterface:
|
|
result[i] = vv
|
|
default:
|
|
return nil, errors.New("invalid type")
|
|
}
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
func (p *tstSlicerIn2) Slice(in any) (any, error) {
|
|
items := in.([]any)
|
|
result := make(testSlicerInterfaces, len(items))
|
|
for i, v := range items {
|
|
switch vv := v.(type) {
|
|
case testSlicerInterface:
|
|
result[i] = vv
|
|
default:
|
|
return nil, errors.New("invalid type")
|
|
}
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
func (p *tstSlicerIn1) Name() string {
|
|
return p.TheName
|
|
}
|
|
|
|
func (p *tstSlicerIn2) Name() string {
|
|
return p.TheName
|
|
}
|
|
|
|
func (p *tstSlicer) Slice(in any) (any, error) {
|
|
items := in.([]any)
|
|
result := make(tstSlicers, len(items))
|
|
for i, v := range items {
|
|
switch vv := v.(type) {
|
|
case *tstSlicer:
|
|
result[i] = vv
|
|
default:
|
|
return nil, errors.New("invalid type")
|
|
}
|
|
}
|
|
return result, nil
|
|
}
|
|
|
|
type tstSlicers []*tstSlicer
|
|
|
|
func TestSlice(t *testing.T) {
|
|
t.Parallel()
|
|
c := qt.New(t)
|
|
|
|
for i, test := range []struct {
|
|
args []any
|
|
expected any
|
|
}{
|
|
{[]any{"a", "b"}, []string{"a", "b"}},
|
|
{[]any{&tstSlicer{"a"}, &tstSlicer{"b"}}, tstSlicers{&tstSlicer{"a"}, &tstSlicer{"b"}}},
|
|
{[]any{&tstSlicer{"a"}, "b"}, []any{&tstSlicer{"a"}, "b"}},
|
|
{[]any{}, []any{}},
|
|
{[]any{nil}, []any{nil}},
|
|
{[]any{5, "b"}, []any{5, "b"}},
|
|
{[]any{&tstSlicerIn1{"a"}, &tstSlicerIn2{"b"}}, testSlicerInterfaces{&tstSlicerIn1{"a"}, &tstSlicerIn2{"b"}}},
|
|
{[]any{&tstSlicerIn1{"a"}, &tstSlicer{"b"}}, []any{&tstSlicerIn1{"a"}, &tstSlicer{"b"}}},
|
|
} {
|
|
errMsg := qt.Commentf("[%d] %v", i, test.args)
|
|
|
|
result := Slice(test.args...)
|
|
|
|
c.Assert(test.expected, qt.DeepEquals, result, errMsg)
|
|
}
|
|
}
|
|
|
|
func TestSortedStringSlice(t *testing.T) {
|
|
t.Parallel()
|
|
c := qt.New(t)
|
|
|
|
var s SortedStringSlice = []string{"a", "b", "b", "b", "c", "d"}
|
|
|
|
c.Assert(s.Contains("a"), qt.IsTrue)
|
|
c.Assert(s.Contains("b"), qt.IsTrue)
|
|
c.Assert(s.Contains("z"), qt.IsFalse)
|
|
c.Assert(s.Count("b"), qt.Equals, 3)
|
|
c.Assert(s.Count("z"), qt.Equals, 0)
|
|
c.Assert(s.Count("a"), qt.Equals, 1)
|
|
|
|
}
|