mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-07 20:30:36 -05:00
tpl: updates cast.ToTruth to conform to hreflect.IsTruthful
Concession from review, where cast.ToTruth should behave exactly like hreflect.IsTruthful. Additionally, cast.ToBool always returns a bool with nil error.
This commit is contained in:
parent
5a72de2600
commit
28434238db
3 changed files with 22 additions and 30 deletions
|
@ -20,23 +20,21 @@ aliases: []
|
||||||
|
|
||||||
Useful for turning different types into booleans based on their [truthy-ness](https://developer.mozilla.org/en-US/docs/Glossary/Truthy).
|
Useful for turning different types into booleans based on their [truthy-ness](https://developer.mozilla.org/en-US/docs/Glossary/Truthy).
|
||||||
|
|
||||||
It follows the same rules as [`bool`](/functions/bool), but with increased flexibility.
|
|
||||||
|
|
||||||
```
|
```
|
||||||
{{ truth "true" }} → true
|
{{ truth "true" }} → true
|
||||||
{{ truth "false" }} → false
|
{{ truth "false" }} → true
|
||||||
|
|
||||||
{{ truth "TRUE" }} → true
|
{{ truth "TRUE" }} → true
|
||||||
{{ truth "FALSE" }} → false
|
{{ truth "FALSE" }} → true
|
||||||
|
|
||||||
{{ truth "t" }} → true
|
{{ truth "t" }} → true
|
||||||
{{ truth "f" }} → false
|
{{ truth "f" }} → true
|
||||||
|
|
||||||
{{ truth "T" }} → true
|
{{ truth "T" }} → true
|
||||||
{{ truth "F" }} → false
|
{{ truth "F" }} → true
|
||||||
|
|
||||||
{{ truth "1" }} → true
|
{{ truth "1" }} → true
|
||||||
{{ truth "0" }} → false
|
{{ truth "0" }} → true
|
||||||
|
|
||||||
{{ truth 1 }} → true
|
{{ truth 1 }} → true
|
||||||
{{ truth 0 }} → false
|
{{ truth 0 }} → false
|
||||||
|
|
|
@ -17,6 +17,7 @@ package cast
|
||||||
import (
|
import (
|
||||||
"html/template"
|
"html/template"
|
||||||
|
|
||||||
|
"github.com/gohugoio/hugo/common/hreflect"
|
||||||
_cast "github.com/spf13/cast"
|
_cast "github.com/spf13/cast"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -49,23 +50,18 @@ func (ns *Namespace) ToFloat(v any) (float64, error) {
|
||||||
// ToBool converts v to a boolean.
|
// ToBool converts v to a boolean.
|
||||||
func (ns *Namespace) ToBool(v any) (bool, error) {
|
func (ns *Namespace) ToBool(v any) (bool, error) {
|
||||||
v = convertTemplateToString(v)
|
v = convertTemplateToString(v)
|
||||||
return _cast.ToBoolE(v)
|
result, err := _cast.ToBoolE(v)
|
||||||
|
if err != nil {
|
||||||
|
return false, nil
|
||||||
|
}
|
||||||
|
return result, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// ToTruth yields the same behavior as ToBool when possible.
|
// ToTruth yields the same behavior as ToBool when possible.
|
||||||
// If the cast is unsuccessful, ToTruth converts v to a boolean using the JavaScript [definition of truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy).
|
// If the cast is unsuccessful, ToTruth converts v to a boolean using the JavaScript [definition of truthy](https://developer.mozilla.org/en-US/docs/Glossary/Truthy).
|
||||||
// Accordingly, it never yields an error, but maintains the signature of other cast methods for consistency.
|
// Accordingly, it never yields an error, but maintains the signature of other cast methods for consistency.
|
||||||
func (ns *Namespace) ToTruth(v any) (bool, error) {
|
func (ns *Namespace) ToTruth(v any) (bool, error) {
|
||||||
result, err := ns.ToBool(v)
|
return hreflect.IsTruthful(v), nil
|
||||||
if err != nil {
|
|
||||||
switch v {
|
|
||||||
case "", "nil", "null", "undefined", "NaN":
|
|
||||||
return false, nil
|
|
||||||
default:
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func convertTemplateToString(v any) any {
|
func convertTemplateToString(v any) any {
|
||||||
|
|
|
@ -144,10 +144,8 @@ func TestToBool(t *testing.T) {
|
||||||
{false, false, nil},
|
{false, false, nil},
|
||||||
{nil, false, nil},
|
{nil, false, nil},
|
||||||
|
|
||||||
// error cases
|
{"cheese", false, nil},
|
||||||
{"cheese", nil, false},
|
{"", false, nil},
|
||||||
{"", nil, false},
|
|
||||||
{1.67, nil, false},
|
|
||||||
} {
|
} {
|
||||||
errMsg := qt.Commentf("[%d] %v", i, test.v)
|
errMsg := qt.Commentf("[%d] %v", i, test.v)
|
||||||
|
|
||||||
|
@ -173,15 +171,15 @@ func TestToTruth(t *testing.T) {
|
||||||
expect any
|
expect any
|
||||||
}{
|
}{
|
||||||
{"true", true},
|
{"true", true},
|
||||||
{"false", false},
|
{"false", true},
|
||||||
{"TRUE", true},
|
{"TRUE", true},
|
||||||
{"FALSE", false},
|
{"FALSE", true},
|
||||||
{"t", true},
|
{"t", true},
|
||||||
{"f", false},
|
{"f", true},
|
||||||
{"T", true},
|
{"T", true},
|
||||||
{"F", false},
|
{"F", true},
|
||||||
{"1", true},
|
{"1", true},
|
||||||
{"0", false},
|
{"0", true},
|
||||||
{1, true},
|
{1, true},
|
||||||
{0, false},
|
{0, false},
|
||||||
{"cheese", true},
|
{"cheese", true},
|
||||||
|
@ -194,9 +192,9 @@ func TestToTruth(t *testing.T) {
|
||||||
{template.JSStr("6"), true},
|
{template.JSStr("6"), true},
|
||||||
{t, true},
|
{t, true},
|
||||||
{nil, false},
|
{nil, false},
|
||||||
{"null", false},
|
{"null", true},
|
||||||
{"undefined", false},
|
{"undefined", true},
|
||||||
{"NaN", false},
|
{"NaN", true},
|
||||||
} {
|
} {
|
||||||
errMsg := qt.Commentf("[%d] %v", i, test.v)
|
errMsg := qt.Commentf("[%d] %v", i, test.v)
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue