Migrate to YAML encoder `gopkg.in/yaml.v3

Previously the `github.com/ghodss/yaml` (1) package was used as encoder
for YAML (2) files. It was evaluated and choosen over the
`gopkg.in/yaml.v2` package because it fixed some problems and misleading
YAML specification implementations while also simplifying the usage of
both JSON (3) and YAML (2) at the same time.
Unfortunately the package is not actively maintained anymore and also
has some problems and usage edge cases while the `gopkg.in/yaml` package
is actively maintained and improved the YAML specification compatibility
a lot.
Therefore snowsaw migrated to the latest major version
`gopkg.in/yaml.v3` (4) replacing the previously used package.

References:
  (1) https://github.com/ghodss/yaml
  (2) https://yaml.org
  (3) https://www.json.org
  (4) https://github.com/go-yaml/yaml/tree/v3

Epic GH-33
Resolves GH-69

Author: arcticicestudio

go.mod

@@ -4,10 +4,10 @@ go 1.12
 
 require (
 	github.com/fatih/color v1.7.0
-	github.com/ghodss/yaml v1.0.0
 	github.com/imdario/mergo v0.3.7
 	github.com/magefile/mage v1.8.0
 	github.com/mattn/go-colorable v0.1.2 // indirect
 	github.com/mitchellh/go-homedir v1.1.0
 	github.com/spf13/cobra v0.0.5
+	gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22
 )

go.sum

@@ -8,8 +8,6 @@ github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSs
 github.com/fatih/color v1.7.0 h1:DkWD4oS2D8LGGgTQ6IvwJJXSL5Vp2ffcQg58nFV38Ys=
 github.com/fatih/color v1.7.0/go.mod h1:Zm6kSWBoL9eyXnKyktHP6abPY2pDugNf5KwzbycvMj4=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
-github.com/ghodss/yaml v1.0.0 h1:wQHKEahhL6wmXdzwWG11gIVCkOv05bNOh+Rxn0yngAk=
-github.com/ghodss/yaml v1.0.0/go.mod h1:4dBDuWmgqj2HViK6kFavaiC9ZROes6MMH2rRYeMEF04=
 github.com/hashicorp/hcl v1.0.0/go.mod h1:E5yfLk+7swimpb2L/Alb/PJmXilQ/rhwaUYs4T20WEQ=
 github.com/imdario/mergo v0.3.7 h1:Y+UAYTZ7gDEuOfhxKWy+dvb5dRQ6rJjFSdX2HZY1/gI=
 github.com/imdario/mergo v0.3.7/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA=
@@ -48,3 +46,5 @@ gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22 h1:0efs3hwEZhFKsCoP8l6dDB1AZWMgnEl3yWXWRZTOaEA=
+gopkg.in/yaml.v3 v3.0.0-20190709130402-674ba3eaed22/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

pkg/config/builder/builder.go

@@ -16,12 +16,13 @@ import (
 	"fmt"
 	"io/ioutil"
 	"path/filepath"
-	"reflect"
 
 	"github.com/fatih/color"
 	"github.com/imdario/mergo"
 
+	"github.com/arcticicestudio/snowsaw/pkg/config"
 	"github.com/arcticicestudio/snowsaw/pkg/config/encoder"
+	"github.com/arcticicestudio/snowsaw/pkg/config/encoder/yaml"
 	"github.com/arcticicestudio/snowsaw/pkg/config/source/file"
 	"github.com/arcticicestudio/snowsaw/pkg/prt"
 	"github.com/arcticicestudio/snowsaw/pkg/util/filesystem"
@@ -33,71 +34,63 @@ type builder struct {
 }
 
 // Load tries to load all given configuration files.
-// It checks if the path is valid and exists, tries to assign a matching encoder.Encoder based on the file extension and
-// returns a pointer to a builder to chain and pass the loaded files to the Merge function.
+// It checks if the path is valid and exists, tries to assign a matching encoder based on the file extension and returns
+// a pointer to a builder to chain the merge function.
 func Load(files ...*file.File) *builder {
-	s := &builder{Files: []*file.File{}}
+	b := &builder{Files: []*file.File{}}
 
 	for _, f := range files {
-		// Convert to absolute path and check if file exists, otherwise ignore and check next.
-		f.Path, _ = filepath.Abs(f.Path)
-		if exists, _ := filesystem.FileExists(f.Path); !exists {
+		// Convert to an absolute path and check if the file exists, otherwise ignore and check next.
+		absPath, absPathErr := filepath.Abs(f.Path)
+		if absPathErr != nil {
+			prt.Debugf("Could not convert to absolute configuration file path: %v", absPathErr)
+			continue
+		}
+		if exists, _ := filesystem.FileExists(absPath); !exists {
 			prt.Debugf("Ignoring non-existent configuration file: %s", color.CyanString(f.Path))
 			continue
 		}
+		f.Path = absPath
 
-		// Find matching encoder by file extension if not already set.
-		if f.Encoder == nil {
-			fileExt := filepath.Ext(f.Path)
-			if len(fileExt) <= 1 {
-				prt.Debugf("Ignoring configuration file without supported extension: %s", color.CyanString(f.Path))
-				continue
-			}
-
-			// Strip dot character separating the file name and extension.
-			fileExt = fileExt[1:]
-
-			// Only add files with supported encoders.
-			for ext, enc := range encoder.ExtensionMapping {
-				if ext == fileExt {
-					f.Encoder = enc
-					s.Files = append(s.Files, f)
-					break
-				}
-			}
-		} else {
-			s.Files = append(s.Files, f)
+		fileExt := filepath.Ext(f.Path)
+		// Check if the file matches the supported YAML extension...
+		if len(fileExt) <= 1 || fileExt[1:] != encoder.ExtensionsYaml {
+			prt.Debugf("Ignoring configuration file without supported extension: %s", color.CyanString(f.Path))
+			continue
+		}
+		// ...when trimming the dot character that separates the file name and extension.
+		if fileExt[1:] == encoder.ExtensionsYaml {
+			f.Encoder = yaml.NewYamlEncoder()
+			b.Files = append(b.Files, f)
 		}
 	}
 
-	return s
+	return b
 }
 
 // Into accepts a configuration struct pointer and populates it with the current config state.
-// The order of the files array is maintained when merging the configuration states into the struct is enabled.
-func (s *builder) Into(c interface{}, merge bool) error {
-	base := reflect.New(reflect.TypeOf(c).Elem()).Interface()
-
-	for _, f := range s.Files {
+// The order of the files are maintained when merging of the configuration states is enabled.
+func (b *builder) Into(c *config.Config, merge bool) error {
+	for _, f := range b.Files {
 		content, err := ioutil.ReadFile(f.Path)
 		if err != nil {
 			return err
 		}
 
 		if !merge {
-			// Decode the file content into the given base configuration state using the assigned encoder...
+			// Decode the file content into the given configuration state using the assigned encoder...
 			if encErr := f.Encoder.Decode(content, &c); encErr != nil {
 				return fmt.Errorf("%s: %v", f.Path, encErr)
 			}
 			continue
 		}
 
-		// ...or merge into the given base configuration state.
-		raw := base
-		if encErr := f.Encoder.Decode(content, &raw); encErr != nil {
+		newState := &config.Config{}
+		// ...or merge into the given encoded configuration state.
+		if encErr := f.Encoder.Decode(content, &newState); encErr != nil {
 			return fmt.Errorf("%s: %v", f.Path, encErr)
 		}
-		if encErr := mergo.Merge(c, raw, mergo.WithAppendSlice, mergo.WithOverride); encErr != nil {
+		if encErr := mergo.Merge(c, newState, mergo.WithAppendSlice, mergo.WithOverride); encErr != nil {
 			return fmt.Errorf("%s: %v", f.Path, encErr)
 		}
 	}

pkg/config/config.go

@@ -27,18 +27,18 @@ import (
 // Config represents the application-wide configurations.
 type Config struct {
 	// LogLevel is the application-wide logging verbosity level.
-	LogLevel string `json:"logLevel" yaml:"logLevel"`
+	LogLevel string `yaml:"logLevel"`
 
 	// Snowblocks are general snowblocks configurations.
-	Snowblocks Snowblocks `json:"snowblocks,flow" yaml:"snowblocks,flow"`
+	Snowblocks Snowblocks `yaml:"snowblocks,flow"`
 }
 
 // Snowblocks represents the general snowblocks configurations.
 type Snowblocks struct {
 	// BaseDirs are the paths of the snowblock base directories.
-	BaseDirs []string `json:"baseDirs,flow" yaml:"baseDirs,flow"`
+	BaseDirs []string `yaml:"baseDirs,flow"`
 	// Paths are the paths of the snowblocks directories.
-	Paths []string `json:"paths,flow" yaml:"paths,flow"`
+	Paths []string `yaml:"paths,flow"`
 }
 
 func init() {

pkg/config/constants.go

@@ -12,10 +12,7 @@
 package config
 
 import (
-	"github.com/arcticicestudio/snowsaw/pkg/api/snowblock"
 	"github.com/arcticicestudio/snowsaw/pkg/config/source/file"
-	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task"
-	"github.com/arcticicestudio/snowsaw/pkg/snowblock/task/link"
 )
 
 const (

pkg/config/encoder/yaml/yaml.go

@@ -13,7 +13,7 @@
 package yaml
 
 import (
-	"github.com/ghodss/yaml"
+	"gopkg.in/yaml.v3"
 )
 
 // Encoder represents a YAML configuration file encoder.