Support four backticks in doc-test parser (#194)

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [[unpublished]](https://github.com/mlange-42/modo/compare/v0.10.1...main)
+
+### Other
+
+* Doc-tests parser supports quadruple backticks (#194)
+
 ## [[v0.10.1]](https://github.com/mlange-42/modo/compare/v0.10.0...v0.10.1)
 
 ### Documentation

document/doctest.go

@@ -6,6 +6,7 @@ import (
 	"os"
 	"path"
 	"path/filepath"
+	"sort"
 	"strings"
 )
 
@@ -121,7 +122,7 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 	scanner := bufio.NewScanner(strings.NewReader(text))
 	outText := strings.Builder{}
 
-	fenced := false
+	fenced := fenceNone
 	blocks := map[string]*docTest{}
 	var blockLines []string
 	var globalLines []string
@@ -133,8 +134,8 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 		origLine := scanner.Text()
 
 		isStart := false
-		isFence := strings.HasPrefix(origLine, codeFence3)
-		if isFence && !fenced {
+		currFence := getFenceType(origLine)
+		if currFence != fenceNone && fenced == fenceNone {
 			var ok bool
 			var err error
 			blockName, excluded, global, ok, err = parseBlockAttr(origLine)
@@ -146,7 +147,7 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 			if !ok {
 				blockName = ""
 			}
-			fenced = true
+			fenced = currFence
 			isStart = true
 		}
 
@@ -155,7 +156,7 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 			outText.WriteRune('\n')
 		}
 
-		if fenced && !isFence && blockName != "" {
+		if fenced != fenceNone && currFence != fenced && blockName != "" {
 			if global {
 				globalLines = append(globalLines, origLine)
 			} else {
@@ -164,11 +165,11 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 		}
 		count++
 
-		if isFence && fenced && !isStart {
+		if fenced != fenceNone && currFence == fenced && !isStart {
 			if blockName == "" {
 				excluded = false
 				global = false
-				fenced = false
+				fenced = fenceNone
 				continue
 			}
 			if dt, ok := blocks[blockName]; ok {
@@ -186,13 +187,13 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 			globalLines = globalLines[:0]
 			excluded = false
 			global = false
-			fenced = false
+			fenced = fenceNone
 		}
 	}
 	if err := scanner.Err(); err != nil {
 		panic(err)
 	}
-	if fenced {
+	if fenced != fenceNone {
 		if err := warnOrError(strict, "unbalanced code block in %s", strings.Join(elems, ".")); err != nil {
 			return "", nil, err
 		}
@@ -202,6 +203,7 @@ func extractTestsText(text string, elems []string, strict bool) (string, []*docT
 	for _, block := range blocks {
 		tests = append(tests, block)
 	}
+	sort.Slice(tests, func(i, j int) bool { return tests[i].Name < tests[j].Name })
 
 	return strings.TrimSuffix(outText.String(), "\n"), tests, nil
 }

document/doctest_test.go

@@ -84,6 +84,43 @@ func TestExtractDocTests(t *testing.T) {
 	})
 }
 
+func TestExtractDocTests4Ticks(t *testing.T) {
+	text := "Docstring\n" +
+		"\n" +
+		"```mojo {doctest=\"test1\" hide=true global=true}\n" +
+		"````mojo {doctest=\"test2\"}\n" +
+		"Test1\n" +
+		"````\n" +
+		"```\n" +
+		"\n" +
+		"````mojo {doctest=\"test3\" hide=true global=true}\n" +
+		"```mojo {doctest=\"test4\"}\n" +
+		"Test2\n" +
+		"```\n" +
+		"````\n"
+
+	proc := NewProcessor(nil, nil, nil, &Config{})
+	outText, err := proc.extractTests(text, []string{"pkg", "Struct"}, 1)
+	assert.Nil(t, err)
+	assert.Equal(t, 3, len(strings.Split(outText, "\n")))
+
+	assert.Equal(t, 2, len(proc.docTests))
+
+	assert.Equal(t, &docTest{
+		Name:   "test1",
+		Path:   []string{"pkg", "Struct"},
+		Code:   []string{},
+		Global: []string{"````mojo {doctest=\"test2\"}", "Test1", "````"},
+	}, proc.docTests[0])
+
+	assert.Equal(t, &docTest{
+		Name:   "test3",
+		Path:   []string{"pkg", "Struct"},
+		Code:   []string{},
+		Global: []string{"```mojo {doctest=\"test4\"}", "Test2", "```"},
+	}, proc.docTests[1])
+}
+
 func TestExtractTestsMarkdown(t *testing.T) {
 	inDir := t.TempDir()
 	outDir := t.TempDir()

document/exports.go

@@ -8,8 +8,6 @@ import (
 
 const exportsMarker = "Exports:"
 const exportsPrefix = "- "
-const codeFence3 = "```"
-const codeFence4 = "````"
 
 type packageExport struct {
 	Short []string

document/util.go

@@ -5,11 +5,34 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
+	"strings"
 	"text/template"
 
 	"github.com/mlange-42/modo/assets"
 )
 
+const codeFence3 = "```"
+const codeFence4 = "````"
+
+type fenceType uint8
+
+const (
+	fenceNone fenceType = iota
+	fenceThree
+	fenceFour
+)
+
+func getFenceType(line string) fenceType {
+	isFence4 := strings.HasPrefix(line, codeFence4)
+	if strings.HasPrefix(line, codeFence3) && !isFence4 {
+		return fenceThree
+	}
+	if isFence4 {
+		return fenceFour
+	}
+	return fenceNone
+}
+
 // appends to a slice, but guaranties to return a new one and not alter the original.
 func appendNew[T any](sl []T, elems ...T) []T {
 	sl2 := make([]T, len(sl), len(sl)+len(elems))