helpers: Test coverage increase - hugo - [fork] hugo port for 9front
HTML git clone git@git.drkhsh.at/hugo.git
DIR Log
DIR Files
DIR Refs
DIR Submodules
DIR README
DIR LICENSE
---
DIR commit e95f3af933ea58df0389facca9bfde1119ef2bf4
DIR parent 318a9845265e69702cbabb048de27532ef106e86
HTML Author: Gergely Brautigam <skarlso777@gmail.com>
Date: Fri, 5 Feb 2016 18:40:49 +0100
helpers: Test coverage increase
Started to increase coverage in helpers package, now at 74.9% of statements.
In the process, also a few minor changes have been applied to content.go.
* Content.go has undergone a formatting refactor regarding comments
* Unused function TruncateWords has been removed
* RenderingContext's "mmark" has been changed to use MmarkRender
* Content_test.go added to cover content.go's functionality
Diffstat:
M helpers/content.go | 35 +++++++++----------------------
M helpers/content_test.go | 295 ++++++++++++++++++++++++++++++
2 files changed, 305 insertions(+), 25 deletions(-)
---
DIR diff --git a/helpers/content.go b/helpers/content.go
@@ -35,10 +35,10 @@ import (
"sync"
)
-// Length of the summary that Hugo extracts from a content.
+// SummaryLength is the length of the summary that Hugo extracts from a content.
var SummaryLength = 70
-// Custom divider <!--more--> let's user define where summarization ends.
+// SummaryDivider denotes where content summarization should end. The default is "<!--more-->".
var SummaryDivider = []byte("<!--more-->")
// Blackfriday holds configuration values for Blackfriday rendering.
@@ -157,7 +157,7 @@ func BytesToHTML(b []byte) template.HTML {
return template.HTML(string(b))
}
-// GetHtmlRenderer creates a new Renderer with the given configuration.
+// GetHTMLRenderer creates a new Renderer with the given configuration.
func GetHTMLRenderer(defaultFlags int, ctx *RenderingContext) blackfriday.Renderer {
renderParameters := blackfriday.HtmlRendererParameters{
FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"),
@@ -237,7 +237,7 @@ func markdownRenderWithTOC(ctx *RenderingContext) []byte {
getMarkdownExtensions(ctx))
}
-// mmark
+// GetMmarkHtmlRenderer returns markdown html renderer.
func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Renderer {
renderParameters := mmark.HtmlRendererParameters{
FootnoteAnchorPrefix: viper.GetString("FootnoteAnchorPrefix"),
@@ -259,6 +259,7 @@ func GetMmarkHtmlRenderer(defaultFlags int, ctx *RenderingContext) mmark.Rendere
}
}
+// GetMmarkExtensions returns markdown extensions.
func GetMmarkExtensions(ctx *RenderingContext) int {
flags := 0
flags |= mmark.EXTENSION_TABLES
@@ -283,17 +284,12 @@ func GetMmarkExtensions(ctx *RenderingContext) int {
return flags
}
+// MmarkRender renders markdowns.
func MmarkRender(ctx *RenderingContext) []byte {
return mmark.Parse(ctx.Content, GetMmarkHtmlRenderer(0, ctx),
GetMmarkExtensions(ctx)).Bytes()
}
-func MmarkRenderWithTOC(ctx *RenderingContext) []byte {
- return mmark.Parse(ctx.Content,
- GetMmarkHtmlRenderer(0, ctx),
- GetMmarkExtensions(ctx)).Bytes()
-}
-
// ExtractTOC extracts Table of Contents from content.
func ExtractTOC(content []byte) (newcontent []byte, toc []byte) {
origContent := make([]byte, len(content))
@@ -331,7 +327,7 @@ func ExtractTOC(content []byte) (newcontent []byte, toc []byte) {
}
// RenderingContext holds contextual information, like content and configuration,
-// for a given content renderin.g
+// for a given content rendering.
type RenderingContext struct {
Content []byte
PageFmt string
@@ -361,7 +357,7 @@ func RenderBytesWithTOC(ctx *RenderingContext) []byte {
case "asciidoc":
return []byte(GetAsciidocContent(ctx.Content))
case "mmark":
- return MmarkRenderWithTOC(ctx)
+ return MmarkRender(ctx)
case "rst":
return []byte(GetRstContent(ctx.Content))
}
@@ -403,17 +399,7 @@ func RemoveSummaryDivider(content []byte) []byte {
return bytes.Replace(content, SummaryDivider, []byte(""), -1)
}
-// TruncateWords takes content and an int and shortens down the number
-// of words in the content down to the number of int.
-func TruncateWords(s string, max int) string {
- words := strings.Fields(s)
- if max > len(words) {
- return strings.Join(words, " ")
- }
-
- return strings.Join(words[:max], " ")
-}
-
+// TruncateWordsByRune truncates words by runes.
func TruncateWordsByRune(words []string, max int) (string, bool) {
count := 0
for index, word := range words {
@@ -430,9 +416,8 @@ func TruncateWordsByRune(words []string, max int) (string, bool) {
if count >= max {
truncatedWords := append(words[:index], word[:ri])
return strings.Join(truncatedWords, " "), true
- } else {
- count++
}
+ count++
}
}
}
DIR diff --git a/helpers/content_test.go b/helpers/content_test.go
@@ -14,10 +14,14 @@
package helpers
import (
+ "bytes"
"html/template"
+ "reflect"
"strings"
"testing"
+ "github.com/miekg/mmark"
+ "github.com/russross/blackfriday"
"github.com/stretchr/testify/assert"
)
@@ -33,6 +37,7 @@ func TestStripHTML(t *testing.T) {
{"</br> strip br<br>", " strip br\n"},
{"</br> strip br2<br />", " strip br2\n"},
{"This <strong>is</strong> a\nnewline", "This is a newline"},
+ {"No Tags", "No Tags"},
}
for i, d := range data {
output := StripHTML(d.input)
@@ -117,3 +122,293 @@ func TestTruncateWordsByRune(t *testing.T) {
}
}
}
+
+func TestGetHTMLRendererFlags(t *testing.T) {
+ ctx := &RenderingContext{}
+ renderer := GetHTMLRenderer(blackfriday.HTML_USE_XHTML, ctx)
+ flags := renderer.GetFlags()
+ if flags&blackfriday.HTML_USE_XHTML != blackfriday.HTML_USE_XHTML {
+ t.Errorf("Test flag: %d was not found amongs set flags:%d; Result: %d", blackfriday.HTML_USE_XHTML, flags, flags&blackfriday.HTML_USE_XHTML)
+ }
+}
+
+func TestGetHTMLRendererAllFlags(t *testing.T) {
+ type data struct {
+ testFlag int
+ }
+
+ allFlags := []data{
+ {blackfriday.HTML_USE_XHTML},
+ {blackfriday.HTML_FOOTNOTE_RETURN_LINKS},
+ {blackfriday.HTML_USE_SMARTYPANTS},
+ {blackfriday.HTML_SMARTYPANTS_ANGLED_QUOTES},
+ {blackfriday.HTML_SMARTYPANTS_FRACTIONS},
+ {blackfriday.HTML_HREF_TARGET_BLANK},
+ {blackfriday.HTML_SMARTYPANTS_DASHES},
+ {blackfriday.HTML_SMARTYPANTS_LATEX_DASHES},
+ }
+ defaultFlags := blackfriday.HTML_USE_XHTML
+ ctx := &RenderingContext{}
+ ctx.Config = ctx.getConfig()
+ ctx.Config.AngledQuotes = true
+ ctx.Config.Fractions = true
+ ctx.Config.HrefTargetBlank = true
+ ctx.Config.LatexDashes = true
+ ctx.Config.PlainIDAnchors = true
+ ctx.Config.SmartDashes = true
+ ctx.Config.Smartypants = true
+ ctx.Config.SourceRelativeLinksEval = true
+ renderer := GetHTMLRenderer(defaultFlags, ctx)
+ actualFlags := renderer.GetFlags()
+ var expectedFlags int
+ //OR-ing flags together...
+ for _, d := range allFlags {
+ expectedFlags |= d.testFlag
+ }
+ if expectedFlags != actualFlags {
+ t.Errorf("Expected flags (%d) did not equal actual (%d) flags.", expectedFlags, actualFlags)
+ }
+}
+
+func TestGetHTMLRendererAnchors(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.DocumentID = "testid"
+ ctx.Config = ctx.getConfig()
+ ctx.Config.PlainIDAnchors = false
+
+ actualRenderer := GetHTMLRenderer(0, ctx)
+ headerBuffer := &bytes.Buffer{}
+ footnoteBuffer := &bytes.Buffer{}
+ expectedFootnoteHref := []byte("href=\"#fn:testid:href\"")
+ expectedHeaderID := []byte("<h1 id=\"id:testid\"></h1>\n")
+
+ actualRenderer.Header(headerBuffer, func() bool { return true }, 1, "id")
+ actualRenderer.FootnoteRef(footnoteBuffer, []byte("href"), 1)
+
+ if !bytes.Contains(footnoteBuffer.Bytes(), expectedFootnoteHref) {
+ t.Errorf("Footnote anchor prefix not applied. Actual:%s Expected:%s", footnoteBuffer.String(), expectedFootnoteHref)
+ }
+
+ if !bytes.Equal(headerBuffer.Bytes(), expectedHeaderID) {
+ t.Errorf("Header Id Postfix not applied. Actual:%s Expected:%s", headerBuffer.String(), expectedHeaderID)
+ }
+}
+
+func TestGetMmarkHtmlRenderer(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.DocumentID = "testid"
+ ctx.Config = ctx.getConfig()
+ ctx.Config.PlainIDAnchors = false
+ actualRenderer := GetMmarkHtmlRenderer(0, ctx)
+
+ headerBuffer := &bytes.Buffer{}
+ footnoteBuffer := &bytes.Buffer{}
+ expectedFootnoteHref := []byte("href=\"#fn:testid:href\"")
+ expectedHeaderID := []byte("<h1 id=\"id\"></h1>")
+
+ actualRenderer.FootnoteRef(footnoteBuffer, []byte("href"), 1)
+ actualRenderer.Header(headerBuffer, func() bool { return true }, 1, "id")
+
+ if !bytes.Contains(footnoteBuffer.Bytes(), expectedFootnoteHref) {
+ t.Errorf("Footnote anchor prefix not applied. Actual:%s Expected:%s", footnoteBuffer.String(), expectedFootnoteHref)
+ }
+
+ if bytes.Equal(headerBuffer.Bytes(), expectedHeaderID) {
+ t.Errorf("Header Id Postfix applied. Actual:%s Expected:%s", headerBuffer.String(), expectedHeaderID)
+ }
+}
+
+func TestGetMarkdownExtensionsMasksAreRemovedFromExtensions(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.Config = ctx.getConfig()
+ ctx.Config.Extensions = []string{"headerId"}
+ ctx.Config.ExtensionsMask = []string{"noIntraEmphasis"}
+
+ actualFlags := getMarkdownExtensions(ctx)
+ if actualFlags&blackfriday.EXTENSION_NO_INTRA_EMPHASIS == blackfriday.EXTENSION_NO_INTRA_EMPHASIS {
+ t.Errorf("Masked out flag {%v} found amongst returned extensions.", blackfriday.EXTENSION_NO_INTRA_EMPHASIS)
+ }
+}
+
+func TestGetMarkdownExtensionsByDefaultAllExtensionsAreEnabled(t *testing.T) {
+ type data struct {
+ testFlag int
+ }
+ ctx := &RenderingContext{}
+ ctx.Config = ctx.getConfig()
+ ctx.Config.Extensions = []string{""}
+ ctx.Config.ExtensionsMask = []string{""}
+ allExtensions := []data{
+ {blackfriday.EXTENSION_NO_INTRA_EMPHASIS},
+ {blackfriday.EXTENSION_TABLES},
+ {blackfriday.EXTENSION_FENCED_CODE},
+ {blackfriday.EXTENSION_AUTOLINK},
+ {blackfriday.EXTENSION_STRIKETHROUGH},
+ {blackfriday.EXTENSION_SPACE_HEADERS},
+ {blackfriday.EXTENSION_FOOTNOTES},
+ {blackfriday.EXTENSION_HEADER_IDS},
+ {blackfriday.EXTENSION_AUTO_HEADER_IDS},
+ {blackfriday.EXTENSION_DEFINITION_LISTS},
+ }
+
+ actualFlags := getMarkdownExtensions(ctx)
+ for _, e := range allExtensions {
+ if actualFlags&e.testFlag != e.testFlag {
+ t.Errorf("Flag %v was not found in the list of extensions.", e)
+ }
+ }
+}
+
+func TestGetMarkdownExtensionsAddingFlagsThroughRenderingContext(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.Config = ctx.getConfig()
+ ctx.Config.Extensions = []string{"definitionLists"}
+ ctx.Config.ExtensionsMask = []string{""}
+
+ actualFlags := getMarkdownExtensions(ctx)
+ if actualFlags&blackfriday.EXTENSION_DEFINITION_LISTS != blackfriday.EXTENSION_DEFINITION_LISTS {
+ t.Errorf("Masked out flag {%v} found amongst returned extensions.", blackfriday.EXTENSION_DEFINITION_LISTS)
+ }
+}
+
+func TestGetMarkdownRenderer(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.Content = []byte("testContent")
+ ctx.Config = ctx.getConfig()
+ actualRenderedMarkdown := markdownRender(ctx)
+ expectedRenderedMarkdown := []byte("<p>testContent</p>\n")
+ if !bytes.Equal(actualRenderedMarkdown, expectedRenderedMarkdown) {
+ t.Errorf("Actual rendered Markdown (%s) did not match expected markdown (%s)", actualRenderedMarkdown, expectedRenderedMarkdown)
+ }
+}
+
+func TestGetMarkdownRendererWithTOC(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.Content = []byte("testContent")
+ ctx.Config = ctx.getConfig()
+ actualRenderedMarkdown := markdownRenderWithTOC(ctx)
+ expectedRenderedMarkdown := []byte("<nav>\n</nav>\n\n<p>testContent</p>\n")
+ if !bytes.Equal(actualRenderedMarkdown, expectedRenderedMarkdown) {
+ t.Errorf("Actual rendered Markdown (%s) did not match expected markdown (%s)", actualRenderedMarkdown, expectedRenderedMarkdown)
+ }
+}
+
+func TestGetMmarkExtensions(t *testing.T) {
+ //TODO: This is doing the same just with different marks...
+ type data struct {
+ testFlag int
+ }
+ ctx := &RenderingContext{}
+ ctx.Config = ctx.getConfig()
+ ctx.Config.Extensions = []string{"tables"}
+ ctx.Config.ExtensionsMask = []string{""}
+ allExtensions := []data{
+ {mmark.EXTENSION_TABLES},
+ {mmark.EXTENSION_FENCED_CODE},
+ {mmark.EXTENSION_AUTOLINK},
+ {mmark.EXTENSION_SPACE_HEADERS},
+ {mmark.EXTENSION_CITATION},
+ {mmark.EXTENSION_TITLEBLOCK_TOML},
+ {mmark.EXTENSION_HEADER_IDS},
+ {mmark.EXTENSION_AUTO_HEADER_IDS},
+ {mmark.EXTENSION_UNIQUE_HEADER_IDS},
+ {mmark.EXTENSION_FOOTNOTES},
+ {mmark.EXTENSION_SHORT_REF},
+ {mmark.EXTENSION_NO_EMPTY_LINE_BEFORE_BLOCK},
+ {mmark.EXTENSION_INCLUDE},
+ }
+
+ actualFlags := GetMmarkExtensions(ctx)
+ for _, e := range allExtensions {
+ if actualFlags&e.testFlag != e.testFlag {
+ t.Errorf("Flag %v was not found in the list of extensions.", e)
+ }
+ }
+}
+
+func TestMmarkRender(t *testing.T) {
+ ctx := &RenderingContext{}
+ ctx.Content = []byte("testContent")
+ ctx.Config = ctx.getConfig()
+ actualRenderedMarkdown := MmarkRender(ctx)
+ expectedRenderedMarkdown := []byte("<p>testContent</p>\n")
+ if !bytes.Equal(actualRenderedMarkdown, expectedRenderedMarkdown) {
+ t.Errorf("Actual rendered Markdown (%s) did not match expected markdown (%s)", actualRenderedMarkdown, expectedRenderedMarkdown)
+ }
+}
+
+func TestExtractTOCNormalContent(t *testing.T) {
+ content := []byte("<nav>\n<ul>\nTOC<li><a href=\"#")
+
+ actualTocLessContent, actualToc := ExtractTOC(content)
+ expectedTocLess := []byte("TOC<li><a href=\"#")
+ expectedToc := []byte("<nav id=\"TableOfContents\">\n<ul>\n")
+
+ if !bytes.Equal(actualTocLessContent, expectedTocLess) {
+ t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, expectedTocLess)
+ }
+
+ if !bytes.Equal(actualToc, expectedToc) {
+ t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
+ }
+}
+
+func TestExtractTOCGreaterThanSeventy(t *testing.T) {
+ content := []byte("<nav>\n<ul>\nTOC This is a very long content which will definitly be greater than seventy, I promise you that.<li><a href=\"#")
+
+ actualTocLessContent, actualToc := ExtractTOC(content)
+ //Because the start of Toc is greater than 70+startpoint of <li> content and empty TOC will be returned
+ expectedToc := []byte("")
+
+ if !bytes.Equal(actualTocLessContent, content) {
+ t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, content)
+ }
+
+ if !bytes.Equal(actualToc, expectedToc) {
+ t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
+ }
+}
+
+func TestExtractNoTOC(t *testing.T) {
+ content := []byte("TOC")
+
+ actualTocLessContent, actualToc := ExtractTOC(content)
+ expectedToc := []byte("")
+
+ if !bytes.Equal(actualTocLessContent, content) {
+ t.Errorf("Actual tocless (%s) did not equal expected (%s) tocless content", actualTocLessContent, content)
+ }
+
+ if !bytes.Equal(actualToc, expectedToc) {
+ t.Errorf("Actual toc (%s) did not equal expected (%s) toc content", actualToc, expectedToc)
+ }
+}
+
+func TestTotalWords(t *testing.T) {
+ testString := "Two, Words!"
+ actualWordCount := TotalWords(testString)
+
+ if actualWordCount != 2 {
+ t.Errorf("Actual word count (%d) for test string (%s) did not match 2.", actualWordCount, testString)
+ }
+}
+
+func TestWordCount(t *testing.T) {
+ testString := "Two, Words!"
+ expectedMap := map[string]int{"Two,": 1, "Words!": 1}
+ actualMap := WordCount(testString)
+
+ if !reflect.DeepEqual(expectedMap, actualMap) {
+ t.Errorf("Actual Map (%v) does not equal expected (%v)", actualMap, expectedMap)
+ }
+}
+
+func TestRemoveSummaryDivider(t *testing.T) {
+ content := []byte("This is before. <!--more-->This is after.")
+ actualRemovedContent := RemoveSummaryDivider(content)
+ expectedRemovedContent := []byte("This is before. This is after.")
+
+ if !bytes.Equal(actualRemovedContent, expectedRemovedContent) {
+ t.Errorf("Actual removed content (%s) did not equal expected removed content (%s)", actualRemovedContent, expectedRemovedContent)
+ }
+}