12930260133

Committed 23 Jan 2025 01:29PM CUT coverage: 61.572%. Remained the same

Build # 12930260133

Build Type

Pull #106

github

Committed by

web-flow

Commit Message

Merge af7cd61ff into 7946c93f0

Pull Request Pull Request #106: Fix file permissions

Run Details

987 of 1603 relevant lines covered (61.57%)

29.41 hits per line

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

48.39

/document/render.go

package document

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

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

func Render(docs *Docs, config *Config, form Formatter) error {
        t, err := loadTemplates(form, config.TemplateDirs...)
        if err != nil {
                return err
        }
        if !config.DryRun {
                proc := NewProcessor(docs, form, t, config)
                return renderWith(config, proc)
        }

        files := []string{}
        proc := NewProcessorWithWriter(docs, form, t, config, func(file, text string) error {
                files = append(files, file)
                return nil
        })
        err = renderWith(config, proc)
        if err != nil {
                return err
        }

        fmt.Println("Dry-run. Would write these files:")
        for _, f := range files {
                fmt.Println(f)
        }
        return nil
}

func ExtractTests(docs *Docs, config *Config, form Formatter) error {
        caseSensitiveSystem = !config.CaseInsensitive
        t, err := loadTemplates(form, config.TemplateDirs...)
        if err != nil {
                return err
        }
        var proc *Processor
        if config.DryRun {
                proc = NewProcessorWithWriter(docs, form, t, config, func(file, text string) error {
                        return nil
                })
        } else {
                proc = NewProcessor(docs, form, t, config)
        }
        return proc.ExtractTests()
}

func renderWith(config *Config, proc *Processor) error {
        caseSensitiveSystem = !config.CaseInsensitive
        if err := proc.PrepareDocs(); err != nil {
                return err
        }
        if err := renderPackage(proc.ExportDocs.Decl, []string{config.OutputDir}, proc); err != nil {
                return err
        }
        if err := proc.Formatter.WriteAuxiliary(proc.ExportDocs.Decl, config.OutputDir, proc); err != nil {
                return err
        }
        return nil
}

func renderElement(data interface {
        Named
        Kinded
}, proc *Processor) (string, error) {
        b := strings.Builder{}
        err := proc.Template.ExecuteTemplate(&b, data.GetKind()+".md", data)
        if err != nil {
                return "", err
        }
        return proc.Formatter.ProcessMarkdown(data, b.String(), proc)
}

func renderPackage(p *Package, dir []string, proc *Processor) error {
        newDir := appendNew(dir, p.GetFileName())
        pkgPath := path.Join(newDir...)
        if err := proc.mkDirs(pkgPath); err != nil {
                return err
        }

        for _, pkg := range p.Packages {
                if err := renderPackage(pkg, newDir, proc); err != nil {
                        return err
                }
        }

        for _, mod := range p.Modules {
                if err := renderModule(mod, newDir, proc); err != nil {
                        return err
                }
        }

        if err := renderList(p.Structs, newDir, proc); err != nil {
                return err
        }
        if err := renderList(p.Traits, newDir, proc); err != nil {
                return err
        }
        if err := renderList(p.Functions, newDir, proc); err != nil {
                return err
        }

        text, err := renderElement(p, proc)
        if err != nil {
                return err
        }
        if err := linkAndWrite(text, newDir, len(newDir), "package", proc); err != nil {
                return err
        }

        return nil
}

func renderModule(mod *Module, dir []string, proc *Processor) error {
        newDir := appendNew(dir, mod.GetFileName())
        if err := proc.mkDirs(path.Join(newDir...)); err != nil {
                return err
        }

        if err := renderList(mod.Structs, newDir, proc); err != nil {
                return err
        }
        if err := renderList(mod.Traits, newDir, proc); err != nil {
                return err
        }
        if err := renderList(mod.Functions, newDir, proc); err != nil {
                return err
        }

        text, err := renderElement(mod, proc)
        if err != nil {
                return err
        }
        if err := linkAndWrite(text, newDir, len(newDir), "module", proc); err != nil {
                return err
        }

        return nil
}

func renderList[T interface {
        Named
        Kinded
}](list []T, dir []string, proc *Processor) error {
        for _, elem := range list {
                newDir := appendNew(dir, elem.GetFileName())
                text, err := renderElement(elem, proc)
                if err != nil {
                        return err
                }
                if err := linkAndWrite(text, newDir, len(dir), elem.GetKind(), proc); err != nil {
                        return err
                }
        }
        return nil
}

func loadTemplates(f Formatter, additional ...string) (*template.Template, error) {
        allTemplates, err := findTemplatesFS()
        if err != nil {
                return nil, err
        }
        templ := template.New("all")
        templ = templ.Funcs(template.FuncMap{
                "toLink": f.ToLinkPath,
        })
        templ, err = templ.ParseFS(assets.Templates, allTemplates...)
        if err != nil {
                return nil, err
        }

        for _, dir := range additional {
                if dir == "" {
                        continue
                }
                moreTemplates, err := findTemplates(dir)
                if err != nil {
                        return nil, err
                }
                templ, err = templ.ParseFiles(moreTemplates...)
                if err != nil {
                        return nil, err
                }
        }
        return templ, nil
}

