From 141be61623147d45f8898f8f5d8c54a9e543419c Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Wed, 14 Feb 2024 15:39:14 -0800 Subject: [PATCH] initial commits --- appendframe.go | 28 +++++++++++++ appendframe_test.go | 96 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 124 insertions(+) create mode 100644 appendframe.go create mode 100644 appendframe_test.go diff --git a/appendframe.go b/appendframe.go new file mode 100644 index 0000000..bc672f0 --- /dev/null +++ b/appendframe.go @@ -0,0 +1,28 @@ +package frameproto + +// AppendFrame will append the HTML element for the Frame-Protocol's (i.e., Farcaster Frame's) "fc:frame" name-value pair. +// +// For example, this call: +// +// var p []byte +// +// // ... +// +// var version string = "vNext" +// +// p = frameproto.AppendFrame(p, version) +// +// Would append this HTML element: +// +// +// +// Note that this package provides some constants to use with AppendFrame. +// Namely: VersionVNext (for "vNext"). +// +// Which in code would be used as: +// +// p = frameproto.AppendFrame(p, frameproto.VersionVNext) +func AppendFrame(p []byte, version string) []byte { + const property string = MetaPropertyFrame + return appendMetaPropertyContent(p, property, version) +} diff --git a/appendframe_test.go b/appendframe_test.go new file mode 100644 index 0000000..fbe7f26 --- /dev/null +++ b/appendframe_test.go @@ -0,0 +1,96 @@ +package frameproto + +import ( + "testing" +) + +func TestAppendFrame(t *testing.T) { + + tests := []struct{ + Version string + Expected string + }{ + { + Version: "", + Expected: ``+"\n", + }, + + + + { + Version: "something", + Expected: ``+"\n", + }, + + + + { + Version: "Hello world! 🙂", + Expected: ``+"\n", + }, + + + + { + Version: "vNext", + Expected: ``+"\n", + }, + + + + { + Version: "2020-01-01", + Expected: ``+"\n", + }, + } + + for testNumber, test := range tests { + + { + var buffer [256]byte + var p []byte = buffer[0:0] + + p = AppendFrame(p, test.Version) + + expected := test.Expected + actual := string(p) + + 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 + } + } + + { + const top string = "\n\n" + const bottom string = "\n\n\n\n" + + var buffer [256]byte + var p []byte = buffer[0:0] + + p = append(p, top...) + + p = AppendFrame(p, test.Version) + + p = append(p, bottom...) + + expected := top + test.Expected + bottom + actual := string(p) + + 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 + } + } + } +}