Refactor: remove named returns and magic numbers

Author: jonhadfield

constants.go

@@ -0,0 +1,5 @@
+package sncli
+
+import "time"
+
+const spinnerDelay = 100 * time.Millisecond

debug.go

@@ -2,6 +2,7 @@ package sncli
 
 import (
 	"encoding/base64"
+	"errors"
 	"fmt"
 	"strings"
 
@@ -18,7 +19,7 @@ type DecryptStringInput struct {
 	Key       string
 }
 
-func DecryptString(input DecryptStringInput) (plaintext string, err error) {
+func DecryptString(input DecryptStringInput) (string, error) {
 	key1 := input.Session.MasterKey
 	if input.Key != "" {
 		key1 = input.Key
@@ -34,20 +35,18 @@ func DecryptString(input DecryptStringInput) (plaintext string, err error) {
 
 	version, nonce, cipherText, authData := splitContent(input.In)
 	if version != "004" {
-		return plaintext, fmt.Errorf("only version 004 of encryption is supported")
+		return "", errors.New("only version 004 of encryption is supported")
 	}
 
 	bad, err := base64.StdEncoding.DecodeString(authData)
 	if err != nil {
-		err = fmt.Errorf("failed to base64 decode auth data: '%s' err: %+v", authData, err)
-
-		return
+		return "", fmt.Errorf("failed to base64 decode auth data: '%s' err: %+v", authData, err)
 	}
 	fmt.Printf("Decoded Auth Data: %+v\n", string(bad))
 
 	pb, err := crypto.DecryptCipherText(cipherText, key1, nonce, authData)
 	if err != nil {
-		return
+		return "", err
 	}
 
 	return string(pb), nil
@@ -107,16 +106,16 @@ type CreateItemsKeyInput struct {
 // 	return nil
 // }
 
-func splitContent(in string) (version, nonce, cipherText, authenticatedData string) {
+func splitContent(in string) (string, string, string, string) {
 	components := strings.Split(in, ":")
 	if len(components) < 3 {
 		panic(components)
 	}
 
-	version = components[0]           // protocol version
-	nonce = components[1]             // encryption nonce
-	cipherText = components[2]        // ciphertext
-	authenticatedData = components[3] // authenticated data
+	version := components[0]           // protocol version
+	nonce := components[1]             // encryption nonce
+	cipherText := components[2]        // ciphertext
+	authenticatedData := components[3] // authenticated data
 
-	return
+	return version, nonce, cipherText, authenticatedData
 }

healthcheck.go

@@ -28,9 +28,9 @@ func ItemKeysHealthcheck(input ItemsKeysHealthcheckInput) error {
 	if !input.Session.Debug {
 		prefix := color.HiWhite.Sprintf("retrieving items ")
 
-		s := spinner.New(spinner.CharSets[14], 100*time.Millisecond, spinner.WithWriter(os.Stdout))
+		s := spinner.New(spinner.CharSets[14], spinnerDelay, spinner.WithWriter(os.Stdout))
 		if input.UseStdOut {
-			s = spinner.New(spinner.CharSets[14], 100*time.Millisecond, spinner.WithWriter(os.Stderr))
+			s = spinner.New(spinner.CharSets[14], spinnerDelay, spinner.WithWriter(os.Stderr))
 		}
 
 		s.Prefix = prefix

helpers.go

@@ -130,22 +130,19 @@ type EncryptedItemsFile struct {
 	Items items.EncryptedItems `json:"items"`
 }
 
-func readJSON(filePath string) (items items.EncryptedItems, err error) {
+func readJSON(filePath string) (items.EncryptedItems, error) {
 	file, err := os.ReadFile(filePath)
 	if err != nil {
-		err = fmt.Errorf("%w failed to open: %s", err, filePath)
-		return
+		return nil, fmt.Errorf("%w failed to open: %s", err, filePath)
 	}
 
 	var eif EncryptedItemsFile
 
-	err = json.Unmarshal(file, &eif)
-	if err != nil {
-		err = fmt.Errorf("failed to unmarshall json: %w", err)
-		return
+	if err = json.Unmarshal(file, &eif); err != nil {
+		return nil, fmt.Errorf("failed to unmarshall json: %w", err)
 	}
 
-	return eif.Items, err
+	return eif.Items, nil
 }
 
 func ItemRefsToYaml(irs []items.ItemReference) []ItemReferenceYAML {
@@ -198,12 +195,13 @@ func CommaSplit(i string) []string {
 	return s
 }
 
-func RemoveDeleted(in items.Items) (out items.Items) {
+func RemoveDeleted(in items.Items) items.Items {
+	var out items.Items
 	for _, i := range in {
 		if !i.IsDeleted() {
 			out = append(out, i)
 		}
 	}
 
-	return
+	return out
 }

main.go

@@ -275,7 +275,8 @@ func referenceExists(tag items.Tag, refID string) bool {
 	return false
 }
 
-func filterEncryptedItemsByTypes(ei items.EncryptedItems, types []string) (o items.EncryptedItems) {
+func filterEncryptedItemsByTypes(ei items.EncryptedItems, types []string) items.EncryptedItems {
+	var o items.EncryptedItems
 	for _, i := range ei {
 		if StringInSlice(i.ContentType, types, true) {
 			o = append(o, i)
@@ -285,7 +286,8 @@ func filterEncryptedItemsByTypes(ei items.EncryptedItems, types []string) (o ite
 	return o
 }
 
-func filterItemsByTypes(ei items.Items, types []string) (o items.Items) {
+func filterItemsByTypes(ei items.Items, types []string) items.Items {
+	var o items.Items
 	for _, i := range ei {
 		if StringInSlice(i.GetContentType(), types, true) {
 			o = append(o, i)
@@ -295,7 +297,8 @@ func filterItemsByTypes(ei items.Items, types []string) (o items.Items) {
 	return o
 }
 
-func filterCacheItemsByTypes(ei cache.Items, types []string) (o cache.Items) {
+func filterCacheItemsByTypes(ei cache.Items, types []string) cache.Items {
+	var o cache.Items
 	for _, i := range ei {
 		if StringInSlice(i.ContentType, types, true) {
 			o = append(o, i)
@@ -312,9 +315,9 @@ func (i *WipeConfig) Run() (int, error) {
 	if !i.Session.Debug && i.UseStdOut {
 		prefix := color.HiWhite.Sprintf("wiping ")
 
-		s := spinner.New(spinner.CharSets[14], 100*time.Millisecond, spinner.WithWriter(os.Stdout))
+		s := spinner.New(spinner.CharSets[14], spinnerDelay, spinner.WithWriter(os.Stdout))
 		if i.UseStdOut {
-			s = spinner.New(spinner.CharSets[14], 100*time.Millisecond, spinner.WithWriter(os.Stderr))
+			s = spinner.New(spinner.CharSets[14], spinnerDelay, spinner.WithWriter(os.Stderr))
 		}
 
 		s.Prefix = prefix