summaryrefslogtreecommitdiff
path: root/describe/describe.go
blob: 476178296ac5db42e39e259e328f30bd4dbb6c68 (plain)
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
package describe

import (
	"bufio"
	"git.ewy.one/pik.git/model"
	"io"
	"os"
	"strings"
)

var DescriptionPrefixes = []string{
	"#",
	"//",
}

var descriptions = make(map[model.Target]*string)

// Describe attempts to read a description from a file and stores it in the cache
func Describe(key model.Target, file string) (string, error) {
	if d := descriptions[key]; d != nil {
		return *d, nil
	}
	fd, err := os.Open(file)
	if err != nil {
		msg := err.Error()
		descriptions[key] = &msg
		return "", err
	}
	defer fd.Close()
	text, err := FromReader(fd)
	if err != nil {
		return text, err
	} else {
		descriptions[key] = &text
	}
	return text, err
}

// FromReader reads a description from an io.Reader and returns it.
// this is not stored in the cache.
func FromReader(reader io.Reader) (string, error) {
	scanner := bufio.NewScanner(reader)
	scanner.Split(bufio.ScanLines)
	scanner.Scan()
	text := scanner.Text()
	if strings.HasPrefix(text, "#!") {
		scanner.Scan()
		text = scanner.Text()
	}
	text = strings.TrimSpace(text)
	hasPrefix := false
	for _, p := range DescriptionPrefixes {
		if strings.HasPrefix(text, p) {
			hasPrefix = true
			break
		}
	}
	if !hasPrefix {
		return "", nil
	}
	for _, c := range DescriptionPrefixes {
		text = strings.TrimPrefix(text, c)
		text = strings.TrimSpace(text)
	}
	return text, nil
}