Merge pull request #45 from 200sc/release/v0.6.0

Release/v0.6.0

.github/workflows/go.yml

@@ -16,7 +16,7 @@ jobs:
     - name: Set up Go
       uses: actions/setup-go@v2
       with:
-        go-version: "1.20"
+        go-version: "1.21"
 
     - name: Build
       run: go build -v ./...

CONTRIBUTING.md

@@ -4,3 +4,11 @@ Please raise issues for discussion before opening PRs (or ideally before startin
 just to save time if its not the direction we want to take the project.
 
 For small changes (anywhere from typos to non-breaking bug fixes) going straight to a PR is fine, but not required.
+
+## Testing
+
+This library is organized so `go test -v` will test tokenization, parsing, code generation, and the validity of the output generated code. Output code is validated via some integrated tests, and by relying on `go test` itself checking that output can be compiled.
+
+If an example file fails tokenization, it can be added to `testTokenizeFiles` to track that failure and prevent regressions. Likewise for parsing, `TestReadFile` notes expected parsing output. Adding a variant that just ensures a file -can- be parsed, not ensuring a particular AST, is a welcome augmentation.
+
+For generated code, add the example file to `generated/base` and add it's name, minus `.bop`, to `genTestFiles`.

bebop.go

@@ -2,7 +2,7 @@
 package bebop
 
 // Version is the library version. Should be used by CLI tools when passed a '--version' flag.
-const Version = "v0.5.0"
+const Version = "v0.6.0"
 
 // A File is a structured representation of a .bop file.
 type File struct {

gen_templates.go

@@ -64,9 +64,9 @@ const (
 	hintSafeKey = "&safe"
 
 	fmtErrReturn            = "if err != nil {\n\treturn err\n}"
-	fmtAddSizeToAt          = "tmp := (%ASGN)\nat += tmp.Size()"
+	fmtAddSizeToAt          = "{\n\ttmp := (%ASGN)\n\tat += tmp.Size()\n}\n"
 	fmtAdd4PlusLenToAt      = "at += 4 + len(%ASGN)"
-	fmtAddSizeToBodyLen     = "tmp := (%ASGN)\nbodyLen += tmp.Size()"
+	fmtAddSizeToBodyLen     = "{\n\ttmp := (%ASGN)\n\tbodyLen += tmp.Size()\n}\n"
 	fmtAdd4PlusLenToBodyLen = "bodyLen += 4 + len(%ASGN)"
 
 	fmtMakeType           = "(%RECV), err = Make%TYPE(r)\n" + fmtErrReturn

gen_test.go

@@ -404,6 +404,7 @@ var genTestFiles = []string{
 	"documentation",
 	"enums",
 	"foo",
+	"fruit",
 	"jazz",
 	"lab",
 	"map_types",

go.mod

@@ -1,3 +1,3 @@
 module github.com/200sc/bebop
 
-go 1.20
+go 1.21

testdata/base/fruit.bop

@@ -0,0 +1,10 @@
+struct Fruit {
+        uint64 ID;
+        string Name;
+}
+
+struct Basket {
+        Fruit Apples;
+        Fruit Oranges;
+        Fruit Mangos;
+}