Merge pull request #9 from spatialcurrent/packages

Refactor into multiple packages

Author: pjdufour

.circleci/config.yml

@@ -2,64 +2,54 @@ version: 2.1
 executors:
   base:
     docker:
-      - image: circleci/golang:1.12
+      - image: circleci/golang:1.12-node
     working_directory: /go/src/github.com/spatialcurrent/go-simple-serializer
 jobs:
   pre_deps_golang:
     executor: base
     steps:
       - checkout
-      - run: make deps
+      - run: make deps_go
       - run: sudo chown -R circleci /go/src
       - save_cache:
           key: v1-go-src-{{ .Branch }}-{{ .Revision }}
           paths:
             - /go/src
-  test:
+  test_go:
     executor: base
     steps:
       - run: sudo chown -R circleci /go/src
       - restore_cache:
           keys:
             - v1-go-src-{{ .Branch }}-{{ .Revision }}
-      - run:
-          name: Get shadow
-          command: go get golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow
-      - run:
-          name: Install shadow
-          command: go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow
-      - run:
-          name: Download and install errcheck
-          command: go get -u github.com/kisielk/errcheck
-      - run:
-          name: Download and install misspell
-          command: go get -u github.com/client9/misspell/cmd/misspell
-      - run:
-          name: Download and install ineffassign
-          command: go get -u github.com/gordonklaus/ineffassign
-      - run:
-          name: Download and install staticheck
-          command: go get -u honnef.co/go/tools/cmd/staticcheck
-      - run: make test
-  validate:
+      - run: make deps_go_test
+      - run: make test_go
+      - run: make imports
+      - run: git diff --exit-code
+  test_javascript:
     executor: base
     steps:
       - run: sudo chown -R circleci /go/src
       - restore_cache:
           keys:
             - v1-go-src-{{ .Branch }}-{{ .Revision }}
-      - run:
-          name: Install Dig
-          command: sudo apt update && sudo apt install dnsutils
-      - run:
-          name: "Update ~/.ssh/known_hosts"
-          command: |
-            mkdir ~/.ssh/
-            touch ~/.ssh/known_hosts
-            for ip in $(dig @8.8.8.8 github.com +short); do ssh-keyscan github.com,$ip; ssh-keyscan $ip; done 2>/dev/null >> ~/.ssh/known_hosts
-      - run: go get github.com/spatialcurrent/go-header/...
-      - run: go install github.com/spatialcurrent/go-header/cmd/goheader
-      - run: goheader fix --fix-year 2019 --exit-code-on-changes 1 --verbose
+      - run: make deps_gopherjs
+      - run: make deps_javascript
+      - run: npm run test:clean
+  examples:
+    executor: base
+    steps:
+      - run: sudo chown -R circleci /go/src
+      - restore_cache:
+          keys:
+            - v1-go-src-{{ .Branch }}-{{ .Revision }}
+      - run: make deps_gopherjs
+      - run: make deps_javascript
+      - run: npm run test:clean
+      - run: make run_example_c
+      - run: make run_example_cpp
+      - run: make run_example_javascript
+      - run: make run_example_python
   build_cli:
     executor: base
     steps:
@@ -79,12 +69,10 @@ jobs:
       - restore_cache:
           keys:
             - v1-go-src-{{ .Branch }}-{{ .Revision }}
-      - run:
-          name: Install GopherJS
-          command: go get -u github.com/gopherjs/gopherjs
+      - run: make deps_gopherjs
       - run: make build_javascript
       - store_artifacts:
-          path: bin
+          path: dist
           destination: /
   build_so:
     executor: base
@@ -93,6 +81,7 @@ jobs:
       - restore_cache:
           keys:
             - v1-go-src-{{ .Branch }}-{{ .Revision }}
+      - run: sudo make deps_arm
       - run: make build_so
       - store_artifacts:
           path: bin
@@ -101,10 +90,13 @@ workflows:
   main:
     jobs:
       - pre_deps_golang
