Extract `func (c *CommandArgumentValidator) validate(args []string) (…

…err error)`
roots · Nov 4, 2019 · 1427619 · 1427619
1 parent 5bcfd42
commit 1427619
Show file tree

Hide file tree

Showing 23 changed files with 111 additions and 86 deletions.
diff --git a/cmd/alias.go b/cmd/alias.go
@@ -46,9 +46,10 @@ func (c *AliasCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/check.go b/cmd/check.go
@@ -33,9 +33,10 @@ var Requirements = []trellis.Requirement{
 }
 
 func (c *CheckCommand) Run(args []string) int {
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/command_argument_validator.go b/cmd/command_argument_validator.go
@@ -0,0 +1,25 @@
+package cmd
+
+import "fmt"
+
+type CommandArgumentValidator struct {
+	required int
+	optional int
+}
+
+func (c *CommandArgumentValidator) validate(args []string) (err error) {
+	argCount := len(args)
+
+	expectedCount := fmt.Sprintf("exactly %d", c.required)
+	if (c.optional > 0) {
+		expectedCount = fmt.Sprintf("between %d and %d", c.required, c.required+c.optional)
+	}
+
+	if argCount > c.required+c.optional {
+		err = fmt.Errorf("Error: too many arguments (expected %s, got %d)\n", expectedCount, len(args))
+	} else if argCount < c.required {
+		err = fmt.Errorf("Error: missing arguments (expected %s, got %d)\n", expectedCount, len(args))
+	}
+
+	return
+}
diff --git a/cmd/validate_argument_count_test.go → cmd/command_argument_validator_test.go b/cmd/validate_argument_count_test.go → cmd/command_argument_validator_test.go
@@ -5,7 +5,7 @@ import (
 	"testing"
 )
 
-func TestValidateArgumentCount(t *testing.T) {
+func TestCommandArgumentValidatorValidate(t *testing.T) {
 	cases := []struct {
 		name             string
 		args             []string
@@ -58,7 +58,12 @@ func TestValidateArgumentCount(t *testing.T) {
 	}
 
 	for _, tc := range cases {
-		actual := validateArgumentCount(tc.args, tc.requiredArgCount, tc.optionalArgCount)
+		validator := &CommandArgumentValidator{
+			required: tc.requiredArgCount,
+			optional: tc.optionalArgCount,
+		}
+
+		actual := validator.validate(tc.args)
 
 		if "" == tc.expectedMessage && actual != nil {
 			t.Errorf("expected result to be valid, got %s", actual)

diff --git a/cmd/deploy.go b/cmd/deploy.go
@@ -42,9 +42,10 @@ func (c *DeployCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/dot_env.go b/cmd/dot_env.go
@@ -20,9 +20,10 @@ func (c *DotEnvCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/down.go b/cmd/down.go
@@ -19,9 +19,10 @@ func (c *DownCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/droplet_create.go b/cmd/droplet_create.go
@@ -63,9 +63,10 @@ func (c *DropletCreateCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 0, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/galaxy_install.go b/cmd/galaxy_install.go
@@ -20,9 +20,10 @@ func (c *GalaxyInstallCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/info.go b/cmd/info.go
@@ -19,9 +19,10 @@ func (c *InfoCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/init.go b/cmd/init.go
@@ -21,9 +21,10 @@ func (c *InitCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/new.go b/cmd/new.go
@@ -54,19 +54,16 @@ func (c *NewCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	switch len(args) {
-	case 0:
-		c.UI.Error("Error: missing PATH argument\n")
-		c.UI.Output(c.Help())
-		return 1
-	case 1:
-		path = args[0]
-	default:
-		c.UI.Error(fmt.Sprintf("Error: too many arguments (expected 1, got %d)\n", len(args)))
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}
 
+	path = args[0]
+
 	path, _ = filepath.Abs(path)
 	fi, statErr := os.Stat(path)
 

diff --git a/cmd/new_test.go b/cmd/new_test.go
@@ -23,7 +23,7 @@ func TestNewRunValidations(t *testing.T) {
 			"no_args",
 			false,
 			nil,
-			"Error: missing PATH argument",
+			"Error: missing arguments (expected exactly 1, got 0)",
 			1,
 		},
 		{

diff --git a/cmd/provision.go b/cmd/provision.go
@@ -44,9 +44,10 @@ func (c *ProvisionCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/rollback.go b/cmd/rollback.go
@@ -42,9 +42,10 @@ func (c *RollbackCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/ssh.go b/cmd/ssh.go
@@ -22,9 +22,10 @@ func (c *SshCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 1, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/up.go b/cmd/up.go
@@ -43,9 +43,10 @@ func (c *UpCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 0, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/valet_link.go b/cmd/valet_link.go
@@ -20,9 +20,10 @@ func (c *ValetLinkCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 0, 1)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 0, optional: 1}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/validate_argument_count.go b/cmd/validate_argument_count.go
diff --git a/cmd/vault_decrypt.go b/cmd/vault_decrypt.go
@@ -42,9 +42,10 @@ func (c *VaultDecryptCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/vault_edit.go b/cmd/vault_edit.go
@@ -26,9 +26,10 @@ func (c *VaultEditCommand) Run(args []string) int {
 		return 1
 	}
 
-	argCountErr := validateArgumentCount(args, 1, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/vault_encrypt.go b/cmd/vault_encrypt.go
@@ -42,9 +42,10 @@ func (c *VaultEncryptCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}

diff --git a/cmd/vault_view.go b/cmd/vault_view.go
@@ -41,9 +41,10 @@ func (c *VaultViewCommand) Run(args []string) int {
 
 	args = c.flags.Args()
 
-	argCountErr := validateArgumentCount(args, 1, 0)
-	if argCountErr != nil {
-		c.UI.Error(argCountErr.Error())
+	commandArgumentValidator := &CommandArgumentValidator{required: 1, optional: 0}
+	commandArgumentErr := commandArgumentValidator.validate(args)
+	if commandArgumentErr != nil {
+		c.UI.Error(commandArgumentErr.Error())
 		c.UI.Output(c.Help())
 		return 1
 	}
-Original file line number
+Diff line change
@@ Expand Up / @@ -23,7 +23,7 @@ func TestNewRunValidations(t *testing.T) { @@
     			"no_args",
     			false,
     			nil,
-    			"Error: missing PATH argument",
+    			"Error: missing arguments (expected exactly 1, got 0)",
 ,
     		},
     		{
@@ Expand Down @@