WTF-730 Fix missing color key config error (#738)

* WTF-730 Fix missing color key config error Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Add Subheading color formatting to modules Users can now set a `subheading` color in their config to change the color of subheadings in widget display. Defaults to `red`. Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Fix oustanding color issues Clean up missing color config changes not addressed in earlier commits. Signed-off-by: Chris Cummer <chriscummer@me.com> * Remove unused dependency Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Base cleanup Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Fix a few bugs related to color config changes Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Fix issues with PagerDuty subheading display Signed-off-by: Chris Cummer <chriscummer@me.com> * WTF-730 Fix bug with Todo list colour rendering Signed-off-by: Chris Cummer <chriscummer@me.com>
2025-01-18 04:03:14 -08:00 · 2019-11-09 11:21:45 -08:00
parent 1bfca29d17
commit 200dbcc03c
33 changed files with 366 additions and 137 deletions
--- a/cfg/common_settings.go
+++ b/cfg/common_settings.go
@@ -7,24 +7,6 @@ import (
 	"github.com/olebedev/config"
 )

-type Colors struct {
-	Background      string
-	BorderFocusable string
-	BorderFocused   string
-	BorderNormal    string
-	Checked         string
-	Foreground      string
-	HighlightBack   string
-	HighlightFore   string
-	Text            string
-	Title           string
-
-	Rows struct {
-		Even string
-		Odd  string
-	}
-}
-
 type Module struct {
 	Name string
 	Type string
@@ -42,11 +24,11 @@ type Sigils struct {
 }

 type Common struct {
-	Colors
 	Module
 	PositionSettings `help:"Defines where in the grid this module’s widget will be displayed."`
 	Sigils

+	Colors          ColorTheme
 	Bordered        bool   `help:"Whether or not the module should be displayed with a border." values:"true, false" optional:"true" default:"true"`
 	Enabled         bool   `help:"Whether or not this module is executed and if its data displayed onscreen." values:"true, false" optional:"true" default:"false"`
 	Focusable       bool   `help:"Whether or  not this module is focusable." values:"true, false" optional:"true" default:"false"`
@@ -57,23 +39,44 @@ type Common struct {
 	focusChar int `help:"Define one of the number keys as a short cut key to access the widget." optional:"true"`
 }

+// NewCommonSettingsFromModule returns a common settings configuration tailed to the given module
 func NewCommonSettingsFromModule(name, defaultTitle string, defaultFocusable bool, moduleConfig *config.Config, globalSettings *config.Config) *Common {
-	colorsConfig, _ := globalSettings.Get("wtf.colors")
-	sigilsPath := "wtf.sigils"
+	baseColors := NewDefaultColorTheme()
+
+	colorsConfig, err := globalSettings.Get("wtf.colors")
+	if err != nil && strings.Contains(err.Error(), "Nonexistent map") {
+		// Create a default colors config to fill in for the missing one
+		// This comes into play when the configuration file does not contain a `colors:` key, i.e:
+		//
+		//     wtf:
+		//       # colors:                <- missing
+		//       refreshInterval: 1
+		//       openFileUtil: "open"
+		//
+		colorsConfig, _ = NewDefaultColorConfig()
+	}
+
+	// And finally create a third instance to be the final default fallback in case there are empty or nil values in
+	// the colors extracted from the config file (aka colorsConfig)
+	defaultColorTheme := NewDefaultColorTheme()
+
+	baseColors.BorderTheme.Focusable = moduleConfig.UString("colors.border.focusable", colorsConfig.UString("border.focusable", defaultColorTheme.BorderTheme.Focusable))
+	baseColors.BorderTheme.Focused = moduleConfig.UString("colors.border.focused", colorsConfig.UString("border.focused", defaultColorTheme.BorderTheme.Focused))
+	baseColors.BorderTheme.Unfocusable = moduleConfig.UString("colors.border.normal", colorsConfig.UString("border.normal", defaultColorTheme.BorderTheme.Unfocusable))
+
+	baseColors.CheckboxTheme.Checked = moduleConfig.UString("colors.checked", colorsConfig.UString("checked", defaultColorTheme.CheckboxTheme.Checked))
+
+	baseColors.RowTheme.EvenForeground = moduleConfig.UString("colors.rows.even", colorsConfig.UString("rows.even", defaultColorTheme.RowTheme.EvenForeground))
+	baseColors.RowTheme.OddForeground = moduleConfig.UString("colors.rows.odd", colorsConfig.UString("rows.odd", defaultColorTheme.RowTheme.OddForeground))
+
+	baseColors.TextTheme.Subheading = moduleConfig.UString("colors.subheading", colorsConfig.UString("subheading", defaultColorTheme.TextTheme.Subheading))
+	baseColors.TextTheme.Text = moduleConfig.UString("colors.text", colorsConfig.UString("text", defaultColorTheme.TextTheme.Text))
+	baseColors.TextTheme.Title = moduleConfig.UString("colors.title", colorsConfig.UString("title", defaultColorTheme.TextTheme.Title))
+
+	baseColors.WidgetTheme.Background = moduleConfig.UString("colors.background", colorsConfig.UString("background", defaultColorTheme.WidgetTheme.Background))

 	common := Common{
-		Colors: Colors{
-			Background:      moduleConfig.UString("colors.background", colorsConfig.UString("background", "transparent")),
-			BorderFocusable: moduleConfig.UString("colors.border.focusable", colorsConfig.UString("border.focusable", "red")),
-			BorderFocused:   moduleConfig.UString("colors.border.focused", colorsConfig.UString("border.focused", "orange")),
-			BorderNormal:    moduleConfig.UString("colors.border.normal", colorsConfig.UString("border.normal", "gray")),
-			Checked:         moduleConfig.UString("colors.checked", colorsConfig.UString("checked", "white")),
-			Foreground:      moduleConfig.UString("colors.foreground", colorsConfig.UString("foreground", "white")),
-			HighlightFore:   moduleConfig.UString("colors.highlight.fore", colorsConfig.UString("highlight.fore", "black")),
-			HighlightBack:   moduleConfig.UString("colors.highlight.back", colorsConfig.UString("highlight.back", "green")),
-			Text:            moduleConfig.UString("colors.text", colorsConfig.UString("text", "white")),
-			Title:           moduleConfig.UString("colors.title", colorsConfig.UString("title", "white")),
-		},
+		Colors: baseColors,

 		Module: Module{
 			Name: name,
@@ -92,12 +95,10 @@ func NewCommonSettingsFromModule(name, defaultTitle string, defaultFocusable boo
 		focusChar: moduleConfig.UInt("focusChar", -1),
 	}

-	common.Colors.Rows.Even = moduleConfig.UString("colors.rows.even", colorsConfig.UString("rows.even", "white"))
-	common.Colors.Rows.Odd = moduleConfig.UString("colors.rows.odd", colorsConfig.UString("rows.odd", "lightblue"))
+	sigilsPath := "wtf.sigils"

 	common.Sigils.Checkbox.Checked = globalSettings.UString(sigilsPath+".checkbox.checked", "x")
 	common.Sigils.Checkbox.Unchecked = globalSettings.UString(sigilsPath+".checkbox.unchecked", " ")
-
 	common.Sigils.Paging.Normal = globalSettings.UString(sigilsPath+".paging.normal", globalSettings.UString("wtf.paging.pageSigil", "*"))
 	common.Sigils.Paging.Selected = globalSettings.UString(sigilsPath+".paging.select", globalSettings.UString("wtf.paging.selectedSigil", "_"))

@@ -107,11 +108,19 @@ func NewCommonSettingsFromModule(name, defaultTitle string, defaultFocusable boo
 /* -------------------- Exported Functions -------------------- */

 func (common *Common) DefaultFocusedRowColor() string {
-	return fmt.Sprintf("%s:%s", common.Colors.HighlightFore, common.Colors.HighlightBack)
+	return fmt.Sprintf(
+		"%s:%s",
+		common.Colors.RowTheme.HighlightedForeground,
+		common.Colors.RowTheme.HighlightedBackground,
+	)
 }

 func (common *Common) DefaultRowColor() string {
-	return fmt.Sprintf("%s:%s", common.Colors.Foreground, common.Colors.Background)
+	return fmt.Sprintf(
+		"%s:%s",
+		common.Colors.RowTheme.EvenForeground,
+		common.Colors.RowTheme.EvenBackground,
+	)
 }

 func (common *Common) FocusChar() string {
@@ -124,10 +133,10 @@ func (common *Common) FocusChar() string {

 func (common *Common) RowColor(idx int) string {
 	if idx%2 == 0 {
-		return common.Colors.Rows.Even
+		return common.Colors.RowTheme.EvenForeground
 	}

-	return common.Colors.Rows.Odd
+	return common.Colors.RowTheme.OddForeground
 }

 func (common *Common) RightAlignFormat(width int) string {
--- a/cfg/default_color_theme.go
+++ b/cfg/default_color_theme.go
@@ -0,0 +1,106 @@
+package cfg
+
+import (
+	"github.com/olebedev/config"
+	"gopkg.in/yaml.v2"
+)
+
+// BorderTheme defines the default color scheme for drawing widget borders
+type BorderTheme struct {
+	Focusable   string
+	Focused     string
+	Unfocusable string
+}
+
+// CheckboxTheme defines the default color scheme for drawing checkable rows in widgets
+type CheckboxTheme struct {
+	Checked string
+}
+
+// RowTheme defines the default color scheme for row text
+type RowTheme struct {
+	EvenBackground string
+	EvenForeground string
+
+	OddBackground string
+	OddForeground string
+
+	HighlightedBackground string
+	HighlightedForeground string
+}
+
+// TextTheme defines the default color scheme for text rendering
+type TextTheme struct {
+	Subheading string
+	Text       string
+	Title      string
+}
+
+type WidgetTheme struct {
+	Background string
+}
+
+// ColorTheme is an alamgam of all the default color settings
+type ColorTheme struct {
+	BorderTheme
+	CheckboxTheme
+	RowTheme
+	TextTheme
+	WidgetTheme
+}
+
+// NewDefaultColorTheme creates and returns an instance of DefaultColorTheme
+func NewDefaultColorTheme() ColorTheme {
+	defaultTheme := ColorTheme{
+		BorderTheme: BorderTheme{
+			Focusable:   "blue",
+			Focused:     "orange",
+			Unfocusable: "gray",
+		},
+
+		CheckboxTheme: CheckboxTheme{
+			Checked: "gray",
+		},
+
+		RowTheme: RowTheme{
+			EvenBackground: "transparent",
+			EvenForeground: "white",
+
+			OddBackground: "transparent",
+			OddForeground: "lightblue",
+
+			HighlightedForeground: "black",
+			HighlightedBackground: "green",
+		},
+
+		TextTheme: TextTheme{
+			Subheading: "red",
+			Text:       "white",
+			Title:      "green",
+		},
+
+		WidgetTheme: WidgetTheme{
+			Background: "transparent",
+		},
+	}
+
+	return defaultTheme
+}
+
+// NewDefaultColorConfig creates and returns a config.Config-compatible configuration struct
+// using a DefaultColorTheme to pre-populate all the relevant values
+func NewDefaultColorConfig() (*config.Config, error) {
+	colorTheme := NewDefaultColorTheme()
+
+	yamlBytes, err := yaml.Marshal(colorTheme)
+	if err != nil {
+		return nil, err
+	}
+
+	cfg, err := config.ParseYamlBytes(yamlBytes)
+	if err != nil {
+		return nil, err
+	}
+
+	return cfg, nil
+}
--- a/cfg/default_color_theme_test.go
+++ b/cfg/default_color_theme_test.go
@@ -0,0 +1,26 @@
+package cfg
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func Test_NewDefaultColorTheme(t *testing.T) {
+	theme := NewDefaultColorTheme()
+
+	assert.Equal(t, "orange", theme.BorderTheme.Focused)
+	assert.Equal(t, "red", theme.TextTheme.Subheading)
+	assert.Equal(t, "transparent", theme.WidgetTheme.Background)
+}
+
+func Test_NewDefaultColorConfig(t *testing.T) {
+	cfg, err := NewDefaultColorConfig()
+
+	assert.Nil(t, err)
+
+	assert.Equal(t, "orange", cfg.UString("bordertheme.focused"))
+	assert.Equal(t, "red", cfg.UString("texttheme.subheading"))
+	assert.Equal(t, "transparent", cfg.UString("widgettheme.background"))
+	assert.Equal(t, "", cfg.UString("widgettheme.missing"))
+}
--- a/cfg/position_validation_test.go
+++ b/cfg/position_validation_test.go
@@ -4,7 +4,7 @@ import (
 	"errors"
 	"testing"

-	"github.com/alecthomas/assert"
+	"github.com/stretchr/testify/assert"
 )

 var (