-      - test:
+      - test_go:
+          requires:
+            - pre_deps_golang
+      - test_javascript:
           requires:
             - pre_deps_golang
-      - validate:
+      - examples:
           requires:
             - pre_deps_golang
       - build_cli:

.eslintignore

@@ -0,0 +1,10 @@
+__mocks__/
+dist/
+bin/
+node_modules/
+webpack/
+.DS_Store
+.npm
+node_modules
+npm-debug.*
+package-lock.json

.eslintrc

@@ -0,0 +1,35 @@
+{
+  "parser": "babel-eslint",
+  "extends": "eslint-config-airbnb",
+  "rules": {
+    "arrow-parens": ["error", "as-needed"],
+    "class-methods-use-this": "off",
+    "comma-dangle": ["error", { "objects": "always-multiline" }],
+    "import/no-named-as-default": "off",
+    "import/no-unresolved": "off",
+    "no-use-before-define": "off",
+    "object-curly-newline": "off",
+    "prefer-destructuring": "off",
+    "react/destructuring-assignment": "off",
+    "react/forbid-prop-types": "off",
+    "react/jsx-filename-extension": "off",
+    "react/jsx-no-bind": "off",
+    "react/no-access-state-in-setstate": "off",
+    "react/prefer-stateless-function": "off",
+    "react/require-default-props": "off",
+    "react/sort-comp": ["error", {                // Team Preference
+      "order": [
+        "static-methods",
+        "/constructor/",
+        "/state/",
+        "instance-variables",
+        "lifecycle",
+        "getters",
+        "everything-else",
+        "render"
+      ]
+    }],
+    "sort-keys": "error",
+    "space-before-function-paren": ["error", "always"]
+  }
+}

.gitignore

@@ -1,5 +1,11 @@
 bin
+dist
 vendor
 Gopkg.lock
 *.so
 *.h
+.DS_Store
+.npm
+node_modules
+npm-debug.*
+package-lock.json

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Spatial Current, Inc.
+Copyright (c) 2019 Spatial Current, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -17,58 +17,168 @@ ifndef DEST
 DEST=bin
 endif
 
-deps:
+.PHONY: help
+
+help:  ## Print the help documentation
+	@grep -E '^[a-zA-Z_-\]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+#
+# Dependencies
+#
+
+deps_go:  ## Install Go dependencies
 	go get -d -t ./...
 
-fmt:
+.PHONY: deps_go_test
+deps_go_test: ## Download Go dependencies for tests
+	go get golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow # download shadow
+	go install golang.org/x/tools/go/analysis/passes/shadow/cmd/shadow # install shadow
+	go get -u github.com/kisielk/errcheck # download and install errcheck
+	go get -u github.com/client9/misspell/cmd/misspell # download and install misspell
+	go get -u github.com/gordonklaus/ineffassign # download and install ineffassign
+	go get -u honnef.co/go/tools/cmd/staticcheck # download and instal staticcheck
+	go get -u golang.org/x/tools/cmd/goimports # download and install goimports
+
+deps_arm:  ## Install dependencies to cross-compile to ARM
+	# ARMv7
+	apt-get install -y libc6-armel-cross libc6-dev-armel-cross binutils-arm-linux-gnueabi libncurses5-dev gcc-arm-linux-gnueabi g++-arm-linux-gnueabi
+  # ARMv8
+	apt-get install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
+
+deps_gopherjs:  ## Install GopherJS
+	go get -u github.com/gopherjs/gopherjs
+
+deps_javascript:  ## Install dependencies for JavaScript tests
+	npm install .
+
+#
+# Go building, formatting, testing, and installing
+#
+
+fmt:  ## Format Go source code
 	go fmt $$(go list ./... )
 
-vet:
+imports: ## Update imports in Go source code
+	# If missing, install goimports with: go get golang.org/x/tools/cmd/goimports
+	goimports -w $$(find . -iname '*.go')
+
+vet: ## Vet Go source code
 	go vet $$(go list ./...)
 
