Merge pull request #129 from devopsdays/restructure-packages

mattstratton · web-flow · commit 7bce670c5edc · 2018-03-24T06:17:03.000-05:00
Restructure packages
diff --git a/Gopkg.lock b/Gopkg.lock
diff --git a/Gopkg.toml b/Gopkg.toml
@@ -37,10 +37,6 @@
   branch = "master"
   name = "github.com/GeertJohan/go.rice"
 
-[[constraint]]
-  branch = "master"
-  name = "github.com/alecthomas/template"
-
 [[constraint]]
   name = "github.com/asaskevich/govalidator"
   version = "9.0.0"
diff --git a/Makefile b/Makefile
@@ -11,7 +11,7 @@ VERSION:=$(shell git describe --tags)
 # VERSION := $(shell grep "const Version " version.go | sed -E 's/.*"(.+)"$$/\1/')
 BUILD:=$(shell date +%FT%T%z)
 
-LDFLAGS=-ldflags "-w -s -X github.com/devopsdays/devopsdays-cli/cmd.Version=${VERSION} -X github.com/devopsdays/devopsdays-cli/cmd.Build=${BUILD}"
+LDFLAGS=-ldflags "-w -s -X github.com/devopsdays/devopsdays-cli/commands.Version=${VERSION} -X github.com/devopsdays/devopsdays-cli/commands.Build=${BUILD}"
 
 help:
 	@echo 'Available commands:'
diff --git a/commands/add.go b/commands/add.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/spf13/cobra"
diff --git a/commands/config.go b/commands/config.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
@@ -28,7 +28,7 @@ var configCmd = &cobra.Command{
 		fmt.Println("Current Working Directory = ", pwd)
 		fmt.Println("DevOpsDays web directory = ", webdir)
 		color.Blue("Checking your config...")
-		CheckHugo()
+		checkHugo()
 		checkGit()
 	},
 }
@@ -38,10 +38,10 @@ func init() {
 
 }
 
-// CheckHugo tests whether or not a compatible version of the Hugo static site generator is instealled.
+// checkHugo tests whether or not a compatible version of the Hugo static site generator is instealled.
 //
 // Currently, the list of supported versions is hard-coded using the `supportedVersions` variable, but this should be moved elsewhere eventually.
