helpers.go

package main

import (
	"encoding/json"
	"fmt"
	"html/template"
	"io/ioutil"
	"os"
	"os/user"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"
	"time"

	"github.com/fatih/color"
)

// AdrConfig ADR configuration, loaded and used by each sub-command
type AdrConfig struct {
	BaseDir string `json:"base_directory"`
}

// Adr basic structure
type Adr struct {
	Number int
	Title  string
	Date   time.Time
	Status AdrStatus
}

// AdrStatus type
type AdrStatus string

// ADR status enums
const (
	PROPOSED   AdrStatus = "Proposed"
	ACCEPTED   AdrStatus = "Accepted"
	DEPRECATED AdrStatus = "Deprecated"
	SUPERSEDED AdrStatus = "Superseded"
)

var usr, err = user.Current()
var adrConfigFolderName = ".adr"
var adrConfigFileName = "config.json"
var adrConfigTemplateName = "template.md"
var adrConfigFolderPath = filepath.Join(usr.HomeDir, adrConfigFolderName)
var adrConfigFilePath = filepath.Join(adrConfigFolderPath, adrConfigFileName)
var adrTemplateFilePath = filepath.Join(adrConfigFolderPath, adrConfigTemplateName)
var adrDefaultBaseFolder = filepath.Join(usr.HomeDir, "adr")

func initBaseDir(baseDir string) {
	if _, err := os.Stat(baseDir); os.IsNotExist(err) {
		err = os.Mkdir(baseDir, 0744)
		if err != nil {
			panic(err)
		}
	} else {
		color.Red(baseDir + " already exists, skipping folder creation")
	}
}

func initConfig(baseDir string) {
	if _, err := os.Stat(adrConfigFolderPath); os.IsNotExist(err) {
		err = os.Mkdir(adrConfigFolderPath, 0744)
		if err != nil {
			panic(err)
		}
	}
	config := AdrConfig{BaseDir: baseDir}
	bytes, err := json.MarshalIndent(config, "", " ")
	if err != nil {
		panic(err)
	}
	err = ioutil.WriteFile(adrConfigFilePath, bytes, 0644)
	if err != nil {
		panic(err)
	}
}

func initTemplate() {
	body, err := fs.ReadFile("tpl/doc.tpl.yaml")
	if err != nil {
		panic(err)
	}

	err = ioutil.WriteFile(adrTemplateFilePath, body, 0644)
	if err != nil {
		panic(err)
	}
}

func updateConfig(config AdrConfig) {
	bytes, err := json.MarshalIndent(config, "", " ")
	if err != nil {
		panic(err)
	}
	err = ioutil.WriteFile(adrConfigFilePath, bytes, 0644)
	if err != nil {
		panic(err)
	}
}

func getConfig() AdrConfig {
	var currentConfig AdrConfig

	bytes, err := ioutil.ReadFile(adrConfigFilePath)
	if err != nil {
		color.Red("No ADR configuration is found!")
		color.HiGreen("Start by initializing ADR configuration, check 'adr init --help' for more help")
		os.Exit(1)
	}

	err = json.Unmarshal(bytes, &currentConfig)
	if err != nil {
		panic(err)
	}
	return currentConfig
}

func newAdr(config AdrConfig, adrName []string) {
	adr := Adr{
		Title:  strings.Join(adrName, " "),
		Date:   time.Now().UTC(),
		Number: findLastNumber(config) + 1,
		Status: PROPOSED,
	}
	tpl, err := template.ParseFiles(adrTemplateFilePath)
	if err != nil {
		panic(err)
	}
	adrFileName := fmt.Sprintf("%05d", adr.Number) + "-" + strings.ToLower(strings.Join(strings.Split(strings.Trim(adr.Title, "\n \t"), " "), "-")) + ".md"
	adrFullPath := filepath.Join(config.BaseDir, adrFileName)
	f, err := os.Create(adrFullPath)
	if err != nil {
		panic(err)
	}
	err = tpl.Execute(f, adr)
	if err != nil {
		panic(err)
	}
	_ = f.Close()
	color.Green("ADR number " + strconv.Itoa(adr.Number) + " was successfully written to : " + adrFullPath)
}

// findLastNumber returns the highest number that is found in a directory.
// If the directory is empty, 0 is returned.
func findLastNumber(config AdrConfig) int {
	var max int
	contents, err := os.ReadDir(config.BaseDir)
	if err != nil {
		panic(err)
	}
	regex := regexp.MustCompile(`(\d{5,}).*`)
	for _, c := range contents {
		m := regex.FindSubmatch([]byte(c.Name()))
		if m != nil {
			n, err := strconv.Atoi(string(m[1]))
			if err != nil {
				panic(err)
			}
			if n >= max {
				max = n
			}
		}
	}
	return max
}