Consolidate the Param methods

Maps in Viper, Hugo's config backing store, is now properly lower-cased not just on top level, the current situation.

While this is mostly a good thing, as you don't need to know the original casing to look up a value, it will be breaking for people doing direct lookups in the ´Site.Params` map.

We will try to find a solution to this "breakage", but the recommended method to get params values is via the `.Param` methods.

This method is now implemented on `Node`, `Page` and `Site` and is case-insensitive:

* Use `.Param "someKey" ` if you want page param with fall back to site param if not found on page.
* Use `.Site.Param "someKey"` to get a site param

See #2590

diff --git a/hugolib/node.go b/hugolib/node.go
index 566fd47993e334c3565f5f64dbe51b067ace59eb..eefb78becd70c6932d1b4552792716610aceea6f 100644 (file)
--- a/hugolib/node.go
+++ b/hugolib/node.go
@@ -24,8 +24,6 @@ import (
        jww "github.com/spf13/jwalterweatherman"
 
        "github.com/spf13/hugo/helpers"
-
-       "github.com/spf13/cast"
 )
 
 type Node struct {
@@ -124,13 +122,9 @@ func (n *Node) IsMenuCurrent(menuID string, inme *MenuEntry) bool {
 
 // Param is a convenience method to do lookups in Site's Params map.
 //
-// This method is also implemented on Page.
+// This method is also implemented on Page and SiteInfo.
 func (n *Node) Param(key interface{}) (interface{}, error) {
-       keyStr, err := cast.ToStringE(key)
-       if err != nil {
-               return nil, err
-       }
-       return n.Site.Params[keyStr], err
+       return n.Site.Param(key)
 }
 
 func (n *Node) Hugo() *HugoInfo {

diff --git a/hugolib/page.go b/hugolib/page.go
index 99ef6e41368fdc830a22b2ae10f9bbf985708b20..508bf252a1fcf3b5a71aa18effd41e24f68bbc2e 100644 (file)
--- a/hugolib/page.go
+++ b/hugolib/page.go
@@ -194,12 +194,13 @@ func (p *Page) IsPage() bool {
 // Param is a convenience method to do lookups in Page's and Site's Params map,
 // in that order.
 //
-// This method is also implemented on Node.
+// This method is also implemented on Node and SiteInfo.
 func (p *Page) Param(key interface{}) (interface{}, error) {
        keyStr, err := cast.ToStringE(key)
        if err != nil {
                return nil, err
        }
+       keyStr = strings.ToLower(keyStr)
        if val, ok := p.Params[keyStr]; ok {
                return val, nil
        }

diff --git a/hugolib/site.go b/hugolib/site.go
index 7b74aa02ffc0921d2ba4848f09ad353ea8d21595..f6a787298dc5d605655449d19c5d582fc910e6b1 100644 (file)
--- a/hugolib/site.go
+++ b/hugolib/site.go
@@ -223,8 +223,21 @@ func newSiteInfoDefaultLanguage(baseURL string, pages ...*Page) *SiteInfo {
 // linkedin
 type SiteSocial map[string]string
 
+// Param is a convenience method to do lookups in Site's Params map.
+//
+// This method is also implemented on Page and Node.
+func (s *SiteInfo) Param(key interface{}) (interface{}, error) {
+       keyStr, err := cast.ToStringE(key)
+       if err != nil {
+               return nil, err
+       }
+       keyStr = strings.ToLower(keyStr)
+       return s.Params[keyStr], nil
+}
+
 // GetParam gets a site parameter value if found, nil if not.
 func (s *SiteInfo) GetParam(key string) interface{} {
+       helpers.Deprecated("SiteInfo", ".GetParam", ".Param")
        v := s.Params[strings.ToLower(key)]
 
        if v == nil {