-func CheckHugo() {
+func checkHugo() {
 	supportedVersions := map[string]bool{"0.36.1": true, "0.37": true, "0.37.1": true}
 	out, err := exec.Command("hugo", "version").Output()
 	if err != nil {
diff --git a/commands/create.go b/commands/create.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/spf13/cobra"
diff --git a/commands/edit.go b/commands/edit.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/spf13/cobra"
diff --git a/commands/event.go b/commands/event.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/organizer.go b/commands/organizer.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/program.go b/commands/program.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/prompt.go b/commands/prompt.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/AlecAivazis/survey"
diff --git a/commands/remove.go b/commands/remove.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/spf13/cobra"
diff --git a/commands/root.go b/commands/root.go
@@ -1,6 +1,6 @@
-// Package cmd defines and implements command-line commands and flags
-// used by devopsdays. Commands and flags are implemented using Cobra.
-package cmd
+// Package commands defines and implements command-line commands and flags
+// used by devopsdays-cli. Commands and flags are implemented using Cobra.
+package commands
 
 import (
 	"bytes"
@@ -89,26 +89,3 @@ func initConfig() {
 		fmt.Println("Using config file:", viper.ConfigFileUsed())
 	}
 }
-
-// func setWebdir() string {
-// 	if os.Getenv("DODPATH") == "" {
-// 		pwd, err := os.Getwd()
-// 		if err != nil {
-// 			fmt.Println(err)
-// 			os.Exit(1)
-// 		}
-// 		return pwd
-// 	}
-// 	s := os.Getenv("DODPATH")
-// 	s = strings.TrimSuffix(s, "/")
-// 	s = strings.TrimSuffix(s, "\\")
-// 	return s
-// }
-
-// func validateWebDir(webdir string) bool {
-// 	filename := "a-nonexistent-file"
-// 	if _, err := os.Stat(filename); os.IsNotExist(err) {
-// 		fmt.Printf("file does not exist")
-// 	}
-
-// }
diff --git a/commands/show.go b/commands/show.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"github.com/spf13/cobra"
diff --git a/commands/speaker.go b/commands/speaker.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/sponsor.go b/commands/sponsor.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/talk.go b/commands/talk.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/commands/version.go b/commands/version.go
@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"fmt"
diff --git a/event/event.go b/event/event.go
@@ -2,7 +2,6 @@
 package event
 
 import (
-	"errors"
 	"fmt"
 	"log"
 	"os"
@@ -12,6 +11,8 @@ import (
 
 	"text/template"
 
+	"github.com/pkg/errors"
+
 	helpers "github.com/devopsdays/devopsdays-cli/helpers"
 	paths "github.com/devopsdays/devopsdays-cli/helpers/paths"
 	"github.com/devopsdays/devopsdays-cli/images"
@@ -227,14 +228,14 @@ func CreateEvent(city, year string) (err error) {
 	NewEvent(myEvent, CityClean(city), year)
 
 	// create the event content files
-	contentfiles := []string{"index", "conduct", "contact", "location", "program", "propose", "registration", "sponsor"}
+	contentfiles := []string{"welcome", "conduct", "contact", "location", "program", "propose", "registration", "sponsor"}
 	for _, contentFile := range contentfiles {
 
-		if result, err := createEventContentFile(city, year, contentFile); err != nil {
+		if err := createEventContentFile(city, year, contentFile); err != nil {
 			fmt.Printf("Error: %s\n", err)
-		} else {
-			fmt.Printf("Event content file created for %s!!!\n", result)
+			os.Exit(1)
 		}
+		fmt.Printf("Event content file created for %s!!!\n", city)
 
 	}
 	if answers.LogoPath != "" {
@@ -280,8 +281,7 @@ func Logo(srcPath, city, year string) (err error) {
 	err = helpers.CopyFile(srcPath, filepath.Join(eventStaticPath, "logo.png"))
 
 	if err != nil {
-		fmt.Println(err)
-		return err
+		return errors.Wrapf(err, "cannot copy logo for %s %s", city, year)
 	}
 	return nil
 
@@ -294,9 +294,10 @@ func LogoSquare(srcPath, city, year string) (err error) {
 		log.Fatal(err)
 	}
 	destPath := filepath.Join(eventStaticPath, "logo-square.png")
-	images.ResizeImage(srcPath, destPath, "png", 600, 600)
-
-	// @todo update helpers.ResizeImage to return error code and do something with it here
+	err = images.ResizeImage(srcPath, destPath, "png", 600, 600)
+	if err != nil {
+		return errors.Wrap(err, "cannot resize image")
+	}
 
 	return nil
 }
diff --git a/event/make_event_files.go b/event/make_event_files.go
@@ -1,41 +1,41 @@
 package event
 
 import (
-	"fmt"
-	"log"
 	"os"
 	"path/filepath"
 	"strings"
 
+	"text/template"
+
 	rice "github.com/GeertJohan/go.rice"
-	"github.com/alecthomas/template"
 	"github.com/devopsdays/devopsdays-cli/helpers/paths"
+	"github.com/pkg/errors"
 )
 
-func createEventContentFile(city, year, page string) (string, error) {
+func createEventContentFile(city, year, page string) error {
 
 	err := os.MkdirAll((paths.EventContentPath(city, year)), 0755)
 	if err != nil {
-		return "", err
+		return errors.Wrap(err, "make event content directory failed")
 	}
 
 	// find a rice.Box
 	// to compile, cd to event directory and run `rice embed-go`
 	templateBox, err := rice.FindBox("templates")
 	if err != nil {
-		log.Fatal(err)
+		return errors.Wrap(err, "content template find failed")
 	}
 	templateName := page + ".md.tmpl"
 	// get file contents as string
 	templateString, err := templateBox.String(templateName)
 	if err != nil {
-		log.Fatal(err)
+		return errors.Wrapf(err, "cannot load template for %s", templateName)
 	}
 	s := []string{strings.TrimSpace(year), "-", strings.Replace(strings.TrimSpace(strings.ToLower(city)), " ", "-", 10)}
 	slug := strings.Join(s, "")
 	t, err := template.New(page+".md").Delims("[[", "]]").Parse(templateString)
 	if err != nil {
-		log.Fatal(err)
+		return errors.Wrapf(err, "template parse failed for %s", templateName)
 	}
 	data := struct {
 		City      string
@@ -51,15 +51,13 @@ func createEventContentFile(city, year, page string) (string, error) {
 	filePath := filepath.Join((paths.EventContentPath(city, year)), (page + ".md"))
 	f, err := os.Create(filePath)
 	if err != nil {
-		return "Cannot create", err
+		return errors.Wrapf(err, "cannot create file for %s", filePath)
 	}
 	defer f.Close()
 	t.Execute(f, data)
 	if err != nil {
-		fmt.Println(err, "template execute error")
-	} else {
-		fmt.Println("Created event content file for", city, "for year", year, "at", filePath)
+		return errors.Wrapf(err, "template execute error for %s", templateName)
 	}
-	return city, nil
+	return nil
 
 }
diff --git a/event/rice-box.go b/event/rice-box.go
diff --git a/event/templates/welcome.md.tmpl b/event/templates/welcome.md.tmpl
@@ -1,7 +1,7 @@
 +++
 Title = "devopsdays [[ .City ]] [[ .Year ]]"
 Type = "welcome"
-aliases = ["/events/[[ .Slug ]]/welcome"]
+aliases = ["/events/[[ .Slug ]]/"]
 Description = "devopsdays [[ .City ]] [[ .Year ]]"
 +++
 
diff --git a/images/resize_image.go b/images/resize_image.go
@@ -4,47 +4,48 @@ import (
 	"fmt"
 	"image/jpeg"
 	"image/png"
-	"log"
 	"os"
 
+	"github.com/pkg/errors"
+
 	"github.com/nfnt/resize"
 )
 
 // ResizeImage takes in the source path of an image, resizes it to the dimensions requested, and copies it to the destination
-func ResizeImage(srcPath string, destPath string, format string, width uint, height uint) {
+func ResizeImage(srcPath string, destPath string, format string, width uint, height uint) error {
 
 	fmt.Println("Resizing image")
 	file, err := os.Open(srcPath)
 	if err != nil {
-		log.Fatal(err)
+		return errors.Wrap(err, "cannot open original image")
 	}
 
 	if format == "png" {
 		img, err := png.Decode(file)
 		if err != nil {
-			log.Fatal(err)
+			return errors.Wrapf(err, "%s is not a PNG file", srcPath)
 		}
 		file.Close()
 		m := resize.Resize(width, height, img, resize.Lanczos3)
 		out, err := os.Create(destPath)
 		if err != nil {
-			log.Fatal(err)
+			return errors.Wrapf(err, "cannot create destination path %s", destPath)
 		}
 		defer out.Close()
 		png.Encode(out, m)
 	} else {
 		img, err := jpeg.Decode(file)
 		if err != nil {
-			log.Fatal(err)
+			return errors.Wrapf(err, "%s is not a JPEG file", srcPath)
 		}
 		file.Close()
 		m := resize.Resize(width, height, img, resize.Lanczos3)
 		out, err := os.Create(destPath)
 		if err != nil {
-			log.Fatal(err)
+			return errors.Wrapf(err, "cannot create destination path %s", destPath)
 		}
 		defer out.Close()
 		jpeg.Encode(out, m, nil)
 	}
-
+	return nil
 }
diff --git a/main.go b/main.go
@@ -1,10 +1,8 @@
 // Command-line utilities for the [devopsdays](https://www.devopsdays.org) website
 package main
 
-import (
-	"github.com/devopsdays/devopsdays-cli/cmd"
-)
+import "github.com/devopsdays/devopsdays-cli/commands"
 
 func main() {
-	cmd.Execute()
+	commands.Execute()
 }

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package cmd`
	`1`	`+package commands`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"github.com/spf13/cobra"`