diff options
| author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-08-16 15:55:03 +0200 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2019-11-06 19:09:08 +0100 |
| commit | 5f6b6ec68936ebbbf590894c02a1a3ecad30735f (patch) | |
| tree | f6c91e225a3f24f51af1bde5cfb5b88515d0665d /markup/rst | |
| parent | 366ee4d8da1c2b0c1751e9bf6d54638439735296 (diff) | |
Prepare for Goldmark
This commmit prepares for the addition of Goldmark as the new Markdown renderer in Hugo.
This introduces a new `markup` package with some common interfaces and each implementation in its own package.
See #5963
Diffstat (limited to 'markup/rst')
| -rw-r--r-- | markup/rst/convert.go | 109 | ||||
| -rw-r--r-- | markup/rst/convert_test.go | 38 |
2 files changed, 147 insertions, 0 deletions
diff --git a/markup/rst/convert.go b/markup/rst/convert.go new file mode 100644 index 000000000..e12e34f6d --- /dev/null +++ b/markup/rst/convert.go @@ -0,0 +1,109 @@ +// Copyright 2019 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Package rst converts content to HTML using the RST external helper. +package rst + +import ( + "bytes" + "os/exec" + "runtime" + + "github.com/gohugoio/hugo/markup/internal" + + "github.com/gohugoio/hugo/markup/converter" +) + +// Provider is the package entry point. +var Provider converter.NewProvider = provider{} + +type provider struct { +} + +func (p provider) New(cfg converter.ProviderConfig) (converter.Provider, error) { + var n converter.NewConverter = func(ctx converter.DocumentContext) (converter.Converter, error) { + return &rstConverter{ + ctx: ctx, + cfg: cfg, + }, nil + } + return n, nil + +} + +type rstConverter struct { + ctx converter.DocumentContext + cfg converter.ProviderConfig +} + +func (c *rstConverter) Convert(ctx converter.RenderContext) (converter.Result, error) { + return converter.Bytes(c.getRstContent(ctx.Src, c.ctx)), nil +} + +// getRstContent calls the Python script rst2html as an external helper +// to convert reStructuredText content to HTML. +func (c *rstConverter) getRstContent(src []byte, ctx converter.DocumentContext) []byte { + logger := c.cfg.Logger + path := getRstExecPath() + + if path == "" { + logger.ERROR.Println("rst2html / rst2html.py not found in $PATH: Please install.\n", + " Leaving reStructuredText content unrendered.") + return src + } + logger.INFO.Println("Rendering", ctx.DocumentName, "with", path, "...") + var result []byte + // certain *nix based OSs wrap executables in scripted launchers + // invoking binaries on these OSs via python interpreter causes SyntaxError + // invoke directly so that shebangs work as expected + // handle Windows manually because it doesn't do shebangs + if runtime.GOOS == "windows" { + python := internal.GetPythonExecPath() + args := []string{path, "--leave-comments", "--initial-header-level=2"} + result = internal.ExternallyRenderContent(c.cfg, ctx, src, python, args) + } else { + args := []string{"--leave-comments", "--initial-header-level=2"} + result = internal.ExternallyRenderContent(c.cfg, ctx, src, path, args) + } + // TODO(bep) check if rst2html has a body only option. + bodyStart := bytes.Index(result, []byte("<body>\n")) + if bodyStart < 0 { + bodyStart = -7 //compensate for length + } + + bodyEnd := bytes.Index(result, []byte("\n</body>")) + if bodyEnd < 0 || bodyEnd >= len(result) { + bodyEnd = len(result) - 1 + if bodyEnd < 0 { + bodyEnd = 0 + } + } + + return result[bodyStart+7 : bodyEnd] +} + +func getRstExecPath() string { + path, err := exec.LookPath("rst2html") + if err != nil { + path, err = exec.LookPath("rst2html.py") + if err != nil { + return "" + } + } + return path +} + +// Supports returns whether rst is installed on this computer. +func Supports() bool { + return getRstExecPath() != "" +} diff --git a/markup/rst/convert_test.go b/markup/rst/convert_test.go new file mode 100644 index 000000000..269d92caa --- /dev/null +++ b/markup/rst/convert_test.go @@ -0,0 +1,38 @@ +// Copyright 2019 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package rst + +import ( + "testing" + + "github.com/gohugoio/hugo/common/loggers" + + "github.com/gohugoio/hugo/markup/converter" + + qt "github.com/frankban/quicktest" +) + +func TestConvert(t *testing.T) { + if !Supports() { + t.Skip("rst not installed") + } + c := qt.New(t) + p, err := Provider.New(converter.ProviderConfig{Logger: loggers.NewErrorLogger()}) + c.Assert(err, qt.IsNil) + conv, err := p.New(converter.DocumentContext{}) + c.Assert(err, qt.IsNil) + b, err := conv.Convert(converter.RenderContext{Src: []byte("testContent")}) + c.Assert(err, qt.IsNil) + c.Assert(string(b.Bytes()), qt.Equals, "<div class=\"document\">\n\n\n<p>testContent</p>\n</div>") +} |