Moved reference argument parsing to new package

Author: silvanocerza

cli/globals/args.go renamed to cli/arguments/reference.go

@@ -13,34 +13,34 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-package globals
+package arguments
 
 import (
 	"fmt"
 	"strings"
 )
 
-// ReferenceArg represents a reference item (core or library) passed to the CLI
+// Reference represents a reference item (core or library) passed to the CLI
 // interface
-type ReferenceArg struct {
+type Reference struct {
 	PackageName  string
 	Architecture string
 	Version      string
 }
 
-func (r *ReferenceArg) String() string {
+func (r *Reference) String() string {
 	if r.Version != "" {
 		return r.PackageName + ":" + r.Architecture + "@" + r.Version
 	}
 	return r.PackageName + ":" + r.Architecture
 }
 
-// ParseReferenceArgs is a convenient wrapper that operates on a slice of strings and
+// ParseReferences is a convenient wrapper that operates on a slice of strings and
 // calls ParseReferenceArg for each of them. It returns at the first invalid argument.
-func ParseReferenceArgs(args []string, parseArch bool) ([]*ReferenceArg, error) {
-	ret := []*ReferenceArg{}
+func ParseReferences(args []string, parseArch bool) ([]*Reference, error) {
+	ret := []*Reference{}
 	for _, arg := range args {
-		reference, err := ParseReferenceArg(arg, parseArch)
+		reference, err := ParseReference(arg, parseArch)
 		if err != nil {
 			return nil, err
 		}
@@ -49,11 +49,11 @@ func ParseReferenceArgs(args []string, parseArch bool) ([]*ReferenceArg, error)
 	return ret, nil
 }
 
-// ParseReferenceArg parses a string and return a ReferenceArg object. If `parseArch` is passed,
+// ParseReference parses a string and return a ReferenceArg object. If `parseArch` is passed,
 // the method also tries to parse the architecture bit, i.e. string must be in the form
 // "packager:arch@version", useful to represent a platform (or core) name.
-func ParseReferenceArg(arg string, parseArch bool) (*ReferenceArg, error) {
-	ret := &ReferenceArg{}
+func ParseReference(arg string, parseArch bool) (*Reference, error) {
+	ret := &Reference{}
 	if arg == "" {
 		return nil, fmt.Errorf("invalid empty core argument")
 	}

cli/globals/args_test.go renamed to cli/arguments/reference_test.go

@@ -13,27 +13,27 @@
 // Arduino software without disclosing the source code of your own applications.
 // To purchase a commercial license, send an email to [email protected].
 
-package globals_test
+package arguments_test
 
 import (
 	"testing"
 
-	"github.com/arduino/arduino-cli/cli/globals"
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 )
 
 var goodCores = []struct {
 	in       string
-	expected *globals.ReferenceArg
+	expected *arguments.Reference
 }{
-	{"arduino:avr", &globals.ReferenceArg{"arduino", "avr", ""}},
-	{"arduino:[email protected]", &globals.ReferenceArg{"arduino", "avr", "1.6.20"}},
+	{"arduino:avr", &arguments.Reference{"arduino", "avr", ""}},
+	{"arduino:[email protected]", &arguments.Reference{"arduino", "avr", "1.6.20"}},
 }
 
 var badCores = []struct {
 	in       string
-	expected *globals.ReferenceArg
+	expected *arguments.Reference
 }{
 	{"arduino:avr:avr", nil},
 	{"[email protected]:avr", nil},
@@ -51,15 +51,15 @@ func TestArgsStringify(t *testing.T) {
 	}
 }
 
-func TestParseReferenceArgCores(t *testing.T) {
+func TestParseReferenceCores(t *testing.T) {
 	for _, tt := range goodCores {
-		actual, err := globals.ParseReferenceArg(tt.in, true)
+		actual, err := arguments.ParseReference(tt.in, true)
 		assert.Nil(t, err)
 		assert.Equal(t, tt.expected, actual)
 	}
 
 	for _, tt := range badCores {
-		actual, err := globals.ParseReferenceArg(tt.in, true)
+		actual, err := arguments.ParseReference(tt.in, true)
 		require.NotNil(t, err, "Testing bad core '%s'", tt.in)
 		require.Equal(t, tt.expected, actual, "Testing bad core '%s'", tt.in)
 	}
@@ -71,7 +71,7 @@ func TestParseArgs(t *testing.T) {
 		input = append(input, tt.in)
 	}
 
-	refs, err := globals.ParseReferenceArgs(input, true)
+	refs, err := arguments.ParseReferences(input, true)
 	assert.Nil(t, err)
 	assert.Equal(t, len(goodCores), len(refs))
 

cli/core/download.go

@@ -19,9 +19,9 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/core"
@@ -49,7 +49,7 @@ func runDownloadCommand(cmd *cobra.Command, args []string) {
 
 	logrus.Info("Executing `arduino core download`")
 
-	platformsRefs, err := globals.ParseReferenceArgs(args, true)
+	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)

cli/core/install.go

@@ -19,9 +19,9 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/core"
@@ -86,7 +86,7 @@ func runInstallCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino core install`")
 
-	platformsRefs, err := globals.ParseReferenceArgs(args, true)
+	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)

cli/core/uninstall.go

@@ -19,9 +19,9 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/core"
@@ -45,7 +45,7 @@ func runUninstallCommand(cmd *cobra.Command, args []string) {
 	inst := instance.CreateAndInit()
 	logrus.Info("Executing `arduino core uninstall`")
 
-	platformsRefs, err := globals.ParseReferenceArgs(args, true)
+	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)

cli/core/upgrade.go

@@ -19,9 +19,9 @@ import (
 	"context"
 	"os"
 
+	"github.com/arduino/arduino-cli/cli/arguments"
 	"github.com/arduino/arduino-cli/cli/errorcodes"
 	"github.com/arduino/arduino-cli/cli/feedback"
-	"github.com/arduino/arduino-cli/cli/globals"
 	"github.com/arduino/arduino-cli/cli/instance"
 	"github.com/arduino/arduino-cli/cli/output"
 	"github.com/arduino/arduino-cli/commands/core"
@@ -73,7 +73,7 @@ func runUpgradeCommand(cmd *cobra.Command, args []string) {
 
 	// proceed upgrading, if anything is upgradable
 	exitErr := false
-	platformsRefs, err := globals.ParseReferenceArgs(args, true)
+	platformsRefs, err := arguments.ParseReferences(args, true)
 	if err != nil {
 		feedback.Errorf("Invalid argument passed: %v", err)
 		os.Exit(errorcodes.ErrBadArgument)