mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-21 20:46:30 -05:00
Finally remove deprecated Page methods
They have been deprecated for a very long time, first with a warning, then with an ERROR. Now they are removed. Closes #4117
This commit is contained in:
parent
c707b71cdf
commit
9563c7d13b
6 changed files with 13 additions and 112 deletions
|
@ -78,7 +78,6 @@ type pageCommon struct {
|
||||||
page.RefProvider
|
page.RefProvider
|
||||||
page.ShortcodeInfoProvider
|
page.ShortcodeInfoProvider
|
||||||
page.SitesProvider
|
page.SitesProvider
|
||||||
page.DeprecatedWarningPageMethods
|
|
||||||
page.TranslationsProvider
|
page.TranslationsProvider
|
||||||
page.TreeProvider
|
page.TreeProvider
|
||||||
resource.LanguageProvider
|
resource.LanguageProvider
|
||||||
|
|
|
@ -20,7 +20,6 @@ import (
|
||||||
"github.com/gohugoio/hugo/common/hugo"
|
"github.com/gohugoio/hugo/common/hugo"
|
||||||
|
|
||||||
"github.com/gohugoio/hugo/common/maps"
|
"github.com/gohugoio/hugo/common/maps"
|
||||||
"github.com/gohugoio/hugo/source"
|
|
||||||
|
|
||||||
"github.com/gohugoio/hugo/output"
|
"github.com/gohugoio/hugo/output"
|
||||||
|
|
||||||
|
@ -65,15 +64,6 @@ func newPageBase(metaProvider *pageMeta) (*pageState, error) {
|
||||||
|
|
||||||
siteAdapter := pageSiteAdapter{s: s, p: ps}
|
siteAdapter := pageSiteAdapter{s: s, p: ps}
|
||||||
|
|
||||||
deprecatedWarningPage := struct {
|
|
||||||
source.FileWithoutOverlap
|
|
||||||
page.DeprecatedWarningPageMethods1
|
|
||||||
}{
|
|
||||||
FileWithoutOverlap: metaProvider.File(),
|
|
||||||
DeprecatedWarningPageMethods1: &pageDeprecatedWarning{p: ps},
|
|
||||||
}
|
|
||||||
|
|
||||||
ps.DeprecatedWarningPageMethods = page.NewDeprecatedWarningPage(deprecatedWarningPage)
|
|
||||||
ps.pageMenus = &pageMenus{p: ps}
|
ps.pageMenus = &pageMenus{p: ps}
|
||||||
ps.PageMenusProvider = ps.pageMenus
|
ps.PageMenusProvider = ps.pageMenus
|
||||||
ps.GetPageProvider = siteAdapter
|
ps.GetPageProvider = siteAdapter
|
||||||
|
|
|
@ -24,7 +24,6 @@ import (
|
||||||
"github.com/gohugoio/hugo/config"
|
"github.com/gohugoio/hugo/config"
|
||||||
"github.com/gohugoio/hugo/tpl"
|
"github.com/gohugoio/hugo/tpl"
|
||||||
|
|
||||||
"github.com/gohugoio/hugo/common/hugo"
|
|
||||||
"github.com/gohugoio/hugo/common/maps"
|
"github.com/gohugoio/hugo/common/maps"
|
||||||
"github.com/gohugoio/hugo/compare"
|
"github.com/gohugoio/hugo/compare"
|
||||||
"github.com/gohugoio/hugo/hugofs/files"
|
"github.com/gohugoio/hugo/hugofs/files"
|
||||||
|
@ -379,18 +378,7 @@ type TreeProvider interface {
|
||||||
// DeprecatedWarningPageMethods lists deprecated Page methods that will trigger
|
// DeprecatedWarningPageMethods lists deprecated Page methods that will trigger
|
||||||
// a WARNING if invoked.
|
// a WARNING if invoked.
|
||||||
// This was added in Hugo 0.55.
|
// This was added in Hugo 0.55.
|
||||||
type DeprecatedWarningPageMethods interface {
|
type DeprecatedWarningPageMethods interface { // This was emptied in Hugo 0.93.0.
|
||||||
source.FileWithoutOverlap
|
|
||||||
DeprecatedWarningPageMethods1
|
|
||||||
}
|
|
||||||
|
|
||||||
type DeprecatedWarningPageMethods1 interface {
|
|
||||||
IsDraft() bool
|
|
||||||
Hugo() hugo.Info
|
|
||||||
LanguagePrefix() string
|
|
||||||
GetParam(key string) interface{}
|
|
||||||
RSSLink() template.URL
|
|
||||||
URL() string
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Move here to trigger ERROR instead of WARNING.
|
// Move here to trigger ERROR instead of WARNING.
|
||||||
|
|
|
@ -47,7 +47,6 @@ const header = `// Copyright 2019 The Hugo Authors. All rights reserved.
|
||||||
`
|
`
|
||||||
|
|
||||||
var (
|
var (
|
||||||
fileInterfaceDeprecated = reflect.TypeOf((*source.FileWithoutOverlap)(nil)).Elem()
|
|
||||||
pageInterfaceDeprecated = reflect.TypeOf((*page.DeprecatedWarningPageMethods)(nil)).Elem()
|
pageInterfaceDeprecated = reflect.TypeOf((*page.DeprecatedWarningPageMethods)(nil)).Elem()
|
||||||
pageInterface = reflect.TypeOf((*page.Page)(nil)).Elem()
|
pageInterface = reflect.TypeOf((*page.Page)(nil)).Elem()
|
||||||
|
|
||||||
|
@ -155,23 +154,17 @@ func generateDeprecatedWrappers(c *codegen.Inspector) error {
|
||||||
}
|
}
|
||||||
|
|
||||||
deprecated := func(name string, tp reflect.Type) string {
|
deprecated := func(name string, tp reflect.Type) string {
|
||||||
var alternative string
|
alternative, found := reasons[name]
|
||||||
if tp == fileInterfaceDeprecated {
|
|
||||||
alternative = "Use .File." + name
|
|
||||||
} else {
|
|
||||||
var found bool
|
|
||||||
alternative, found = reasons[name]
|
|
||||||
if !found {
|
if !found {
|
||||||
panic(fmt.Sprintf("no deprecated reason found for %q", name))
|
panic(fmt.Sprintf("no deprecated reason found for %q", name))
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Sprintf("helpers.Deprecated(%q, %q, true)", "Page."+name, alternative)
|
return fmt.Sprintf("helpers.Deprecated(%q, %q, true)", "Page."+name, alternative)
|
||||||
}
|
}
|
||||||
|
|
||||||
var buff bytes.Buffer
|
var buff bytes.Buffer
|
||||||
|
|
||||||
methods := c.MethodsFromTypes([]reflect.Type{fileInterfaceDeprecated, pageInterfaceDeprecated}, nil)
|
methods := c.MethodsFromTypes([]reflect.Type{pageInterfaceDeprecated}, nil)
|
||||||
|
|
||||||
for _, m := range methods {
|
for _, m := range methods {
|
||||||
fmt.Fprint(&buff, m.Declaration("*pageDeprecated"))
|
fmt.Fprint(&buff, m.Declaration("*pageDeprecated"))
|
||||||
|
@ -181,7 +174,8 @@ func generateDeprecatedWrappers(c *codegen.Inspector) error {
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pkgImports := append(methods.Imports(), "github.com/gohugoio/hugo/helpers")
|
pkgImports := methods.Imports()
|
||||||
|
// pkgImports := append(methods.Imports(), "github.com/gohugoio/hugo/helpers")
|
||||||
|
|
||||||
fmt.Fprintf(f, `%s
|
fmt.Fprintf(f, `%s
|
||||||
|
|
||||||
|
|
|
@ -17,9 +17,6 @@ package page
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"html/template"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/bep/gitmap"
|
"github.com/bep/gitmap"
|
||||||
"github.com/gohugoio/hugo/common/maps"
|
"github.com/gohugoio/hugo/common/maps"
|
||||||
"github.com/gohugoio/hugo/config"
|
"github.com/gohugoio/hugo/config"
|
||||||
|
@ -29,6 +26,8 @@ import (
|
||||||
"github.com/gohugoio/hugo/media"
|
"github.com/gohugoio/hugo/media"
|
||||||
"github.com/gohugoio/hugo/navigation"
|
"github.com/gohugoio/hugo/navigation"
|
||||||
"github.com/gohugoio/hugo/source"
|
"github.com/gohugoio/hugo/source"
|
||||||
|
"html/template"
|
||||||
|
"time"
|
||||||
)
|
)
|
||||||
|
|
||||||
func MarshalPageToJSON(p Page) ([]byte, error) {
|
func MarshalPageToJSON(p Page) ([]byte, error) {
|
||||||
|
@ -69,7 +68,8 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
|
||||||
linkTitle := p.LinkTitle()
|
linkTitle := p.LinkTitle()
|
||||||
isNode := p.IsNode()
|
isNode := p.IsNode()
|
||||||
isPage := p.IsPage()
|
isPage := p.IsPage()
|
||||||
path := p.Pathc()
|
path := p.Path()
|
||||||
|
pathc := p.Pathc()
|
||||||
slug := p.Slug()
|
slug := p.Slug()
|
||||||
lang := p.Lang()
|
lang := p.Lang()
|
||||||
isSection := p.IsSection()
|
isSection := p.IsSection()
|
||||||
|
@ -127,6 +127,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
|
||||||
IsNode bool
|
IsNode bool
|
||||||
IsPage bool
|
IsPage bool
|
||||||
Path string
|
Path string
|
||||||
|
Pathc string
|
||||||
Slug string
|
Slug string
|
||||||
Lang string
|
Lang string
|
||||||
IsSection bool
|
IsSection bool
|
||||||
|
@ -183,6 +184,7 @@ func MarshalPageToJSON(p Page) ([]byte, error) {
|
||||||
IsNode: isNode,
|
IsNode: isNode,
|
||||||
IsPage: isPage,
|
IsPage: isPage,
|
||||||
Path: path,
|
Path: path,
|
||||||
|
Pathc: pathc,
|
||||||
Slug: slug,
|
Slug: slug,
|
||||||
Lang: lang,
|
Lang: lang,
|
||||||
IsSection: isSection,
|
IsSection: isSection,
|
||||||
|
|
|
@ -15,13 +15,6 @@
|
||||||
|
|
||||||
package page
|
package page
|
||||||
|
|
||||||
import (
|
|
||||||
"github.com/gohugoio/hugo/common/hugo"
|
|
||||||
"github.com/gohugoio/hugo/helpers"
|
|
||||||
"github.com/gohugoio/hugo/hugofs"
|
|
||||||
"html/template"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewDeprecatedWarningPage adds deprecation warnings to the given implementation.
|
// NewDeprecatedWarningPage adds deprecation warnings to the given implementation.
|
||||||
func NewDeprecatedWarningPage(p DeprecatedWarningPageMethods) DeprecatedWarningPageMethods {
|
func NewDeprecatedWarningPage(p DeprecatedWarningPageMethods) DeprecatedWarningPageMethods {
|
||||||
return &pageDeprecated{p: p}
|
return &pageDeprecated{p: p}
|
||||||
|
@ -30,68 +23,3 @@ func NewDeprecatedWarningPage(p DeprecatedWarningPageMethods) DeprecatedWarningP
|
||||||
type pageDeprecated struct {
|
type pageDeprecated struct {
|
||||||
p DeprecatedWarningPageMethods
|
p DeprecatedWarningPageMethods
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *pageDeprecated) Filename() string {
|
|
||||||
helpers.Deprecated("Page.Filename", "Use .File.Filename", true)
|
|
||||||
return p.p.Filename()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) Dir() string {
|
|
||||||
helpers.Deprecated("Page.Dir", "Use .File.Dir", true)
|
|
||||||
return p.p.Dir()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) IsDraft() bool {
|
|
||||||
helpers.Deprecated("Page.IsDraft", "Use .Draft.", true)
|
|
||||||
return p.p.IsDraft()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) Extension() string {
|
|
||||||
helpers.Deprecated("Page.Extension", "Use .File.Extension", true)
|
|
||||||
return p.p.Extension()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) Hugo() hugo.Info {
|
|
||||||
helpers.Deprecated("Page.Hugo", "Use the global hugo function.", true)
|
|
||||||
return p.p.Hugo()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) Ext() string {
|
|
||||||
helpers.Deprecated("Page.Ext", "Use .File.Ext", true)
|
|
||||||
return p.p.Ext()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) LanguagePrefix() string {
|
|
||||||
helpers.Deprecated("Page.LanguagePrefix", "Use .Site.LanguagePrefix.", true)
|
|
||||||
return p.p.LanguagePrefix()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) GetParam(arg0 string) interface{} {
|
|
||||||
helpers.Deprecated("Page.GetParam", "Use .Param or .Params.myParam.", true)
|
|
||||||
return p.p.GetParam(arg0)
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) LogicalName() string {
|
|
||||||
helpers.Deprecated("Page.LogicalName", "Use .File.LogicalName", true)
|
|
||||||
return p.p.LogicalName()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) BaseFileName() string {
|
|
||||||
helpers.Deprecated("Page.BaseFileName", "Use .File.BaseFileName", true)
|
|
||||||
return p.p.BaseFileName()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) RSSLink() template.URL {
|
|
||||||
helpers.Deprecated("Page.RSSLink", "Use the Output Format's link, e.g. something like:\n {{ with .OutputFormats.Get \"RSS\" }}{{ .RelPermalink }}{{ end }}", true)
|
|
||||||
return p.p.RSSLink()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) TranslationBaseName() string {
|
|
||||||
helpers.Deprecated("Page.TranslationBaseName", "Use .File.TranslationBaseName", true)
|
|
||||||
return p.p.TranslationBaseName()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) URL() string {
|
|
||||||
helpers.Deprecated("Page.URL", "Use .Permalink or .RelPermalink. If what you want is the front matter URL value, use .Params.url", true)
|
|
||||||
return p.p.URL()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) ContentBaseName() string {
|
|
||||||
helpers.Deprecated("Page.ContentBaseName", "Use .File.ContentBaseName", true)
|
|
||||||
return p.p.ContentBaseName()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) UniqueID() string {
|
|
||||||
helpers.Deprecated("Page.UniqueID", "Use .File.UniqueID", true)
|
|
||||||
return p.p.UniqueID()
|
|
||||||
}
|
|
||||||
func (p *pageDeprecated) FileInfo() hugofs.FileMetaInfo {
|
|
||||||
helpers.Deprecated("Page.FileInfo", "Use .File.FileInfo", true)
|
|
||||||
return p.p.FileInfo()
|
|
||||||
}
|
|
||||||
|
|
Loading…
Reference in a new issue