-test:
+test_go: ## Run Go tests
 	bash scripts/test.sh
 
-bin/gss_darwin_amd64:
+build: build_cli build_javascript build_so build_android  ## Build CLI, Shared Objects (.so), JavaScript, and Android
+
+install:  ## Install GSS CLI on current platform
+	go install -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
+
+#
+# Command line Programs
+#
+
+bin/gss_darwin_amd64: ## Build GSS CLI for Darwin / amd64
 	GOOS=darwin GOARCH=amd64 go build -o $(DEST)/gss_darwin_amd64 -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
 
-bin/gss_linux_amd64:
+bin/gss_linux_amd64: ## Build GSS CLI for Linux / amd64
 	GOOS=linux GOARCH=amd64 go build -o $(DEST)/gss_linux_amd64 -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
 
-bin/gss_windows_amd64.exe:
+bin/gss_windows_amd64.exe:  ## Build GSS CLI for Windows / amd64
 	GOOS=windows GOARCH=amd64 go build -o $(DEST)/gss_windows_amd64.exe -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
 
-bin/gss_linux_arm64:
+bin/gss_linux_arm64: ## Build GSS CLI for Linux / arm64
 	GOOS=linux GOARCH=arm64 go build -o $(DEST)/gss_linux_arm64 -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
 
-# Build Shared Object
-bin/gss.so:
-	go build -o $(DEST)/gss.so -buildmode=c-shared -ldflags "$(LDFLAGS)" -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/plugins/gss
+build_cli: bin/gss_darwin_amd64 bin/gss_linux_amd64 bin/gss_windows_amd64.exe bin/gss_linux_arm64  ## Build command line programs
+
+#
+# Shared Objects
+#
+
+bin/gss.so:  ## Compile Shared Object for current platform
+	# https://golang.org/cmd/link/
+	# CGO Enabled : https://github.com/golang/go/issues/24068
+	CGO_ENABLED=1 go build -o $(DEST)/gss.so -buildmode=c-shared -ldflags "$(LDFLAGS)" -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/plugins/gss
+
+bin/gss_linux_amd64.so:  ## Compile Shared Object for Linux / amd64
+	# https://golang.org/cmd/link/
+	# CGO Enabled : https://github.com/golang/go/issues/24068
+	GOOS=linux GOARCH=amd64 CGO_ENABLED=1 go build -o $(DEST)/gss_linux_amd64.so -buildmode=c-shared -ldflags "$(LDFLAGS)" -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/plugins/gss
+
+bin/gss_linux_armv7.so:  ## Compile Shared Object for Linux / ARMv7
+	# LDFLAGS - https://golang.org/cmd/link/
+	# CGO Enabled  - https://github.com/golang/go/issues/24068
+	# GOARM/GOARCH Compatability Table - https://github.com/golang/go/wiki/GoArm
+	# ARM Cross Compiler Required - https://www.acmesystems.it/arm9_toolchain
+	GOOS=linux GOARCH=arm GOARM=7 CGO_ENABLED=1 CC=arm-linux-gnueabi-gcc go build -ldflags "-linkmode external -extldflags -static" -o $(DEST)/gss_linux_armv7.so -buildmode=c-shared -ldflags "$(LDFLAGS)" -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/plugins/gss
+
+bin/gss_linux_armv8.so:   ## Compile Shared Object for Linux / ARMv8
+	# LDFLAGS - https://golang.org/cmd/link/
+	# CGO Enabled  - https://github.com/golang/go/issues/24068
+	# GOARM/GOARCH Compatability Table - https://github.com/golang/go/wiki/GoArm
+	# ARM Cross Compiler Required - https://www.acmesystems.it/arm9_toolchain
+	# Dependencies - https://www.96boards.org/blog/cross-compile-files-x86-linux-to-96boards/
+	GOOS=linux GOARCH=arm64 CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc go build -ldflags "-linkmode external -extldflags -static" -o $(DEST)/gss_linux_armv8.so -buildmode=c-shared -ldflags "$(LDFLAGS)" -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/plugins/gss
+
+build_so: bin/gss_linux_amd64.so bin/gss_linux_armv7.so bin/gss_linux_armv8.so  ## Build Shared Objects (.so)
+
+#
+# Android
+#
 
