Make Page.Content a method that returns interface{}

To prepare for a `Resource.Content` method.

See #4622

diff --git a/hugolib/embedded_shortcodes_test.go b/hugolib/embedded_shortcodes_test.go
index 50da35c5b6979af5a47068ffc513f2b264d8298c..fb663f1cb3d7587ddcc8e73053a9efb0538f9df0 100644 (file)
--- a/hugolib/embedded_shortcodes_test.go
+++ b/hugolib/embedded_shortcodes_test.go
@@ -69,7 +69,7 @@ func doTestShortcodeCrossrefs(t *testing.T, relative bool) {
 
        require.Len(t, s.RegularPages, 1)
 
-       output := string(s.RegularPages[0].Content)
+       output := string(s.RegularPages[0].content)
 
        if !strings.Contains(output, expected) {
                t.Errorf("Got\n%q\nExpected\n%q", output, expected)

diff --git a/hugolib/hugo_sites_build_test.go b/hugolib/hugo_sites_build_test.go
index 1626fadcffcfb6f514930f6f91bf9e9978da11d0..0515def4ebc7f6340be0f371a82a5587a77c7af3 100644 (file)
--- a/hugolib/hugo_sites_build_test.go
+++ b/hugolib/hugo_sites_build_test.go
@@ -378,9 +378,9 @@ func doTestMultiSitesBuild(t *testing.T, configTemplate, configSuffix string) {
        b.AssertFileContent("public/en/tags/tag1/index.html", "Tag1|Hello|http://example.com/blog/en/tags/tag1/")
 
        // Check Blackfriday config
-       require.True(t, strings.Contains(string(doc1fr.Content), "«"), string(doc1fr.Content))
-       require.False(t, strings.Contains(string(doc1en.Content), "«"), string(doc1en.Content))
-       require.True(t, strings.Contains(string(doc1en.Content), "“"), string(doc1en.Content))
+       require.True(t, strings.Contains(string(doc1fr.content), "«"), string(doc1fr.content))
+       require.False(t, strings.Contains(string(doc1en.content), "«"), string(doc1en.content))
+       require.True(t, strings.Contains(string(doc1en.content), "“"), string(doc1en.content))
 
        // Check that the drafts etc. are not built/processed/rendered.
        assertShouldNotBuild(t, b.H)
@@ -630,9 +630,9 @@ func assertShouldNotBuild(t *testing.T, sites *HugoSites) {
        for _, p := range s.rawAllPages {
                // No HTML when not processed
                require.Equal(t, p.shouldBuild(), bytes.Contains(p.workContent, []byte("</")), p.BaseFileName()+": "+string(p.workContent))
-               require.Equal(t, p.shouldBuild(), p.Content != "", p.BaseFileName())
+               require.Equal(t, p.shouldBuild(), p.content != "", p.BaseFileName())
 
-               require.Equal(t, p.shouldBuild(), p.Content != "", p.BaseFileName())
+               require.Equal(t, p.shouldBuild(), p.content != "", p.BaseFileName())
 
        }
 }

diff --git a/hugolib/page.go b/hugolib/page.go
index 195e68084ac4f46f3ec1c45fef6738e4b1682b7e..8595c1b352e07852e029e8742d492e6d97306b74 100644 (file)
--- a/hugolib/page.go
+++ b/hugolib/page.go
@@ -128,7 +128,7 @@ type Page struct {
        params map[string]interface{}
 
        // Content sections
-       Content         template.HTML
+       content         template.HTML
        Summary         template.HTML
        TableOfContents template.HTML
 
@@ -263,6 +263,10 @@ type Page struct {
        targetPathDescriptorPrototype *targetPathDescriptor
 }
 
+func (p *Page) Content() (interface{}, error) {
+       return p.content, nil
+}
+
 // Sites is a convenience method to get all the Hugo sites/languages configured.
 func (p *Page) Sites() SiteInfos {
        infos := make(SiteInfos, len(p.s.owner.Sites))
@@ -462,7 +466,7 @@ func (p *Page) PlainWords() []string {
 
 func (p *Page) initPlain() {
        p.plainInit.Do(func() {
-               p.plain = helpers.StripHTML(string(p.Content))
+               p.plain = helpers.StripHTML(string(p.content))
                return
        })
 }
@@ -1098,7 +1102,7 @@ func (p *Page) prepareForRender(cfg *BuildCfg) error {
                        workContentCopy = summaryContent.content
                }
 
-               p.Content = helpers.BytesToHTML(workContentCopy)
+               p.content = helpers.BytesToHTML(workContentCopy)
 
                if summaryContent == nil {
                        if err := p.setAutoSummary(); err != nil {
@@ -1107,7 +1111,7 @@ func (p *Page) prepareForRender(cfg *BuildCfg) error {
                }
 
        } else {
-               p.Content = helpers.BytesToHTML(workContentCopy)
+               p.content = helpers.BytesToHTML(workContentCopy)
        }
 
        //analyze for raw stats
@@ -1720,7 +1724,7 @@ func (p *Page) prepareLayouts() error {
        if p.Kind == KindPage {
                if !p.IsRenderable() {
                        self := "__" + p.UniqueID()
-                       err := p.s.TemplateHandler().AddLateTemplate(self, string(p.Content))
+                       err := p.s.TemplateHandler().AddLateTemplate(self, string(p.content))
                        if err != nil {
                                return err
                        }

diff --git a/hugolib/pageSort.go b/hugolib/pageSort.go
index a9477059de974ae289ff39b4601cfe2d841e96fc..26682a3c82c3d268fade0b6ed8b93b749f2a2988 100644 (file)
--- a/hugolib/pageSort.go
+++ b/hugolib/pageSort.go
@@ -237,7 +237,7 @@ func (p Pages) ByLength() Pages {
        key := "pageSort.ByLength"
 
        length := func(p1, p2 *Page) bool {
-               return len(p1.Content) < len(p2.Content)
+               return len(p1.content) < len(p2.content)
        }
 
        pages, _ := spc.get(key, pageBy(length).Sort, p)

diff --git a/hugolib/pageSort_test.go b/hugolib/pageSort_test.go
index d9c0d0761c043298381bac57e7fb77c8c7cc70a8..2b0ceb367ede18c757750582c3ad7dc38d130c9a 100644 (file)
--- a/hugolib/pageSort_test.go
+++ b/hugolib/pageSort_test.go
@@ -80,7 +80,7 @@ func TestSortByN(t *testing.T) {
                {(Pages).ByPublishDate, func(p Pages) bool { return p[0].PublishDate == d4 }},
                {(Pages).ByExpiryDate, func(p Pages) bool { return p[0].ExpiryDate == d4 }},
                {(Pages).ByLastmod, func(p Pages) bool { return p[1].Lastmod == d3 }},
-               {(Pages).ByLength, func(p Pages) bool { return p[0].Content == "b_content" }},
+               {(Pages).ByLength, func(p Pages) bool { return p[0].content == "b_content" }},
        } {
                setSortVals([4]time.Time{d1, d2, d3, d4}, [4]string{"b", "ab", "cde", "fg"}, [4]int{0, 3, 2, 1}, p)
 
@@ -168,7 +168,7 @@ func setSortVals(dates [4]time.Time, titles [4]string, weights [4]int, pages Pag
                pages[len(dates)-1-i].linkTitle = pages[i].title + "l"
                pages[len(dates)-1-i].PublishDate = dates[i]
                pages[len(dates)-1-i].ExpiryDate = dates[i]
-               pages[len(dates)-1-i].Content = template.HTML(titles[i] + "_content")
+               pages[len(dates)-1-i].content = template.HTML(titles[i] + "_content")
        }
        lastLastMod := pages[2].Lastmod
        pages[2].Lastmod = pages[1].Lastmod

diff --git a/hugolib/page_bundler_test.go b/hugolib/page_bundler_test.go
index becf8c6223512858187804d3e57ecb36a7c21fb7..d6aac177413bf5055835043d7398f6e25b54d3c3 100644 (file)
--- a/hugolib/page_bundler_test.go
+++ b/hugolib/page_bundler_test.go
@@ -87,7 +87,7 @@ func TestPageBundlerSiteRegular(t *testing.T) {
                                assert.Equal(singlePage, s.getPage("page", "a/1"))
                                assert.Equal(singlePage, s.getPage("page", "1"))
 
-                               assert.Contains(singlePage.Content, "TheContent")
+                               assert.Contains(singlePage.content, "TheContent")
 
                                if ugly {
                                        assert.Equal("/a/1.html", singlePage.RelPermalink())
@@ -129,7 +129,7 @@ func TestPageBundlerSiteRegular(t *testing.T) {
                                firstPage := pageResources[0].(*Page)
                                secondPage := pageResources[1].(*Page)
                                assert.Equal(filepath.FromSlash("b/my-bundle/1.md"), firstPage.pathOrTitle(), secondPage.pathOrTitle())
-                               assert.Contains(firstPage.Content, "TheContent")
+                               assert.Contains(firstPage.content, "TheContent")
                                assert.Equal(6, len(leafBundle1.Resources))
 
                                // https://github.com/gohugoio/hugo/issues/4582
@@ -395,7 +395,7 @@ HEADLESS {{< myShort >}}
        assert.Equal("Headless Bundle in Topless Bar", headless.Title())
        assert.Equal("", headless.RelPermalink())
        assert.Equal("", headless.Permalink())
-       assert.Contains(headless.Content, "HEADLESS SHORTCODE")
+       assert.Contains(headless.content, "HEADLESS SHORTCODE")
 
        headlessResources := headless.Resources
        assert.Equal(3, len(headlessResources))
@@ -404,7 +404,7 @@ HEADLESS {{< myShort >}}
        assert.NotNil(pageResource)
        assert.IsType(&Page{}, pageResource)
        p := pageResource.(*Page)
-       assert.Contains(p.Content, "SHORTCODE")
+       assert.Contains(p.content, "SHORTCODE")
        assert.Equal("p1.md", p.Name())
 
        th := testHelper{s.Cfg, s.Fs, t}

diff --git a/hugolib/page_test.go b/hugolib/page_test.go
index 2b679c84272892e7e166d65f0e69b1a46889d2ef..308bf31cb3f4dbdcb595e7cca5e5f5d5508df1cc 100644 (file)
--- a/hugolib/page_test.go
+++ b/hugolib/page_test.go
@@ -481,7 +481,7 @@ func checkPageTitle(t *testing.T, page *Page, title string) {
 
 func checkPageContent(t *testing.T, page *Page, content string, msg ...interface{}) {
        a := normalizeContent(content)
-       b := normalizeContent(string(page.Content))
+       b := normalizeContent(string(page.content))
        if a != b {
                t.Fatalf("Page content is:\n%q\nExpected:\n%q (%q)", b, a, msg)
        }
@@ -616,7 +616,7 @@ func testAllMarkdownEnginesForPages(t *testing.T,
                require.NoError(t, err)
                require.NotNil(t, home)
                require.Equal(t, homePath, home.Path())
-               require.Contains(t, home.Content, "Home Page Content")
+               require.Contains(t, home.content, "Home Page Content")
 
        }
 
@@ -726,8 +726,8 @@ func TestPageWithDelimiterForMarkdownThatCrossesBorder(t *testing.T) {
                t.Fatalf("Got summary:\n%q", p.Summary)
        }
 
-       if p.Content != template.HTML("<p>The <a href=\"http://gohugo.io/\">best static site generator</a>.<sup class=\"footnote-ref\" id=\"fnref:1\"><a href=\"#fn:1\">1</a></sup>\n</p>\n<div class=\"footnotes\">\n\n<hr />\n\n<ol>\n<li id=\"fn:1\">Many people say so.\n <a class=\"footnote-return\" href=\"#fnref:1\"><sup>[return]</sup></a></li>\n</ol>\n</div>") {
-               t.Fatalf("Got content:\n%q", p.Content)
+       if p.content != template.HTML("<p>The <a href=\"http://gohugo.io/\">best static site generator</a>.<sup class=\"footnote-ref\" id=\"fnref:1\"><a href=\"#fn:1\">1</a></sup>\n</p>\n<div class=\"footnotes\">\n\n<hr />\n\n<ol>\n<li id=\"fn:1\">Many people say so.\n <a class=\"footnote-return\" href=\"#fnref:1\"><sup>[return]</sup></a></li>\n</ol>\n</div>") {
+               t.Fatalf("Got content:\n%q", p.content)
        }
 }
 
@@ -1511,7 +1511,7 @@ func TestPageSimpleMethods(t *testing.T) {
        } {
 
                p, _ := s.NewPage("Test")
-               p.Content = "<h1>Do Be Do Be Do</h1>"
+               p.content = "<h1>Do Be Do Be Do</h1>"
                if !this.assertFunc(p) {
                        t.Errorf("[%d] Page method error", i)
                }

diff --git a/hugolib/shortcode_test.go b/hugolib/shortcode_test.go
index 449d55abd5717d0b14d60563926cbbe01a887daf..51f99830b38618b3a1b47c7c31f99a505c130780 100644 (file)
--- a/hugolib/shortcode_test.go
+++ b/hugolib/shortcode_test.go
@@ -87,7 +87,7 @@ title: "Title"
 
        require.Len(t, h.Sites[0].RegularPages, 1)
 
-       output := strings.TrimSpace(string(h.Sites[0].RegularPages[0].Content))
+       output := strings.TrimSpace(string(h.Sites[0].RegularPages[0].content))
        output = strings.TrimPrefix(output, "<p>")
        output = strings.TrimSuffix(output, "</p>")