Merge pull request #5 from jippi/upserter-refactor

More refactoring & tests

.gitignore

@@ -1,7 +1,6 @@
 .env
 .env.*
 !.env.example
-env.*
 
 dist/
 bin/

.golangci.yaml

@@ -230,6 +230,7 @@ linters-settings:
     ignore-names:
       - tt
       - err
+      - i
 
   tagalign:
     # Align and sort can be used together or separately.

.goreleaser.yaml

@@ -27,7 +27,7 @@ metadata:
   mod_timestamp: "{{ .CommitTimestamp }}"
 
 builds:
-  - main: ./cmd/
+  - main: .
     env:
       - CGO_ENABLED=0
     goos:

.vscode/settings.json

@@ -13,5 +13,10 @@
   ],
   "[go]": {
     "editor.formatOnSave": true,
-  }
+  },
+  "cSpell.words": [
+    "bitmask",
+    "Upsert",
+    "upserter"
+  ]
 }

Taskfile.yml

@@ -24,7 +24,7 @@ tasks:
     generates:
       - ./dottie
     cmds:
-      - go build -o dottie ./cmd/
+      - go build -o dottie .
 
   test:
     desc: Run tests
@@ -35,7 +35,7 @@ tasks:
       SOURCE_FILES: '{{default "./..." .SOURCE_FILES}}'
       TEST_PATTERN: '{{default "." .TEST_PATTERN}}'
     cmds:
-      - go test {{.TEST_OPTIONS}} -race -covermode=atomic -coverprofile=coverage.out {{.SOURCE_FILES}} -run {{.TEST_PATTERN}} -timeout=5m
+      - go test {{.TEST_OPTIONS}} -race -coverpkg=./... -covermode=atomic -coverprofile=coverage.out {{.SOURCE_FILES}} -run {{.TEST_PATTERN}} -timeout=5m
 
   cover:
     desc: Open the cover tool

cmd/disable/disable.go

@@ -10,32 +10,34 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Command = &cobra.Command{
-	Use:               "disable KEY",
-	Short:             "Disable (comment out) a KEY if it exists",
-	GroupID:           "manipulate",
-	ValidArgsFunction: shared.NewCompleter().WithHandlers(render.ExcludeDisabledAssignments).Get(),
-	RunE: func(cmd *cobra.Command, args []string) error {
-		if len(args) == 0 {
-			return errors.New("Missing required argument: KEY")
-		}
-
-		key := args[0]
-
-		filename := cmd.Flag("file").Value.String()
-
-		env, err := pkg.Load(filename)
-		if err != nil {
-			return err
-		}
-
-		existing := env.Get(key)
-		if existing == nil {
-			return fmt.Errorf("Could not find KEY [%s]", key)
-		}
-
-		existing.Disable()
-
-		return pkg.Save(filename, env)
-	},
+func NewCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:               "disable KEY",
+		Short:             "Disable (comment out) a KEY if it exists",
+		GroupID:           "manipulate",
+		ValidArgsFunction: shared.NewCompleter().WithHandlers(render.ExcludeDisabledAssignments).Get(),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if len(args) == 0 {
+				return errors.New("Missing required argument: KEY")
+			}
+
+			key := args[0]
+
+			filename := cmd.Flag("file").Value.String()
+
+			env, err := pkg.Load(filename)
+			if err != nil {
+				return err
+			}
+
+			existing := env.Get(key)
+			if existing == nil {
+				return fmt.Errorf("Could not find KEY [%s]", key)
+			}
+
+			existing.Disable()
+
+			return pkg.Save(filename, env)
+		},
+	}
 }

cmd/disable/disable_test.go

@@ -0,0 +1,13 @@
+package disable_test
+
+import (
+	"testing"
+
+	"github.com/jippi/dottie/pkg/test_helpers"
+)
+
+func TestCommand(t *testing.T) {
+	t.Parallel()
+
+	test_helpers.RunFilebasedCommandTests(t, 0, "disable")
+}

cmd/disable/tests/disable-a-key-already-disabled.command.txt

@@ -0,0 +1 @@
+KEY_B

cmd/disable/tests/disable-a-key-already-disabled.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+#KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/disable-a-key-already-disabled/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+#KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/disable-a-key.command.txt

@@ -0,0 +1 @@
+KEY_B

cmd/disable/tests/disable-a-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+#KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/disable-a-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+#KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/invalid-key.command.txt

@@ -0,0 +1 @@
+NONEXISTING_KEY

cmd/disable/tests/invalid-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/invalid-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/invalid-key/stderr.golden

