version bump - v0.3.0

- remove identity package
- strip down env package
  - use adrg/xdg in lieu of (poorly) reinventing the wheel

cmd/agedit/cli.go

@@ -14,6 +14,7 @@ import (
 	"git.burning.moe/celediel/agedit/pkg/encrypt"
 	"git.burning.moe/celediel/agedit/pkg/env"
 
+	"github.com/adrg/xdg"
 	"github.com/charmbracelet/log"
 	"github.com/ilyakaznacheev/cleanenv"
 	"github.com/urfave/cli/v2"
@@ -22,7 +23,7 @@ import (
 const (
 	name          string = "agedit"
 	usage         string = "Edit age encrypted files with your $EDITOR"
-	version       string = "0.2.3"
+	version       string = "0.3.0"
 	help_template string = `NAME:
    {{.Name}} {{if .Version}}v{{.Version}}{{end}} - {{.Usage}}
 
@@ -39,6 +40,7 @@ COPYRIGHT:
    {{.Copyright}}
    {{end}}
 `
+	sep string = string(os.PathSeparator)
 )
 
 var (
@@ -170,7 +172,7 @@ func before(ctx *cli.Context) error {
 	// set some defaults
 	cfg = config.Defaults
 	cfg.Editor = env.GetEditor()
-	cfg_dir := env.GetConfigDir(name)
+	cfg_dir := xdg.ConfigHome + sep + name + sep
 	cfg.IdentityFile = cfg_dir + "identity.key"
 	configFile = cfg_dir + name + ".yaml"
 	logger = log.NewWithOptions(os.Stderr, log.Options{

go.mod

@@ -4,6 +4,7 @@ go 1.22.0
 
 require (
 	filippo.io/age v1.1.1
+	github.com/adrg/xdg v0.4.0
 	github.com/charmbracelet/log v0.4.0
 	github.com/ilyakaznacheev/cleanenv v1.5.0
 	github.com/urfave/cli/v2 v2.27.1

go.sum

@@ -3,20 +3,17 @@ filippo.io/age v1.1.1/go.mod h1:l03SrzDUrBkdBx8+IILdnn2KZysqQdbEBUQ4p3sqEQE=
 github.com/BurntSushi/toml v1.2.1/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
 github.com/BurntSushi/toml v1.3.2 h1:o7IhLm0Msx3BaB+n3Ag7L8EVlByGnpq14C4YWiu/gL8=
 github.com/BurntSushi/toml v1.3.2/go.mod h1:CxXYINrC8qIiEnFrOxCa7Jy5BFHlXnUU2pbicEuybxQ=
+github.com/adrg/xdg v0.4.0 h1:RzRqFcjH4nE5C6oTAxhBtoE2IRyjBSa62SCbyPidvls=
+github.com/adrg/xdg v0.4.0/go.mod h1:N6ag73EX4wyxeaoeHctc1mas01KZgsj5tYiAIwqJE/E=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
-github.com/charmbracelet/lipgloss v0.9.1 h1:PNyd3jvaJbg4jRHKWXnCj1akQm4rh8dbEzN1p/u1KWg=
-github.com/charmbracelet/lipgloss v0.9.1/go.mod h1:1mPmG4cxScwUQALAAnacHaigiiHB9Pmr+v1VEawJl6I=
 github.com/charmbracelet/lipgloss v0.10.0 h1:KWeXFSexGcfahHX+54URiZGkBFazf70JNMtwg/AFW3s=
 github.com/charmbracelet/lipgloss v0.10.0/go.mod h1:Wig9DSfvANsxqkRsqj6x87irdy123SR4dOXlKa91ciE=
-github.com/charmbracelet/log v0.3.1 h1:TjuY4OBNbxmHWSwO3tosgqs5I3biyY8sQPny/eCMTYw=
-github.com/charmbracelet/log v0.3.1/go.mod h1:OR4E1hutLsax3ZKpXbgUqPtTjQfrh1pG3zwHGWuuq8g=
 github.com/charmbracelet/log v0.4.0 h1:G9bQAcx8rWA2T3pWvx7YtPTPwgqpk7D68BX21IRW8ZM=
 github.com/charmbracelet/log v0.4.0/go.mod h1:63bXt/djrizTec0l11H20t8FDSvA4CRZJ1KH22MdptM=
-github.com/cpuguy83/go-md2man/v2 v2.0.2 h1:p1EgwI/C7NhT0JmVkwCD2ZBK8j4aeHQX2pMHHBfMQ6w=
-github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/cpuguy83/go-md2man/v2 v2.0.4 h1:wfIWP927BUkWJb2NmU/kNDYIBTh/ziUX91+lVfRxZq4=
 github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/go-logfmt/logfmt v0.6.0 h1:wGYYu3uicYdqXVgoYbvnkrPVXkuLM1p1ifugDMEdRi4=
@@ -27,8 +24,6 @@ github.com/joho/godotenv v1.5.1 h1:7eLL/+HRGLY0ldzfGMeQkb7vMd0as4CfYvUVzLqw0N0=
 github.com/joho/godotenv v1.5.1/go.mod h1:f4LDr5Voq0i2e/R5DDNOoa2zzDfwtkZa6DnEwAbqwq4=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
-github.com/mattn/go-isatty v0.0.18 h1:DOKFKCQ7FNG2L1rbrmstDN4QVRdS89Nkh85u68Uwp98=
-github.com/mattn/go-isatty v0.0.18/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
 github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk=
@@ -41,35 +36,30 @@ github.com/muesli/termenv v0.15.2/go.mod h1:Epx+iuz8sNs7mNKhxzH4fWXGNpZwUaJKRS1n
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
-github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/russross/blackfriday/v2 v2.1.0 h1:JIOH55/0cWyOuilr9/qlrm0BSXldqnqwMsf35Ld67mk=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/urfave/cli/v2 v2.27.1 h1:8xSQ6szndafKVRmfyeUMxkNUJQMjL1F2zmsZ+qHpfho=
 github.com/urfave/cli/v2 v2.27.1/go.mod h1:8qnjx1vcq5s2/wpsqoZFndg2CE5tNFyrTvS6SinrnYQ=
-github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673 h1:bAn7/zixMGCfxrRTfdpNzjtPYqr8smhKouy9mxVdGPU=
-github.com/xrash/smetrics v0.0.0-20201216005158-039620a65673/go.mod h1:N3UwUGtsrSj3ccvlPHLoLsHnpR27oXr4ZE984MbSER8=
 github.com/xrash/smetrics v0.0.0-20240312152122-5f08fbb34913 h1:+qGGcbkzsfDQNPPe9UDgpxAWQrhbbBXOYJFQDq/dtJw=
 github.com/xrash/smetrics v0.0.0-20240312152122-5f08fbb34913/go.mod h1:4aEEwZQutDLsQv2Deui4iYQ6DWTxR14g6m8Wv88+Xqk=
-golang.org/x/crypto v0.4.0 h1:UVQgzMY87xqpKNgb+kDsll2Igd33HszWHFLmpaRMq/8=
-golang.org/x/crypto v0.4.0/go.mod h1:3quD/ATkf6oY+rnes5c3ExXTbLc8mueNue5/DoinL80=
 golang.org/x/crypto v0.21.0 h1:X31++rzVUdKhX5sWmSOFZxx8UW/ldWx55cbf08iNAMA=
 golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs=
-golang.org/x/exp v0.0.0-20231006140011-7918f672742d h1:jtJma62tbqLibJ5sFQz8bKtEM8rJBtfilJ2qTU199MI=
-golang.org/x/exp v0.0.0-20231006140011-7918f672742d/go.mod h1:ldy0pHrwJyGW56pPQzzkH36rKxoZW1tw7ZJpeKx+hdo=
 golang.org/x/exp v0.0.0-20240318143956-a85f2c67cd81 h1:6R2FC06FonbXQ8pK11/PDFY6N6LWlf9KlzibaCapmqc=
 golang.org/x/exp v0.0.0-20240318143956-a85f2c67cd81/go.mod h1:CQ1k9gNrJ50XIzaKCRR2hssIjF07kZFEiieALBM/ARQ=
+golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.13.0 h1:Af8nKPmuFypiUBjVoU9V20FiaFXOcuZI21p0ycVYYGE=
-golang.org/x/sys v0.13.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.18.0 h1:DBdB3niSjOA/O0blCZBqDefyWNYveAYMNF1Wum0DYQ4=
 golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 olympos.io/encoding/edn v0.0.0-20201019073823-d3554ca0b0a3 h1:slmdOY3vp8a7KQbHkL+FLbvbkgMqmXojpFUO/jENuqQ=

pkg/encrypt_decrypt_test.go

@@ -8,7 +8,6 @@ import (
 	"filippo.io/age"
 	"git.burning.moe/celediel/agedit/pkg/decrypt"
 	"git.burning.moe/celediel/agedit/pkg/encrypt"
-	"git.burning.moe/celediel/agedit/pkg/identity"
 	"git.burning.moe/celediel/agedit/pkg/tmpfile"
 )
 
@@ -142,30 +141,3 @@ func TestMultipleIdentities(t *testing.T) {
 		})
 	}
 }
-
-// TestNewIdentity creats a new identity, writes it to file, then re-reads it back from the file.
-func TestNewIdentity(t *testing.T) {
-	for range 1000 {
-		outfile := generator.GenerateFullPath()
-
-		id, err := identity.NewIdentity()
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		err = identity.WriteIdentityToFile(id, outfile)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		other_identity, err := identity.ReadIdentityFromFile(outfile)
-		if err != nil {
-			t.Fatal(err)
-		}
-
-		if id.Recipient().String() != other_identity.Recipient().String() && id.String() != other_identity.String() {
-			t.Fatal("Identities don't match!", id.Recipient(), "!=", id.Recipient())
-		}
-		os.Remove(outfile)
-	}
-}

pkg/env/env.go

@@ -11,10 +11,10 @@ import (
 // variables EDITOR and VISUAL
 func GetEditor() string {
 	var editor string
-	if os.Getenv("EDITOR") != "" {
-		editor = os.Getenv("EDITOR")
-	} else if os.Getenv("VISUAL") != "" {
-		editor = os.Getenv("VISUAL")
+	if v, ok := os.LookupEnv("EDITOR"); ok {
+		editor = v
+	} else if v, ok := os.LookupEnv("VISUAL"); ok {
+		editor = v
 	} /* else {
 		// TODO: maybe pick something based on the OS
 	} */
@@ -22,58 +22,6 @@ func GetEditor() string {
 	return editor
 }
 
-// GetConfigDir gets a config directory based from environmental variables + the app name
-//
-// On Windows, %APPDATA%\agedit is used
-//
-// On UNIX-like systems, $XDG_CONFIG_HOME/agedit is tried, if it isn't defined, $HOME/.config/agedit is used
-func GetConfigDir(appname string) string {
-	var configdir string
-	switch runtime.GOOS {
-	case "windows":
-		configdir = os.Getenv("APPDATA")
-	default:
-		fallthrough
-	case "darwin":
-		// TODO: figure out the proper Mac OS local directories
-		fallthrough
-	case "linux":
-		if confighome := os.Getenv("XDG_CONFIG_HOME"); confighome != "" {
-			configdir = confighome
-		} else {
-			configdir = make_path(os.Getenv("HOME"), ".config")
-		}
-	}
-
-	return make_path(configdir, appname)
-}
-
-// GetConfigDir gets a config directory based from environmental variables + the app name
-//
-// On Windows, %LOCALAPPDATA%\agedit is used
-//
-// On UNIX-like systems, $XDG_DATA_HOME/agedit is tried, if it isn't defined, $HOME/.local/share/agedit is used
-func GetDataDir(appname string) string {
-	var datadir string
-	switch runtime.GOOS {
-	case "windows":
-		datadir = os.Getenv("LOCALAPPDATA")
-	default:
-		fallthrough
-	case "darwin":
-		// TODO: also here
-		fallthrough
-	case "linux":
-		if datahome := os.Getenv("XDG_DATA_HOME"); datahome != "" {
-			datadir = datahome
-		} else {
-			datadir = make_path(os.Getenv("HOME"), ".local", "share")
-		}
-	}
-
-	return make_path(datadir, appname)
-}
-
 // GetTempDirectory returns the systems temporary directory
 //
 // returns %TEMP% on Windows, /tmp on UNIX-like systems
@@ -97,24 +45,3 @@ func GetTempDirectory() string {
 	}
 	return tmp
 }
-
-func make_path(paths ...string) string {
-	sep := string(os.PathSeparator)
-	output := strings.Builder{}
-
-	// add / to the start if it's not already there and we're not on Windows
-	if match, err := regexp.Match("^\\w", []byte(paths[0])); err == nil && match && runtime.GOOS != "windows" {
-		output.WriteString(sep)
-	}
-
-	for _, path := range paths {
-		// don't add / to the end if it's there
-		if strings.HasSuffix(path, sep) {
-			output.WriteString(path)
-		} else {
-			output.WriteString(path + sep)
-		}
-	}
-
-	return output.String()
-}

pkg/identity/identity.go

@@ -1,43 +0,0 @@
-package identity
-
-import (
-	"io/fs"
-	"os"
-
-	"filippo.io/age"
-)
-
-// NewIdentity generates a new Age identity
-func NewIdentity() (*age.X25519Identity, error) {
-	id, err := age.GenerateX25519Identity()
-	if err != nil {
-		return nil, err
-	}
-
-	return id, nil
-}
-
-// ReadIdentityFromFile reads the identity from the supplied filename
-func ReadIdentityFromFile(filename string) (*age.X25519Identity, error) {
-	bytes, err := os.ReadFile(filename)
-	if err != nil {
-		return nil, err
-	}
-
-	id, err := age.ParseX25519Identity(string(bytes))
-	if err != nil {
-		return nil, err
-	}
-
-	return id, nil
-}
-
-// WriteIdentityToFile writes the supplied identity to the supplied filename
-func WriteIdentityToFile(id *age.X25519Identity, filename string) error {
-	err := os.WriteFile(filename, []byte(id.String()), fs.FileMode(0600))
-	if err != nil {
-		return err
-	}
-
-	return nil
-}