github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/hugolib/page_test.go

541 lines
20 KiB
Go
Raw Normal View History

Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
package hugolib
import (
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
"html/template"
"path"
"strings"
"testing"
"time"
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
)
var EMPTY_PAGE = ""
Add IsRenderable to Page As pages are read from the target, they will be assessed if they should be rendered or not. The logic for IsRenderable is in the parser/page.go and looks for anything exception '<'.
2013-09-18 13:17:43 -04:00
const (
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE = "---\ntitle: Simple\n---\nSimple Page\n"
INVALID_FRONT_MATTER_MISSING = "This is a test"
RENDER_NO_FRONT_MATTER = "<!doctype><html><head></head><body>This is a test</body></html>"
INVALID_FRONT_MATTER_SHORT_DELIM = `
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
--
title: Short delim start
---
Short Delim
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
INVALID_FRONT_MATTER_SHORT_DELIM_ENDING = `
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
---
title: Short delim ending
--
Short Delim
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
INVALID_FRONT_MATTER_LEADING_WS = `
Further work on path/section stuff. Tests passing now.
2013-08-14 08:57:14 -04:00
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
---
title: Leading WS
---
Leading
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_JSON = `
Adding more test cases
2013-08-07 02:04:49 -04:00
{
"title": "spf13-vim 3.0 release and new website",
"description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim.",
"tags": [ ".vimrc", "plugins", "spf13-vim", "vim" ],
"date": "2012-04-06",
"categories": [
"Development",
"VIM"
],
"slug": "spf13-vim-3-0-release-and-new-website"
}
Switching to the rjson library which is more friendly to human generated json.
2013-10-01 22:45:24 -04:00
Content of the file goes Here
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_JSON_LOOSE = `
Switching to the rjson library which is more friendly to human generated json.
2013-10-01 22:45:24 -04:00
{
"title": "spf13-vim 3.0 release and new website"
"description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
"tags": [ ".vimrc", "plugins", "spf13-vim", "vim" ]
"date": "2012-04-06"
"categories": [
"Development"
"VIM"
],
"slug": "spf13-vim-3-0-release-and-new-website"
}
Further work on path/section stuff. Tests passing now.
2013-08-14 08:57:14 -04:00
Content of the file goes Here
Adding more test cases
2013-08-07 02:04:49 -04:00
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_RFC3339_DATE = "---\ntitle: RFC3339 Date\ndate: \"2013-05-17T16:59:30Z\"\n---\nrfc3339 content"
SIMPLE_PAGE_JSON_MULTIPLE = `
Adding more test cases
2013-08-07 02:04:49 -04:00
{
"title": "foobar",
"customData": { "foo": "bar" },
"date": "2012-08-06"
}
Some text
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_JSON_COMPACT = `
Adding more test cases
2013-08-07 02:04:49 -04:00
{"title":"foobar","customData":{"foo":"bar"},"date":"2012-08-06"}
Text
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_NOLAYOUT = `---
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
title: simple_no_layout
---
No Layout called out`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_LAYOUT_FOOBAR = `---
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
title: simple layout foobar
layout: foobar
---
Layout foobar`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_TYPE_FOOBAR = `---
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
type: foobar
---
type foobar`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_TYPE_LAYOUT = `---
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
type: barfoo
layout: buzfoo
---
type and layout set`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_WITH_SUMMARY_DELIMITER = `---
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
title: Simple
---
Fix parsing edge case of frontmatter When the frontmatter contains a - (or other delimiter) close to the closing frontmatter delimiter, frontmatter detection would fail.
2013-09-18 12:15:46 -04:00
Summary Next Line
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
<!--more-->
Restoring former snippet behavior & adding test to ensure future behavior
2013-10-04 12:28:28 -04:00
Some more text
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_WITH_SHORTCODE_IN_SUMMARY = `---
Restoring former snippet behavior & adding test to ensure future behavior
2013-10-04 12:28:28 -04:00
title: Simple
---
Summary Next Line. {{% img src="/not/real" %}}.
More text here.
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
Some more text
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_WITH_SUMMARY_DELIMITER_SAME_LINE = `---
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
title: Simple
---
Fix parsing edge case of frontmatter When the frontmatter contains a - (or other delimiter) close to the closing frontmatter delimiter, frontmatter detection would fail.
2013-09-18 12:15:46 -04:00
Summary Same Line<!--more-->
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
Some more text
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
`
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
SIMPLE_PAGE_WITH_LONG_CONTENT = `---
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
title: Simple
---
Moved TOC test into page_test. Some general page_test cleanup.
2014-01-28 23:09:24 -05:00
Lorem ipsum dolor sit amet, consectetur adipisicing 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. Lorem ipsum dolor sit
amet, consectetur adipisicing 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. Lorem ipsum dolor sit amet,
consectetur adipisicing 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. Lorem ipsum dolor sit amet, consectetur
adipisicing 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. Lorem ipsum dolor sit amet, consectetur adipisicing 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. Lorem
ipsum dolor sit amet, consectetur adipisicing 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. Lorem ipsum dolor sit
amet, consectetur adipisicing 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.`
PAGE_WITH_TOC = `---
title: TOC
---
For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.
## AA
I have no idea, of course, how long it took me to reach the limit of the plain,
but at last I entered the foothills, following a pretty little canyon upward
toward the mountains. Beside me frolicked a laughing brooklet, hurrying upon
its noisy way down to the silent sea. In its quieter pools I discovered many
small fish, of four-or five-pound weight I should imagine. In appearance,
except as to size and color, they were not unlike the whale of our own seas. As
I watched them playing about I discovered, not only that they suckled their
young, but that at intervals they rose to the surface to breathe as well as to
feed upon certain grasses and a strange, scarlet lichen which grew upon the
rocks just above the water line.
### AAA
I remember I felt an extraordinary persuasion that I was being played with,
that presently, when I was upon the very verge of safety, this mysterious
death--as swift as the passage of light--would leap after me from the pit about
the cylinder and strike me down. ## BB
### BBB
"You're a great Granser," he cried delightedly, "always making believe them little marks mean something."
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
`
Add IsRenderable to Page As pages are read from the target, they will be assessed if they should be rendered or not. The logic for IsRenderable is in the parser/page.go and looks for anything exception '<'.
2013-09-18 13:17:43 -04:00
)
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
Adding support for more front matter types (int, float & date)
2013-10-24 17:31:04 -04:00
var PAGE_WITH_VARIOUS_FRONTMATTER_TYPES = `+++
a_string = "bar"
an_integer = 1
a_float = 1.3
a_date = 1979-05-27T07:32:00Z
+++
Front Matter with various frontmatter types`
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
func checkError(t *testing.T, err error, expected string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if err == nil {
t.Fatalf("err is nil. Expected: %s", expected)
}
if err.Error() != expected {
t.Errorf("err.Error() returned: '%s'. Expected: '%s'", err.Error(), expected)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
func TestDegenerateEmptyPageZeroLengthName(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
_, err := ReadFrom(strings.NewReader(EMPTY_PAGE), "")
if err == nil {
t.Fatalf("A zero length page name must return an error")
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
checkError(t, err, "Zero length page name")
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
func TestDegenerateEmptyPage(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
_, err := ReadFrom(strings.NewReader(EMPTY_PAGE), "test")
if err != nil {
t.Fatalf("Empty files should not trigger an error. Should be able to touch a file while watching without erroring out.")
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
//checkError(t, err, "EOF")
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
func checkPageTitle(t *testing.T, page *Page, title string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Title != title {
t.Fatalf("Page title is: %s. Expected %s", page.Title, title)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
func checkPageContent(t *testing.T, page *Page, content string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Content != template.HTML(content) {
Moved TOC test into page_test. Some general page_test cleanup.
2014-01-28 23:09:24 -05:00
t.Fatalf("Page content is: %q\nExpected: %q", page.Content, content)
}
}
func checkPageTOC(t *testing.T, page *Page, toc string) {
if page.TableOfContents != template.HTML(toc) {
t.Fatalf("Page TableOfContents is: %q.\nExpected %q", page.TableOfContents, toc)
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
func checkPageSummary(t *testing.T, page *Page, summary string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Summary != template.HTML(summary) {
Moved TOC test into page_test. Some general page_test cleanup.
2014-01-28 23:09:24 -05:00
t.Fatalf("Page summary is: %q.\nExpected %q", page.Summary, summary)
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
}
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
func checkPageType(t *testing.T, page *Page, pageType string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Type() != pageType {
t.Fatalf("Page type is: %s. Expected: %s", page.Type(), pageType)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
func checkPageLayout(t *testing.T, page *Page, layout ...string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if !listEqual(page.Layout(), layout) {
t.Fatalf("Page layout is: %s. Expected: %s", page.Layout(), layout)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Date rendering unit tests in pages Tests to ensure rendering dates in templates is working correctly. Actually, I was running into invalid templates not giving warnings when I was trying to render a date.
2013-09-03 17:51:06 -04:00
func checkPageDate(t *testing.T, page *Page, time time.Time) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Date != time {
t.Fatalf("Page date is: %s. Expected: %s", page.Date, time)
}
Date rendering unit tests in pages Tests to ensure rendering dates in templates is working correctly. Actually, I was running into invalid templates not giving warnings when I was trying to render a date.
2013-09-03 17:51:06 -04:00
}
Truncated; .Site.Params; First function * Add `.Truncated` bool to each page; will be set true if the `.Summary` is truncated and it's worth showing a "more" link of some kind. * Add `Params` to the site config, defining `.Site.Params` accessible to each page; this lets the site maintainer associate arbitrary data with names, on a site-wide basis. * Provide a `First` function to templates: * Use-case: `{{range First 5 .Site.Recent}}` or anything else which is a simple iterable provided by hugolib * Tests by me for `.Truncated` and `First` Also @noahcampbell contributed towards this: * Add UnitTest for `.Site.Params`: > Digging into this test case a bit more, I'm realizing that we need > to create a param test case to ensure that for each type we render > (page, index, homepage, rss, etc.) that the proper fields are > represented. This will help us refactor without fear in the > future. Sample config.yaml: ```yaml title: "Test site" params: Subtitle: "More tests always good" AuthorName: "John Doe" SidebarRecentLimit: 5 ``` Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-10 15:04:51 -05:00
func checkTruncation(t *testing.T, page *Page, shouldBe bool, msg string) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if page.Summary == "" {
t.Fatal("page has no summary, can not check truncation")
}
if page.Truncated != shouldBe {
if shouldBe {
t.Fatalf("page wasn't truncated: %s", msg)
} else {
t.Fatalf("page was truncated: %s", msg)
}
}
Truncated; .Site.Params; First function * Add `.Truncated` bool to each page; will be set true if the `.Summary` is truncated and it's worth showing a "more" link of some kind. * Add `Params` to the site config, defining `.Site.Params` accessible to each page; this lets the site maintainer associate arbitrary data with names, on a site-wide basis. * Provide a `First` function to templates: * Use-case: `{{range First 5 .Site.Recent}}` or anything else which is a simple iterable provided by hugolib * Tests by me for `.Truncated` and `First` Also @noahcampbell contributed towards this: * Add UnitTest for `.Site.Params`: > Digging into this test case a bit more, I'm realizing that we need > to create a param test case to ensure that for each type we render > (page, index, homepage, rss, etc.) that the proper fields are > represented. This will help us refactor without fear in the > future. Sample config.yaml: ```yaml title: "Test site" params: Subtitle: "More tests always good" AuthorName: "John Doe" SidebarRecentLimit: 5 ``` Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-10 15:04:51 -05:00
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
func TestCreateNewPage(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE), "simple.md")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "Simple")
checkPageContent(t, p, "<p>Simple Page</p>\n")
checkPageSummary(t, p, "Simple Page")
checkPageType(t, p, "page")
checkPageLayout(t, p, "page/single.html", "single.html")
checkTruncation(t, p, false, "simple short page")
Wordpress summaries Allow full control of summaries which can be rendered as html rather than text. Using a `<!--more-->` html comment in your markdown / rst you can indiciate where the summary should end and have the summary converted to html. Signed-off-by: Noah Campbell <noahcampbell@gmail.com> Conflicts: hugolib/page_test.go
2013-08-21 05:37:14 -04:00
}
func TestPageWithDelimiter(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SUMMARY_DELIMITER), "simple.md")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "Simple")
checkPageContent(t, p, "<p>Summary Next Line</p>\n\n<p>Some more text</p>\n")
checkPageSummary(t, p, "<p>Summary Next Line</p>\n")
checkPageType(t, p, "page")
checkPageLayout(t, p, "page/single.html", "single.html")
checkTruncation(t, p, true, "page with summary delimiter")
Restoring former snippet behavior & adding test to ensure future behavior
2013-10-04 12:28:28 -04:00
}
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
Restoring former snippet behavior & adding test to ensure future behavior
2013-10-04 12:28:28 -04:00
func TestPageWithShortCodeInSummary(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SHORTCODE_IN_SUMMARY), "simple.md")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "Simple")
checkPageContent(t, p, "<p>Summary Next Line. {{% img src=&ldquo;/not/real&rdquo; %}}.\nMore text here.</p>\n\n<p>Some more text</p>\n")
checkPageSummary(t, p, "Summary Next Line. . More text here. Some more text")
checkPageType(t, p, "page")
checkPageLayout(t, p, "page/single.html", "single.html")
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
}
Moved TOC test into page_test. Some general page_test cleanup.
2014-01-28 23:09:24 -05:00
func TestTableOfContents(t *testing.T) {
p, err := ReadFrom(strings.NewReader(PAGE_WITH_TOC), "tocpage.md")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageContent(t, p, "\n\n<p>For some moments the old man did not reply. He stood with bowed head, buried in deep thought. But at last he spoke.</p>\n\n<h2 id=\"toc_0\">AA</h2>\n\n<p>I have no idea, of course, how long it took me to reach the limit of the plain,\nbut at last I entered the foothills, following a pretty little canyon upward\ntoward the mountains. Beside me frolicked a laughing brooklet, hurrying upon\nits noisy way down to the silent sea. In its quieter pools I discovered many\nsmall fish, of four-or five-pound weight I should imagine. In appearance,\nexcept as to size and color, they were not unlike the whale of our own seas. As\nI watched them playing about I discovered, not only that they suckled their\nyoung, but that at intervals they rose to the surface to breathe as well as to\nfeed upon certain grasses and a strange, scarlet lichen which grew upon the\nrocks just above the water line.</p>\n\n<h3 id=\"toc_1\">AAA</h3>\n\n<p>I remember I felt an extraordinary persuasion that I was being played with,\nthat presently, when I was upon the very verge of safety, this mysterious\ndeath&mdash;as swift as the passage of light&mdash;would leap after me from the pit about\nthe cylinder and strike me down. ## BB</p>\n\n<h3 id=\"toc_2\">BBB</h3>\n\n<p>&ldquo;You&rsquo;re a great Granser,&rdquo; he cried delightedly, &ldquo;always making believe them little marks mean something.&rdquo;</p>\n")
checkPageTOC(t, p, "<nav id=\"TableOfContents\">\n<ul>\n<li>\n<ul>\n<li><a href=\"#toc_0\">AA</a>\n<ul>\n<li><a href=\"#toc_1\">AAA</a></li>\n<li><a href=\"#toc_2\">BBB</a></li>\n</ul></li>\n</ul></li>\n</ul>\n</nav>")
}
The <!--more--> (summary divider) now works even if it is on the same line as content Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-01 00:07:22 -04:00
func TestPageWithMoreTag(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SUMMARY_DELIMITER_SAME_LINE), "simple.md")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "Simple")
checkPageContent(t, p, "<p>Summary Same Line</p>\n\n<p>Some more text</p>\n")
checkPageSummary(t, p, "<p>Summary Same Line</p>\n")
checkPageType(t, p, "page")
checkPageLayout(t, p, "page/single.html", "single.html")
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Date rendering unit tests in pages Tests to ensure rendering dates in templates is working correctly. Actually, I was running into invalid templates not giving warnings when I was trying to render a date.
2013-09-03 17:51:06 -04:00
func TestPageWithDate(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_RFC3339_DATE), "simple")
p.Convert()
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
d, err := time.Parse(time.RFC3339, "2013-05-17T16:59:30Z")
if err != nil {
t.Fatalf("Unable to prase page.")
}
checkPageDate(t, p, d)
Date rendering unit tests in pages Tests to ensure rendering dates in templates is working correctly. Actually, I was running into invalid templates not giving warnings when I was trying to render a date.
2013-09-03 17:51:06 -04:00
}
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
func TestWordCount(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_LONG_CONTENT), "simple.md")
p.Convert()
Big refactor of pages code. Changed TOC code to only parse when actually used
2014-01-27 17:16:28 -05:00
p.analyzePage()
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if p.WordCount != 483 {
t.Fatalf("incorrect word count. expected %v, got %v", 483, p.WordCount)
}
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if p.FuzzyWordCount != 500 {
t.Fatalf("incorrect word count. expected %v, got %v", 500, p.WordCount)
}
Adding support for MinRead. Closed #106
2013-10-15 09:32:21 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if p.ReadingTime != 3 {
t.Fatalf("incorrect min read. expected %v, got %v", 3, p.ReadingTime)
}
Truncated; .Site.Params; First function * Add `.Truncated` bool to each page; will be set true if the `.Summary` is truncated and it's worth showing a "more" link of some kind. * Add `Params` to the site config, defining `.Site.Params` accessible to each page; this lets the site maintainer associate arbitrary data with names, on a site-wide basis. * Provide a `First` function to templates: * Use-case: `{{range First 5 .Site.Recent}}` or anything else which is a simple iterable provided by hugolib * Tests by me for `.Truncated` and `First` Also @noahcampbell contributed towards this: * Add UnitTest for `.Site.Params`: > Digging into this test case a bit more, I'm realizing that we need > to create a param test case to ensure that for each type we render > (page, index, homepage, rss, etc.) that the proper fields are > represented. This will help us refactor without fear in the > future. Sample config.yaml: ```yaml title: "Test site" params: Subtitle: "More tests always good" AuthorName: "John Doe" SidebarRecentLimit: 5 ``` Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-10 15:04:51 -05:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
checkTruncation(t, p, true, "long page")
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
}
Adding more test cases
2013-08-07 02:04:49 -04:00
func TestCreatePage(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
var tests = []struct {
r string
}{
{SIMPLE_PAGE_JSON},
{SIMPLE_PAGE_JSON_LOOSE},
{SIMPLE_PAGE_JSON_MULTIPLE},
//{strings.NewReader(SIMPLE_PAGE_JSON_COMPACT)},
}
for _, test := range tests {
if _, err := ReadFrom(strings.NewReader(test.r), "page"); err != nil {
t.Errorf("Unable to parse page: %s", err)
}
}
Adding more test cases
2013-08-07 02:04:49 -04:00
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
func TestDegenerateInvalidFrontMatterShortDelim(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
var tests = []struct {
r string
err string
}{
{INVALID_FRONT_MATTER_SHORT_DELIM_ENDING, "Unable to read frontmatter at filepos 45: EOF"},
}
for _, test := range tests {
_, err := ReadFrom(strings.NewReader(test.r), "invalid/front/matter/short/delim")
checkError(t, err, test.err)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Add IsRenderable to Page As pages are read from the target, they will be assessed if they should be rendered or not. The logic for IsRenderable is in the parser/page.go and looks for anything exception '<'.
2013-09-18 13:17:43 -04:00
func TestShouldRenderContent(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
var tests = []struct {
text string
render bool
}{
{INVALID_FRONT_MATTER_MISSING, true},
// TODO how to deal with malformed frontmatter. In this case it'll be rendered as markdown.
{INVALID_FRONT_MATTER_SHORT_DELIM, true},
{RENDER_NO_FRONT_MATTER, false},
}
for _, test := range tests {
p := pageMust(ReadFrom(strings.NewReader(test.text), "render/front/matter"))
if p.IsRenderable() != test.render {
t.Errorf("expected p.IsRenderable() == %t, got %t", test.render, p.IsRenderable())
}
}
Add IsRenderable to Page As pages are read from the target, they will be assessed if they should be rendered or not. The logic for IsRenderable is in the parser/page.go and looks for anything exception '<'.
2013-09-18 13:17:43 -04:00
}
Adding support for more front matter types (int, float & date)
2013-10-24 17:31:04 -04:00
func TestDifferentFrontMatterVarTypes(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
page, _ := ReadFrom(strings.NewReader(PAGE_WITH_VARIOUS_FRONTMATTER_TYPES), "test/file1.md")
dateval, _ := time.Parse(time.RFC3339, "1979-05-27T07:32:00Z")
if page.GetParam("a_string") != "bar" {
t.Errorf("frontmatter not handling strings correctly should be %s, got: %s", "bar", page.GetParam("a_string"))
}
if page.GetParam("an_integer") != 1 {
t.Errorf("frontmatter not handling ints correctly should be %s, got: %s", "1", page.GetParam("an_integer"))
}
if page.GetParam("a_float") != 1.3 {
t.Errorf("frontmatter not handling floats correctly should be %s, got: %s", 1.3, page.GetParam("a_float"))
}
if page.GetParam("a_date") != dateval {
t.Errorf("frontmatter not handling dates correctly should be %s, got: %s", dateval, page.GetParam("a_date"))
}
Adding support for more front matter types (int, float & date)
2013-10-24 17:31:04 -04:00
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
func TestDegenerateInvalidFrontMatterLeadingWhitespace(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
_, err := ReadFrom(strings.NewReader(INVALID_FRONT_MATTER_LEADING_WS), "invalid/front/matter/leading/ws")
if err != nil {
t.Fatalf("Unable to parse front matter given leading whitespace: %s", err)
}
Adding ability to read from io.Reader This allows for testing without relying on the file system. Parsing algorithm to not read the entire file into memory.
2013-08-05 10:53:58 -04:00
}
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
Ensure Section is set before returning Page object.
2013-08-30 20:14:36 -04:00
func TestSectionEvaluation(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
page, _ := ReadFrom(strings.NewReader(SIMPLE_PAGE), "blue/file1.md")
if page.Section != "blue" {
t.Errorf("Section should be %s, got: %s", "blue", page.Section)
}
Ensure Section is set before returning Page object.
2013-08-30 20:14:36 -04:00
}
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
func L(s ...string) []string {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
return s
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
}
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
func TestLayoutOverride(t *testing.T) {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
var (
path_content_two_dir = path.Join("content", "dub", "sub", "file1.md")
path_content_one_dir = path.Join("content", "gub", "file1.md")
path_content_no_dir = path.Join("content", "file1")
path_one_directory = path.Join("fub", "file1.md")
path_no_directory = path.Join("file1.md")
)
tests := []struct {
content string
path string
expectedLayout []string
}{
{SIMPLE_PAGE_NOLAYOUT, path_content_two_dir, L("dub/sub/single.html", "dub/single.html", "single.html")},
{SIMPLE_PAGE_NOLAYOUT, path_content_one_dir, L("gub/single.html", "single.html")},
{SIMPLE_PAGE_NOLAYOUT, path_content_no_dir, L("page/single.html", "single.html")},
{SIMPLE_PAGE_NOLAYOUT, path_one_directory, L("fub/single.html", "single.html")},
{SIMPLE_PAGE_NOLAYOUT, path_no_directory, L("page/single.html", "single.html")},
{SIMPLE_PAGE_LAYOUT_FOOBAR, path_content_two_dir, L("dub/sub/foobar.html", "dub/foobar.html", "foobar.html")},
{SIMPLE_PAGE_LAYOUT_FOOBAR, path_content_one_dir, L("gub/foobar.html", "foobar.html")},
{SIMPLE_PAGE_LAYOUT_FOOBAR, path_one_directory, L("fub/foobar.html", "foobar.html")},
{SIMPLE_PAGE_LAYOUT_FOOBAR, path_no_directory, L("page/foobar.html", "foobar.html")},
{SIMPLE_PAGE_TYPE_FOOBAR, path_content_two_dir, L("foobar/single.html", "single.html")},
{SIMPLE_PAGE_TYPE_FOOBAR, path_content_one_dir, L("foobar/single.html", "single.html")},
{SIMPLE_PAGE_TYPE_FOOBAR, path_content_no_dir, L("foobar/single.html", "single.html")},
{SIMPLE_PAGE_TYPE_FOOBAR, path_one_directory, L("foobar/single.html", "single.html")},
{SIMPLE_PAGE_TYPE_FOOBAR, path_no_directory, L("foobar/single.html", "single.html")},
{SIMPLE_PAGE_TYPE_LAYOUT, path_content_two_dir, L("barfoo/buzfoo.html", "buzfoo.html")},
{SIMPLE_PAGE_TYPE_LAYOUT, path_content_one_dir, L("barfoo/buzfoo.html", "buzfoo.html")},
{SIMPLE_PAGE_TYPE_LAYOUT, path_content_no_dir, L("barfoo/buzfoo.html", "buzfoo.html")},
{SIMPLE_PAGE_TYPE_LAYOUT, path_one_directory, L("barfoo/buzfoo.html", "buzfoo.html")},
{SIMPLE_PAGE_TYPE_LAYOUT, path_no_directory, L("barfoo/buzfoo.html", "buzfoo.html")},
}
for _, test := range tests {
p, err := ReadFrom(strings.NewReader(test.content), test.path)
if err != nil {
t.Fatalf("Unable to parse content:\n%s\n", test.content)
}
if !listEqual(p.Layout(), test.expectedLayout) {
t.Errorf("Layout mismatch. Expected: %s, got: %s", test.expectedLayout, p.Layout())
}
}
Removing GetSection Using GetXXX is not idiomatic to Go. Also added a bunch of unit testing around this method.
2013-08-14 18:22:57 -04:00
}
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
func listEqual(left, right []string) bool {
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
if len(left) != len(right) {
return false
}
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
for i := range left {
if left[i] != right[i] {
return false
}
}
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
renaming MinRead to ReadingTime and adding to documentation.
2014-01-21 17:12:59 -05:00
return true
Refactor layout selection code The render code path would use a fallback if there was an exception. This change instead relies on explicit declaration of the layout to use and includes a check to see if the layout indeed exists before attempting to render it.
2013-10-07 00:57:45 -04:00
}
Reference in a new issue Copy permalink