Merge pull request #15 from gabrielrobert/feature/refactoring-interfaces

packageHandler interface

Author: gabrielrobert

actions.go

@@ -6,9 +6,11 @@ import (
 	"github.com/urfave/cli"
 )
 
+var handlers = []packageHandler{iOSHandler{}, androidHandler{}, uwpHandler{}}
+
 // called by executing `xavtool current`
 func current(c *cli.Context) error {
-	allFiles, err := findManifests(getWorkingDir())
+	allFiles, err := findManifests(getWorkingDir(), handlers)
 
 	// validations
 	if err != nil {
@@ -35,7 +37,7 @@ func current(c *cli.Context) error {
 
 // called by executing `xavtool increment`
 func increment(c *cli.Context) error {
-	allFiles, err := findManifests(getWorkingDir())
+	allFiles, err := findManifests(getWorkingDir(), handlers)
 
 	// validations
 	if err != nil {
@@ -68,7 +70,7 @@ func increment(c *cli.Context) error {
 		}
 
 		setVersion(file, newVersion)
-		updatedManifest, err := findManifests(file.Path)
+		updatedManifest, err := findManifests(file.Path, handlers)
 
 		if err != nil {
 			return cli.NewExitError(err, 5)
@@ -93,7 +95,7 @@ func set(c *cli.Context) error {
 		return cli.NewExitError(fmt.Sprintf("Version '%v' is not valid", newVersion), 3)
 	}
 
-	allFiles, err := findManifests(getWorkingDir())
+	allFiles, err := findManifests(getWorkingDir(), handlers)
 
 	// validations
 	if err != nil {
@@ -113,7 +115,7 @@ func set(c *cli.Context) error {
 	// execute version update
 	for _, file := range allFiles {
 		setVersion(file, newVersion)
-		updatedManifest, err := findManifests(file.Path)
+		updatedManifest, err := findManifests(file.Path, handlers)
 
 		if err != nil {
 			return cli.NewExitError(err, 7)
@@ -125,11 +127,9 @@ func set(c *cli.Context) error {
 }
 
 func setVersion(file packageInfo, version string) {
-	if isiOsPackage(file.Path) {
-		changeiOSPackageVersion(file, version)
-	} else if isAndroidPackage(file.Path) {
-		changeAndroidPackageVersion(file, version)
-	} else if isUWPPackage(file.Path) {
-		changeUWPPackageVersion(file, version)
+	for _, handler := range handlers {
+		if handler.isPackage(file.Path) {
+			handler.changePackageVersion(file, version)
+		}
 	}
 }

actions_test.go

@@ -3,12 +3,17 @@ package main
 import (
 	"bytes"
 	"encoding/xml"
+	"errors"
+	"fmt"
 	"io"
 	"strings"
 
 	"github.com/clbanning/mxj"
 )
 
+type androidHandler struct {
+}
+
 type androidBundlerHeader struct {
 	XMLName xml.Name `xml:"manifest"`
 	Name    string   `xml:"package,attr"`
@@ -20,46 +25,49 @@ type androidBundlerHeader struct {
 	Attrs       []xml.Attr `xml:",attr"`
 }
 
-func isAndroidPackage(filename string) bool {
+func (h androidHandler) isPackage(filename string) bool {
 	return strings.ToLower(getFilename(filename)) == "androidmanifest.xml"
 }
 
-func getAndroidPackageInfo(filePath string) packageInfo {
+func (h androidHandler) getPackageInfo(filePath string) (packageInfo, error) {
 	byteValue := readFile(filePath)
-	data, err := readAndroidData(byteValue)
+	data, err := h.read(byteValue)
 
 	if err != nil {
-		return packageInfo{Path: filePath, HasError: true}
+		return packageInfo{Path: filePath, HasError: true}, err
 	}
 
 	return packageInfo{
 		Name:    data.Name,
 		Version: data.VersionName,
 		Path:    filePath,
-	}
+	}, nil
 }
 
-func readAndroidData(data []byte) (*androidBundlerHeader, error) {
+func (h androidHandler) read(data []byte) (*androidBundlerHeader, error) {
 	var header androidBundlerHeader
 	err := xml.Unmarshal(data, &header)
 	return &header, err
 }
 
-func changeAndroidPackageVersion(file packageInfo, newVersion string) error {
+func (h androidHandler) changePackageVersion(file packageInfo, newVersion string) error {
 	fileBytes := readFile(file.Path)
-	processedBytes := applyVersionToAndroidXML(fileBytes, newVersion)
+	processedBytes, err := h.applyVersion(fileBytes, newVersion)
+	if err != nil {
+		return fmt.Errorf("Invalid xml file: %v", file.Path)
+	}
 	saveFile(file.Path, processedBytes)
 	return nil
 }
 
-func applyVersionToAndroidXML(data []byte, newVersion string) []byte {
-	fileReader := bytes.NewReader(data)
+func (h androidHandler) applyVersion(byteValue []byte, newVersion string) ([]byte, error) {
+	fileReader := bytes.NewReader(byteValue)
 	for m, err := mxj.NewMapXmlSeqReader(fileReader); m != nil || err != io.EOF; m, err = mxj.NewMapXmlSeqReader(fileReader) {
 		if err != nil {
 			if err == mxj.NO_ROOT {
 				continue
 			} else {
-				check(err)
+				return nil, errors.New("Invalid xml")
 			}
 		}
 		vmap := m["manifest"].(map[string]interface{})
@@ -82,8 +90,8 @@ func applyVersionToAndroidXML(data []byte, newVersion string) []byte {
 
 		// Write header
 		header := `<?xml version="1.0" encoding="utf-8"?>` + "\n"
-		return []byte(header + string(b))
+		return []byte(header + string(b)), nil
 	}
 
-	return nil
+	return nil, nil
 }

android_handler.go

@@ -7,7 +7,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
-func Test_isAndroidPackage(t *testing.T) {
+func Test_androidHandler_isPackage(t *testing.T) {
 	type args struct {
 		filename string
 	}
@@ -23,39 +23,47 @@ func Test_isAndroidPackage(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			if got := isAndroidPackage(tt.args.filename); got != tt.want {
+			handler := new(androidHandler)
+			if got := handler.isPackage(tt.args.filename); got != tt.want {
 				t.Errorf("isAndroidPackage() = %v, want %v", got, tt.want)
 			}
 		})
 	}
 }
 
-func Test_getAndroidPackageInfo(t *testing.T) {
-	currentVersion := getAndroidPackageInfo(filePath)
+func Test_androidHandler_getPackageInfo(t *testing.T) {
+	handler := new(androidHandler)
+	currentVersion, err := handler.getPackageInfo(filePath)
+	require.NoError(t, err)
 	if currentVersion.Version != "1.0.1" {
 		t.Errorf("version mismatch; actual %v, expected %v", currentVersion, "1.0.1")
 	}
 }
 
-func Test_changeAndroidPackageVersion(t *testing.T) {
-	currentVersion := getAndroidPackageInfo(filePath)
+func Test_androidHandler_changePackageVersion(t *testing.T) {
+	handler := new(androidHandler)
+	currentVersion, err := handler.getPackageInfo(filePath)
+	require.NoError(t, err)
 	if currentVersion.Version != "1.0.1" {
 		t.Errorf("version mismatch; actual %v, expected %v", currentVersion, "1.0.1")
 	}
 
-	changeAndroidPackageVersion(currentVersion, "1.0.2")
-	currentVersion = getAndroidPackageInfo(filePath)
+	handler.changePackageVersion(currentVersion, "1.0.2")
+	currentVersion, err = handler.getPackageInfo(filePath)
+	require.NoError(t, err)
 	if currentVersion.Version != "1.0.2" {
 		t.Errorf("version mismatch; actual %v, expected %v", currentVersion, "1.0.2")
 	}
 
 	// some kind of rollback
-	changeAndroidPackageVersion(currentVersion, "1.0.1")
+	handler.changePackageVersion(currentVersion, "1.0.1")
 }
 
-func Test_applyVersionToAndroidXML(t *testing.T) {
-	processedBytes := applyVersionToAndroidXML(androidSeed, "1.0.2")
-	xml, _ := readAndroidData(processedBytes)
+func Test_androidHandler_applyVersion(t *testing.T) {
+	handler := new(androidHandler)
+	processedBytes, err := handler.applyVersion(androidSeed, "1.0.2")
+	require.NoError(t, err)
+	xml, _ := handler.read(processedBytes)
 	if xml.VersionName != "1.0.2" {
 		t.Errorf("VersionName mismatch; expected %v", "1.0.2")
 	}
@@ -64,7 +72,7 @@ func Test_applyVersionToAndroidXML(t *testing.T) {
 	}
 }
 
-func Test_readAndroidData(t *testing.T) {
+func Test_androidHandler_read(t *testing.T) {
 	type args struct {
 		data []byte
 	}
@@ -80,7 +88,8 @@ func Test_readAndroidData(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := readAndroidData(tt.args.data)
+			handler := new(androidHandler)
+			got, err := handler.read(tt.args.data)
 			if tt.shouldError {
 				require.Error(t, err)
 				return

android_handler_test.go

@@ -14,7 +14,7 @@ type packageInfo struct {
 	HasError bool
 }
 
-func findManifests(root string) ([]packageInfo, error) {
+func findManifests(root string, handlers []packageHandler) ([]packageInfo, error) {
 	var result error
 	fileList := []packageInfo{}
 
@@ -24,16 +24,14 @@ func findManifests(root string) ([]packageInfo, error) {
 			return filepath.SkipDir
 		}
 
-		if isiOsPackage(f.Name()) {
-			pkg, err := getiOSPackageInfo(path)
-			fileList = append(fileList, pkg)
-			if err != nil {
-				result = multierror.Append(result, err)
+		for _, handler := range handlers {
+			if handler.isPackage(path) {
+				pkg, err := handler.getPackageInfo(path)
+				fileList = append(fileList, pkg)
+				if err != nil {
+					result = multierror.Append(result, err)
+				}
 			}
-		} else if isAndroidPackage(f.Name()) {
-			fileList = append(fileList, getAndroidPackageInfo(path))
-		} else if isUWPPackage(f.Name()) {
-			fileList = append(fileList, getUWPPackageInfo(path))
 		}
 
 		return nil

finders.go

@@ -10,7 +10,7 @@ func Test_FindManifests(t *testing.T) {
 	dir, err := os.Getwd()
 	check(err)
 
-	foundFiles, err := findManifests(dir)
+	foundFiles, err := findManifests(dir, []packageHandler{iOSHandler{}, androidHandler{}, uwpHandler{}})
 	if foundFiles == nil || len(foundFiles) == 0 {
 		t.Errorf("at least one file should be found")
 	}

finders_test.go

@@ -11,13 +11,16 @@ import (
 	multierror "github.com/hashicorp/go-multierror"
 )
 
-func isiOsPackage(filename string) bool {
+type iOSHandler struct {
+}
+
+func (h iOSHandler) isPackage(filename string) bool {
 	return strings.ToLower(getFilename(filename)) == "info.plist"
 }
 
-func getiOSPackageInfo(filePath string) (packageInfo, error) {
+func (h iOSHandler) getPackageInfo(filePath string) (packageInfo, error) {
 	byteValue := readFile(filePath)
-	data, err := readiOSData(byteValue)
+	data, err := h.read(byteValue)
 
 	if err != nil {
 		return packageInfo{Path: filePath, HasError: true}, err
@@ -30,7 +33,7 @@ func getiOSPackageInfo(filePath string) (packageInfo, error) {
 	}, nil
 }
 
-func readiOSData(data []byte) (map[string]interface{}, error) {
+func (h iOSHandler) read(data []byte) (map[string]interface{}, error) {
 	var result error
 
 	buffer := bytes.NewReader(data)
@@ -57,18 +60,18 @@ func readiOSData(data []byte) (map[string]interface{}, error) {
 	return decodeInterface, result
 }
 
-func changeiOSPackageVersion(file packageInfo, newVersion string) error {
+func (h iOSHandler) changePackageVersion(file packageInfo, newVersion string) error {
 	// open file with all data
 	byteValue := readFile(file.Path)
-	processedBytes, err := applyVersionToiOSPlist(byteValue, newVersion)
+	processedBytes, err := h.applyVersion(byteValue, newVersion)
 	if err != nil {
 		return fmt.Errorf("Invalid plist file: %v", file.Path)
 	}
 	saveFile(file.Path, processedBytes)
 	return nil
 }
 
-func applyVersionToiOSPlist(byteValue []byte, newVersion string) ([]byte, error) {
+func (h iOSHandler) applyVersion(byteValue []byte, newVersion string) ([]byte, error) {
 	buffer := bytes.NewReader(byteValue)
 	decoder := plist.NewDecoder(buffer)
 	var data = map[string]interface{}{}