-# Build JavaScript Library
-bin/gss.js:
-	gopherjs build -o $(DEST)/gss.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.js
+bin/gss.aar:  ## Build Android Archive Library
+	gomobile bind -target android -javapkg=com.spatialcurrent -o $(DEST)/gss.aar -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/pkg/gss
 
-# Build Minified JavaScript Library
-bin/gss.min.js:
-	gopherjs build -m -o $(DEST)/gss.min.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.js
+build_android: bin/gss.arr  ## Build artifacts for Android
 
-# Build Android Archive Library
-bin/gss.aar:
-	gomobile bind -target android -javapkg=com.spatialcurrent -o $(DEST)/gss.aar -gcflags="$(GCFLAGS)" github.com/spatialcurrent/go-simple-serializer/gss
+#
+# JavaScript
+#
 
-build_cli: bin/gss_darwin_amd64 bin/gss_linux_amd64 bin/gss_windows_amd64.exe bin/gss_linux_arm64
+dist/gss.mod.js:  ## Build JavaScript module
+	gopherjs build -o dist/gss.mod.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.mod.js
 
-build_javascript: bin/gss.js bin/gss.min.js
+dist/gss.mod.min.js:  ## Build minified JavaScript module
+	gopherjs build -m -o dist/gss.mod.min.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.mod.js
 
-build_android: bin/gss.arr
+dist/gss.global.js:  ## Build JavaScript library that attaches to global or window.
+	GSS_JS_EXPORT_GLOBAL=1 gopherjs build -o dist/gss.global.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.global.js
 
-build_so: bin/gss.so
+dist/gss.global.min.js:  ## Build minified JavaScript library that attaches to global or window.
+	GSS_JS_EXPORT_GLOBAL=1 gopherjs build -m -o dist/gss.global.min.js github.com/spatialcurrent/go-simple-serializer/cmd/gss.global.js
 
-build: build_cli build_javascript build_so build_android
+build_javascript: dist/gss.mod.js dist/gss.mod.min.js dist/gss.global.js dist/gss.global.min.js  ## Build artifacts for JavaScript
 
-install:
-	go install -gcflags="$(GCFLAGS)" -ldflags="$(LDFLAGS)" github.com/spatialcurrent/go-simple-serializer/cmd/gss
+test_javascript:  ## Run JavaScript tests
+	npm run test
+
+lint:  ## Lint JavaScript source code
+	npm run lint
+
+#
+# Examples
+#
+
+bin/gss_example_c: bin/gss.so  ## Build C example
+	mkdir -p bin && cd bin && gcc -o gss_example_c -I. ./../examples/c/main.c -L. -l:gss.so
+
+bin/gss_example_cpp: bin/gss.so  ## Build C++ example
+	mkdir -p bin && cd bin && g++ -o gss_example_cpp -I . ./../examples/cpp/main.cpp -L. -l:gss.so
+
+run_example_c: bin/gss.so bin/gss_example_c  ## Run C example
+	cd bin && LD_LIBRARY_PATH=. ./gss_example_c
+
+run_example_cpp: bin/gss.so bin/gss_example_cpp  ## Run C++ example
+	cd bin && LD_LIBRARY_PATH=. ./gss_example_cpp
+
+run_example_python: bin/gss.so  ## Run Python example
+	LD_LIBRARY_PATH=bin python examples/python/test.py
+
+run_example_javascript: dist/gss.mod.js  ## Run JavaScript module example
+	node examples/js/index.mod.js
+
+## Clean
 
-clean:
+clean:  ## Clean artifacts
 	rm -fr bin
+	rm -fr dist