initial commits

versions.go

@@ -0,0 +1,5 @@
+package frameproto
+
+const (
+	VersionVNext = "vNext"
+)

writeframe.go

@@ -0,0 +1,28 @@
+package frameproto
+
+import (
+	"io"
+)
+
+// WriteFrame will write the HTML <meta/> element for the Frame-Protocol's (i.e., Farcaster Frame's) "fc:frame" name-value pair.
+//
+// For example, this call:
+//
+//	var version string = "vNext"
+//	
+//	frameproto.WriteFrame(writer, version)
+//
+// Would write this HTML <meta/> element:
+//
+//	<meta property="fc:frame" content="vNext" />
+//
+// Note that this package provides some constants to use with WriteFrame.
+// Namely: VersionVNext (for "vNext").
+//
+// Which in code would be used as:
+//
+//	frameproto.WriteFrame(writer, frameproto.VersionVNext)
+func WriteFrame(writer io.Writer, version string) {
+	const property string = MetaPropertyFrame
+	writeMetaPropertyContent(writer, property, version)
+}

writeframe_test.go

@@ -0,0 +1,68 @@
+package frameproto
+
+import (
+	"testing"
+
+	"strings"
+)
+
+func TestWriteFrame(t *testing.T) {
+
+	tests := []struct{
+		Version string
+		Expected string
+	}{
+		{
+			Version:                                     "",
+			Expected: `<meta property="fc:frame" content="" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                      "something",
+			Expected: `<meta property="fc:frame" content="something" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                     "Hello world! 🙂",
+			Expected: `<meta property="fc:frame" content="Hello world! 🙂" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                     "vNext",
+			Expected: `<meta property="fc:frame" content="vNext" />`+"\n",
+		},
+
+
+
+		{
+			Version:                                     "2020-01-01",
+			Expected: `<meta property="fc:frame" content="2020-01-01" />`+"\n",
+		},
+	}
+
+	for testNumber, test := range tests {
+
+		var buffer strings.Builder
+
+		WriteFrame(&buffer, test.Version)
+
+		expected := test.Expected
+		actual   := buffer.String()
+
+		if expected != actual {
+			t.Errorf("For test #%d, the actual written meta-tag is not what was expected.", testNumber)
+			t.Logf("EXPECTED: %s", expected)
+			t.Logf("ACTUAL:   %s", actual)
+			t.Logf("EXPECTED: %q", expected)
+			t.Logf("ACTUAL:   %q", actual)
+			t.Logf("LABEL: %q", test.Version)
+			continue
+		}
+	}
+}