svengreb · svengreb · Nov 16, 2020 · Nov 15, 2020 · Nov 16, 2020 · Nov 16, 2020
@@ -1,3 +1,9 @@
 module github.com/svengreb/wand
 
 go 1.15
+
+require (
+	github.com/Masterminds/semver/v3 v3.1.0
+	github.com/go-git/go-git/v5 v5.1.0
+	github.com/stretchr/testify v1.6.1
+)
@@ -0,0 +1,83 @@
+github.com/Masterminds/semver/v3 v3.1.0 h1:Y2lUDsFKVRSYGojLJ1yLxSXdMmMYTYls0rCvoqmMUQk=
+github.com/Masterminds/semver/v3 v3.1.0/go.mod h1:VPu/7SZ7ePZ3QOrcuXROw5FAcLl4a0cBrbBpGY/8hQs=
+github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7 h1:uSoVVbwJiQipAclBbw+8quDsfcvFjOpI5iCf4p/cqCs=
+github.com/alcortesm/tgz v0.0.0-20161220082320-9c5fe88206d7/go.mod h1:6zEj6s6u/ghQa61ZWa/C2Aw3RkjiTBOix7dkqa1VLIs=
+github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239 h1:kFOfPq6dUM1hTo4JG6LR5AXSUEsOjtdm0kw0FtQtMJA=
+github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5 h1:0CwZNZbxp69SHPdPJAN/hZIm0C4OItdklCFmMRWYpio=
+github.com/armon/go-socks5 v0.0.0-20160902184237-e75332964ef5/go.mod h1:wHh0iHkYZB8zMSxRWpUBQtwG5a7fFgvEO+odwuTv2gs=
+github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/emirpasic/gods v1.12.0 h1:QAUIPSaCu4G+POclxeqb3F+WPpdKqFGlw36+yOzGlrg=
+github.com/emirpasic/gods v1.12.0/go.mod h1:YfzfFFoVP/catgzJb4IKIqXjX78Ha8FMSDh3ymbK86o=
+github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568 h1:BHsljHzVlRcyQhjrss6TZTdY2VfCqZPbv5k3iBFa2ZQ=
+github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568/go.mod h1:xEzjJPgXI435gkrCt3MPfRiAkVrwSbHsst4LCFVfpJc=
+github.com/gliderlabs/ssh v0.2.2 h1:6zsha5zo/TWhRhwqCD3+EarCAgZ2yN28ipRnGPnwkI0=
+github.com/gliderlabs/ssh v0.2.2/go.mod h1:U7qILu1NlMHj9FlMhZLlkCdDnU1DBEAqr0aevW3Awn0=
+github.com/go-git/gcfg v1.5.0 h1:Q5ViNfGF8zFgyJWPqYwA7qGFoMTEiBmdlkcfRmpIMa4=
+github.com/go-git/gcfg v1.5.0/go.mod h1:5m20vg6GwYabIxaOonVkTdrILxQMpEShl1xiMF4ua+E=
+github.com/go-git/go-billy/v5 v5.0.0 h1:7NQHvd9FVid8VL4qVUMm8XifBK+2xCoZ2lSk0agRrHM=
+github.com/go-git/go-billy/v5 v5.0.0/go.mod h1:pmpqyWchKfYfrkb/UVH4otLvyi/5gJlGI4Hb3ZqZ3W0=
+github.com/go-git/go-git-fixtures/v4 v4.0.1 h1:q+IFMfLx200Q3scvt2hN79JsEzy4AmBTp/pqnefH+Bc=
+github.com/go-git/go-git-fixtures/v4 v4.0.1/go.mod h1:m+ICp2rF3jDhFgEZ/8yziagdT1C+ZpZcrJjappBCDSw=
+github.com/go-git/go-git/v5 v5.1.0 h1:HxJn9g/E7eYvKW3Fm7Jt4ee8LXfPOm/H1cdDu8vEssk=
+github.com/go-git/go-git/v5 v5.1.0/go.mod h1:ZKfuPUoY1ZqIG4QG9BDBh3G4gLM5zvPuSJAozQrZuyM=
+github.com/google/go-cmp v0.3.0 h1:crn/baboCvb5fXaQ0IJ1SGTsTVrWpDsCWC8EGETZijY=
+github.com/google/go-cmp v0.3.0/go.mod h1:8QqcDgzrUqlUb/G2PQTWiueGozuR1884gddMywk6iLU=
+github.com/imdario/mergo v0.3.9 h1:UauaLniWCFHWd+Jp9oCEkTBj8VO/9DKg3PV3VCNMDIg=
+github.com/imdario/mergo v0.3.9/go.mod h1:2EnlNZ0deacrJVfApfmtdGgDfMuh/nq6Ok1EcJh5FfA=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99 h1:BQSFePA1RWJOlocH6Fxy8MmwDt+yVQYULKfN0RoTN8A=
+github.com/jbenet/go-context v0.0.0-20150711004518-d14ea06fba99/go.mod h1:1lJo3i6rXxKeerYnT8Nvf0QmHCRC1n8sfWVwXF2Frvo=
+github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd h1:Coekwdh0v2wtGp9Gmz1Ze3eVRAWJMLokvN3QjdzCHLY=
+github.com/kevinburke/ssh_config v0.0.0-20190725054713-01f96b0aa0cd/go.mod h1:CT57kijsi8u/K/BOFA39wgDQJ9CxiF4nAY/ojJ6r6mM=
+github.com/kr/pretty v0.1.0/go.mod h1:dAy3ld7l9f0ibDNOQOHHMYYIIbhfbHSm3C4ZsoJORNo=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
+github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
+github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/pkg/errors v0.8.1 h1:iURUrRGxPUNPdy5/HRSm+Yj6okJ6UtLINN0Q9M4+h3I=
+github.com/pkg/errors v0.8.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sergi/go-diff v1.1.0 h1:we8PVUC3FE2uYfodKH/nBHMSetSfHDR6scGdBi+erh0=
+github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/xanzy/ssh-agent v0.2.1 h1:TCbipTQL2JiiCprBWx9frJ2eJlCYT00NmctrHxVAr70=
+github.com/xanzy/ssh-agent v0.2.1/go.mod h1:mLlQY/MoOhWBj+gOGMQkOeiEvkx+8pJSI+0Bx9h2kr4=
+golang.org/x/crypto v0.0.0-20190219172222-a4c6cb3142f2/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073 h1:xMPOj6Pz6UipU1wXLkrtqpHbR0AVFnyPEQq/wRWz9lM=
+golang.org/x/crypto v0.0.0-20200302210943-78000ba7a073/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20200301022130-244492dfa37a h1:GuSPYbZzB5/dcLNCwLQLsg3obCJtX9IJhpXkvY7kzk0=
+golang.org/x/net v0.0.0-20200301022130-244492dfa37a/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190221075227-b4e8571b14e0/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527 h1:uYVVQ9WP/Ds2ROhcaGPeIdVq0RIXVLwsHlnvJ+cT1So=
+golang.org/x/sys v0.0.0-20200302150141-5c8b2ff67527/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.2 h1:tW2bmiBqwgJj/UpqtC8EpXEZVYOwU0yG4iWbprSVAcs=
+golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/warnings.v0 v0.1.2 h1:wFXVbFY8DY5/xOe1ECiWdKCzZlxgshcYVNkBHstARME=
+gopkg.in/warnings.v0 v0.1.2/go.mod h1:jksf8JmL6Qr/oQM2OXTHunEvvTAsrWBLb6OOjuVWRNI=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.4 h1:/eiJrUcujPVeJ3xlSWaiNi3uSVmDGBK1pDHUHAnao1I=
+gopkg.in/yaml.v2 v2.2.4/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
@@ -0,0 +1,58 @@
+// Copyright (c) 2019-present Sven Greb <development@svengreb.de>
+// This source code is licensed under the MIT license found in the LICENSE file.
+
+package project
+
+import (
+	"errors"
+	"fmt"
+)
+
+const (
+	// ErrDeriveVCSInformation indicates that the derivation of VCS version information failed.
+	ErrDeriveVCSInformation = ErrString("failed to derive VCS version information")
+
+	// ErrDetectProjectRootDirPath indicates that the detection of a project root directory path failed.
+	ErrDetectProjectRootDirPath = ErrString("failed to detect project root directory path")
+
+	// ErrDetermineGoModuleInformation indicates that a determination of Go module information failed.
+	ErrDetermineGoModuleInformation = ErrString("failed to determine Go module information")
+
+	// ErrPathNotRelative indicates that a path is not releative.
+	ErrPathNotRelative = ErrString("path is not relative")
+)
+
+// ErrString is a string type for implementing constant errors.
+type ErrString string
+
+func (e ErrString) Error() string {
+	return string(e)
+}
+
+// ErrProject represents a project error.
+type ErrProject struct {
+	// Err is a wrapped error.
+	Err error
+	// Kind is the error kind.
+	Kind error
+}
+
+func (e *ErrProject) Error() string {
+	msg := "project error"
+	if e.Kind != nil {
+		msg = fmt.Sprintf("%s: %v", msg, e.Kind)
+	}
+	if e.Err != nil {
+		msg = fmt.Sprintf("%s: %v", msg, e.Err)
+	}
+
+	return msg
+}
+
+// Is enables usage of errors.Is() to determine the kind of error that occurred.
+func (e *ErrProject) Is(err error) bool {
+	return errors.Is(err, e.Kind)
+}
+
+// Unwrap returns the underlying error for usage with errors.Unwrap().
+func (e *ErrProject) Unwrap() error { return e.Err }
@@ -0,0 +1,50 @@
+// Copyright (c) 2019-present Sven Greb <development@svengreb.de>
+// This source code is licensed under the MIT license found in the LICENSE file.
+
+package project
+
+import (
+	"fmt"
+
+	"github.com/Masterminds/semver/v3"
+)
+
+const (
+	// GoModuleVersionLatest is the "version query suffix" for the latest version of a Go module.
+	// See https://golang.org/ref/mod#version-queries for more details.
+	GoModuleVersionLatest = "latest"
+)
+
+// GoModuleID stores partial information to identify a Go module.
+// See https://golang.org/ref/mod#modules-overview for more details.
+type GoModuleID struct {
+	// IsLatest indicates if the Go module version uses GoModuleVersionLatest as "version query suffix".
+	IsLatest bool
+
+	// Path is the canonical name for a module, declared with the module directive in the module's go.mod file.
+	//
+	// See:
+	//   (1) https://golang.org/ref/mod#module-path
+	//   (2) https://golang.org/ref/mod#go-mod-file-module
+	//   (3) https://golang.org/ref/mod#glos-go-mod-file
+	Path string
+
+	// Version identifies an immutable snapshot of a module starting with the letter "v", followed by a semantic
+	// version.
+	// Note that a nil value is resolved using GoModuleVersionLatest s "version query suffix".
+	//
+	// See:
+	//   (1) https://golang.org/ref/mod#versions
+	//   (2) https://golang.org/ref/mod#version-queries
+	//   (3) https://semver.org/spec/v2.0.0.html
+	//   (4) https://golang.org/cmd/go/#hdr-Pseudo_versions
+	//   (5) https://blog.golang.org/publishing-go-modules
+	Version *semver.Version
+}
+
+func (gm *GoModuleID) String() string {
+	if gm.Version != nil && !gm.IsLatest {
+		return fmt.Sprintf("%s@%s", gm.Path, gm.Version.Original())
+	}
+	return fmt.Sprintf("%s@%s", gm.Path, GoModuleVersionLatest)
+}
@@ -0,0 +1,139 @@
+// Copyright (c) 2019-present Sven Greb <development@svengreb.de>
+// This source code is licensed under the MIT license found in the LICENSE file.
+
+package project
+
+import (
+	"os"
+	"path/filepath"
+	"runtime/debug"
+
+	"github.com/Masterminds/semver/v3"
+
+	"github.com/svengreb/wand/pkg/project/vcs"
+	vcsNone "github.com/svengreb/wand/pkg/project/vcs/none"
+)
+
+const (
+	// DefaultBaseOutputDir is the default base output directory relative to Options.RootDirPathAbs for compile, test
+	// and production artifacts as well as distribution bundles, static web files or metric/statistic reports.
+	DefaultBaseOutputDir = "out"
+
+	// DefaultVersion is the default version for a project vcs.Repository.
+	DefaultVersion = "v0.0.0"
+)
+
+// Options stores project options.
+type Options struct {
+	// BaseOutputDir is the base project output directory, relative to RootDirPathAbs, for compile, test and production
+	// artifacts as well as distribution bundles, static web files or metric/statistic reports.
+	BaseOutputDir string
+
+	// DefaultVersion is the default project version.
+	DefaultVersion string
+
+	// DisplayName is the project display name.
+	DisplayName string
+
+	// GoModule is the project Go module.
+	GoModule *GoModuleID
+
+	// Name is the project name.
+	Name string
+
+	// Repository is the project repository.
+	Repository vcs.Repository
+
+	// RootDirPathAbs is the absolute path to the project root directory.
+	RootDirPathAbs string
+
+	// VCSKind is the VCS kind of the project Repository.
+	VCSKind vcs.Kind
+}
+
+// Option is a project option.
+type Option func(*Options)
+
+// WithBaseOutputDir sets the base output directory.
+func WithBaseOutputDir(dir string) Option {
+	return func(o *Options) {
+		o.BaseOutputDir = dir
+	}
+}
+
+// WithDefaultVersion set the project default verion.
+func WithDefaultVersion(defaultVersion string) Option {
+	return func(o *Options) {
+		o.DefaultVersion = defaultVersion
+	}
+}
+
+// WithDisplayName sets the project display name.
+func WithDisplayName(name string) Option {
+	return func(o *Options) {
+		o.DisplayName = name
+	}
+}
+
+// WithGoModule sets the project Go module.
+func WithGoModule(module *GoModuleID) Option {
+	return func(o *Options) {
+		o.GoModule = module
+	}
+}
+
+// WithName sets the project name.
+func WithName(name string) Option {
+	return func(o *Options) {
+		o.Name = name
+	}
+}
+
+// WithVCSKind sets the vcs.Kind of the project vcs.Repository.
+func WithVCSKind(kind vcs.Kind) Option {
+	return func(o *Options) {
+		o.VCSKind = kind
+	}
+}
+
+// newOptions creates new project options.
+// The absolute path to the root directory is automatically set based on the current working directory and the Go module
+// name is automatically determined using the runtime/debug package.
+func newOptions(opts ...Option) (*Options, error) {
+	rootDirPath, pwdErr := os.Getwd()
+	if pwdErr != nil {
+		return nil, &ErrProject{
+			Err:  pwdErr,
+			Kind: ErrDetectProjectRootDirPath,
+		}
+	}
+
+	buildInfo, ok := debug.ReadBuildInfo()
+	if !ok {
+		return nil, &ErrProject{Kind: ErrDetermineGoModuleInformation}
+	}
+
+	goModuleVersion, goModuleVersionErr := semver.NewVersion(buildInfo.Main.Version)
+	if goModuleVersionErr == nil {
+		return nil, &ErrProject{Err: goModuleVersionErr, Kind: ErrDetermineGoModuleInformation}
+	}
+
+	opt := &Options{
+		BaseOutputDir:  DefaultBaseOutputDir,
+		DefaultVersion: DefaultVersion,
+		DisplayName:    filepath.Base(rootDirPath),
+		GoModule: &GoModuleID{
+			Path:    buildInfo.Main.Path,
+			Version: goModuleVersion,
+		},
+		Name:           filepath.Base(rootDirPath),
+		Repository:     vcsNone.New(),
+		RootDirPathAbs: rootDirPath,
+		VCSKind:        vcs.KindNone,
+	}
+	for _, o := range opts {
+		o(opt)
+	}
+
+	return opt, nil
+}