Merge branch 'dev' into 'master'

v1.1.0

See merge request objectbox/objectbox-go!67

Author: vaind

.gitlab-ci.yml

@@ -1,22 +1,47 @@
-test:linux:x64:
+.test:linux:x64:
   stage: test
-  image: golang
   tags: [x64, linux, docker]
+  before_script:
+    - 'cd /usr/local/lib && { curl --fail -o libobjectbox.so -H "PRIVATE-TOKEN: $CI_API_TOKEN" "${OBXLIB_URL_Linux64}" ; ldconfig ; cd - ; }'
   script:
-    - 'cd /usr/local/lib && { curl -o libobjectbox.so -H "PRIVATE-TOKEN: $CI_API_TOKEN" "${OBXLIB_URL_Linux64}" ; ldconfig ; cd - ; }'
     - ./build/build.sh
 
+# minimal supported Go version is 1.11.4
+test:linux:x64:go1.11.4:
+  extends: .test:linux:x64
+  image: golang:1.11.4
+  script:
+    - ./build/build.sh -test.short
+
+test:linux:x64:go1.12:
+  extends: .test:linux:x64
+  image: golang:1.12
+  script:
+    - ./build/build.sh -test.short
+
+test:linux:x64:go1.13:
+  extends: .test:linux:x64
+  image: golang:1.13
+
 test:linux:ARMv7hf:
   stage: test
-  image: arm32v7/golang
+  image: golang
   tags: [armv7hf, linux, docker]
   script:
-    - 'cd /usr/local/lib && { curl -o libobjectbox.so -H "PRIVATE-TOKEN: $CI_API_TOKEN" "${OBXLIB_URL_LinuxARMv7hf}" ; ldconfig ; cd - ; }'
-    - ./build/build.sh
+    - 'cd /usr/local/lib && { curl --fail -o libobjectbox.so -H "PRIVATE-TOKEN: $CI_API_TOKEN" "${OBXLIB_URL_LinuxARMv7hf}" ; ldconfig ; cd - ; }'
+    - ./build/build.sh -test.short
 
 test:mac:x64:
   stage: test
   tags: [x64, mac, go]
   script:
-    - 'curl -o /usr/local/lib/libobjectbox.dylib -H "PRIVATE-TOKEN: $CI_API_TOKEN" "$OBXLIB_URL_Mac64"'
+    - 'curl --fail -o /usr/local/lib/libobjectbox.dylib -H "PRIVATE-TOKEN: $CI_API_TOKEN" "$OBXLIB_URL_Mac64"'
+    - ./build/build.sh
+
+test:win:x64:
+  stage: test
+  tags: [x64, windows, go]
+  script:
+    - libDir=$(realpath $(dirname $(which gcc))/../lib)
+    - 'curl --fail -o $libDir/objectbox.dll -H "PRIVATE-TOKEN: $CI_API_TOKEN" "$OBXLIB_URL_Win64"'
     - ./build/build.sh

README.md

