Delete low-value helper components (#115)

I'd rather reserve the package for components that have proven repeatedly useful, like `Classes` and `HTML5`.
maragudk · Nov 3, 2022 · b12942f · b12942f
1 parent 3bb4e3e
commit b12942f
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 124 deletions.
diff --git a/components/attributes.go b/components/attributes.go
diff --git a/components/attributes_test.go b/components/attributes_test.go
diff --git a/components/documents.go → components/components.go b/components/documents.go → components/components.go
@@ -2,6 +2,10 @@
 package components
 
 import (
+	"io"
+	"sort"
+	"strings"
+
 	g "github.com/maragudk/gomponents"
 	. "github.com/maragudk/gomponents/html"
 )
@@ -31,3 +35,30 @@ func HTML5(p HTML5Props) g.Node {
 		),
 	)
 }
+
+// Classes is a map of strings to booleans, which Renders to an attribute with name "class".
+// The attribute value is a sorted, space-separated string of all the map keys,
+// for which the corresponding map value is true.
+type Classes map[string]bool
+
+func (c Classes) Render(w io.Writer) error {
+	var included []string
+	for c, include := range c {
+		if include {
+			included = append(included, c)
+		}
+	}
+	sort.Strings(included)
+	return Class(strings.Join(included, " ")).Render(w)
+}
+
+func (c Classes) Type() g.NodeType {
+	return g.AttributeType
+}
+
+// String satisfies fmt.Stringer.
+func (c Classes) String() string {
+	var b strings.Builder
+	_ = c.Render(&b)
+	return b.String()
+}
diff --git a/components/documents_test.go → components/components_test.go b/components/documents_test.go → components/components_test.go
@@ -1,6 +1,7 @@
 package components_test
 
 import (
+	"os"
 	"testing"
 
 	g "github.com/maragudk/gomponents"
@@ -30,3 +31,32 @@ func TestHTML5(t *testing.T) {
 		assert.Equal(t, `<!doctype html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><title>Hat</title></head><body></body></html>`, e)
 	})
 }
+
+func TestClasses(t *testing.T) {
+	t.Run("given a map, returns sorted keys from the map with value true", func(t *testing.T) {
+		assert.Equal(t, ` class="boheme-hat hat partyhat"`, Classes{
+			"boheme-hat": true,
+			"hat":        true,
+			"partyhat":   true,
+			"turtlehat":  false,
+		})
+	})
+
+	t.Run("renders as attribute in an element", func(t *testing.T) {
+		e := g.El("div", Classes{"hat": true})
+		assert.Equal(t, `<div class="hat"></div>`, e)
+	})
+
+	t.Run("also works with fmt", func(t *testing.T) {
+		a := Classes{"hat": true}
+		if a.String() != ` class="hat"` {
+			t.FailNow()
+		}
+	})
+}
+
+func ExampleClasses() {
+	e := g.El("div", Classes{"party-hat": true, "boring-hat": false})
+	_ = e.Render(os.Stdout)
+	// Output: <div class="party-hat"></div>
+}
diff --git a/components/elements.go b/components/elements.go
diff --git a/components/elements_test.go b/components/elements_test.go