From 8182a27ed4f7a65b97f07b6b24be6b1c40b45c01 Mon Sep 17 00:00:00 2001 From: Joe Mooring Date: Fri, 27 Oct 2023 09:07:14 -0700 Subject: [PATCH] Simplify example usage of apply function --- content/en/functions/collections/Apply.md | 102 +++------------------- 1 file changed, 12 insertions(+), 90 deletions(-) diff --git a/content/en/functions/collections/Apply.md b/content/en/functions/collections/Apply.md index d7401908a..4d972b853 100644 --- a/content/en/functions/collections/Apply.md +++ b/content/en/functions/collections/Apply.md @@ -1,7 +1,7 @@ --- title: collections.Apply linkTitle: apply -description: Given an array or slice, `apply` returns a new slice with a function applied over it. +description: Returns a new collection with each element transformed by the given function. categories: [functions] keywords: [] menu: @@ -9,8 +9,8 @@ menu: parent: functions function: aliases: [apply] - returnType: any - signatures: ['collections.Apply COLLECTION FUNCTION [PARAM...]'] + returnType: '[]any' + signatures: [collections.Apply COLLECTION FUNCTION PARAM...] relatedFunctions: - collections.Apply - collections.Delimit @@ -21,95 +21,17 @@ relatedFunctions: aliases: [/functions/apply] --- -`apply` expects at least three arguments, depending on the function being applied. +The `apply` function takes three or more arguments, depending on the function being applied to the collection elements. -1. The first argument is the sequence to operate on. -2. The second argument is the name of the function as a string, which must be the name of a valid [template function]. -3. After that, the arguments to the applied function are provided, with the string `"."` standing in for each element of the sequence the function is to be applied against. +The first argument is the collection itself, the second argument is the function name, and the remaining arguments are passed to the function, with the string `"."` representing the collection element. -Here is an example of a content file with `names:` as a front matter field: - -{{< code-toggle file="content/example.md" fm=true copy=false >}} -title: Example -names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ] -{{< /code-toggle >}} - -You can then use `apply` as follows: ```go-html-template -{{ apply .Params.names "urlize" "." }} +{{ $s := slice "hello" "world" }} + +{{ $s = apply $s "strings.FirstUpper" "." }} +{{ $s }} → [Hello World] + +{{ $s = apply $s "strings.Replace" "." "l" "_" }} +{{ $s }} → [He__o Wor_d] ``` - -Which will result in the following: - -``` -"derek-perkins", "joe-bergevin", "tanner-linsley" -``` - -This is *roughly* equivalent to using the following with [`range`]: - -```go-html-template -{{ range .Params.names }}{{ . | urlize }}{{ end }} -``` - -However, it is not possible to provide the output of a range to the [`delimit`]function, so you need to `apply` it. - -If you have `post-tag-list.html` and `post-tag-link.html` as [partials], you *could* use the following snippets, respectively: - -{{< code file="layouts/partials/post-tag-list.html" copy=false >}} -{{ with .Params.tags }} -
- Tags: - {{ $len := len . }} - {{ if eq $len 1 }} - {{ partial "post-tag-link.html" (index . 0) }} - {{ else }} - {{ $last := sub $len 1 }} - {{ range first $last . }} - {{ partial "post-tag-link.html" . }}, - {{ end }} - {{ partial "post-tag-link.html" (index . $last) }} - {{ end }} -
-{{ end }} -{{< /code >}} - -{{< code file="layouts/partials/post-tag-link.html" copy=false >}} -{{ . }} -{{< /code >}} - -This works, but the complexity of `post-tag-list.html` is fairly high. The Hugo template needs to perform special behavior for the case where there’s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like `Tags: tag1 , tag2 , tag3` because of the way that the HTML is generated and then interpreted by a browser. - -This first version of `layouts/partials/post-tag-list.html` separates all of the operations for ease of reading. The combined and DRYer version is shown next: - -```go-html-template -{{ with .Params.tags }} -
- Tags: - {{ $sort := sort . }} - {{ $links := apply $sort "partial" "post-tag-link.html" "." }} - {{ $clean := apply $links "chomp" "." }} - {{ delimit $clean ", " }} -
-{{ end }} -``` - -Now in the completed version, you can sort the tags, convert the tags to links with `layouts/partials/post-tag-link.html`, [`chomp`] stray newlines, and join the tags together in a delimited list for presentation. Here is an even DRYer version of the preceding example: - -{{< code file="layouts/partials/post-tag-list.html" >}} -{{ with .Params.tags }} -
- Tags: - {{ delimit (apply (apply (sort .) "partial" "post-tag-link.html" ".") "chomp" ".") ", " }} -
-{{ end }} -{{< /code >}} - -{{% note %}} -`apply` does not work when receiving the sequence as an argument through a pipeline. -{{% /note %}} - -[`chomp`]: /functions/strings/chomp/ -[`delimit`]: /functions/collections/delimit/ -[template function]: /functions/ -[`range`]: /functions/go-template/range/