@@ -18,7 +18,7 @@ id, err := box.Put(&Person{ FirstName: "Joe", LastName:  "Green" })
 Want details? **[Read the docs](https://golang.objectbox.io/)** or
 **[check out the API reference](https://godoc.org/github.com/objectbox/objectbox-go/objectbox)**.
 
-Latest release: [v1.0.0 (2019-07-16)](https://golang.objectbox.io/)
+Latest release: [v1.1.0 (2019-12-16)](https://golang.objectbox.io/)
 
 Some features
 -------------

build/build.sh

@@ -1,20 +1,21 @@
 #!/usr/bin/env bash
 set -eu
-
+args="$@"
 buildDir=${PWD}/build-artifacts
 
 function preBuild {
     echo "******** Preparing build ********"
     echo "Creating build artifacts directory '$buildDir'"
-    mkdir -p $buildDir
+    mkdir -p "$buildDir"
 }
 
 function build {
     echo "******** Building ********"
-    for CMD in `ls cmd`; do
-        echo "building cmd/${CMD}"
-        cd cmd/${CMD}
-        go build -o ${buildDir}/${CMD}
+    for path in cmd/*; do
+        echo "building ${path}"
+        cd "${path}"
+        cmd=$(basename "${path}")
+        go build -o "${buildDir}/${cmd}"
         cd -
     done
 }
@@ -23,17 +24,17 @@ function postBuild {
     echo "******** Collecting artifacts ********"
 
     echo "The $buildDir contains the following files: "
-    ls -l $buildDir
+    ls -l "$buildDir"
 }
 
 function test {
     echo "******** Testing ********"
 
     # on amd64, we run extended tests (memory sanitizer & race checks)
     if [[ $(go env GOARCH) == "amd64" ]]; then
-        ./build/test.sh -race
+        ./build/test.sh $args -race
     else
-        ./build/test.sh
+        ./build/test.sh $args
     fi
 }
 
@@ -42,6 +43,8 @@ function generate {
     go generate ./...
 }
 
+go version
+
 preBuild
 build
 generate

build/test.sh

@@ -10,8 +10,9 @@ fi
 
 unformatted_files=$(gofmt -l .)
 if [[ ${unformatted_files} ]]; then
-    echo "Some files are not formatted properly. You can use \`gofmt -l -w .\` to fix them."
-    printf "%s\n" ${unformatted_files}
+    echo "Some files are not formatted properly. You can use \`gofmt -l -w .\` to fix them:"
+    printf "%s\n" "${unformatted_files}"
+    exit 1
 fi
 
 go vet ./...

cmd/objectbox-gogen/doc.go

@@ -7,17 +7,29 @@ containing the struct that you want to persist and executing `go generate` in th
 
 Alternatively, you can run the command manually:
 
-	objectbox-gogen [flags]
+	objectbox-gogen [flags] [path-pattern]
+		to generate the binding code
 
+or
 
-The flags are
+	objectbox-gogen clean [path-pattern]
+		to remove the generated files instead of creating them - this removes *.obx.go and objectbox-model.go but keeps objectbox-model.json
 
+path-pattern:
+  * a path or a valid path pattern as accepted by the go tool (e.g. ./...)
+  * if not given, the generator expects GOFILE environment variable to be set
+
+Available flags:
   -byValue
         getters should return a struct value (a copy) instead of a struct pointer
+  -help
+        print this help
   -persist string
         path to the model information persistence file
   -source string
-        path to the source file containing structs to process
+        @deprecated, equivalent to passing the given source file path as as the path-pattern argument
+  -version
+        print the generator version info
 
 
 

cmd/objectbox-gogen/objectbox-gogen.go

@@ -19,17 +19,23 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/objectbox/objectbox-go/internal/generator"
 	"os"
+
+	"github.com/objectbox/objectbox-go/internal/generator"
 )
 
 func main() {
-	sourceFile, options := getArgs()
+	path, clean, options := getArgs()
 
-	fmt.Printf("Generating ObjectBox bindings for %s", sourceFile)
-	fmt.Println()
+	var err error
+	if clean {
+		fmt.Printf("Removing ObjectBox bindings for %s\n", path)
+		err = generator.Clean(path)
+	} else {
+		fmt.Printf("Generating ObjectBox bindings for %s\n", path)
+		err = generator.Process(path, options)
+	}
 
-	err := generator.Process(sourceFile, options)
 	stopOnError(err)
 }
 
@@ -40,32 +46,90 @@ func stopOnError(err error) {
 	}
 }
 
+func showUsage() {
+	fmt.Fprint(flag.CommandLine.Output(), `Usage:
+	objectbox-gogen [flags] [path-pattern]
+		to generate the binding code
+
+or
+
+	objectbox-gogen clean [path-pattern]
+		to remove the generated files instead of creating them - this removes *.obx.go and objectbox-model.go but keeps objectbox-model.json
+
+path-pattern:
+  * a path or a valid path pattern as accepted by the go tool (e.g. ./...)
+  * if not given, the generator expects GOFILE environment variable to be set
+
+Available flags:
+`)
+	flag.PrintDefaults()
+}
+
 func showUsageAndExit() {
-	flag.Usage()
+	showUsage()
 	os.Exit(1)
 }
 
-func getArgs() (file string, options generator.Options) {
+func getArgs() (path string, clean bool, options generator.Options) {
 	var printVersion bool
-	flag.StringVar(&file, "source", "", "path to the source file containing structs to process")
+	var printHelp bool
+	flag.Usage = showUsage
+	flag.StringVar(&path, "source", "", "@deprecated, equivalent to passing the given source file path as as the path-pattern argument")
 	flag.StringVar(&options.ModelInfoFile, "persist", "", "path to the model information persistence file")
 	flag.BoolVar(&options.ByValue, "byValue", false, "getters should return a struct value (a copy) instead of a struct pointer")
 	flag.BoolVar(&printVersion, "version", false, "print the generator version info")
+	flag.BoolVar(&printHelp, "help", false, "print this help")
 	flag.Parse()
 
+	if printHelp {
+		showUsage()
+		os.Exit(0)
+	}
+
 	if printVersion {
 		fmt.Println(fmt.Sprintf("ObjectBox Go binding code generator version: %d", generator.Version))
 		os.Exit(0)
 	}
 
-	if len(file) == 0 {
+	if len(path) != 0 {
+		fmt.Println("'source' flag is deprecated and will be removed in the future - use a standard positional argument instead. See command help for more information.")
+	}
+
+	var argPath string
+
+	if flag.NArg() == 2 {
+		clean = true
+		if flag.Arg(0) != "clean" {
+			fmt.Printf("Unknown argument %s", flag.Arg(0))
+			showUsageAndExit()
+		}
+
+		argPath = flag.Arg(1)
+
+	} else if flag.NArg() == 1 {
+		argPath = flag.Arg(0)
+	} else if flag.NArg() != 0 {
+		showUsageAndExit()
+	}
+
+	// if the path-pattern positional argument was given
+	if len(argPath) > 0 {
+		if len(path) == 0 {
+			path = argPath
+		} else if argPath != path {
+			fmt.Printf("Path argument mismatch - given 'source' flag '%s' and the positional path argument '%s'\n", path, argPath)
+			showUsageAndExit()
+		}
+	}
+
+	if len(path) == 0 {
 		// if the command is run by go:generate some environment variables are set
 		// https://golang.org/pkg/cmd/go/internal/generate/
 		if gofile, exists := os.LookupEnv("GOFILE"); exists {
-			file = gofile
+			path = gofile
 		}
 
-		if len(file) == 0 {
+		if len(path) == 0 {
 			showUsageAndExit()
 		}
 	}

examples/tasks/internal/model/objectbox-model.go

@@ -12,7 +12,7 @@
           "id": "1:2193439623591184445",
           "name": "Id",
           "type": 6,
-          "flags": 8193
+          "flags": 1
         },
         {
           "id": "2:6177929178231325611",

examples/tasks/internal/model/objectbox-model.json

@@ -18,6 +18,7 @@ package model
 
 //go:generate go run github.com/objectbox/objectbox-go/cmd/objectbox-gogen
 
+// Task model
 type Task struct {
 	Id           uint64
 	Text         string