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

Polish func naming in shortcode handling

Browse source
This commit is contained in:
bep 2015-04-18 00:40:54 +02:00
parent bed053071e
commit be46a4b9b0
2 changed files with 8 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
hugolib/shortcode.go
View file

@ -118,9 +118,9 @@ func (sc shortcode) String() string {
return fmt.Sprintf("%s(%q, %t){%s}", sc.name, params, sc.doMarkup, sc.inner) return fmt.Sprintf("%s(%q, %t){%s}", sc.name, params, sc.doMarkup, sc.inner)
} }
// ShortcodesHandle does all in one go: extract, render and replace // handleShortcodes does all in one go: extract, render and replace
// only used for testing // only used for testing
func ShortcodesHandle(stringToParse string, page *Page, t tpl.Template) string { func handleShortcodes(stringToParse string, page *Page, t tpl.Template) string {
tmpContent, tmpShortcodes := extractAndRenderShortcodes(stringToParse, page, t) tmpContent, tmpShortcodes := extractAndRenderShortcodes(stringToParse, page, t)
if len(tmpShortcodes) > 0 { if len(tmpShortcodes) > 0 {
@ -171,7 +171,7 @@ const innerCleanupExpand = "$1"
func renderShortcode(sc shortcode, p *Page, t tpl.Template) string { func renderShortcode(sc shortcode, p *Page, t tpl.Template) string {
var data = &ShortcodeWithPage{Params: sc.params, Page: p} var data = &ShortcodeWithPage{Params: sc.params, Page: p}
tmpl := GetTemplate(sc.name, t) tmpl := getShortcodeTemplate(sc.name, t)
if tmpl == nil { if tmpl == nil {
jww.ERROR.Printf("Unable to locate template for shortcode '%s' in page %s", sc.name, p.BaseFileName()) jww.ERROR.Printf("Unable to locate template for shortcode '%s' in page %s", sc.name, p.BaseFileName())
@ -229,7 +229,7 @@ func renderShortcode(sc shortcode, p *Page, t tpl.Template) string {
} }
return ShortcodeRender(tmpl, data) return renderShortcodeWithPage(tmpl, data)
} }
func extractAndRenderShortcodes(stringToParse string, p *Page, t tpl.Template) (string, map[string]string) { func extractAndRenderShortcodes(stringToParse string, p *Page, t tpl.Template) (string, map[string]string) {
@ -320,7 +320,7 @@ Loop:
sc.inner = append(sc.inner, currItem.val) sc.inner = append(sc.inner, currItem.val)
case tScName: case tScName:
sc.name = currItem.val sc.name = currItem.val
tmpl := GetTemplate(sc.name, t) tmpl := getShortcodeTemplate(sc.name, t)
if tmpl == nil { if tmpl == nil {
return sc, fmt.Errorf("Unable to locate template for shortcode '%s' in page %s", sc.name, p.BaseFileName()) return sc, fmt.Errorf("Unable to locate template for shortcode '%s' in page %s", sc.name, p.BaseFileName())
@ -481,7 +481,7 @@ func replaceShortcodeTokens(source []byte, prefix string, wrapped bool, replacem
return b, err return b, err
} }
func GetTemplate(name string, t tpl.Template) *template.Template { func getShortcodeTemplate(name string, t tpl.Template) *template.Template {
if x := t.Lookup("shortcodes/" + name + ".html"); x != nil { if x := t.Lookup("shortcodes/" + name + ".html"); x != nil {
return x return x
} }
@ -491,7 +491,7 @@ func GetTemplate(name string, t tpl.Template) *template.Template {
return t.Lookup("_internal/shortcodes/" + name + ".html") return t.Lookup("_internal/shortcodes/" + name + ".html")
} }
func ShortcodeRender(tmpl *template.Template, data *ShortcodeWithPage) string { func renderShortcodeWithPage(tmpl *template.Template, data *ShortcodeWithPage) string {
buffer := bp.GetBuffer() buffer := bp.GetBuffer()
defer bp.PutBuffer(buffer) defer bp.PutBuffer(buffer)

2
hugolib/shortcode_test.go
View file

@ -20,7 +20,7 @@ func pageFromString(in, filename string) (*Page, error) {
func CheckShortCodeMatch(t *testing.T, input, expected string, template tpl.Template) { func CheckShortCodeMatch(t *testing.T, input, expected string, template tpl.Template) {
p, _ := pageFromString(SIMPLE_PAGE, "simple.md") p, _ := pageFromString(SIMPLE_PAGE, "simple.md")
output := ShortcodesHandle(input, p, template) output := handleShortcodes(input, p, template)
if output != expected { if output != expected {
t.Fatalf("Shortcode render didn't match. Expected: %q, Got: %q", expected, output) t.Fatalf("Shortcode render didn't match. Expected: %q, Got: %q", expected, output)