Implement top-level variables and rerun introduced in Alfred 3.2

Author: deanishe

feedback.go

@@ -351,10 +351,10 @@ func (m *Modifier) MarshalJSON() ([]byte, error) {
 // and Modifier structs.
 type Feedback struct {
 	// Items are the results to be sent to Alfred.
-	Items []*Item `json:"items"`
-	// Set to true when feedback has been sent.
-	sent bool
-	vars map[string]string
+	Items []*Item
+	rerun float64           // Tell Alfred to re-run Script Filter.
+	sent  bool              // Set to true when feedback has been sent.
+	vars  map[string]string // Top-level feedback variables.
 }
 
 // NewFeedback creates a new, initialised Feedback struct.
@@ -374,10 +374,11 @@ func (fb *Feedback) Var(k, v string) *Feedback {
 	return fb
 }
 
-// Var returns the value of Feedback's workflow variable for key k.
-// func (fb *Feedback) Var(k string) string {
-// 	return fb.vars[k]
-// }
+// Rerun tells Alfred to re-run the Script Filter after `secs` seconds.
+func (fb *Feedback) Rerun(secs float64) *Feedback {
+	fb.rerun = secs
+	return fb
+}
 
 // Vars returns the Feedback's workflow variables.
 func (fb *Feedback) Vars() map[string]string {
@@ -402,11 +403,11 @@ func (fb *Feedback) NewItem(title string) *Item {
 	it := &Item{title: title, vars: map[string]string{}}
 
 	// Variables
-	if len(fb.vars) > 0 {
-		for k, v := range fb.vars {
-			it.Var(k, v)
-		}
-	}
+	// if len(fb.vars) > 0 {
+	// 	for k, v := range fb.vars {
+	// 		it.Var(k, v)
+	// 	}
+	// }
 
 	fb.Items = append(fb.Items, it)
 	return it
@@ -432,6 +433,20 @@ func (fb *Feedback) NewFileItem(path string) *Item {
 	return it
 }
 
+// MarshalJSON serializes Feedback to Alfred 3's JSON format.
+// You shouldn't need to call this: use Send() instead.
+func (fb *Feedback) MarshalJSON() ([]byte, error) {
+	return json.Marshal(&struct {
+		Variables map[string]string `json:"variables,omitempty"`
+		Rerun     float64           `json:"rerun,omitempty"`
+		Items     []*Item           `json:"items"`
+	}{
+		Items:     fb.Items,
+		Rerun:     fb.rerun,
+		Variables: fb.vars,
+	})
+}
+
 // Send generates JSON from this struct and sends it to Alfred
 // (by writing the JSON to STDOUT).
 func (fb *Feedback) Send() error {

feedback_test.go

@@ -289,14 +289,17 @@ func TestMarshalFeedback(t *testing.T) {
 
 	// Feedback with item
 	// want = `<items><item valid="no"><title>item 1</title></item></items>`
-	want = `{"items":[{"title":"item 1"}]}`
+	want = `{"items":[{"title":"item 1","valid":false}]}`
 	fb.NewItem("item 1")
 
 	got, err = json.Marshal(fb)
 	if err != nil {
 		t.Fatalf("Error marshalling feedback: got: %s want: %s: %v",
 			got, want, err)
 	}
+	if string(got) != want {
+		t.Fatalf("Wrong feedback JSON. Expected=%s, got=%s", want, got)
+	}
 
 }
 
@@ -313,6 +316,22 @@ func TestModifiersInheritVars(t *testing.T) {
 	}
 }
 
+// TestFeedbackRerun verifies that rerun is properly set.
+func TestFeedbackRerun(t *testing.T) {
+	fb := NewFeedback()
+
+	fb.Rerun(1.5)
+
+	want := `{"rerun":1.5,"items":[]}`
+	got, err := json.Marshal(fb)
+	if err != nil {
+		t.Fatalf("Error serializing feedback: got: %s want: %s: %s", got, want, err)
+	}
+	if string(got) != want {
+		t.Fatalf("Wrong feedback JSON. Expected=%s, got=%s", want, got)
+	}
+}
+
 // TestFeedbackVars tests if vars are properly inherited by Items and Modifiers
 func TestFeedbackVars(t *testing.T) {
 	fb := NewFeedback()
@@ -322,14 +341,26 @@ func TestFeedbackVars(t *testing.T) {
 		t.Fatalf("Feedback var has wrong value. Expected=bar, Received=%v", fb.Vars()["foo"])
 	}
 
+	want := `{"variables":{"foo":"bar"},"items":[]}`
+	got, err := json.Marshal(fb)
+	if err != nil {
+		t.Fatalf("Error serializing feedback: got: %s want: %s: %s", got, want, err)
+	}
+	if string(got) != want {
+		t.Fatalf("Wrong feedback JSON. Expected=%s, got=%s", want, got)
+	}
+
+	// Top-level vars are not inherited
 	it := fb.NewItem("title")
-	if it.Vars()["foo"] != "bar" {
-		t.Fatalf("Item var has wrong value. Expected=bar, Received=%v", it.Vars()["foo"])
+	if it.Vars()["foo"] != "" {
+		t.Fatalf("Item var has wrong value. Expected='', Received=%v", it.Vars()["foo"])
 	}
 
+	// Modifier inherits Item vars
+	it.Var("foo", "baz")
 	m := it.NewModifier("cmd")
-	if m.Vars()["foo"] != "bar" {
-		t.Fatalf("Modifier var has wrong value. Expected=bar, Received=%v", m.Vars()["foo"])
+	if m.Vars()["foo"] != "baz" {
+		t.Fatalf("Modifier var has wrong value. Expected=baz, Received=%v", m.Vars()["foo"])
 	}
 }
 

workflow.go

@@ -602,9 +602,18 @@ func (wf *Workflow) OpenLog() error {
 // --------------------------------------------------------------------
 // Feedback
 
+// Rerun tells Alfred to re-run the Script Filter after `secs` seconds.
+func Rerun(secs float64) *Workflow { return wf.Rerun(secs) }
+
+// Rerun tells Alfred to re-run the Script Filter after `secs` seconds.
+func (wf *Workflow) Rerun(secs float64) *Workflow {
+	wf.Feedback.Rerun(secs)
+	return wf
+}
+
 // Vars returns the workflow variables set on Workflow.Feedback.
 // See Feedback.Vars() for more information.
-func Vars() map[string]string { return wf.Feedback.Vars() }
+func Vars() map[string]string { return wf.Vars() }
 
 // Vars returns the workflow variables set on Workflow.Feedback.
 // See Feedback.Vars() for more information.