Make comments sortable for diffing generated files

Signed-off-by: Knut Ahlers <knut@ahlers.me>

config.go

@@ -5,6 +5,7 @@ import (
 	"io/ioutil"
 	"net/http"
 	"os"
+	"sort"
 	"strings"
 	"text/template"
 
@@ -86,6 +87,11 @@ func loadConfigFile(filename string) (*configfile, error) {
 
 	funcs := korvike.GetFunctionMap()
 	funcs["to_punycode"] = domainToPunycode
+	funcs["join"] = strings.Join
+	funcs["sort"] = func(in []string) []string {
+		sort.Slice(in, func(i, j int) bool { return strings.ToLower(in[i]) < strings.ToLower(in[j]) })
+		return in
+	}
 
 	if out.tpl, err = template.
 		New("configTemplate").

config.sample.yaml

@@ -114,7 +114,7 @@ template: |
 
   ; Blacklist entries
   {{ range .blacklist -}}
-  {{ to_punycode .Domain }} CNAME . ; {{ .Comment }}
+  {{ to_punycode .Domain }} CNAME . ; {{ .Comments }}
   {{ end }}
 
 ...

main.go

@@ -4,7 +4,6 @@ import (
 	"fmt"
 	"os"
 	"sort"
-	"strings"
 	"sync"
 
 	log "github.com/sirupsen/logrus"
@@ -108,7 +107,7 @@ func main() {
 func addIfNotExists(entries []entry, e entry) []entry {
 	for i, pe := range entries {
 		if pe.Domain == e.Domain {
-			entries[i].Comment = strings.Join([]string{pe.Comment, e.Comment}, ", ")
+			entries[i].Comments = append(pe.Comments, e.Comments...)
 			return entries
 		}
 	}

provider.go

@@ -12,8 +12,8 @@ var (
 )
 
 type entry struct {
-	Domain  string
+	Domain   string
-	Comment string
+	Comments []string
 }
 
 type provider interface {

provider_domainList.go

@@ -44,8 +44,8 @@ func (p providerdomainList) GetDomainList(d providerDefinition) ([]entry, error)
 		}
 
 		entries = append(entries, entry{
-			Domain:  domain,
+			Domain:   domain,
-			Comment: d.Name,
+			Comments: []string{d.Name},
 		})
 	}
 

provider_hostFile.go

@@ -63,8 +63,8 @@ func (p providerHostFile) GetDomainList(d providerDefinition) ([]entry, error) {
 		}
 
 		entries = append(entries, entry{
-			Domain:  groups[1],
+			Domain:   groups[1],
-			Comment: comment,
+			Comments: []string{comment},
 		})
 	}