Add reStructedText support

main.go

@@ -16,6 +16,7 @@ import (
 	// register supported doc types
 	_ "code.gitea.io/gitea/modules/markup/markdown"
 	_ "code.gitea.io/gitea/modules/markup/orgmode"
+	_ "code.gitea.io/gitea/modules/markup/reStructuredText"
 
 	"github.com/urfave/cli"
 )

modules/markup/orgmode/orgmode.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a MIT-style
 // license that can be found in the LICENSE file.
 
-package markup
+package orgmode
 
 import (
 	"code.gitea.io/gitea/modules/markup"

modules/markup/orgmode/orgmode_test.go

@@ -2,7 +2,7 @@
 // Use of this source code is governed by a MIT-style
 // license that can be found in the LICENSE file.
 
-package markup
+package orgmode
 
 import (
 	"strings"

modules/markup/reStructuredText/reStructuredText.go

@@ -0,0 +1,57 @@
+// Copyright 2017 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package rst
+
+import (
+	"bufio"
+	"bytes"
+
+	"code.gitea.io/gitea/modules/log"
+	"code.gitea.io/gitea/modules/markup"
+
+	gorst "github.com/hhatto/gorst"
+)
+
+func init() {
+	markup.RegisterParser(Parser{})
+}
+
+// Parser implements markup.Parser for reStructuredText
+type Parser struct {
+}
+
+// Name return the parser's name
+func (Parser) Name() string {
+	return "reStructuredText"
+}
+
+// Extensions return the parser supported extensions
+func (Parser) Extensions() []string {
+	return []string{".rst"}
+}
+
+// Render renders reStructuredText bytes to HTML
+func Render(rawBytes []byte, urlPrefix string, metas map[string]string, isWiki bool) []byte {
+	p := gorst.NewParser(nil)
+	var b bytes.Buffer
+	w := bufio.NewWriter(&b)
+	p.ReStructuredText(bytes.NewReader(rawBytes), gorst.ToHTML(w))
+	if err := w.Flush(); err != nil {
+		log.Error(4, "Render ReStructuredText failed: %v", err)
+		return []byte("")
+	}
+
+	return b.Bytes()
+}
+
+// RenderString renders reStructuredText string to HTML
+func RenderString(rawContent string, urlPrefix string, metas map[string]string, isWiki bool) string {
+	return string(Render([]byte(rawContent), urlPrefix, metas, isWiki))
+}
+
+// Render renders reStructuredText bytes to HTML, for implementations of markup.Parser
+func (Parser) Render(rawBytes []byte, urlPrefix string, metas map[string]string, isWiki bool) []byte {
+	return Render(rawBytes, urlPrefix, metas, isWiki)
+}

modules/markup/reStructuredText/reStructuredText_test.go

@@ -0,0 +1,63 @@
+// Copyright 2017 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package rst
+
+import (
+	"strings"
+	"testing"
+
+	"code.gitea.io/gitea/modules/setting"
+
+	"github.com/stretchr/testify/assert"
+)
+
+const AppURL = "http://localhost:3000/"
+const Repo = "go-gitea/gitea"
+const AppSubURL = AppURL + Repo + "/"
+
+func test(t *testing.T, input, expected string) {
+	buffer := RenderString(input, setting.AppSubURL, nil, false)
+	assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(buffer))
+}
+
+func TestRender_StandardLinks(t *testing.T) {
+	var appURL = setting.AppURL
+	var appSubURL = setting.AppSubURL
+	setting.AppURL = AppURL
+	setting.AppSubURL = AppSubURL
+	defer func() {
+		setting.AppURL = appURL
+		setting.AppSubURL = appSubURL
+	}()
+
+	googleRendered := `<p><a href="https://google.com/">reStructuredText</a></p>`
+	test(t, "reStructuredText_\n\n.. _reStructuredText: https://google.com/\n", googleRendered)
+
+	// TODO: gorst didn't support relative link.
+	/*lnk := markup.URLJoin(AppSubURL, "WikiPage")
+	test("WikiPage_\n\n.. _WikiPage: WikiPage\n",
+		`<p><a href="`+lnk+`">WikiPage</a></p>`)*/
+}
+
+func TestRender_Images(t *testing.T) {
+	var appURL = setting.AppURL
+	var appSubURL = setting.AppSubURL
+	setting.AppURL = AppURL
+	setting.AppSubURL = AppSubURL
+	defer func() {
+		setting.AppURL = appURL
+		setting.AppSubURL = appSubURL
+	}()
+
+	// TODO: relative image link is not supported by gorst
+	//url := "../../.images/src/02/train.jpg"
+	//result := markup.URLJoin(AppSubURL, url)
+	url := "https://help.github.com/assets/images/site/favicon.png"
+	result := url
+
+	test(t,
+		".. image:: "+url,
+		`<img src="`+result+`" alt="`+result+`" />`)
+}