[#99] add support for named queries to be stored in configs

.jira.d/config.yml

@@ -3,3 +3,9 @@ config:
 password-source: pass
 endpoint: https://go-jira.atlassian.net
 user: admin
+
+queries:
+  todo: |-
+    resolution = unresolved {{if .project}}AND project = '{{.project}}'{{end}} AND status = 'To Do'
+  progress: |-
+    resolution = unresolved {{if .project}}AND project = '{{.project}}'{{end}} AND status = 'In Progress'

jiracli/templates.go

@@ -13,9 +13,11 @@ import (
 	"strings"
 	"text/template"
 
+	yaml "gopkg.in/coryb/yaml.v2"
+
+	"github.com/coryb/figtree"
 	"github.com/mgutz/ansi"
 	"golang.org/x/crypto/ssh/terminal"
-	yaml "gopkg.in/coryb/yaml.v2"
 )
 
 func findTemplate(name string) ([]byte, error) {
@@ -157,6 +159,48 @@ func TemplateProcessor() *template.Template {
 	return template.New("gojira").Funcs(funcs)
 }
 
+func ConfigTemplate(fig *figtree.FigTree, template, command string, opts interface{}) (string, error) {
+	tmp, err := translateOptions(opts)
+	if err != nil {
+		return "", err
+	}
+	fig.LoadAllConfigs(command+".yml", tmp)
+	fig.LoadAllConfigs("config.yml", tmp)
+
+	tmpl, err := TemplateProcessor().Parse(template)
+	if err != nil {
+		return "", err
+	}
+	buf := bytes.NewBufferString("")
+	if err := tmpl.Execute(buf, &tmp); err != nil {
+		return "", err
+	}
+	return buf.String(), nil
+}
+
+func translateOptions(opts interface{}) (interface{}, error) {
+	// HACK HACK HACK: convert data formats to json for backwards compatibilty with templates
+	jsonData, err := json.Marshal(opts)
+	if err != nil {
+		return nil, err
+	}
+
+	defer func(mapType, iface reflect.Type) {
+		yaml.DefaultMapType = mapType
+		yaml.IfaceType = iface
+	}(yaml.DefaultMapType, yaml.IfaceType)
+
+	yaml.DefaultMapType = reflect.TypeOf(map[string]interface{}{})
+	yaml.IfaceType = yaml.DefaultMapType.Elem()
+
+	var rawData map[string]interface{}
+	if err := yaml.Unmarshal(jsonData, &rawData); err != nil {
+		return nil, err
+	}
+	return &rawData, nil
+
+}
+
 func RunTemplate(templateName string, data interface{}, out io.Writer) error {
 
 	templateContent, err := getTemplate(templateName)
@@ -168,22 +212,9 @@ func RunTemplate(templateName string, data interface{}, out io.Writer) error {
 		out = os.Stdout
 	}
 
-	// HACK HACK HACK: convert data formats to json for backwards compatibilty with templates
-	var rawData interface{}
-	if jsonData, err := json.Marshal(data); err != nil {
+	rawData, err := translateOptions(data)
+	if err != nil {
 		return err
-	} else {
-		defer func(mapType, iface reflect.Type) {
-			yaml.DefaultMapType = mapType
-			yaml.IfaceType = iface
-		}(yaml.DefaultMapType, yaml.IfaceType)
-
-		yaml.DefaultMapType = reflect.TypeOf(map[string]interface{}{})
-		yaml.IfaceType = yaml.DefaultMapType.Elem()
-
-		if err := yaml.Unmarshal(jsonData, &rawData); err != nil {
-			return err
-		}
 	}
 
 	tmpl, err := TemplateProcessor().Parse(templateContent)

jiracmd/edit.go

@@ -18,6 +18,7 @@ type EditOptions struct {
 	jira.SearchOptions    `yaml:",inline" json:",inline" figtree:",inline"`
 	Overrides             map[string]string `yaml:"overrides,omitempty" json:"overrides,omitempty"`
 	Issue                 string            `yaml:"issue,omitempty" json:"issue,omitempty"`
+	Queries               map[string]string `yaml:"queries,omitempty" json:"queries,omitempty"`
 }
 
 func CmdEditRegistry() *jiracli.CommandRegistryEntry {
@@ -32,19 +33,28 @@ func CmdEditRegistry() *jiracli.CommandRegistryEntry {
 		"Edit issue details",
 		func(fig *figtree.FigTree, cmd *kingpin.CmdClause) error {
 			jiracli.LoadConfigs(cmd, fig, &opts)
-			return CmdEditUsage(cmd, &opts)
+			return CmdEditUsage(cmd, &opts, fig)
 		},
 		func(o *oreo.Client, globals *jiracli.GlobalOptions) error {
 			return CmdEdit(o, globals, &opts)
 		},
 	}
 }
 
-func CmdEditUsage(cmd *kingpin.CmdClause, opts *EditOptions) error {
+func CmdEditUsage(cmd *kingpin.CmdClause, opts *EditOptions, fig *figtree.FigTree) error {
 	jiracli.BrowseUsage(cmd, &opts.CommonOptions)
 	jiracli.EditorUsage(cmd, &opts.CommonOptions)
 	jiracli.TemplateUsage(cmd, &opts.CommonOptions)
 	cmd.Flag("noedit", "Disable opening the editor").SetValue(&opts.SkipEditing)
+	cmd.Flag("named-query", "The name of a query in the `queries` configuration").Short('n').Action(func(ctx *kingpin.ParseContext) error {
+		name := jiracli.FlagValue(ctx, "named-query")
+		if query, ok := opts.Queries[name]; ok && query != "" {
+			var err error
+			opts.Query, err = jiracli.ConfigTemplate(fig, query, cmd.FullCommand(), opts)
+			return err
+		}
+		return fmt.Errorf("A valid named-query %q not found in `queries` configuration", name)
+	}).String()
 	cmd.Flag("query", "Jira Query Language (JQL) expression for the search to edit multiple issues").Short('q').StringVar(&opts.Query)
 	cmd.Flag("comment", "Comment message for issue").Short('m').PreAction(func(ctx *kingpin.ParseContext) error {
 		opts.Overrides["comment"] = jiracli.FlagValue(ctx, "comment")

jiracmd/list.go

@@ -1,6 +1,8 @@
 package jiracmd
 
 import (
+	"fmt"
+
 	"github.com/coryb/figtree"
 	"github.com/coryb/oreo"
 	"gopkg.in/Netflix-Skunkworks/go-jira.v1"
@@ -11,6 +13,7 @@ import (
 type ListOptions struct {
 	jiracli.CommonOptions `yaml:",inline" json:",inline" figtree:",inline"`
 	jira.SearchOptions    `yaml:",inline" json:",inline" figtree:",inline"`
+	Queries               map[string]string `yaml:"queries,omitempty" json:"queries,omitempty"`
 }
 
 func CmdListRegistry() *jiracli.CommandRegistryEntry {
@@ -33,22 +36,31 @@ func CmdListRegistry() *jiracli.CommandRegistryEntry {
 			if opts.Sort == "" {
 				opts.Sort = "priority asc, key"
 			}
-			return CmdListUsage(cmd, &opts)
+			return CmdListUsage(cmd, &opts, fig)
 		},
 		func(o *oreo.Client, globals *jiracli.GlobalOptions) error {
 			return CmdList(o, globals, &opts)
 		},
 	}
 }
 
-func CmdListUsage(cmd *kingpin.CmdClause, opts *ListOptions) error {
+func CmdListUsage(cmd *kingpin.CmdClause, opts *ListOptions, fig *figtree.FigTree) error {
 	jiracli.TemplateUsage(cmd, &opts.CommonOptions)
 	jiracli.GJsonQueryUsage(cmd, &opts.CommonOptions)
 	cmd.Flag("assignee", "User assigned the issue").Short('a').StringVar(&opts.Assignee)
 	cmd.Flag("component", "Component to search for").Short('c').StringVar(&opts.Component)
 	cmd.Flag("issuetype", "Issue type to search for").Short('i').StringVar(&opts.IssueType)
 	cmd.Flag("limit", "Maximum number of results to return in search").Short('l').IntVar(&opts.MaxResults)
 	cmd.Flag("project", "Project to search for").Short('p').StringVar(&opts.Project)
+	cmd.Flag("named-query", "The name of a query in the `queries` configuration").Short('n').Action(func(ctx *kingpin.ParseContext) error {
+		name := jiracli.FlagValue(ctx, "named-query")
+		if query, ok := opts.Queries[name]; ok && query != "" {
+			var err error
+			opts.Query, err = jiracli.ConfigTemplate(fig, query, cmd.FullCommand(), opts)
+			return err
+		}
+		return fmt.Errorf("A valid named-query %q not found in `queries` configuration", name)
+	}).String()
 	cmd.Flag("query", "Jira Query Language (JQL) expression for the search").Short('q').StringVar(&opts.Query)
 	cmd.Flag("queryfields", "Fields that are used in \"list\" template").Short('f').StringVar(&opts.QueryFields)
 	cmd.Flag("reporter", "Reporter to search for").Short('r').StringVar(&opts.Reporter)