github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-21 20:46:30 -05:00
Code Issues Projects Releases Packages Wiki Activity

Do not return error on .Get "class" and vice versa in shortcodes

Browse source 
The current error handling makes parameter checking in shortcodes too verbose for no good reason.

Fixes #4745
This commit is contained in:
Bjørn Erik Pedersen 2018-05-21 17:47:52 +02:00
parent 0a7027e2a8
commit 2f17f9378a
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
hugolib/shortcode.go
View file

@ -85,7 +85,10 @@ func (scp *ShortcodeWithPage) Get(key interface{}) interface{} {
switch key.(type) { switch key.(type) {
case int64, int32, int16, int8, int: case int64, int32, int16, int8, int:
if reflect.TypeOf(scp.Params).Kind() == reflect.Map { if reflect.TypeOf(scp.Params).Kind() == reflect.Map {
return "error: cannot access named params by position" // We treat this as a non error, so people can do similar to
// {{ $myParam := .Get "myParam" | default .Get 0 }}
// Without having to do additional checks.
return nil
} else if reflect.TypeOf(scp.Params).Kind() == reflect.Slice { } else if reflect.TypeOf(scp.Params).Kind() == reflect.Slice {
idx := int(reflect.ValueOf(key).Int()) idx := int(reflect.ValueOf(key).Int())
ln := reflect.ValueOf(scp.Params).Len() ln := reflect.ValueOf(scp.Params).Len()
@ -101,10 +104,10 @@ func (scp *ShortcodeWithPage) Get(key interface{}) interface{} {
return "" return ""
} }
} else if reflect.TypeOf(scp.Params).Kind() == reflect.Slice { } else if reflect.TypeOf(scp.Params).Kind() == reflect.Slice {
if reflect.ValueOf(scp.Params).Len() == 1 && reflect.ValueOf(scp.Params).Index(0).String() == "" { // We treat this as a non error, so people can do similar to
return nil // {{ $myParam := .Get "myParam" | default .Get 0 }}
} // Without having to do additional checks.
return "error: cannot access positional params by string name" return nil
} }
} }

9
hugolib/shortcode_test.go
View file

@ -185,17 +185,14 @@ func TestNestedNamedMissingParam(t *testing.T) {
func TestIsNamedParamsSC(t *testing.T) { func TestIsNamedParamsSC(t *testing.T) {
t.Parallel() t.Parallel()
wt := func(tem tpl.TemplateHandler) error { wt := func(tem tpl.TemplateHandler) error {
tem.AddTemplate("_internal/shortcodes/byposition.html", `<div id="{{ .Get 0 }}">`) tem.AddTemplate("_internal/shortcodes/bynameorposition.html", `{{ with .Get "id" }}Named: {{ . }}{{ else }}Pos: {{ .Get 0 }}{{ end }}`)
tem.AddTemplate("_internal/shortcodes/byname.html", `<div id="{{ .Get "id" }}">`)
tem.AddTemplate("_internal/shortcodes/ifnamedparams.html", `<div id="{{ if .IsNamedParams }}{{ .Get "id" }}{{ else }}{{ .Get 0 }}{{end}}">`) tem.AddTemplate("_internal/shortcodes/ifnamedparams.html", `<div id="{{ if .IsNamedParams }}{{ .Get "id" }}{{ else }}{{ .Get 0 }}{{end}}">`)
return nil return nil
} }
CheckShortCodeMatch(t, `{{< ifnamedparams id="name" >}}`, `<div id="name">`, wt) CheckShortCodeMatch(t, `{{< ifnamedparams id="name" >}}`, `<div id="name">`, wt)
CheckShortCodeMatch(t, `{{< ifnamedparams position >}}`, `<div id="position">`, wt) CheckShortCodeMatch(t, `{{< ifnamedparams position >}}`, `<div id="position">`, wt)
CheckShortCodeMatch(t, `{{< byname id="name" >}}`, `<div id="name">`, wt) CheckShortCodeMatch(t, `{{< bynameorposition id="name" >}}`, `Named: name`, wt)
CheckShortCodeMatch(t, `{{< byname position >}}`, `<div id="error: cannot access positional params by string name">`, wt) CheckShortCodeMatch(t, `{{< bynameorposition position >}}`, `Pos: position`, wt)
CheckShortCodeMatch(t, `{{< byposition position >}}`, `<div id="position">`, wt)
CheckShortCodeMatch(t, `{{< byposition id="name" >}}`, `<div id="error: cannot access named params by position">`, wt)
} }
func TestInnerSC(t *testing.T) { func TestInnerSC(t *testing.T) {