From: Jim McDonald Date: Fri, 5 Apr 2019 17:11:04 +0000 (+0100) Subject: hugolib: Consider summary in front matter for .Summary X-Git-Tag: v0.55.0~9 X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=3a62d54745e2cbfda6772390830042908d725c71;p=brevno-suite%2Fhugo hugolib: Consider summary in front matter for .Summary Add the ability to have a `summary` page variable that overrides the auto-generated summary. Logic for obtaining summary becomes: * if summary divider is present in content, use the text above it * if summary variables is present in page metadata, use that * auto-generate summary from first _x_ words of the content Fixes #5800 --- diff --git a/helpers/content.go b/helpers/content.go index be5090c2..3892647b 100644 --- a/helpers/content.go +++ b/helpers/content.go @@ -42,6 +42,12 @@ import ( // SummaryDivider denotes where content summarization should end. The default is "". var SummaryDivider = []byte("") +var ( + openingPTag = []byte("

") + closingPTag = []byte("

") + paragraphIndicator = []byte("/

tags from HTML input in the situation +// where said tags are the only

tags in the input and enclose the content +// of the input (whitespace excluded). +func (c *ContentSpec) TrimShortHTML(input []byte) []byte { + first := bytes.Index(input, paragraphIndicator) + last := bytes.LastIndex(input, paragraphIndicator) + if first == last { + input = bytes.TrimSpace(input) + input = bytes.TrimPrefix(input, openingPTag) + input = bytes.TrimSuffix(input, closingPTag) + input = bytes.TrimSpace(input) + } + return input +} + func isEndOfSentence(r rune) bool { return r == '.' || r == '?' || r == '!' || r == '"' || r == '\n' } diff --git a/helpers/content_test.go b/helpers/content_test.go index 1dd4a2fb..709c8114 100644 --- a/helpers/content_test.go +++ b/helpers/content_test.go @@ -29,6 +29,28 @@ import ( const tstHTMLContent = "

content foobar. Follow up

This is some text.
And some more.

" +func TestTrimShortHTML(t *testing.T) { + tests := []struct { + input, output []byte + }{ + {[]byte(""), []byte("")}, + {[]byte("Plain text"), []byte("Plain text")}, + {[]byte(" \t\n Whitespace text\n\n"), []byte("Whitespace text")}, + {[]byte("

Simple paragraph

"), []byte("Simple paragraph")}, + {[]byte("\n \n \t

\t Whitespace\nHTML \n\t

\n\t"), []byte("Whitespace\nHTML")}, + {[]byte("

Multiple

paragraphs

"), []byte("

Multiple

paragraphs

")}, + {[]byte("

Nested

paragraphs

"), []byte("

Nested

paragraphs