func findTemplatesFS() ([]string, error) {
        allTemplates := []string{}
        err := fs.WalkDir(assets.Templates, ".",
                func(path string, info os.DirEntry, err error) error {
                        if err != nil {
                                return err
                        }
                        if !info.IsDir() {
                                allTemplates = append(allTemplates, path)
                        }
                        return nil
                })
        if err != nil {
                return nil, err
        }
        return allTemplates, nil
}

func findTemplates(dir string) ([]string, error) {
        allTemplates := []string{}
        err := filepath.WalkDir(dir,
                func(path string, info os.DirEntry, err error) error {
                        if err != nil {
                                return err
                        }
                        if !info.IsDir() {
                                allTemplates = append(allTemplates, path)
                        }
                        return nil
                })
        if err != nil {
                return nil, err
        }
        return allTemplates, nil
}

func linkAndWrite(text string, dir []string, modElems int, kind string, proc *Processor) error {
        text, err := proc.ReplacePlaceholders(text, dir[1:], modElems-1)
        if err != nil {
                return err
        }
        outFile, err := proc.Formatter.ToFilePath(path.Join(dir...), kind)
        if err != nil {
                return err
        }
        return proc.WriteFile(outFile, text)
}

1	package document
2
3	import (
4	"fmt"
5	"io/fs"
6	"os"
7	"path"
8	"path/filepath"
9	"strings"
10	"text/template"
11
12	"github.com/mlange-42/modo/assets"
13	)
14
15	func Render(docs Docs, config Config, form Formatter) error {	2✔
16	t, err := loadTemplates(form, config.TemplateDirs...)	2✔
17	if err != nil {	2✔
18	return err	×
19	}	×
20	if !config.DryRun {	3✔
21	proc := NewProcessor(docs, form, t, config)	1✔
22	return renderWith(config, proc)	1✔
23	}	1✔
24
25	files := []string{}	1✔
26	proc := NewProcessorWithWriter(docs, form, t, config, func(file, text string) error {	10✔
27	files = append(files, file)	9✔
28	return nil	9✔
29	})	9✔
30	err = renderWith(config, proc)	1✔
31	if err != nil {	1✔
32	return err	×
33	}	×
34
35	fmt.Println("Dry-run. Would write these files:")	1✔
36	for _, f := range files {	10✔
37	fmt.Println(f)	9✔
38	}	9✔
39	return nil	1✔
40	}
41
42	func ExtractTests(docs Docs, config Config, form Formatter) error {	×
43	caseSensitiveSystem = !config.CaseInsensitive	×
44	t, err := loadTemplates(form, config.TemplateDirs...)	×
45	if err != nil {	×
46	return err	×
47	}	×
48	var proc *Processor	×
49	if config.DryRun {	×
50	proc = NewProcessorWithWriter(docs, form, t, config, func(file, text string) error {	×
51	return nil	×
52	})	×
53	} else {	×
54	proc = NewProcessor(docs, form, t, config)	×
55	}	×
56	return proc.ExtractTests()	×
57	}
58
59	func renderWith(config Config, proc Processor) error {	6✔
60	caseSensitiveSystem = !config.CaseInsensitive	6✔
61	if err := proc.PrepareDocs(); err != nil {	6✔
62	return err	×
63	}	×
64	if err := renderPackage(proc.ExportDocs.Decl, []string{config.OutputDir}, proc); err != nil {	6✔
65	return err	×
66	}	×
67	if err := proc.Formatter.WriteAuxiliary(proc.ExportDocs.Decl, config.OutputDir, proc); err != nil {	6✔
68	return err	×
69	}	×
70	return nil	6✔
71	}
72
73	func renderElement(data interface {
74	Named
75	Kinded
76	}, proc *Processor) (string, error) {	35✔
77	b := strings.Builder{}	35✔
78	err := proc.Template.ExecuteTemplate(&b, data.GetKind()+".md", data)	35✔
79	if err != nil {	35✔
80	return "", err	×
81	}	×
82	return proc.Formatter.ProcessMarkdown(data, b.String(), proc)	35✔
83	}
84
85	func renderPackage(p Package, dir []string, proc Processor) error {	8✔
86	newDir := appendNew(dir, p.GetFileName())	8✔
87	pkgPath := path.Join(newDir...)	8✔
88	if err := proc.mkDirs(pkgPath); err != nil {	8✔
89	return err	×
90	}	×
91
92	for _, pkg := range p.Packages {	10✔
93	if err := renderPackage(pkg, newDir, proc); err != nil {	2✔
94	return err	×
95	}	×
96	}
97
98	for _, mod := range p.Modules {	16✔
99	if err := renderModule(mod, newDir, proc); err != nil {	8✔
100	return err	×
101	}	×
102	}
103
104	if err := renderList(p.Structs, newDir, proc); err != nil {	8✔
105	return err	×
106	}	×
107	if err := renderList(p.Traits, newDir, proc); err != nil {	8✔
108	return err	×
109	}	×
110	if err := renderList(p.Functions, newDir, proc); err != nil {	8✔
111	return err	×
112	}	×
113
114	text, err := renderElement(p, proc)	8✔
115	if err != nil {	8✔
116	return err	×
117	}	×
118	if err := linkAndWrite(text, newDir, len(newDir), "package", proc); err != nil {	8✔
119	return err	×
120	}	×
121
122	return nil	8✔
123	}
124
125	func renderModule(mod Module, dir []string, proc Processor) error {	8✔
126	newDir := appendNew(dir, mod.GetFileName())	8✔
127	if err := proc.mkDirs(path.Join(newDir...)); err != nil {	8✔
128	return err	×
129	}	×
130
131	if err := renderList(mod.Structs, newDir, proc); err != nil {	8✔
132	return err	×
133	}	×
134	if err := renderList(mod.Traits, newDir, proc); err != nil {	8✔
135	return err	×
136	}	×
137	if err := renderList(mod.Functions, newDir, proc); err != nil {	8✔
138	return err	×
139	}	×
140
141	text, err := renderElement(mod, proc)	8✔
142	if err != nil {	8✔
143	return err	×
144	}	×
145	if err := linkAndWrite(text, newDir, len(newDir), "module", proc); err != nil {	8✔
146	return err	×
147	}	×
148
149	return nil	8✔
150	}
151
152	func renderList[T interface {
153	Named
154	Kinded
155	}](list []T, dir []string, proc *Processor) error {	48✔
156	for _, elem := range list {	65✔
157	newDir := appendNew(dir, elem.GetFileName())	17✔
158	text, err := renderElement(elem, proc)	17✔
159	if err != nil {	17✔
160	return err	×
161	}	×
162	if err := linkAndWrite(text, newDir, len(dir), elem.GetKind(), proc); err != nil {	17✔
163	return err	×
164	}	×
165	}
166	return nil	48✔
167	}
168
169	func loadTemplates(f Formatter, additional ...string) (*template.Template, error) {	8✔
170	allTemplates, err := findTemplatesFS()	8✔
171	if err != nil {	8✔
172	return nil, err	×
173	}	×
174	templ := template.New("all")	8✔
175	templ = templ.Funcs(template.FuncMap{	8✔
176	"toLink": f.ToLinkPath,	8✔
177	})	8✔
178	templ, err = templ.ParseFS(assets.Templates, allTemplates...)	8✔
179	if err != nil {	8✔
180	return nil, err	×
181	}	×
182
183	for _, dir := range additional {	8✔
184	if dir == "" {	×
185	continue	×
186	}
187	moreTemplates, err := findTemplates(dir)	×
188	if err != nil {	×
189	return nil, err	×
190	}	×
191	templ, err = templ.ParseFiles(moreTemplates...)	×
192	if err != nil {	×
193	return nil, err	×
194	}	×
195	}
196	return templ, nil	8✔
197	}
198
199	func findTemplatesFS() ([]string, error) {	8✔
200	allTemplates := []string{}	8✔
201	err := fs.WalkDir(assets.Templates, ".",	8✔
202	func(path string, info os.DirEntry, err error) error {	264✔
203	if err != nil {	256✔
204	return err	×
205	}	×
206	if !info.IsDir() {	472✔
207	allTemplates = append(allTemplates, path)	216✔
208	}	216✔
209	return nil	256✔
210	})
211	if err != nil {	8✔
212	return nil, err	×
213	}	×
214	return allTemplates, nil	8✔
215	}
216
217	func findTemplates(dir string) ([]string, error) {	×
218	allTemplates := []string{}	×
219	err := filepath.WalkDir(dir,	×
220	func(path string, info os.DirEntry, err error) error {	×
221	if err != nil {	×
222	return err	×
223	}	×
224	if !info.IsDir() {	×
225	allTemplates = append(allTemplates, path)	×
226	}	×
227	return nil	×
228	})
229	if err != nil {	×
230	return nil, err	×
231	}	×
232	return allTemplates, nil	×
233	}
234
235	func linkAndWrite(text string, dir []string, modElems int, kind string, proc *Processor) error {	33✔
236	text, err := proc.ReplacePlaceholders(text, dir[1:], modElems-1)	33✔
237	if err != nil {	33✔
238	return err	×
239	}	×
240	outFile, err := proc.Formatter.ToFilePath(path.Join(dir...), kind)	33✔
241	if err != nil {	33✔
242	return err	×
243	}	×
244	return proc.WriteFile(outFile, text)	33✔
245	}

mlange-42 / modo / 12930260133

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