v3.0 (feat): add template runner and it dependency prompt wrapper to load and parse cmf yaml file

Author: Rodrigonavarro23

mocks/templaterunner.go

@@ -0,0 +1,62 @@
+package prompt
+
+import (
+	"errors"
+	"strings"
+
+	"github.com/mritd/promptx"
+)
+
+// SelectItem a default item struct
+type SelectItem struct {
+	Title       string
+	Description string
+	Value       string
+}
+
+// SelectConfiguration a complete configuration select options
+type SelectConfiguration struct {
+	ActiveTpl    string
+	InactiveTpl  string
+	SelectPrompt string
+	SelectedTpl  string
+	DetailsTpl   string
+}
+
+// Select Returns a selected item
+func Select(items []SelectItem, config SelectConfiguration) SelectItem {
+	configuration := &promptx.SelectConfig{
+		ActiveTpl:    config.ActiveTpl,
+		InactiveTpl:  config.InactiveTpl,
+		SelectPrompt: config.SelectPrompt,
+		SelectedTpl:  config.SelectedTpl,
+		DisPlaySize:  9,
+		DetailsTpl:   config.DetailsTpl,
+	}
+
+	selector := &promptx.Select{
+		Items:  items,
+		Config: configuration,
+	}
+
+	return items[selector.Run()]
+}
+
+// Input return a simple user input
+func Input(title string, errorMessage string, defaultValue string) string {
+	input := promptx.NewDefaultPrompt(func(line []rune) error {
+		if strings.TrimSpace(string(line)) == "" && defaultValue == "" {
+			return errors.New(errorMessage)
+		}
+
+		return nil
+	}, title)
+
+	value := input.Run()
+
+	if value == "" && defaultValue != "" {
+		return defaultValue
+	}
+
+	return value
+}

prompt/prompt.go

@@ -0,0 +1,61 @@
+package promptxwrapper
+
+import (
+	"errors"
+	"strings"
+
+	"github.com/mritd/promptx"
+	"github.com/walmartdigital/commit-message-formatter/prompt"
+	"github.com/walmartdigital/commit-message-formatter/templaterunner"
+)
+
+// PromptxWrapper promptx wrapper object
+type PromptxWrapper struct{}
+
+// NewPromptxWrapper return a new instance of promptxWrapper
+func NewPromptxWrapper() *PromptxWrapper {
+	return &PromptxWrapper{}
+}
+
+// ReadValue return a value from user single input
+func (pw *PromptxWrapper) ReadValue(title string, errorMessage string, defaultValue string) string {
+	input := promptx.NewDefaultPrompt(func(line []rune) error {
+		if strings.TrimSpace(string(line)) == "" && defaultValue == "" {
+			return errors.New(errorMessage)
+		}
+
+		return nil
+	}, title)
+
+	value := input.Run()
+
+	if value == "" && defaultValue != "" {
+		return defaultValue
+	}
+
+	return value
+}
+
+// ReadValueFromList return a value from user multi select input
+func (pw *PromptxWrapper) ReadValueFromList(title string, options []templaterunner.Options) string {
+	configuration := &promptx.SelectConfig{
+		ActiveTpl:    "\U0001F449  {{ .Title | cyan | bold }}",
+		InactiveTpl:  "    {{ .Title | white }}",
+		SelectPrompt: title,
+		SelectedTpl:  "\U0001F44D {{ \"" + title + "\" | cyan }} {{ .Title | cyan | bold }}",
+		DetailsTpl: `-------------------------------
+		{{ .Title | white | bold }} {{ .Description | white | bold }}`,
+	}
+
+	var items []prompt.SelectItem
+	for _, option := range options {
+		items = append(items, prompt.SelectItem{Title: option.Value, Value: option.Value, Description: option.Description})
+	}
+
+	selector := &promptx.Select{
+		Items:  items,
+		Config: configuration,
+	}
+
+	return items[selector.Run()].Value
+}

promptxWrapper/promptxwrapper.go

@@ -0,0 +1,125 @@
+package templaterunner
+
+import (
+	"errors"
+	"strings"
+
+	"gopkg.in/yaml.v2"
+)
+
+type templateRunner struct {
+	promptManager PromptManager
+}
+
+// PromptManager ...
+type PromptManager interface {
+	ReadValue(title string, errorMessage string, defaultValue string) string
+	ReadValueFromList(title string, options []Options) string
+}
+
+// TemplateRunner main template interface
+type TemplateRunner interface {
+	Run(yamlData string, injectedVariables map[string]string) (message string, err error)
+}
+
+// Template main template struct
+type Template struct {
+	Prompt   []PromptItem `yaml:"PROMPT"`
+	Template string       `yaml:"TEMPLATE"`
+}
+
+//PromptItem ...
+type PromptItem struct {
+	Key          string    `yaml:"KEY"`
+	Label        string    `yaml:"LABEL"`
+	ErrorLabel   string    `yaml:"ERROR_LABEL"`
+	DefaultValue string    `yaml:"DEFAULT_VALUE"`
+	Options      []Options `yaml:"OPTIONS"`
+}
+
+// Options multiselect option struct
+type Options struct {
+	Value       string `yaml:"VALUE"`
+	Description string `yaml:"DESC"`
+}
+
+type keyValue struct {
+	Key   string
+	Value string
+}
+
+// NewTemplateRunner return a  bluetnew instance of template
+func NewTemplateRunner(promptManager PromptManager) TemplateRunner {
+	return &templateRunner{
+		promptManager: promptManager,
+	}
+}
+
+func (tr *templateRunner) parseYaml(yamlData string) (Template, error) {
+	template := Template{}
+	err := yaml.Unmarshal([]byte(yamlData), &template)
+
+	if err != nil {
+		return Template{}, errors.New("parsing yaml error")
+	}
+
+	return template, nil
+}
+
+// Run return the result of run the template
+func (tr *templateRunner) Run(yamlData string, injectedVariables map[string]string) (string, error) {
+	template, err := tr.parseYaml(yamlData)
+	if err != nil {
+		return "", err
+	}
+
+	variables := tr.prompt(template)
+	for k, v := range injectedVariables {
+		variables = append(variables, keyValue{Key: k, Value: v})
+	}
+
+	message := tr.parseTemplate(template.Template, variables)
+
+	return message, err
+}
+
+func (tr *templateRunner) parseTemplate(template string, variables []keyValue) string {
+	for _, v := range variables {
+		template = strings.Replace(template, "{{"+v.Key+"}}", v.Value, -1)
+	}
+
+	return template
+}
+
+func (tr *templateRunner) prompt(template Template) []keyValue {
+	variables := []keyValue{}
+	for _, step := range template.Prompt {
+		result := ""
+		var errorMessage = "empty value"
+
+		if step.ErrorLabel != "" {
+			errorMessage = step.ErrorLabel
+		}
+
+		if step.Options == nil {
+			var labelMessage = step.Label
+
+			if step.DefaultValue != "" {
+				labelMessage += " (" + step.DefaultValue + ")"
+			}
+
+			labelMessage += ":"
+
+			result = tr.promptManager.ReadValue(labelMessage, errorMessage, step.DefaultValue)
+		} else {
+			result = tr.promptManager.ReadValueFromList(step.Label, step.Options)
+		}
+
+		variables = append(variables, keyValue{
+			Key:   step.Key,
+			Value: result,
+		})
+	}
+
+	return variables
+}