summaryrefslogtreecommitdiffstats
path: root/hugolib/collections.go
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-09-10 09:48:10 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2018-09-14 10:12:08 +0200
commite27fd4c1b80b7acb43290ac50e9f140d690cf042 (patch)
tree34b0f36bde4598781f9b331b5956fae3b4b33866 /hugolib/collections.go
parentb7ca3e1b3a83ef27bef841c319edb5b377cc4102 (diff)
tpl/collections: Add collections.Append
Before this commit you would typically use `.Scratch.Add` to manually create slices in a loop. With variable overwrite in Go 1.11, we can do better. This commit adds the `append` template func. A made-up example: ```bash {{ $p1 := index .Site.RegularPages 0 }}{{ $p2 := index .Site.RegularPages 1 }} {{ $pages := slice }} {{ if true }} {{ $pages = $pages | append $p2 $p1 }} {{ end }} ``` Note that with 2 slices as arguments, the two examples below will give the same result: ```bash {{ $s1 := slice "a" "b" | append (slice "c" "d") }} {{ $s2 := slice "a" "b" | append "c" "d" }} ``` Both of the above will give `[]string{a, b, c, d}`. This commit also improves the type handling in the `slice` template function. Now `slice "a" "b"` will give a `[]string` slice. The old behaviour was to return a `[]interface{}`. Fixes #5190
Diffstat (limited to 'hugolib/collections.go')
-rw-r--r--hugolib/collections.go68
1 files changed, 47 insertions, 21 deletions
diff --git a/hugolib/collections.go b/hugolib/collections.go
index 56830d8e6..b9992c425 100644
--- a/hugolib/collections.go
+++ b/hugolib/collections.go
@@ -16,14 +16,17 @@ package hugolib
import (
"fmt"
+ "github.com/gohugoio/hugo/resource"
+
"github.com/gohugoio/hugo/common/collections"
)
var (
- _ collections.Grouper = (*Page)(nil)
- _ collections.Slicer = (*Page)(nil)
- _ collections.Slicer = PageGroup{}
- _ collections.Slicer = WeightedPage{}
+ _ collections.Grouper = (*Page)(nil)
+ _ collections.Slicer = (*Page)(nil)
+ _ collections.Slicer = PageGroup{}
+ _ collections.Slicer = WeightedPage{}
+ _ resource.ResourcesConverter = Pages{}
)
// collections.Slicer implementations below. We keep these bridge implementations
@@ -32,36 +35,50 @@ var (
// Slice is not meant to be used externally. It's a bridge function
// for the template functions. See collections.Slice.
-func (p *Page) Slice(items []interface{}) (interface{}, error) {
+func (p *Page) Slice(items interface{}) (interface{}, error) {
return toPages(items)
}
// Slice is not meant to be used externally. It's a bridge function
// for the template functions. See collections.Slice.
-func (p PageGroup) Slice(items []interface{}) (interface{}, error) {
- groups := make(PagesGroup, len(items))
- for i, v := range items {
- g, ok := v.(PageGroup)
- if !ok {
- return nil, fmt.Errorf("type %T is not a PageGroup", v)
+func (p PageGroup) Slice(in interface{}) (interface{}, error) {
+ switch items := in.(type) {
+ case PageGroup:
+ return items, nil
+ case []interface{}:
+ groups := make(PagesGroup, len(items))
+ for i, v := range items {
+ g, ok := v.(PageGroup)
+ if !ok {
+ return nil, fmt.Errorf("type %T is not a PageGroup", v)
+ }
+ groups[i] = g
}
- groups[i] = g
+ return groups, nil
+ default:
+ return nil, fmt.Errorf("invalid slice type %T", items)
}
- return groups, nil
}
// Slice is not meant to be used externally. It's a bridge function
// for the template functions. See collections.Slice.
-func (p WeightedPage) Slice(items []interface{}) (interface{}, error) {
- weighted := make(WeightedPages, len(items))
- for i, v := range items {
- g, ok := v.(WeightedPage)
- if !ok {
- return nil, fmt.Errorf("type %T is not a WeightedPage", v)
+func (p WeightedPage) Slice(in interface{}) (interface{}, error) {
+ switch items := in.(type) {
+ case WeightedPages:
+ return items, nil
+ case []interface{}:
+ weighted := make(WeightedPages, len(items))
+ for i, v := range items {
+ g, ok := v.(WeightedPage)
+ if !ok {
+ return nil, fmt.Errorf("type %T is not a WeightedPage", v)
+ }
+ weighted[i] = g
}
- weighted[i] = g
+ return weighted, nil
+ default:
+ return nil, fmt.Errorf("invalid slice type %T", items)
}
- return weighted, nil
}
// collections.Grouper implementations below
@@ -76,3 +93,12 @@ func (p *Page) Group(key interface{}, in interface{}) (interface{}, error) {
}
return PageGroup{Key: key, Pages: pages}, nil
}
+
+// ToResources wraps resource.ResourcesConverter
+func (pages Pages) ToResources() resource.Resources {
+ r := make(resource.Resources, len(pages))
+ for i, p := range pages {
+ r[i] = p
+ }
+ return r
+}