templates: unify data interface

Require that all aerc template data objects implement the same
TemplateData interface.

Implement that interface in two different places:

1) state.TemplateData (renamed/moved from templates.TemplateData).
   This structure (along with all its methods) needs to be decoupled
   from the templates package to break the import cycle with the config
   package. This allows much simpler construction of this object and
   ensure that values are calculated only when requested.

2) config.dummyData (extracted from templates).
   This is only used in the config package to validate user templates.
   Putting it here allows also to break an import cycle.

Use state.TemplateData everywhere (including for account tabs title
rendering).

Signed-off-by: Robin Jarry <robin@jarry.cc>
Reviewed-by: Moritz Poldrack <moritz@poldrack.dev>

1 files changed, 16 insertions, 15 deletions

diff --git a/config/ui_test.go b/config/ui_test.go
index c5eb6031..677dcc86 100644
--- a/config/ui_test.go
+++ b/config/ui_test.go
@@ -1,13 +1,20 @@
 package config
 
 import (
-	"bytes"
+	"reflect"
 	"testing"
+	"text/template"
 
-	"git.sr.ht/~rjarry/aerc/lib/templates"
 	"github.com/stretchr/testify/assert"
 )
 
+func templateText(t *template.Template) string {
+	// unfortunately, the original template text is stored as a private
+	// field, for test purposes, access its value via reflection
+	v := reflect.ValueOf(t).Elem()
+	return v.FieldByName("text").String()
+}
+
 func TestConvertIndexFormat(t *testing.T) {
 	columns, err := convertIndexFormat("%-20.20D %-17.17n %Z %s")
 	if err != nil {
@@ -15,32 +22,26 @@ func TestConvertIndexFormat(t *testing.T) {
 	}
 	assert.Len(t, columns, 4)
 
-	data := templates.DummyData()
-	var buf bytes.Buffer
-
 	assert.Equal(t, "date", columns[0].Name)
 	assert.Equal(t, 20.0, columns[0].Width)
 	assert.Equal(t, ALIGN_LEFT|WIDTH_EXACT, columns[0].Flags)
-	assert.Nil(t, columns[0].Template.Execute(&buf, data))
+	assert.Equal(t, `{{.DateAutoFormat .Date.Local}}`,
+		templateText(columns[0].Template))
 
-	buf.Reset()
 	assert.Equal(t, "name", columns[1].Name)
 	assert.Equal(t, 17.0, columns[1].Width)
 	assert.Equal(t, ALIGN_LEFT|WIDTH_EXACT, columns[1].Flags)
-	assert.Nil(t, columns[1].Template.Execute(&buf, data))
-	assert.Equal(t, "John Doe", buf.String())
+	assert.Equal(t, `{{index (.From | names) 0}}`,
+		templateText(columns[1].Template))
 
-	buf.Reset()
 	assert.Equal(t, "flags", columns[2].Name)
 	assert.Equal(t, 4.0, columns[2].Width)
 	assert.Equal(t, ALIGN_RIGHT|WIDTH_EXACT, columns[2].Flags)
-	assert.Nil(t, columns[2].Template.Execute(&buf, data))
-	assert.Equal(t, "O!*", buf.String())
+	assert.Equal(t, `{{.Flags | join ""}}`,
+		templateText(columns[2].Template))
 
-	buf.Reset()
 	assert.Equal(t, "subject", columns[3].Name)
 	assert.Equal(t, 0.0, columns[3].Width)
 	assert.Equal(t, ALIGN_LEFT|WIDTH_AUTO, columns[3].Flags)
-	assert.Nil(t, columns[3].Template.Execute(&buf, data))
-	assert.Equal(t, "[PATCH aerc 2/3] foo: baz bar buz", buf.String())
+	assert.Equal(t, `{{.Subject}}`, templateText(columns[3].Template))
 }