Simplify the inclusion of the Common config settings into each module

Signed-off-by: Chris Cummer <chriscummer@me.com>

Author: senorprogrammer

cfg/common_settings.go

@@ -28,13 +28,16 @@ type Common struct {
 	PositionSettings `help:"Defines where in the grid this module’s widget will be displayed."`
 	Sigils
 
-	Colors          ColorTheme
+	Colors ColorTheme
+	Config *config.Config
+
+	DocPath string
+
 	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"`
 	RefreshInterval int    `help:"How often, in seconds, this module will update its data." values:"A positive integer, 0..n." optional:"true"`
 	Title           string `help:"The title string to show when displaying this module" optional:"true"`
-	Config          *config.Config
 
 	focusChar int `help:"Define one of the number keys as a short cut key to access the widget." optional:"true"`
 }
@@ -167,6 +170,15 @@ func (common *Common) PaginationMarker(len, pos, width int) string {
 	return sigils
 }
 
+// SetDocumentationPath is used to explicitly set the documentation path that should be opened
+// when the key to open the documentation is pressed.
+// Setting this is probably not necessary unless the module documentation is nested inside a
+// documentation subdirectory in the /wtfutildocs repo, or the module here has a different
+// name than the module's display name in the documentation (which ideally wouldn't be a thing).
+func (common *Common) SetDocumentationPath(path string) {
+	common.DocPath = path
+}
+
 // Validations aggregates all the validations from all the sub-sections in Common into a
 // single array of validations
 func (common *Common) Validations() []Validatable {

modules/azuredevops/settings.go

@@ -14,7 +14,7 @@ const (
 
 // Settings defines the configuration options for this module
 type Settings struct {
-	common *cfg.Common
+	*cfg.Common
 
 	apiToken    string `help:"Your Azure DevOps Access Token."`
 	labelColor  string
@@ -26,7 +26,7 @@ type Settings struct {
 // NewSettingsFromYAML creates and returns an instance of Settings with configuration options populated
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
 	settings := Settings{
-		common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocus, ymlConfig, globalConfig),
+		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocus, ymlConfig, globalConfig),
 
 		apiToken:    ymlConfig.UString("apiToken", os.Getenv("WTF_AZURE_DEVOPS_API_TOKEN")),
 		labelColor:  ymlConfig.UString("labelColor", "white"),

modules/azuredevops/widget.go

@@ -21,7 +21,7 @@ type Widget struct {
 
 func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget {
 	widget := Widget{
-		TextWidget: view.NewTextWidget(app, pages, settings.common),
+		TextWidget: view.NewTextWidget(app, pages, settings.Common),
 		settings:   settings,
 	}
 

modules/bamboohr/settings.go

@@ -13,15 +13,15 @@ const (
 )
 
 type Settings struct {
-	common *cfg.Common
+	*cfg.Common
 
 	apiKey    string `help:"Your BambooHR API token."`
 	subdomain string `help:"Your BambooHR API subdomain name."`
 }
 
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
 	settings := Settings{
-		common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
 
 		apiKey:    ymlConfig.UString("apiKey", ymlConfig.UString("apikey", os.Getenv("WTF_BAMBOO_HR_TOKEN"))),
 		subdomain: ymlConfig.UString("subdomain", os.Getenv("WTF_BAMBOO_HR_SUBDOMAIN")),

modules/bamboohr/widget.go

@@ -21,7 +21,7 @@ type Widget struct {
 
 func NewWidget(app *tview.Application, settings *Settings) *Widget {
 	widget := Widget{
-		TextWidget: view.NewTextWidget(app, nil, settings.common),
+		TextWidget: view.NewTextWidget(app, nil, settings.Common),
 
 		settings: settings,
 	}

modules/bargraph/settings.go

@@ -11,12 +11,12 @@ const (
 )
 
 type Settings struct {
-	common *cfg.Common
+	*cfg.Common
 }
 
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
 	settings := Settings{
-		common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
 	}
 
 	return &settings

modules/bargraph/widget.go

@@ -23,7 +23,7 @@ type Widget struct {
 // NewWidget Make new instance of widget
 func NewWidget(app *tview.Application, settings *Settings) *Widget {
 	widget := Widget{
-		BarGraph: view.NewBarGraph(app, "Sample Bar Graph", settings.common),
+		BarGraph: view.NewBarGraph(app, "Sample Bar Graph", settings.Common),
 
 		app: app,
 	}

modules/buildkite/settings.go

@@ -21,7 +21,8 @@ type PipelineSettings struct {
 
 // Settings defines the configuration properties for this module
 type Settings struct {
-	common    *cfg.Common
+	*cfg.Common
+
 	apiKey    string             `help:"Your Buildkite API Token"`
 	orgSlug   string             `help:"Organization Slug"`
 	pipelines []PipelineSettings `help:"An array of pipelines to get data from"`
@@ -30,7 +31,8 @@ type Settings struct {
 // NewSettingsFromYAML creates a new settings instance from a YAML config block
 func NewSettingsFromYAML(name string, ymlConfig *config.Config, globalConfig *config.Config) *Settings {
 	settings := Settings{
-		common:    cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+		Common: cfg.NewCommonSettingsFromModule(name, defaultTitle, defaultFocusable, ymlConfig, globalConfig),
+
 		apiKey:    ymlConfig.UString("apiKey", os.Getenv("WTF_BUILDKITE_TOKEN")),
 		orgSlug:   ymlConfig.UString("organizationSlug"),
 		pipelines: buildPipelineSettings(ymlConfig),

modules/buildkite/widget.go

@@ -17,7 +17,7 @@ type Widget struct {
 
 func NewWidget(app *tview.Application, pages *tview.Pages, settings *Settings) *Widget {
 	widget := Widget{
-		TextWidget: view.NewTextWidget(app, pages, settings.common),
+		TextWidget: view.NewTextWidget(app, pages, settings.Common),
 		settings:   settings,
 	}
 

modules/cds/favorites/display.go

@@ -25,7 +25,7 @@ func (widget *Widget) content() (string, string, bool) {
 	}
 
 	_, _, width, _ := widget.View.GetRect()
-	str := widget.settings.common.PaginationMarker(len(widget.workflows), widget.Idx, width) + "\n"
+	str := widget.settings.PaginationMarker(len(widget.workflows), widget.Idx, width) + "\n"
 	title := fmt.Sprintf("%s - %s", widget.CommonSettings().Title, widget.title(workflow))
 
 	str += widget.displayWorkflowRuns(workflow)
@@ -36,7 +36,7 @@ func (widget *Widget) content() (string, string, bool) {
 func (widget *Widget) title(workflow *sdk.Workflow) string {
 	return fmt.Sprintf(
 		"[%s]%s/%s[white]",
-		widget.settings.common.Colors.TextTheme.Title,
+		widget.settings.Colors.TextTheme.Title,
 		workflow.ProjectKey, workflow.Name,
 	)
 }