hugo/tpl/cast/init.go
Khayyam Saleem 5a72de2600 tpl: adds truth and bool template functions
The behavior of `truth` and `bool` is described in the corresponding
test cases and examples. The decision-making around the behavior is a
based on combination of the existing behavior of strconv.ParseBool in go
and the MDN definition of "truthy" as JavaScript has the most interop
with the Hugo ecosystem.

Addresses #9160 and (indirectly) #5792
2023-10-17 23:52:33 -04:00

78 lines
1.8 KiB
Go

// 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 cast
import (
"context"
"github.com/gohugoio/hugo/deps"
"github.com/gohugoio/hugo/tpl/internal"
)
const name = "cast"
func init() {
f := func(d *deps.Deps) *internal.TemplateFuncsNamespace {
ctx := New()
ns := &internal.TemplateFuncsNamespace{
Name: name,
Context: func(cctx context.Context, args ...any) (any, error) { return ctx, nil },
}
ns.AddMethodMapping(ctx.ToInt,
[]string{"int"},
[][2]string{
{`{{ "1234" | int | printf "%T" }}`, `int`},
},
)
ns.AddMethodMapping(ctx.ToString,
[]string{"string"},
[][2]string{
{`{{ 1234 | string | printf "%T" }}`, `string`},
},
)
ns.AddMethodMapping(ctx.ToFloat,
[]string{"float"},
[][2]string{
{`{{ "1234" | float | printf "%T" }}`, `float64`},
},
)
ns.AddMethodMapping(ctx.ToBool,
[]string{"bool"},
[][2]string{
{`{{ "0" | bool | printf "%T" }}`, `bool`},
{`{{ "true" | bool }}`, `true`},
{`{{ "false" | bool }}`, `false`},
},
)
ns.AddMethodMapping(ctx.ToTruth,
[]string{"truth"},
[][2]string{
{`{{ "1234" | truth | printf "%T" }}`, `bool`},
{`{{ "1234" | truth }}`, `true`},
{`{{ "" | truth }}`, `false`},
},
)
return ns
}
internal.AddTemplateFuncsNamespace(f)
}