support quoted env vars

Author: Mario L Gutierrez

README.md

@@ -22,7 +22,7 @@ import (
     . "gopkg.in/godo.v1"
 )
 
-func Tasks(p *Project) {
+func tasks(p *Project) {
     Env = "GOPATH=.vendor::$GOPATH PG_PASSWORD=dev"
 
     p.Task("default", D{"hello", "build"})
@@ -36,22 +36,23 @@ func Tasks(p *Project) {
         }
     })
 
-    p.Task("build", W{"**/*.go"}, func() {
+    p.Task("build", func() {
         Run("GOOS=linux GOARCH=amd64 go build", In{"cmd/server"})
-    })
+    }).Watch("**/*.go")
 
-    p.Task("views", W{"templates/**/*.go.html"}, func() {
+    p.Task("views", func() {
         Run("razor templates")
-    })
+    }).Watch("templates/**/*.go.html")
 
-    p.Task("server", D{"views"}, W{"server/**/*.go", "cmd/server/*.{go,json}"}, Debounce(3000), func() {
+    p.Task("server", D{"views"}, func() {
         // rebuilds and restarts the process when a watched file changes
         Start("main.go", In{"cmd/server"})
-    })
+    }).Watch("server/**/*.go", "cmd/server/*.{go,json}").
+       Debounce(3000)
 }
 
 func main() {
-    Godo(Tasks)
+    Godo(tasks)
 }
 ```
 
@@ -77,7 +78,6 @@ p.Task("build?", func() {})
 Task options
 
     D{} or Dependencies{} - dependent tasks which run before task
-    Debounce()            - minimum milliseconds before task can run again
     W{} or Watches{}      - array of glob file patterns to watch
 
         /**/   - match zero or more directories
@@ -86,7 +86,7 @@ Task options
         ?      - match a single non-separator char
         **/    - match any directory, start of pattern only
         /**    - match any in this directory, end of pattern only
-        !      - removes files from resultset, start of pattern only
+        !      - removes files from result set, start of pattern only
 
 Task handlers
 
@@ -124,7 +124,7 @@ godo hello -- -n dude
 Args functions are categorized as
 
 *  `Must*` - Argument must be set by user or panic.
-    
+
     ```go
 c.Args.MustInt("number", "n")
 ```

cmd.go

@@ -97,7 +97,7 @@ func killSpawned(command string) {
 
 	err := process.Kill()
 	if err != nil {
-		util.Error("Start", "Could not kill existing process %+v\n", process)
+		util.Error("Start", "Could not kill existing process %+v\n%s\n", process, err.Error())
 		return
 	}
 }

env.go

@@ -70,7 +70,7 @@ func interpolateEnv(env []string, kv string) string {
 
 func getEnv(env []string, key string, checkParent bool) string {
 	for _, kv := range env {
-		pair := strings.Split(kv, "=")
+		pair := splitKV(kv)
 		if pair[0] == key {
 			return pair[1]
 		}
@@ -82,16 +82,28 @@ func getEnv(env []string, key string, checkParent bool) string {
 	return ""
 }
 
+func splitKV(kv string) []string {
+	index := strings.Index(kv, "=")
+	if index < 0 {
+		return nil
+	}
+
+	return []string{
+		kv[0:index],
+		kv[index+1:],
+	}
+}
+
 // upsertenv updates or inserts a key=value pair into an environment.
 func upsertenv(env *[]string, kv string) {
-	pair := strings.Split(kv, "=")
-	if len(pair) != 2 {
+	pair := splitKV(kv)
+	if pair == nil {
 		return
 	}
 
 	set := false
 	for i, item := range *env {
-		ipair := strings.Split(item, "=")
+		ipair := splitKV(item)
 		if ipair[0] == pair[0] {
 			(*env)[i] = interpolateEnv(*env, kv)
 			set = true
@@ -134,8 +146,8 @@ func parseStringEnv(s string) []string {
 	}
 
 	s = str.Clean(s)
-	pairs := strings.Split(s, " ")
-	for _, kv := range pairs {
+	argv := str.ToArgv(s)
+	for _, kv := range argv {
 		if !strings.Contains(kv, "=") {
 			continue
 		}

env_test.go

@@ -63,6 +63,16 @@ func TestEnvironment(t *testing.T) {
 	SetEnviron("", true)
 }
 
+func TestQuotedVar(t *testing.T) {
+	// set back to defaults
+	defer SetEnviron("", true)
+	env := effectiveEnv([]string{`FOO="a=bar b=bah c=baz"`})
+	v := getEnv(env, "FOO", false)
+	if v != `"a=bar b=bah c=baz"` {
+		t.Errorf("Quoted var failed %q", v)
+	}
+}
+
 func TestExpansion(t *testing.T) {
 	SetEnviron(`
 		FOO=foo

