-
Notifications
You must be signed in to change notification settings - Fork 0
/
coverage.html
359 lines (294 loc) · 11.3 KB
/
coverage.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>devscriber: Go Coverage Report</title>
<style>
body {
background: black;
color: rgb(80, 80, 80);
}
body,
pre,
#legend span {
font-family: Menlo, monospace;
font-weight: bold;
}
#topbar {
background: black;
position: fixed;
top: 0;
left: 0;
right: 0;
height: 42px;
border-bottom: 1px solid rgb(80, 80, 80);
}
#content {
margin-top: 50px;
}
#nav,
#legend {
float: left;
margin-left: 10px;
}
#legend {
margin-top: 12px;
}
#nav {
margin-top: 10px;
}
#legend span {
margin: 0 5px;
}
.cov0 {
color: rgb(192, 0, 0)
}
.cov1 {
color: rgb(128, 128, 128)
}
.cov2 {
color: rgb(116, 140, 131)
}
.cov3 {
color: rgb(104, 152, 134)
}
.cov4 {
color: rgb(92, 164, 137)
}
.cov5 {
color: rgb(80, 176, 140)
}
.cov6 {
color: rgb(68, 188, 143)
}
.cov7 {
color: rgb(56, 200, 146)
}
.cov8 {
color: rgb(44, 212, 149)
}
.cov9 {
color: rgb(32, 224, 152)
}
.cov10 {
color: rgb(20, 236, 155)
}
</style>
</head>
<body>
<div id="topbar">
<div id="nav">
<select id="files">
<option value="file0">go.goms.io/github.com/WhitneyLampkin/devscriber/main.go (53.0%)</option>
</select>
</div>
<div id="legend">
<span>not tracked</span>
<span class="cov0">not covered</span>
<span class="cov8">covered</span>
</div>
</div>
<div id="content">
<pre class="file" id="file0" style="display: none">package main
import (
"errors"
"flag"
"fmt"
"io"
"os"
"strconv"
"strings"
"time"
)
// A userInput stores the options provided by the user
type userInput struct {
template string
name string
imageUrl string
all bool
}
// The entry point of the application
func main() <span class="cov0" title="0">{
// Help info displayed when the --help flag is provided
flag.Usage = func() </span><span class="cov0" title="0">{
fmt.Println("+-+-+-+-+-+-+-+-+-+-+")
fmt.Println("|D|e|v|S|c|r|i|b|e|r|")
fmt.Println("+-+-+-+-+-+-+-+-+-+-+")
fmt.Printf("\r\nUsage: %s [OPTIONS]...\n\nOptions:\n", os.Args[0])
flag.PrintDefaults()
}</span>
// Get user input
<span class="cov0" title="0">inputs, err := getUserInput()
check(err)
fmt.Println("+-+-+-+-+-+-+-+-+-+-+")
fmt.Println("|D|e|v|S|c|r|i|b|e|r|")
fmt.Println("+-+-+-+-+-+-+-+-+-+-+")
fmt.Println("\r\nGenerating new file with the following values:")
fmt.Printf("- name: %s", inputs.name)
fmt.Printf("\r\n- template: %s", inputs.template)
fmt.Printf("\r\n- imageUrl: %s", inputs.imageUrl)
// Generate new file(s)
if inputs.all </span><span class="cov0" title="0">{
_, err = generateAllFiles(inputs)
}</span> else<span class="cov0" title="0"> {
_, err = generateFile(inputs.template + ".md")
}</span>
<span class="cov0" title="0">check(err)</span>
}
// Gets user input from the terminal and validates it
// Returns a validated userInput struct
func getUserInput() (userInput, error) <span class="cov8" title="1">{
// Validate the number of required arguments
if len(os.Args) == 0 </span><span class="cov0" title="0">{
return userInput{}, errors.New("the template argument is required")
}</span>
// Define flags for the template, name and imageUrl arguments
<span class="cov8" title="1">template := flag.String("template", "readme-template", "Template type to base the new document on")
name := flag.String("name", "README", "Name of the new document")
imageUrl := flag.String("imageUrl", "./assets/default_image.png", "Url of image to use to decorate the document")
all := flag.Bool("all", false, "Generates all document template when true")
// Parse the flag arguments from the terminal
flag.Parse()
// Validate template value
/* if !(*template == "readme-template" || *template == "readme") {
return userInput{}, errors.New("invalid template value. use readme-template or readme")
} */
// TODO: clean this up later
if *template == "readme" </span><span class="cov0" title="0">{
*template = "readme-template"
}</span>
// Validate name
<span class="cov8" title="1">if *name == "" </span><span class="cov8" title="1">{
return userInput{}, errors.New("there was an error setting the document's name")
}</span>
// Validate imageUrl
<span class="cov8" title="1">if len(*imageUrl) == 0 </span><span class="cov8" title="1">{
// TODO: add true image validation logic
return userInput{}, errors.New("there was an error setting the image's Url")
}</span>
// Return validated userInput
<span class="cov8" title="1">return userInput{*template, *name, *imageUrl, *all}, nil</span>
}
func generateAllFiles(inputs userInput) (bool, error) <span class="cov0" title="0">{
isSuccessful := false
templateFiles, err := os.ReadDir("./templates")
check(err)
for _, file := range templateFiles </span><span class="cov0" title="0">{
_, err := generateFile(file.Name())
check(err)
}</span>
<span class="cov0" title="0">return isSuccessful, err</span>
}
// Returns the filepath of the newly create file
func generateFile(templatePath string) (string, error) <span class="cov8" title="1">{
isAvailable := false
// Getting current templates to validate the templatePath
availableTemplates, err := os.ReadDir("./templates")
check(err)
for _, file := range availableTemplates </span><span class="cov8" title="1">{
if file.Name() == templatePath || strings.Contains(file.Name(), templatePath) </span><span class="cov8" title="1">{
isAvailable = true
break</span>
}
}
// TODO: Refactor later
<span class="cov8" title="1">templatePath = "./templates/" + templatePath + ".md"
if !isAvailable </span><span class="cov0" title="0">{
exitGracefully(fmt.Errorf("the %s filepath does not exist. please try again", templatePath))
}</span>
// Check that template filepath still exists
<span class="cov8" title="1">_, err = validateTemplatePath(templatePath)
check(err)
// Open template file
newDocument, err := os.Open(templatePath)
// Check for errors
check(err)
// Ensure the file is closed after usage
defer newDocument.Close()
// TODO: Create and call a helper function to replace templated values
// Get working directory
workingDir, err := os.Getwd()
if err != nil </span><span class="cov0" title="0">{
return "", fmt.Errorf("error setting %s as the working directory", workingDir)
}</span>
// Create new destination file location
<span class="cov8" title="1">currentTime := time.Now().UTC().Nanosecond()
timeString := strconv.Itoa(currentTime)
//newFilename := "README_" + timeString + ".md"
var newFilename string
switch templatePath </span>{
case "./templates/changelog-template.md":<span class="cov0" title="0">
newFilename = "CHANGELOG_" + timeString + ".md"</span>
case "./templates/codeofconduct-template.md":<span class="cov0" title="0">
newFilename = "CODE_OF_CONDUCT_" + timeString + ".md"</span>
case "./templates/contributing-template.md":<span class="cov0" title="0">
newFilename = "CONTRIBUTING_" + timeString + ".md"</span>
case "./templates/readme-template.md":<span class="cov8" title="1">
newFilename = "README_" + timeString + ".md"</span>
case "./templates/releasenotes-template.md":<span class="cov0" title="0">
newFilename = "RELEASE_NOTES_" + timeString + ".md"</span>
}
<span class="cov8" title="1">destination, err := os.Create(workingDir + "/" + newFilename)
if err != nil </span><span class="cov0" title="0">{
return "", errors.New("error creating the new file destination")
}</span>
<span class="cov8" title="1">defer destination.Close()
// Using io.Copy() since no replacements are being made at this time
newFile, err := io.Copy(destination, newDocument)
if newFile == 0 || err != nil </span><span class="cov0" title="0">{
return "", errors.New("cannot create new file at this time, please try again")
}</span>
<span class="cov8" title="1">fmt.Printf("\r\n\r\nSuccess: %s was added to the current directory\r\n", newFilename)
return newFilename, nil</span>
}
// Ensures the chosen template still exists
func validateTemplatePath(templatePath string) (bool, error) <span class="cov8" title="1">{
// Validate file exists
if _, err := os.Stat(templatePath); err != nil && os.IsNotExist(err) </span><span class="cov8" title="1">{
return false, fmt.Errorf("file %s does not exist", templatePath)
}</span>
// If no errors, the file is valid.
<span class="cov8" title="1">return true, nil</span>
}
// Terminates the execution of the program when unexpected errors occur
func exitGracefully(err error) <span class="cov0" title="0">{
fmt.Fprintf(os.Stderr, "error: %v\n", err)
os.Exit(1)
}</span>
// Checks for errors and terminates the application
func check(e error) <span class="cov8" title="1">{
if e != nil </span><span class="cov0" title="0">{
exitGracefully(e)
}</span>
}
</pre>
</div>
</body>
<script>
(function () {
var files = document.getElementById('files');
var visible;
files.addEventListener('change', onChange, false);
function select(part) {
if (visible)
visible.style.display = 'none';
visible = document.getElementById(part);
if (!visible)
return;
files.value = part;
visible.style.display = 'block';
location.hash = part;
}
function onChange() {
select(files.value);
window.scrollTo(0, 0);
}
if (location.hash != "") {
select(location.hash.substr(1));
}
if (!visible) {
select("file0");
}
})();
</script>
</html>