hugo/resources/page/page_nop.go

483 lines
7.8 KiB
Go
Raw Normal View History

// Copyright 2019 The Hugo Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package page contains the core interfaces and types for the Page resource,
// a core component in Hugo.
package page
import (
"html/template"
"time"
Introduce a tree map for all content This commit introduces a new data structure to store pages and their resources. This data structure is backed by radix trees. This simplies tree operations, makes all pages a bundle, and paves the way for #6310. It also solves a set of annoying issues (see list below). Not a motivation behind this, but this commit also makes Hugo in general a little bit faster and more memory effective (see benchmarks). Especially for partial rebuilds on content edits, but also when taxonomies is in use. ``` name old time/op new time/op delta SiteNew/Bundle_with_image/Edit-16 1.32ms ± 8% 1.00ms ± 9% -24.42% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 1.28ms ± 0% 0.94ms ± 0% -26.26% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 33.9ms ± 2% 21.8ms ± 1% -35.67% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 40.6ms ± 1% 37.7ms ± 3% -7.20% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 56.7ms ± 0% 51.7ms ± 1% -8.82% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 19.9ms ± 2% 18.3ms ± 3% -7.64% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 37.9ms ± 4% 34.0ms ± 2% -10.28% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 10.7ms ± 0% 10.6ms ± 0% -1.15% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 10.8ms ± 0% 10.7ms ± 0% -1.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 43.2ms ± 1% 39.6ms ± 1% -8.35% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 47.6ms ± 1% 47.3ms ± 0% ~ (p=0.057 n=4+4) SiteNew/Deep_content_tree-16 73.0ms ± 1% 74.2ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Many_HTML_templates-16 37.9ms ± 0% 38.1ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Page_collections-16 53.6ms ± 1% 54.7ms ± 1% +2.09% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Bundle_with_image/Edit-16 486kB ± 0% 430kB ± 0% -11.47% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 265kB ± 0% 209kB ± 0% -21.06% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 13.6MB ± 0% 8.8MB ± 0% -34.93% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 66.5MB ± 0% 63.9MB ± 0% -3.95% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 28.8MB ± 0% 25.8MB ± 0% -10.55% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 6.16MB ± 0% 5.56MB ± 0% -9.86% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 16.9MB ± 0% 16.0MB ± 0% -5.19% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 2.28MB ± 0% 2.29MB ± 0% +0.35% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 2.07MB ± 0% 2.07MB ± 0% ~ (p=0.114 n=4+4) SiteNew/Tags_and_categories-16 14.3MB ± 0% 13.2MB ± 0% -7.30% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 69.1MB ± 0% 69.0MB ± 0% ~ (p=0.343 n=4+4) SiteNew/Deep_content_tree-16 31.3MB ± 0% 31.8MB ± 0% +1.49% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 10.8MB ± 0% 10.9MB ± 0% +1.11% (p=0.029 n=4+4) SiteNew/Page_collections-16 21.4MB ± 0% 21.6MB ± 0% +1.15% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Bundle_with_image/Edit-16 4.74k ± 0% 3.86k ± 0% -18.57% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 4.73k ± 0% 3.85k ± 0% -18.58% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 301k ± 0% 198k ± 0% -34.14% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 389k ± 0% 373k ± 0% -4.07% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 338k ± 0% 262k ± 0% -22.63% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 102k ± 0% 88k ± 0% -13.81% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 176k ± 0% 152k ± 0% -13.32% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 273k ± 0% 245k ± 0% -10.36% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 396k ± 0% 398k ± 0% +0.39% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 317k ± 0% 325k ± 0% +2.53% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 146k ± 0% 147k ± 0% +0.98% (p=0.029 n=4+4) SiteNew/Page_collections-16 210k ± 0% 215k ± 0% +2.44% (p=0.029 n=4+4) ``` Fixes #6312 Fixes #6087 Fixes #6738 Fixes #6412 Fixes #6743 Fixes #6875 Fixes #6034 Fixes #6902 Fixes #6173 Fixes #6590
2019-09-10 05:26:34 -04:00
"github.com/gohugoio/hugo/hugofs/files"
"github.com/gohugoio/hugo/hugofs"
"github.com/bep/gitmap"
"github.com/gohugoio/hugo/navigation"
"github.com/gohugoio/hugo/common/hugo"
"github.com/gohugoio/hugo/common/maps"
"github.com/gohugoio/hugo/source"
"github.com/gohugoio/hugo/config"
"github.com/gohugoio/hugo/langs"
"github.com/gohugoio/hugo/media"
"github.com/gohugoio/hugo/related"
"github.com/gohugoio/hugo/resources/resource"
)
var (
NopPage Page = new(nopPage)
NilPage *nopPage
)
// PageNop implements Page, but does nothing.
type nopPage int
func (p *nopPage) Aliases() []string {
return nil
}
func (p *nopPage) Sitemap() config.Sitemap {
return config.Sitemap{}
}
func (p *nopPage) Layout() string {
return ""
}
func (p *nopPage) RSSLink() template.URL {
return ""
}
func (p *nopPage) Author() Author {
return Author{}
}
func (p *nopPage) Authors() AuthorList {
return nil
}
func (p *nopPage) AllTranslations() Pages {
return nil
}
func (p *nopPage) LanguagePrefix() string {
return ""
}
func (p *nopPage) AlternativeOutputFormats() OutputFormats {
return nil
}
func (p *nopPage) BaseFileName() string {
return ""
}
Introduce a tree map for all content This commit introduces a new data structure to store pages and their resources. This data structure is backed by radix trees. This simplies tree operations, makes all pages a bundle, and paves the way for #6310. It also solves a set of annoying issues (see list below). Not a motivation behind this, but this commit also makes Hugo in general a little bit faster and more memory effective (see benchmarks). Especially for partial rebuilds on content edits, but also when taxonomies is in use. ``` name old time/op new time/op delta SiteNew/Bundle_with_image/Edit-16 1.32ms ± 8% 1.00ms ± 9% -24.42% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 1.28ms ± 0% 0.94ms ± 0% -26.26% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 33.9ms ± 2% 21.8ms ± 1% -35.67% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 40.6ms ± 1% 37.7ms ± 3% -7.20% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 56.7ms ± 0% 51.7ms ± 1% -8.82% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 19.9ms ± 2% 18.3ms ± 3% -7.64% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 37.9ms ± 4% 34.0ms ± 2% -10.28% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 10.7ms ± 0% 10.6ms ± 0% -1.15% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 10.8ms ± 0% 10.7ms ± 0% -1.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 43.2ms ± 1% 39.6ms ± 1% -8.35% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 47.6ms ± 1% 47.3ms ± 0% ~ (p=0.057 n=4+4) SiteNew/Deep_content_tree-16 73.0ms ± 1% 74.2ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Many_HTML_templates-16 37.9ms ± 0% 38.1ms ± 1% ~ (p=0.114 n=4+4) SiteNew/Page_collections-16 53.6ms ± 1% 54.7ms ± 1% +2.09% (p=0.029 n=4+4) name old alloc/op new alloc/op delta SiteNew/Bundle_with_image/Edit-16 486kB ± 0% 430kB ± 0% -11.47% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 265kB ± 0% 209kB ± 0% -21.06% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 13.6MB ± 0% 8.8MB ± 0% -34.93% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 66.5MB ± 0% 63.9MB ± 0% -3.95% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 28.8MB ± 0% 25.8MB ± 0% -10.55% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 6.16MB ± 0% 5.56MB ± 0% -9.86% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 16.9MB ± 0% 16.0MB ± 0% -5.19% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 2.28MB ± 0% 2.29MB ± 0% +0.35% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 2.07MB ± 0% 2.07MB ± 0% ~ (p=0.114 n=4+4) SiteNew/Tags_and_categories-16 14.3MB ± 0% 13.2MB ± 0% -7.30% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 69.1MB ± 0% 69.0MB ± 0% ~ (p=0.343 n=4+4) SiteNew/Deep_content_tree-16 31.3MB ± 0% 31.8MB ± 0% +1.49% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 10.8MB ± 0% 10.9MB ± 0% +1.11% (p=0.029 n=4+4) SiteNew/Page_collections-16 21.4MB ± 0% 21.6MB ± 0% +1.15% (p=0.029 n=4+4) name old allocs/op new allocs/op delta SiteNew/Bundle_with_image/Edit-16 4.74k ± 0% 3.86k ± 0% -18.57% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file/Edit-16 4.73k ± 0% 3.85k ± 0% -18.58% (p=0.029 n=4+4) SiteNew/Tags_and_categories/Edit-16 301k ± 0% 198k ± 0% -34.14% (p=0.029 n=4+4) SiteNew/Canonify_URLs/Edit-16 389k ± 0% 373k ± 0% -4.07% (p=0.029 n=4+4) SiteNew/Deep_content_tree/Edit-16 338k ± 0% 262k ± 0% -22.63% (p=0.029 n=4+4) SiteNew/Many_HTML_templates/Edit-16 102k ± 0% 88k ± 0% -13.81% (p=0.029 n=4+4) SiteNew/Page_collections/Edit-16 176k ± 0% 152k ± 0% -13.32% (p=0.029 n=4+4) SiteNew/Bundle_with_image-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Bundle_with_JSON_file-16 26.8k ± 0% 26.8k ± 0% +0.05% (p=0.029 n=4+4) SiteNew/Tags_and_categories-16 273k ± 0% 245k ± 0% -10.36% (p=0.029 n=4+4) SiteNew/Canonify_URLs-16 396k ± 0% 398k ± 0% +0.39% (p=0.029 n=4+4) SiteNew/Deep_content_tree-16 317k ± 0% 325k ± 0% +2.53% (p=0.029 n=4+4) SiteNew/Many_HTML_templates-16 146k ± 0% 147k ± 0% +0.98% (p=0.029 n=4+4) SiteNew/Page_collections-16 210k ± 0% 215k ± 0% +2.44% (p=0.029 n=4+4) ``` Fixes #6312 Fixes #6087 Fixes #6738 Fixes #6412 Fixes #6743 Fixes #6875 Fixes #6034 Fixes #6902 Fixes #6173 Fixes #6590
2019-09-10 05:26:34 -04:00
func (p *nopPage) BundleType() files.ContentClass {
return ""
}
func (p *nopPage) Content() (interface{}, error) {
return "", nil
}
func (p *nopPage) ContentBaseName() string {
return ""
}
func (p *nopPage) CurrentSection() Page {
return nil
}
func (p *nopPage) Data() interface{} {
return nil
}
func (p *nopPage) Date() (t time.Time) {
return
}
func (p *nopPage) Description() string {
return ""
}
func (p *nopPage) RefFrom(argsm map[string]interface{}, source interface{}) (string, error) {
return "", nil
}
func (p *nopPage) RelRefFrom(argsm map[string]interface{}, source interface{}) (string, error) {
return "", nil
}
func (p *nopPage) Dir() string {
return ""
}
func (p *nopPage) Draft() bool {
return false
}
func (p *nopPage) Eq(other interface{}) bool {
return p == other
}
func (p *nopPage) ExpiryDate() (t time.Time) {
return
}
func (p *nopPage) Ext() string {
return ""
}
func (p *nopPage) Extension() string {
return ""
}
var nilFile *source.FileInfo
func (p *nopPage) File() source.File {
return nilFile
}
func (p *nopPage) FileInfo() hugofs.FileMetaInfo {
return nil
}
func (p *nopPage) Filename() string {
return ""
}
func (p *nopPage) FirstSection() Page {
return nil
}
func (p *nopPage) FuzzyWordCount() int {
return 0
}
func (p *nopPage) GetPage(ref string) (Page, error) {
return nil, nil
}
func (p *nopPage) GetParam(key string) interface{} {
return nil
}
2020-02-19 03:16:27 -05:00
func (p *nopPage) GetTerms(taxonomy string) Pages {
return nil
}
func (p *nopPage) GitInfo() *gitmap.GitInfo {
return nil
}
func (p *nopPage) HasMenuCurrent(menuID string, me *navigation.MenuEntry) bool {
return false
}
func (p *nopPage) HasShortcode(name string) bool {
return false
}
func (p *nopPage) Hugo() (h hugo.Info) {
return
}
func (p *nopPage) InSection(other interface{}) (bool, error) {
return false, nil
}
func (p *nopPage) IsAncestor(other interface{}) (bool, error) {
return false, nil
}
func (p *nopPage) IsDescendant(other interface{}) (bool, error) {
return false, nil
}
func (p *nopPage) IsDraft() bool {
return false
}
func (p *nopPage) IsHome() bool {
return false
}
func (p *nopPage) IsMenuCurrent(menuID string, inme *navigation.MenuEntry) bool {
return false
}
func (p *nopPage) IsNode() bool {
return false
}
func (p *nopPage) IsPage() bool {
return false
}
func (p *nopPage) IsSection() bool {
return false
}
func (p *nopPage) IsTranslated() bool {
return false
}
func (p *nopPage) Keywords() []string {
return nil
}
func (p *nopPage) Kind() string {
return ""
}
func (p *nopPage) Lang() string {
return ""
}
func (p *nopPage) Language() *langs.Language {
return nil
}
func (p *nopPage) Lastmod() (t time.Time) {
return
}
func (p *nopPage) Len() int {
return 0
}
func (p *nopPage) LinkTitle() string {
return ""
}
func (p *nopPage) LogicalName() string {
return ""
}
func (p *nopPage) MediaType() (m media.Type) {
return
}
func (p *nopPage) Menus() (m navigation.PageMenus) {
return
}
func (p *nopPage) Name() string {
return ""
}
func (p *nopPage) Next() Page {
return nil
}
func (p *nopPage) OutputFormats() OutputFormats {
return nil
}
func (p *nopPage) Pages() Pages {
return nil
}
func (p *nopPage) RegularPages() Pages {
return nil
}
func (p *nopPage) Paginate(seq interface{}, options ...interface{}) (*Pager, error) {
return nil, nil
}
func (p *nopPage) Paginator(options ...interface{}) (*Pager, error) {
return nil, nil
}
func (p *nopPage) Param(key interface{}) (interface{}, error) {
return nil, nil
}
func (p *nopPage) Params() maps.Params {
return nil
}
func (p *nopPage) Page() Page {
return p
}
func (p *nopPage) Parent() Page {
return nil
}
func (p *nopPage) Path() string {
return ""
}
func (p *nopPage) Permalink() string {
return ""
}
func (p *nopPage) Plain() string {
return ""
}
func (p *nopPage) PlainWords() []string {
return nil
}
func (p *nopPage) Prev() Page {
return nil
}
func (p *nopPage) PublishDate() (t time.Time) {
return
}
func (p *nopPage) PrevInSection() Page {
return nil
}
func (p *nopPage) NextInSection() Page {
return nil
}
func (p *nopPage) PrevPage() Page {
return nil
}
func (p *nopPage) NextPage() Page {
return nil
}
func (p *nopPage) RawContent() string {
return ""
}
func (p *nopPage) ReadingTime() int {
return 0
}
func (p *nopPage) Ref(argsm map[string]interface{}) (string, error) {
return "", nil
}
func (p *nopPage) RelPermalink() string {
return ""
}
func (p *nopPage) RelRef(argsm map[string]interface{}) (string, error) {
return "", nil
}
func (p *nopPage) Render(layout ...string) (template.HTML, error) {
return "", nil
}
func (p *nopPage) RenderString(args ...interface{}) (template.HTML, error) {
return "", nil
}
func (p *nopPage) ResourceType() string {
return ""
}
func (p *nopPage) Resources() resource.Resources {
return nil
}
func (p *nopPage) Scratch() *maps.Scratch {
return nil
}
func (p *nopPage) RelatedKeywords(cfg related.IndexConfig) ([]related.Keyword, error) {
return nil, nil
}
func (p *nopPage) Section() string {
return ""
}
func (p *nopPage) Sections() Pages {
return nil
}
func (p *nopPage) SectionsEntries() []string {
return nil
}
func (p *nopPage) SectionsPath() string {
return ""
}
func (p *nopPage) Site() Site {
return nil
}
func (p *nopPage) Sites() Sites {
return nil
}
func (p *nopPage) Slug() string {
return ""
}
func (p *nopPage) String() string {
return "nopPage"
}
func (p *nopPage) Summary() template.HTML {
return ""
}
func (p *nopPage) TableOfContents() template.HTML {
return ""
}
func (p *nopPage) Title() string {
return ""
}
func (p *nopPage) TranslationBaseName() string {
return ""
}
func (p *nopPage) TranslationKey() string {
return ""
}
func (p *nopPage) Translations() Pages {
return nil
}
func (p *nopPage) Truncated() bool {
return false
}
func (p *nopPage) Type() string {
return ""
}
func (p *nopPage) URL() string {
return ""
}
func (p *nopPage) UniqueID() string {
return ""
}
func (p *nopPage) Weight() int {
return 0
}
func (p *nopPage) WordCount() int {
return 0
}