")}, + } + + c := newTestContentSpec() + for i, test := range tests { + output := c.TrimShortHTML(test.input) + if bytes.Compare(test.output, output) != 0 { + t.Errorf("Test %d failed. Expected %q got %q", i, test.output, output) + } + } +} + func TestStripHTML(t *testing.T) { type test struct { input, expected string diff --git a/hugolib/page__meta.go b/hugolib/page__meta.go index 1e013db6..eefecbe4 100644 --- a/hugolib/page__meta.go +++ b/hugolib/page__meta.go @@ -64,6 +64,8 @@ type pageMeta struct { title string linkTitle string + summary string + resourcePath string weight int @@ -361,6 +363,9 @@ func (pm *pageMeta) setMetadata(p *pageState, frontmatter map[string]interface{} case "linktitle": pm.linkTitle = cast.ToString(v) pm.params[loki] = pm.linkTitle + case "summary": + pm.summary = cast.ToString(v) + pm.params[loki] = pm.summary case "description": pm.description = cast.ToString(v) pm.params[loki] = pm.description diff --git a/hugolib/page__per_output.go b/hugolib/page__per_output.go index 05b35cc8..177e0420 100644 --- a/hugolib/page__per_output.go +++ b/hugolib/page__per_output.go @@ -128,6 +128,14 @@ func newPageContentOutput(p *pageState) func(f output.Format) (*pageContentOutpu cp.summary = helpers.BytesToHTML(summary) } } + } else if cp.p.m.summary != "" { + html := cp.p.s.ContentSpec.RenderBytes(&helpers.RenderingContext{ + Content: []byte(cp.p.m.summary), RenderTOC: false, PageFmt: cp.p.m.markup, + Cfg: p.Language(), + DocumentID: p.File().UniqueID(), DocumentName: p.File().Path(), + Config: cp.p.getRenderingConfig()}) + html = cp.p.s.ContentSpec.TrimShortHTML(html) + cp.summary = helpers.BytesToHTML(html) } } @@ -271,7 +279,7 @@ func (p *pageContentOutput) WordCount() int { } func (p *pageContentOutput) setAutoSummary() error { - if p.p.source.hasSummaryDivider { + if p.p.source.hasSummaryDivider || p.p.m.summary != "" { return nil } diff --git a/hugolib/page_test.go b/hugolib/page_test.go index 6d9d337e..a3b86ef2 100644 --- a/hugolib/page_test.go +++ b/hugolib/page_test.go @@ -45,6 +45,16 @@ const ( simplePageRFC3339Date = "---\ntitle: RFC3339 Date\ndate: \"2013-05-17T16:59:30Z\"\n---\nrfc3339 content" + simplePageWithoutSummaryDelimiter = `--- +title: SimpleWithoutSummaryDelimiter +--- +[Lorem ipsum](https://lipsum.com/) dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. + +Additional text. + +Further text. +` + simplePageWithSummaryDelimiter = `--- title: Simple --- @@ -52,6 +62,16 @@ Summary Next Line Some more text +` + + simplePageWithSummaryParameter = `--- +title: SimpleWithSummaryParameter +summary: "Page with summary parameter and [a link](http://www.example.com/)" +--- + +Some text. + +Some more text. ` simplePageWithSummaryDelimiterAndMarkdownThatCrossesBorder = `--- @@ -519,6 +539,22 @@ func TestCreateNewPage(t *testing.T) { testAllMarkdownEnginesForPages(t, assertFunc, settings, simplePage) } +func TestPageSummary(t *testing.T) { + t.Parallel() + assertFunc := func(t *testing.T, ext string, pages page.Pages) { + p := pages[0] + checkPageTitle(t, p, "SimpleWithoutSummaryDelimiter") + // Source is not Asciidoctor- or RST-compatibile so don't test them + if ext != "ad" && ext != "rst" { + checkPageContent(t, p, normalizeExpected(ext, "

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

\n\n

Additional text.

\n\n

Further text.

\n"), ext) + checkPageSummary(t, p, normalizeExpected(ext, "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Additional text."), ext) + } + checkPageType(t, p, "page") + } + + testAllMarkdownEnginesForPages(t, assertFunc, nil, simplePageWithoutSummaryDelimiter) +} + func TestPageWithDelimiter(t *testing.T) { t.Parallel() assertFunc := func(t *testing.T, ext string, pages page.Pages) { @@ -532,6 +568,22 @@ func TestPageWithDelimiter(t *testing.T) { testAllMarkdownEnginesForPages(t, assertFunc, nil, simplePageWithSummaryDelimiter) } +func TestPageWithSummaryParameter(t *testing.T) { + t.Parallel() + assertFunc := func(t *testing.T, ext string, pages page.Pages) { + p := pages[0] + checkPageTitle(t, p, "SimpleWithSummaryParameter") + checkPageContent(t, p, normalizeExpected(ext, "

Some text.

\n\n

Some more text.

\n"), ext) + // Summary is not Asciidoctor- or RST-compatibile so don't test them + if ext != "ad" && ext != "rst" { + checkPageSummary(t, p, normalizeExpected(ext, "Page with summary parameter and a link"), ext) + } + checkPageType(t, p, "page") + } + + testAllMarkdownEnginesForPages(t, assertFunc, nil, simplePageWithSummaryParameter) +} + // Issue #3854 // Also see https://github.com/gohugoio/hugo/issues/3977 func TestPageWithDateFields(t *testing.T) { diff --git a/hugolib/rss_test.go b/hugolib/rss_test.go index 683a737c..38f0f1ef 100644 --- a/hugolib/rss_test.go +++ b/hugolib/rss_test.go @@ -55,6 +55,9 @@ func TestRSSOutput(t *testing.T) { if c != rssLimit { t.Errorf("incorrect RSS item count: expected %d, got %d", rssLimit, c) } + + // Encoded summary + th.assertFileContent(filepath.Join("public", rssURI), "") - markdownTrimSuffix = []byte("

\n") - markdownParagraphIndicator = []byte("