diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-05-22 14:40:06 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-05-22 18:11:03 +0200 |
commit | 4ddcf52ccc7af3e23109ebaac1f0486087a212ba (patch) | |
tree | 08b51d4693f5ea91d816ca4c5ac043536ae73646 /config/services | |
parent | 353148c2bc2cdb9f2eb8ee967ba756ce09323801 (diff) |
Add an unified .Site.Config with a services section
Fixes #4751
Diffstat (limited to 'config/services')
-rw-r--r-- | config/services/servicesConfig.go | 61 | ||||
-rw-r--r-- | config/services/servicesConfig_test.go | 64 |
2 files changed, 125 insertions, 0 deletions
diff --git a/config/services/servicesConfig.go b/config/services/servicesConfig.go new file mode 100644 index 000000000..676174a56 --- /dev/null +++ b/config/services/servicesConfig.go @@ -0,0 +1,61 @@ +// Copyright 2018 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package services + +import ( + "github.com/gohugoio/hugo/config" + "github.com/mitchellh/mapstructure" +) + +const ( + servicesConfigKey = "services" + + disqusShortnameKey = "disqusshortname" + googleAnalyticsKey = "googleanalytics" +) + +// Config is a privacy configuration for all the relevant services in Hugo. +type Config struct { + Disqus Disqus + GoogleAnalytics GoogleAnalytics +} + +// Disqus holds the functional configuration settings related to the Disqus template. +type Disqus struct { + // A Shortname is the unique identifier assigned to a Disqus site. + Shortname string +} + +// GoogleAnalytics holds the functional configuration settings related to the Google Analytics template. +type GoogleAnalytics struct { + // The GA tracking ID. + ID string +} + +func DecodeConfig(cfg config.Provider) (c Config, err error) { + m := cfg.GetStringMap(servicesConfigKey) + + err = mapstructure.WeakDecode(m, &c) + + // Keep backwards compability. + if c.GoogleAnalytics.ID == "" { + // Try the global config + c.GoogleAnalytics.ID = cfg.GetString(googleAnalyticsKey) + } + if c.Disqus.Shortname == "" { + c.Disqus.Shortname = cfg.GetString(disqusShortnameKey) + } + + return +} diff --git a/config/services/servicesConfig_test.go b/config/services/servicesConfig_test.go new file mode 100644 index 000000000..96ef839a1 --- /dev/null +++ b/config/services/servicesConfig_test.go @@ -0,0 +1,64 @@ +// Copyright 2018 The Hugo Authors. All rights reserved. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package services + +import ( + "testing" + + "github.com/gohugoio/hugo/config" + "github.com/spf13/viper" + "github.com/stretchr/testify/require" +) + +func TestDecodeConfigFromTOML(t *testing.T) { + assert := require.New(t) + + tomlConfig := ` + +someOtherValue = "foo" + +[services] +[services.disqus] +shortname = "DS" +[services.googleAnalytics] +id = "ga_id" +` + cfg, err := config.FromConfigString(tomlConfig, "toml") + assert.NoError(err) + + config, err := DecodeConfig(cfg) + assert.NoError(err) + assert.NotNil(config) + + assert.Equal("DS", config.Disqus.Shortname) + assert.Equal("ga_id", config.GoogleAnalytics.ID) + +} + +// Support old root-level GA settings etc. +func TestUseSettingsFromRootIfSet(t *testing.T) { + assert := require.New(t) + + cfg := viper.New() + cfg.Set("disqusShortname", "root_short") + cfg.Set("googleAnalytics", "ga_root") + + config, err := DecodeConfig(cfg) + assert.NoError(err) + assert.NotNil(config) + + assert.Equal("root_short", config.Disqus.Shortname) + assert.Equal("ga_root", config.GoogleAnalytics.ID) + +} |