feat: Add fromIni template function

twpayne · Aug 14, 2022 · 02b8954 · 02b8954
1 parent ffdc746
commit 02b8954
Show file tree

Hide file tree

Showing 5 changed files with 78 additions and 0 deletions.
diff --git a/assets/chezmoi.io/docs/reference/templates/functions/fromIni.md b/assets/chezmoi.io/docs/reference/templates/functions/fromIni.md
@@ -0,0 +1,9 @@
+# `fromIni` *initext*
+
+`fromIni` returns the parsed value of *initext*.
+
+!!! example
+
+    ```
+    {{ (fromIni "[section]\nkey = value").section.key }}
+    ```
diff --git a/assets/chezmoi.io/mkdocs.yml b/assets/chezmoi.io/mkdocs.yml
@@ -170,6 +170,7 @@ nav:
       - comment: reference/templates/functions/comment.md
       - decrypt: reference/templates/functions/decrypt.md
       - encrypt: reference/templates/functions/encrypt.md
+      - fromIni: reference/templates/functions/fromIni.md
       - fromToml: reference/templates/functions/fromToml.md
       - fromYaml: reference/templates/functions/fromYaml.md
       - glob: reference/templates/functions/glob.md

diff --git a/pkg/cmd/config.go b/pkg/cmd/config.go
@@ -439,6 +439,7 @@ func newConfig(options ...configOption) (*Config, error) {
 		"comment":                  c.commentTemplateFunc,
 		"decrypt":                  c.decryptTemplateFunc,
 		"encrypt":                  c.encryptTemplateFunc,
+		"fromIni":                  c.fromIniTemplateFunc,
 		"fromToml":                 c.fromTomlTemplateFunc,
 		"fromYaml":                 c.fromYamlTemplateFunc,
 		"gitHubKeys":               c.gitHubKeysTemplateFunc,

diff --git a/pkg/cmd/templatefuncs.go b/pkg/cmd/templatefuncs.go
@@ -13,6 +13,7 @@ import (
 
 	"github.com/bmatcuk/doublestar/v4"
 	"github.com/bradenhilton/mozillainstallhash"
+	"gopkg.in/ini.v1"
 	"howett.net/plist"
 
 	"github.com/twpayne/chezmoi/v2/pkg/chezmoi"
@@ -29,6 +30,14 @@ func (c *Config) commentTemplateFunc(prefix, s string) string {
 	return startOfLineRx.ReplaceAllString(s, prefix)
 }
 
+func (c *Config) fromIniTemplateFunc(s string) map[string]any {
+	file, err := ini.Load([]byte(s))
+	if err != nil {
+		panic(err)
+	}
+	return iniFileToMap(file)
+}
+
 func (c *Config) fromTomlTemplateFunc(s string) any {
 	var data any
 	if err := chezmoi.FormatTOML.Unmarshal([]byte(s), &data); err != nil {
@@ -211,3 +220,22 @@ func (c *Config) toYamlTemplateFunc(data any) string {
 	}
 	return string(yaml)
 }
+
+func iniFileToMap(file *ini.File) map[string]any {
+	m := make(map[string]any)
+	for _, section := range file.Sections() {
+		m[section.Name()] = iniSectionToMap(section)
+	}
+	return m
+}
+
+func iniSectionToMap(section *ini.Section) map[string]any {
+	m := make(map[string]any)
+	for _, s := range section.ChildSections() {
+		m[s.Name()] = iniSectionToMap(s)
+	}
+	for _, k := range section.Keys() {
+		m[k.Name()] = k.Value()
+	}
+	return m
+}
diff --git a/pkg/cmd/templatefuncs_test.go b/pkg/cmd/templatefuncs_test.go
@@ -2,12 +2,51 @@ package cmd
 
 import (
 	"errors"
+	"strconv"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"gopkg.in/ini.v1"
+
+	"github.com/twpayne/chezmoi/v2/pkg/chezmoitest"
 )
 
+func TestFromIniTemplateFunc(t *testing.T) {
+	for i, tc := range []struct {
+		text     string
+		expected map[string]any
+	}{
+		{
+			text: chezmoitest.JoinLines(
+				`key = value`,
+			),
+			expected: map[string]any{
+				ini.DefaultSection: map[string]any{
+					"key": "value",
+				},
+			},
+		},
+		{
+			text: chezmoitest.JoinLines(
+				`[section]`,
+				`sectionKey = sectionValue`,
+			),
+			expected: map[string]any{
+				ini.DefaultSection: map[string]any{},
+				"section": map[string]any{
+					"sectionKey": "sectionValue",
+				},
+			},
+		},
+	} {
+		t.Run(strconv.Itoa(i), func(t *testing.T) {
+			c := &Config{}
+			assert.Equal(t, tc.expected, c.fromIniTemplateFunc(tc.text))
+		})
+	}
+}
+
 func TestQuoteListTemplateFunc(t *testing.T) {
 	c, err := newConfig()
 	require.NoError(t, err)