12845272312

Committed 18 Jan 2025 03:31PM CUT coverage: 59.033%. Remained the same

Build # 12845272312

Build Type

push

github

Committed by

web-flow

Commit Message

Fix README, update CHANGELOG (#65)

Run Details

794 of 1345 relevant lines covered (59.03%)

7.46 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

0.0

/format/mdbook.go

package format

import (
        "fmt"
        "io"
        "io/fs"
        "os"
        "path"
        "strings"
        "text/template"

        "github.com/mlange-42/modo/assets"
        "github.com/mlange-42/modo/document"
)

type MdBookFormatter struct{}

func (f *MdBookFormatter) Render(docs *document.Docs, config *document.Config) error {
        return document.Render(docs, config, f)
}

func (f *MdBookFormatter) ProcessMarkdown(element any, text string, proc *document.Processor) (string, error) {
        return text, nil
}

func (f *MdBookFormatter) WriteAuxiliary(p *document.Package, dir string, proc *document.Processor) error {
        if err := f.writeSummary(p, dir, proc); err != nil {
                return err
        }
        if err := f.writeToml(p, dir, proc.Template); err != nil {
                return err
        }
        if err := f.writeCss(dir); err != nil {
                return err
        }
        return nil
}

func (f *MdBookFormatter) ToFilePath(p string, kind string) (string, error) {
        if kind == "package" || kind == "module" {
                return path.Join(p, "_index.md"), nil
        }
        return p + ".md", nil
}

func (f *MdBookFormatter) ToLinkPath(p string, kind string) (string, error) {
        return f.ToFilePath(p, kind)
}

type summary struct {
        Summary   string
        Packages  string
        Modules   string
        Structs   string
        Traits    string
        Functions string
}

func (f *MdBookFormatter) writeSummary(p *document.Package, dir string, proc *document.Processor) error {
        summary, err := f.renderSummary(p, proc)
        if err != nil {
                return err
        }
        summaryPath := path.Join(dir, p.GetFileName(), "SUMMARY.md")
        if err := os.WriteFile(summaryPath, []byte(summary), 0666); err != nil {
                return err
        }
        return nil
}

func (f *MdBookFormatter) renderSummary(p *document.Package, proc *document.Processor) (string, error) {
        s := summary{}

        pkgFile, err := f.ToLinkPath("", "package")
        if err != nil {
                return "", err
        }
        s.Summary = fmt.Sprintf("[`%s`](%s)", p.GetName(), pkgFile)

        pkgs := strings.Builder{}
        for _, p := range p.Packages {
                if err := f.renderPackage(p, proc.Template, nil, &pkgs); err != nil {
                        return "", err
                }
        }
        s.Packages = pkgs.String()

        mods := strings.Builder{}
        for _, m := range p.Modules {
                if err := f.renderModule(m, nil, &mods); err != nil {
                        return "", err
                }
        }
        s.Modules = mods.String()

        elems := strings.Builder{}
        for _, elem := range p.Structs {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Structs = elems.String()
        elems = strings.Builder{}
        for _, elem := range p.Traits {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Traits = elems.String()
        elems = strings.Builder{}
        for _, elem := range p.Functions {
                if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {
                        return "", err
                }
        }
        s.Functions = elems.String()

        b := strings.Builder{}
        if err := proc.Template.ExecuteTemplate(&b, "mdbook_summary.md", &s); err != nil {
                return "", err
        }

        return b.String(), nil
}

func (f *MdBookFormatter) renderPackage(pkg *document.Package, t *template.Template, linkPath []string, out *strings.Builder) error {
        newPath := append([]string{}, linkPath...)
        newPath = append(newPath, pkg.GetFileName())

        pkgFile, err := f.ToLinkPath(path.Join(newPath...), "package")
        if err != nil {
                return err
        }

        fmt.Fprintf(out, "%-*s- [`%s`](%s))\n", 2*len(linkPath), "", pkg.GetName(), pkgFile)
        for _, p := range pkg.Packages {
                if err := f.renderPackage(p, t, newPath, out); err != nil {
                        return err
                }
        }
        for _, m := range pkg.Modules {
                if err := f.renderModule(m, newPath, out); err != nil {
                        return err
                }
        }

        pathStr := path.Join(newPath...)
        childDepth := 2*(len(newPath)-1) + 2
        for _, elem := range pkg.Structs {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range pkg.Traits {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range pkg.Functions {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }

        return nil
}

func (f *MdBookFormatter) renderModule(mod *document.Module, linkPath []string, out *strings.Builder) error {
        newPath := append([]string{}, linkPath...)
        newPath = append(newPath, mod.GetFileName())

        pathStr := path.Join(newPath...)

        modFile, err := f.ToLinkPath(pathStr, "module")
        if err != nil {
                return err
        }
        fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", 2*(len(newPath)-1), "", mod.GetName(), modFile)

        childDepth := 2*(len(newPath)-1) + 2
        for _, elem := range mod.Structs {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range mod.Traits {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        for _, elem := range mod.Functions {
                if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {
                        return err
                }
        }
        return nil
}

func (f *MdBookFormatter) renderModuleMember(mem document.Named, pathStr string, depth int, out io.Writer) error {
        memPath, err := f.ToLinkPath(path.Join(pathStr, mem.GetFileName(), ""), "")
        if err != nil {
                return err
        }
        fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", depth, "", mem.GetName(), memPath)
        return nil
}

func (f *MdBookFormatter) writeToml(p *document.Package, dir string, t *template.Template) error {
        toml, err := f.renderToml(p, t)
        if err != nil {
                return err
        }
        tomlPath := path.Join(dir, "book.toml")
        if err := os.WriteFile(tomlPath, []byte(toml), 0666); err != nil {
                return err
        }
        return nil
}

func (f *MdBookFormatter) renderToml(p *document.Package, t *template.Template) (string, error) {
        b := strings.Builder{}
        if err := t.ExecuteTemplate(&b, "book.toml", p); err != nil {
                return "", err
        }
        return b.String(), nil
}

func (f *MdBookFormatter) writeCss(dir string) error {
        cssDir := path.Join(dir, "css")
        if err := os.MkdirAll(cssDir, os.ModePerm); err != nil && !os.IsExist(err) {
                return err
        }
        css, err := fs.ReadFile(assets.CSS, "css/mdbook.css")
        if err != nil {
                return err
        }
        if err := os.WriteFile(path.Join(cssDir, "custom.css"), css, 0666); err != nil {
                return err
        }
        return nil
}

1	package format
2
3	import (
4	"fmt"
5	"io"
6	"io/fs"
7	"os"
8	"path"
9	"strings"
10	"text/template"
11
12	"github.com/mlange-42/modo/assets"
13	"github.com/mlange-42/modo/document"
14	)
15
16	type MdBookFormatter struct{}
17
18	func (f MdBookFormatter) Render(docs document.Docs, config *document.Config) error {	×
19	return document.Render(docs, config, f)	×
20	}	×
21
22	func (f MdBookFormatter) ProcessMarkdown(element any, text string, proc document.Processor) (string, error) {	×
23	return text, nil	×
24	}	×
25
26	func (f MdBookFormatter) WriteAuxiliary(p document.Package, dir string, proc *document.Processor) error {	×
27	if err := f.writeSummary(p, dir, proc); err != nil {	×
28	return err	×
29	}	×
30	if err := f.writeToml(p, dir, proc.Template); err != nil {	×
31	return err	×
32	}	×
33	if err := f.writeCss(dir); err != nil {	×
34	return err	×
35	}	×
36	return nil	×
37	}
38
39	func (f *MdBookFormatter) ToFilePath(p string, kind string) (string, error) {	×
40	if kind == "package" \|\| kind == "module" {	×
41	return path.Join(p, "_index.md"), nil	×
42	}	×
43	return p + ".md", nil	×
44	}
45
46	func (f *MdBookFormatter) ToLinkPath(p string, kind string) (string, error) {	×
47	return f.ToFilePath(p, kind)	×
48	}	×
49
50	type summary struct {
51	Summary string
52	Packages string
53	Modules string
54	Structs string
55	Traits string
56	Functions string
57	}
58
59	func (f MdBookFormatter) writeSummary(p document.Package, dir string, proc *document.Processor) error {	×
60	summary, err := f.renderSummary(p, proc)	×
61	if err != nil {	×
62	return err	×
63	}	×
64	summaryPath := path.Join(dir, p.GetFileName(), "SUMMARY.md")	×
65	if err := os.WriteFile(summaryPath, []byte(summary), 0666); err != nil {	×
66	return err	×
67	}	×
68	return nil	×
69	}
70
71	func (f MdBookFormatter) renderSummary(p document.Package, proc *document.Processor) (string, error) {	×
72	s := summary{}	×
73		×
74	pkgFile, err := f.ToLinkPath("", "package")	×
75	if err != nil {	×
76	return "", err	×
77	}	×
78	s.Summary = fmt.Sprintf("[`%s`](%s)", p.GetName(), pkgFile)	×
79		×
80	pkgs := strings.Builder{}	×
81	for _, p := range p.Packages {	×
82	if err := f.renderPackage(p, proc.Template, nil, &pkgs); err != nil {	×
83	return "", err	×
84	}	×
85	}
86	s.Packages = pkgs.String()	×
87		×
88	mods := strings.Builder{}	×
89	for _, m := range p.Modules {	×
90	if err := f.renderModule(m, nil, &mods); err != nil {	×
91	return "", err	×
92	}	×
93	}
94	s.Modules = mods.String()	×
95		×
96	elems := strings.Builder{}	×
97	for _, elem := range p.Structs {	×
98	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
99	return "", err	×
100	}	×
101	}
102	s.Structs = elems.String()	×
103	elems = strings.Builder{}	×
104	for _, elem := range p.Traits {	×
105	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
106	return "", err	×
107	}	×
108	}
109	s.Traits = elems.String()	×
110	elems = strings.Builder{}	×
111	for _, elem := range p.Functions {	×
112	if err := f.renderModuleMember(elem, "", 0, &elems); err != nil {	×
113	return "", err	×
114	}	×
115	}
116	s.Functions = elems.String()	×
117		×
118	b := strings.Builder{}	×
119	if err := proc.Template.ExecuteTemplate(&b, "mdbook_summary.md", &s); err != nil {	×
120	return "", err	×
121	}	×
122
123	return b.String(), nil	×
124	}
125
126	func (f MdBookFormatter) renderPackage(pkg document.Package, t template.Template, linkPath []string, out strings.Builder) error {	×
127	newPath := append([]string{}, linkPath...)	×
128	newPath = append(newPath, pkg.GetFileName())	×
129		×
130	pkgFile, err := f.ToLinkPath(path.Join(newPath...), "package")	×
131	if err != nil {	×
132	return err	×
133	}	×
134
135	fmt.Fprintf(out, "%-s- [`%s`](%s))\n", 2len(linkPath), "", pkg.GetName(), pkgFile)	×
136	for _, p := range pkg.Packages {	×
137	if err := f.renderPackage(p, t, newPath, out); err != nil {	×
138	return err	×
139	}	×
140	}
141	for _, m := range pkg.Modules {	×
142	if err := f.renderModule(m, newPath, out); err != nil {	×
143	return err	×
144	}	×
145	}
146
147	pathStr := path.Join(newPath...)	×
148	childDepth := 2*(len(newPath)-1) + 2	×
149	for _, elem := range pkg.Structs {	×
150	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
151	return err	×
152	}	×
153	}
154	for _, elem := range pkg.Traits {	×
155	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
156	return err	×
157	}	×
158	}
159	for _, elem := range pkg.Functions {	×
160	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
161	return err	×
162	}	×
163	}
164
165	return nil	×
166	}
167
168	func (f MdBookFormatter) renderModule(mod document.Module, linkPath []string, out *strings.Builder) error {	×
169	newPath := append([]string{}, linkPath...)	×
170	newPath = append(newPath, mod.GetFileName())	×
171		×
172	pathStr := path.Join(newPath...)	×
173		×
174	modFile, err := f.ToLinkPath(pathStr, "module")	×
175	if err != nil {	×
176	return err	×
177	}	×
178	fmt.Fprintf(out, "%-s- [`%s`](%s)\n", 2(len(newPath)-1), "", mod.GetName(), modFile)	×
179		×
180	childDepth := 2*(len(newPath)-1) + 2	×
181	for _, elem := range mod.Structs {	×
182	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
183	return err	×
184	}	×
185	}
186	for _, elem := range mod.Traits {	×
187	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
188	return err	×
189	}	×
190	}
191	for _, elem := range mod.Functions {	×
192	if err := f.renderModuleMember(elem, pathStr, childDepth, out); err != nil {	×
193	return err	×
194	}	×
195	}
196	return nil	×
197	}
198
199	func (f *MdBookFormatter) renderModuleMember(mem document.Named, pathStr string, depth int, out io.Writer) error {	×
200	memPath, err := f.ToLinkPath(path.Join(pathStr, mem.GetFileName(), ""), "")	×
201	if err != nil {	×
202	return err	×
203	}	×
204	fmt.Fprintf(out, "%-*s- [`%s`](%s)\n", depth, "", mem.GetName(), memPath)	×
205	return nil	×
206	}
207
208	func (f MdBookFormatter) writeToml(p document.Package, dir string, t *template.Template) error {	×
209	toml, err := f.renderToml(p, t)	×
210	if err != nil {	×
211	return err	×
212	}	×
213	tomlPath := path.Join(dir, "book.toml")	×
214	if err := os.WriteFile(tomlPath, []byte(toml), 0666); err != nil {	×
215	return err	×
216	}	×
217	return nil	×
218	}
219
220	func (f MdBookFormatter) renderToml(p document.Package, t *template.Template) (string, error) {	×
221	b := strings.Builder{}	×
222	if err := t.ExecuteTemplate(&b, "book.toml", p); err != nil {	×
223	return "", err	×
224	}	×
225	return b.String(), nil	×
226	}
227
228	func (f *MdBookFormatter) writeCss(dir string) error {	×
229	cssDir := path.Join(dir, "css")	×
230	if err := os.MkdirAll(cssDir, os.ModePerm); err != nil && !os.IsExist(err) {	×
231	return err	×
232	}	×
233	css, err := fs.ReadFile(assets.CSS, "css/mdbook.css")	×
234	if err != nil {	×
235	return err	×
236	}	×
237	if err := os.WriteFile(path.Join(cssDir, "custom.css"), css, 0666); err != nil {	×
238	return err	×
239	}	×
240	return nil	×
241	}

mlange-42 / modo / 12845272312

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous