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

460 lines
16 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 (
Code reorg, helpers.go has been decomposed. It started with wanting to move templates in template bundles and the rest followed. I did my best to start grouping related functions together, but there are some that I missed. There is also the method Urlize that seems to be a special function used in both worlds. I'll need to revisit this method.
2013-09-03 18:38:20 -04:00
"html/template"
Normalize paths within hugo filepath was used inconsistently throughout the hugolib. With the introduction of source and target modules, all path are normalized to "/". This simplifies the processing of paths. It does mean that contributors need to be aware of using path/filepath in any module other than source or target is not recommended. The current exception is hugolib/config.go
2013-09-12 13:48:59 -04:00
"path"
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
"strings"
"testing"
Code reorg, helpers.go has been decomposed. It started with wanting to move templates in template bundles and the rest followed. I did my best to start grouping related functions together, but there are some that I missed. There is also the method Urlize that seems to be a special function used in both worlds. I'll need to revisit this method.
2013-09-03 18:38:20 -04:00
"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 (
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
`
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
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
`
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
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
`
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
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
`
SIMPLE_PAGE_JSON_LOOSE = `
{
"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
`
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
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
`
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
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
`
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
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`
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
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`
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
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`
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
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`
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
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
`
SIMPLE_PAGE_WITH_SHORTCODE_IN_SUMMARY = `---
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
`
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
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
`
SIMPLE_PAGE_WITH_LONG_CONTENT = `---
title: Simple
---
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.
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) {
if err == nil {
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
t.Fatalf("err is nil. Expected: %s", 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
}
if err.Error() != expected {
t.Errorf("err.Error() returned: '%s'. Expected: '%s'", err.Error(), expected)
}
}
func TestDegenerateEmptyPageZeroLengthName(t *testing.T) {
_, err := ReadFrom(strings.NewReader(EMPTY_PAGE), "")
if err == nil {
t.Fatalf("A zero length page name must return an error")
}
checkError(t, err, "Zero length page name")
}
func TestDegenerateEmptyPage(t *testing.T) {
_, err := ReadFrom(strings.NewReader(EMPTY_PAGE), "test")
Allowing empty files (ignored) so you can touch a new file while watching
2013-12-28 13:44:58 -05:00
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
}
Allowing empty files (ignored) so you can touch a new file while watching
2013-12-28 13:44:58 -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) {
if page.Title != title {
t.Fatalf("Page title is: %s. Expected %s", page.Title, title)
}
}
func checkPageContent(t *testing.T, page *Page, content string) {
Remove hugolib.HTML and hugolib.URL types These types were not be rendered correctly by the html/template package. Removing them gets the correct behavior. Fixes #74
2013-09-03 15:41:13 -04:00
if page.Content != template.HTML(content) {
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
t.Fatalf("Page content mismatch\nexp: %q\ngot: %q", content, page.Content)
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) {
Remove hugolib.HTML and hugolib.URL types These types were not be rendered correctly by the html/template package. Removing them gets the correct behavior. Fixes #74
2013-09-03 15:41:13 -04:00
if page.Summary != template.HTML(summary) {
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
t.Fatalf("Page summary is: `%s`. Expected `%s`", page.Summary, summary)
}
}
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) {
if page.Type() != pageType {
t.Fatalf("Page type is: %s. Expected: %s", page.Type(), pageType)
}
}
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) {
if !listEqual(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
t.Fatalf("Page layout is: %s. Expected: %s", page.Layout(), layout)
}
}
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) {
if page.Date != time {
t.Fatalf("Page date is: %s. Expected: %s", page.Date, time)
}
}
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) {
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)
}
}
}
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) {
Allow non-markdown content in content directory Allow content that is not markdown and does not need to be rendered to exists in the content directory. Currently any valid html or xml document can exist. Templates are applied to these documents as well. If you need to have content that doesn't have templates or AbsUrlify like operations, then continue to put this content in static and it will be copied over.
2013-09-18 17:21:27 -04:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE), "simple.md")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
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
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")
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
checkPageSummary(t, p, "Simple Page")
checkPageType(t, p, "page")
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
checkPageLayout(t, p, "page/single.html", "single.html")
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
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) {
Allow non-markdown content in content directory Allow content that is not markdown and does not need to be rendered to exists in the content directory. Currently any valid html or xml document can exist. Templates are applied to these documents as well. If you need to have content that doesn't have templates or AbsUrlify like operations, then continue to put this content in static and it will be copied over.
2013-09-18 17:21:27 -04:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SUMMARY_DELIMITER), "simple.md")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
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
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "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
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")
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
checkPageType(t, p, "page")
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
checkPageLayout(t, p, "page/single.html", "single.html")
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
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) {
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SHORTCODE_IN_SUMMARY), "simple.md")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
Restoring former snippet behavior & adding test to ensure future behavior
2013-10-04 12:28:28 -04:00
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")
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
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
}
func TestPageWithMoreTag(t *testing.T) {
Allow non-markdown content in content directory Allow content that is not markdown and does not need to be rendered to exists in the content directory. Currently any valid html or xml document can exist. Templates are applied to these documents as well. If you need to have content that doesn't have templates or AbsUrlify like operations, then continue to put this content in static and it will be copied over.
2013-09-18 17:21:27 -04:00
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_SUMMARY_DELIMITER_SAME_LINE), "simple.md")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
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
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
checkPageTitle(t, p, "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
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")
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
checkPageType(t, p, "page")
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
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) {
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_RFC3339_DATE), "simple")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
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
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)
}
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
func TestWordCount(t *testing.T) {
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
p, err := ReadFrom(strings.NewReader(SIMPLE_PAGE_WITH_LONG_CONTENT), "simple.md")
render shortcodes prior to converting to html
2013-12-06 23:32:00 -05:00
p.Convert()
Wordcount restored. fixed #92
2013-10-15 09:15:52 -04:00
if err != nil {
t.Fatalf("Unable to create a page with frontmatter and body content: %s", err)
}
if p.WordCount != 483 {
t.Fatalf("incorrect word count. expected %v, got %v", 483, p.WordCount)
}
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
if p.MinRead != 3 {
t.Fatalf("incorrect min read. expected %v, got %v", 3, p.MinRead)
}
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
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) {
var tests = []struct {
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
r string
Adding more test cases
2013-08-07 02:04:49 -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
{SIMPLE_PAGE_JSON},
Switching to the rjson library which is more friendly to human generated json.
2013-10-01 22:45:24 -04:00
{SIMPLE_PAGE_JSON_LOOSE},
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
{SIMPLE_PAGE_JSON_MULTIPLE},
Adding more test cases
2013-08-07 02:04:49 -04:00
//{strings.NewReader(SIMPLE_PAGE_JSON_COMPACT)},
}
for _, test := range tests {
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
if _, err := ReadFrom(strings.NewReader(test.r), "page"); err != nil {
Adding more test cases
2013-08-07 02:04:49 -04:00
t.Errorf("Unable to parse page: %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
func TestDegenerateInvalidFrontMatterShortDelim(t *testing.T) {
var tests = []struct {
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
r string
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
err string
}{
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
{INVALID_FRONT_MATTER_SHORT_DELIM_ENDING, "Unable to read frontmatter at filepos 45: 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
}
for _, test := range tests {
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
_, err := ReadFrom(strings.NewReader(test.r), "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
checkError(t, err, test.err)
}
}
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) {
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())
}
}
}
Adding support for more front matter types (int, float & date)
2013-10-24 17:31:04 -04:00
func TestDifferentFrontMatterVarTypes(t *testing.T) {
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 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) {
_, 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)
}
}
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) {
Normalize paths within hugo filepath was used inconsistently throughout the hugolib. With the introduction of source and target modules, all path are normalized to "/". This simplifies the processing of paths. It does mean that contributors need to be aware of using path/filepath in any module other than source or target is not recommended. The current exception is hugolib/config.go
2013-09-12 13:48:59 -04:00
page, _ := ReadFrom(strings.NewReader(SIMPLE_PAGE), "blue/file1.md")
Ensure Section is set before returning Page object.
2013-08-30 20:14:36 -04:00
if page.Section != "blue" {
t.Errorf("Section should be %s, got: %s", "blue", page.Section)
}
}
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 {
return s
}
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) {
var (
Normalize paths within hugo filepath was used inconsistently throughout the hugolib. With the introduction of source and target modules, all path are normalized to "/". This simplifies the processing of paths. It does mean that contributors need to be aware of using path/filepath in any module other than source or target is not recommended. The current exception is hugolib/config.go
2013-09-12 13:48:59 -04:00
path_content_two_dir = path.Join("content", "dub", "sub", "file1.md")
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
path_content_one_dir = path.Join("content", "gub", "file1.md")
Normalize paths within hugo filepath was used inconsistently throughout the hugolib. With the introduction of source and target modules, all path are normalized to "/". This simplifies the processing of paths. It does mean that contributors need to be aware of using path/filepath in any module other than source or target is not recommended. The current exception is hugolib/config.go
2013-09-12 13:48:59 -04:00
path_content_no_dir = path.Join("content", "file1")
path_one_directory = path.Join("fub", "file1.md")
path_no_directory = path.Join("file1.md")
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
)
tests := []struct {
content string
path string
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
expectedLayout []string
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
{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")},
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
}
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)
}
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
if !listEqual(p.Layout(), test.expectedLayout) {
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
t.Errorf("Layout mismatch. Expected: %s, got: %s", test.expectedLayout, p.Layout())
}
}
}
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 {
if len(left) != len(right) {
return false
}
for i := range left {
if left[i] != right[i] {
return false
}
}
return true
}
Reference in a new issue Copy permalink