project.go

@@ -62,7 +62,7 @@ func (project *Project) namespaceTaskName(name string) (namespace string, taskNa
 }
 
 func (project *Project) debounce(task *Task) bool {
-	debounceMs := task.Debounce
+	debounceMs := task.debounce
 	if debounceMs == 0 {
 		debounceMs = DebounceMs
 	}
@@ -135,7 +135,7 @@ func (project *Project) usage() string {
 
 	for _, name := range names {
 		task := m[name]
-		description := task.Description
+		description := task.description
 		if description == "" {
 			if len(task.Dependencies) > 0 {
 				description = "Runs {" + strings.Join(task.Dependencies, ", ") + ", " + name + "} tasks"
@@ -156,6 +156,36 @@ func (project *Project) Use(namespace string, tasksFunc func(*Project)) {
 	project.Namespace[namespace] = proj
 }
 
+func printDeprecatedWatchWarning(name string, globs []string) {
+	if !deprecatedWarnings {
+		return
+	}
+	util.Deprecate(fmt.Sprintf(`W{} and Watch{} are deprecated. Use Task#Watch()
+	p.Task("%s", func(){
+	}).Watch(%q)
+`, name, globs[0]))
+}
+
+func printDeprecatedDebounceWarning(name string, ms int64) {
+	if !deprecatedWarnings {
+		return
+	}
+	util.Deprecate(fmt.Sprintf(`Debounce() option is deprecated. Use Task#Debounce()
+	p.Task("%s", func(){
+	}).Debounce(%d)
+`, name, ms))
+}
+
+func printDeprecatedDescriptionWarning(name string, desc string) {
+	if !deprecatedWarnings {
+		return
+	}
+	util.Deprecate(fmt.Sprintf(`Description option is deprecated. Use Task#Description()
+	p.Task("%s", func(){
+	}).Description(%q)
+`, name, desc))
+}
+
 // Task adds a task to the project.
 func (project *Project) Task(name string, args ...interface{}) *Task {
 	runOnce := false
@@ -170,21 +200,25 @@ func (project *Project) Task(name string, args ...interface{}) *Task {
 		default:
 			util.Panic("project", "unexpected type %T\n", t) // %T prints whatever type t has
 		case Watch:
-			task.WatchGlobs = t
+			task.Watch(t...)
+			printDeprecatedWatchWarning(name, t)
 		case W:
-			task.WatchGlobs = t
+			task.Watch(t...)
+			printDeprecatedWatchWarning(name, t)
 		case Dependencies:
 			task.Dependencies = t
 		case D:
 			task.Dependencies = t
 		case Debounce:
-			task.Debounce = int64(t)
+			task.Debounce(int64(t))
+			printDeprecatedDebounceWarning(name, int64(t))
 		case func():
 			task.Handler = t
 		case func(*Context):
 			task.ContextHandler = t
 		case string:
-			task.Description = t
+			task.Description(t)
+			printDeprecatedDescriptionWarning(name, t)
 		}
 	}
 	project.Tasks[name] = task
@@ -197,7 +231,6 @@ func watchTask(root string, logName string, handler func(e *watcher.FileEvent))
 	if err != nil {
 		util.Panic("project", "%v\n", err)
 	}
-	//waitTime := time.Duration(0.1 * float64(time.Second))
 	watchr.WatchRecursive(root)
 	watchr.ErrorHandler = func(err error) {
 		util.Error("project", "%v\n", err)
@@ -220,8 +253,6 @@ func watchTask(root string, logName string, handler func(e *watcher.FileEvent))
 			continue
 		}
 		handler(event)
-		// prevent multiple restart in short time
-		//time.Sleep(waitTime)
 	}
 }
 

runner.go

@@ -12,6 +12,7 @@ var watching bool
 var help bool
 var verbose bool
 var version bool
+var deprecatedWarnings bool
 
 // DebounceMs is the default time (1500 ms) to debounce task events in watch mode.
 var DebounceMs int64
@@ -31,6 +32,7 @@ func Usage(tasks string) {
 	format := `godo %s - do task(s)
 
 Usage: godo [flags] [task...]
+  -D             Print deprecated warnings
   -h, --help     This screen
       --verbose  Log verbosely
   -v, --version  Print version
@@ -60,6 +62,7 @@ func godo(tasksFunc func(*Project), argv []string) {
 	verbose = argm.ZeroBool("verbose")
 	version = argm.ZeroBool("version", "v")
 	watching = argm.ZeroBool("watch", "w")
+	deprecatedWarnings = argm.ZeroBool("D")
 	contextArgm = minimist.ParseArgv(argm.Unparsed())
 
 	project := NewProject(tasksFunc)

task.go

@@ -16,7 +16,7 @@ import (
 // A Task is an operation performed on a user's project directory.
 type Task struct {
 	Name           string
-	Description    string
+	description    string
 	Dependencies   []string
 	Handler        func()
 	ContextHandler func(*Context)
@@ -34,7 +34,7 @@ type Task struct {
 	// Complete indicates whether this task has already ran. This flag is
 	// ignored in watch mode.
 	Complete bool
-	Debounce int64
+	debounce int64
 	RunOnce  bool
 }
 
@@ -142,3 +142,27 @@ func (task *Task) RunWithEvent(logName string, e *watcher.FileEvent) {
 
 	task.Complete = true
 }
+
+// Debounce is minimum milliseconds before task can run again
+func (task *Task) Debounce(ms int64) *Task {
+	if ms > 0 {
+		task.debounce = ms
+	}
+	return task
+}
+
+// Watch a set of glob file patterns.
+func (task *Task) Watch(globs ...string) *Task {
+	if len(globs) > 0 {
+		task.WatchGlobs = globs
+	}
+	return task
+}
+
+// Description sets the description for the task.
+func (task *Task) Description(desc string) *Task {
+	if desc != "" {
+		task.description = desc
+	}
+	return task
+}

tasks/Godofile.go

@@ -9,8 +9,7 @@ import (
 	. "gopkg.in/godo.v1"
 )
 
-// Tasks is local project.
-func Tasks(p *Project) {
+func tasks(p *Project) {
 
 	p.Task("dist", D{"test", "lint"})
 
@@ -56,12 +55,12 @@ func Tasks(p *Project) {
 		Run("whoami")
 	})
 
-	p.Task("hello", func(c *Context) {
+	p.Task("hello", Debounce(3000), W{"*.hello"}, func(c *Context) {
 		name := c.Args.MayString("default value", "name", "n")
 		fmt.Println("Hello", name)
 	})
 }
 
 func main() {
-	Godo(Tasks)
+	Godo(tasks)
 }

util/logging.go

@@ -2,12 +2,14 @@ package util
 
 import (
 	"fmt"
-	"github.com/mgutz/ansi"
 	"runtime"
+
+	"github.com/mgutz/ansi"
 )
 
 var cyan = ansi.ColorFunc("cyan")
 var red = ansi.ColorFunc("red+b")
+var yellow = ansi.ColorFunc("yellow+b")
 var redInverse = ansi.ColorFunc("white:red")
 var gray = ansi.ColorFunc("black+h")
 var magenta = ansi.ColorFunc("magenta+h")
@@ -41,3 +43,8 @@ func Panic(group string, format string, any ...interface{}) {
 	fmt.Printf(redInverse(group) + " ")
 	fmt.Printf(redInverse(format), any...)
 }
+
+// Deprecate writes a deprecation warning.
+func Deprecate(message string) {
+	fmt.Printf(yellow("godo") + " " + message)
+}