Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add try #9797

Merged
merged 1 commit into from
Jan 5, 2025
Merged

Add try #9797

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion tpl/internal/go_templates/texttemplate/hugo_template.go
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ package template

import (
"context"
"fmt"
"io"
"reflect"

Expand Down Expand Up @@ -255,10 +256,32 @@ func (s *state) evalField(dot reflect.Value, fieldName string, node parse.Node,
panic("not reached")
}

// TryValue is what gets returned when using the "try" keyword.
type TryValue struct {
// Value is the value returned by the function or method wrapped with "try".
// This will always be nil if Err is set.
Value any
// Err is the error returned by the function or method wrapped with "try".
// This will always be nil if Value is set.
Err error
}

// evalCall executes a function or method call. If it's a method, fun already has the receiver bound, so
// it looks just like a function call. The arg list, if non-nil, includes (in the manner of the shell), arg[0]
// as the function itself.
func (s *state) evalCall(dot, fun reflect.Value, isBuiltin bool, node parse.Node, name string, args []parse.Node, final reflect.Value, first ...reflect.Value) reflect.Value {
func (s *state) evalCall(dot, fun reflect.Value, isBuiltin bool, node parse.Node, name string, args []parse.Node, final reflect.Value, first ...reflect.Value) (val reflect.Value) {
// Added for Hugo.
if name == "try" {
defer func() {
if r := recover(); r != nil {
if err, ok := r.(error); ok {
val = reflect.ValueOf(TryValue{nil, err})
} else {
val = reflect.ValueOf(TryValue{nil, fmt.Errorf("%v", r)})
}
}
}()
}
if args != nil {
args = args[1:] // Zeroth arg is function name/node; not passed to function.
}
Expand Down Expand Up @@ -371,6 +394,11 @@ func (s *state) evalCall(dot, fun reflect.Value, isBuiltin bool, node parse.Node
s.helper.OnCalled(s.ctx, s.prep, name, argv, vv)
}

// Added for Hugo.
if name == "try" {
return reflect.ValueOf(TryValue{vv.Interface(), nil})
}

return vv
}

Expand Down
2 changes: 1 addition & 1 deletion tpl/partials/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func init() {
},
)

// TODO(bep) we need the return to be a valid identifier, but
// TODO(bep) we need the return to be a valid identifiers, but
// should consider another way of adding it.
ns.AddMethodMapping(func() string { return "" },
[]string{"return"},
Expand Down
7 changes: 7 additions & 0 deletions tpl/safe/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ func init() {
},
)

ns.AddMethodMapping(func(v any) (any, error) {
return v, nil
},
[]string{"try"},
[][2]string{},
)

return ns
}

Expand Down
34 changes: 34 additions & 0 deletions tpl/templates/templates_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -93,3 +93,37 @@ Home: true

`)
}

func TestTry(t *testing.T) {
t.Parallel()

files := `
-- config.toml --
baseURL = 'http://example.com/'
-- layouts/index.html --
Home.
{{ $g := try ("hello = \"Hello Hugo\"" | transform.Unmarshal) }}
{{ with $g.Err }}
Err1: {{ . }}
{{ else }}
Value1: {{ $g.Value.hello | safeHTML }}|
{{ end }}
{{ $g := try ("hello != \"Hello Hugo\"" | transform.Unmarshal) }}
{{ with $g.Err }}
Err2: {{ . | safeHTML }}
{{ else }}
Value2: {{ $g.Value.hello | safeHTML }}|
{{ end }}
Try upper: {{ (try ("hello" | upper)).Value }}
Try printf: {{ (try (printf "hello %s" "world")).Value }}
`

b := hugolib.Test(t, files)

b.AssertFileContent("public/index.html",
"Value1: Hello Hugo|",
"Err2: template: index.html:",
"Try upper: HELLO",
"Try printf: hello world",
)
}
Loading