@@ -0,0 +1 @@
+Could not find KEY [NONEXISTING_KEY]

cmd/disable/tests/missing-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/missing-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/disable/tests/missing-key/stderr.golden

@@ -0,0 +1 @@
+Missing required argument: KEY

cmd/enable/enable.go

@@ -10,32 +10,34 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Command = &cobra.Command{
-	Use:               "enable KEY",
-	Short:             "Enable (uncomment) a KEY if it exists",
-	GroupID:           "manipulate",
-	ValidArgsFunction: shared.NewCompleter().WithHandlers(render.ExcludeActiveAssignments).Get(),
-	RunE: func(cmd *cobra.Command, args []string) error {
-		if len(args) == 0 {
-			return errors.New("Missing required argument: KEY")
-		}
-
-		filename := cmd.Flag("file").Value.String()
-
-		env, err := pkg.Load(filename)
-		if err != nil {
-			return err
-		}
-
-		key := args[0]
-
-		existing := env.Get(key)
-		if existing == nil {
-			return fmt.Errorf("Could not find KEY [%s]", key)
-		}
-
-		existing.Enable()
-
-		return pkg.Save(filename, env)
-	},
+func NewCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:               "enable KEY",
+		Short:             "Enable (uncomment) a KEY if it exists",
+		GroupID:           "manipulate",
+		ValidArgsFunction: shared.NewCompleter().WithHandlers(render.ExcludeActiveAssignments).Get(),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			if len(args) == 0 {
+				return errors.New("Missing required argument: KEY")
+			}
+
+			filename := cmd.Flag("file").Value.String()
+
+			env, err := pkg.Load(filename)
+			if err != nil {
+				return err
+			}
+
+			key := args[0]
+
+			existing := env.Get(key)
+			if existing == nil {
+				return fmt.Errorf("Could not find KEY [%s]", key)
+			}
+
+			existing.Enable()
+
+			return pkg.Save(filename, env)
+		},
+	}
 }

cmd/enable/enable_test.go

@@ -0,0 +1,13 @@
+package enable_test
+
+import (
+	"testing"
+
+	"github.com/jippi/dottie/pkg/test_helpers"
+)
+
+func TestCommand(t *testing.T) {
+	t.Parallel()
+
+	test_helpers.RunFilebasedCommandTests(t, 0, "enable")
+}

cmd/enable/tests/enable-a-key-already-enabled.command.txt

@@ -0,0 +1 @@
+KEY_B

cmd/enable/tests/enable-a-key-already-enabled.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/enable-a-key-already-enabled/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/enable-a-key.command.txt

@@ -0,0 +1 @@
+KEY_B

cmd/enable/tests/enable-a-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+#KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/enable-a-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/invalid-key.command.txt

@@ -0,0 +1 @@
+NONEXISTING_KEY

cmd/enable/tests/invalid-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/invalid-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/invalid-key/stderr.golden

@@ -0,0 +1 @@
+Could not find KEY [NONEXISTING_KEY]

cmd/enable/tests/missing-key.env

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/missing-key/env.golden

@@ -0,0 +1,6 @@
+KEY_A="I'm key A"
+
+# Comment for KEY_B
+KEY_B="I'm key B"
+
+KEY_C="I'm key C"

cmd/enable/tests/missing-key/stderr.golden

@@ -0,0 +1 @@
+Missing required argument: KEY

cmd/fmt/fmt.go

@@ -6,24 +6,26 @@ import (
 	"github.com/spf13/cobra"
 )
 
-var Command = &cobra.Command{
-	Use:     "fmt",
-	Short:   "Format a .env file",
-	GroupID: "manipulate",
-	RunE: func(cmd *cobra.Command, args []string) error {
-		filename := cmd.Flag("file").Value.String()
+func NewCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:     "fmt",
+		Short:   "Format a .env file",
+		GroupID: "manipulate",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			filename := cmd.Flag("file").Value.String()
 
-		env, err := pkg.Load(filename)
-		if err != nil {
-			return err
-		}
+			env, err := pkg.Load(filename)
+			if err != nil {
+				return err
+			}
 
-		if err := pkg.Save(filename, env); err != nil {
-			return err
-		}
+			if err := pkg.Save(filename, env); err != nil {
+				return err
+			}
 
-		tui.Theme.Success.StdoutPrinter().Printfln("File [%s] was successfully formatted", filename)
+			tui.Theme.Success.StdoutPrinter().Printfln("File [%s] was successfully formatted", filename)
 
-		return nil
-	},
+			return nil
+		},
+	}
 }