New packages and formats (#15)

new packages and formats

Author: pjdufour

.circleci/config.yml

@@ -26,6 +26,16 @@ jobs:
       - run: make test_go
       - run: make imports
       - run: git diff --exit-code
+  test_cli:
+    executor: base
+    steps:
+      - run: sudo chown -R circleci /go/src
+      - restore_cache:
+          keys:
+            - v1-go-src-{{ .Branch }}-{{ .Revision }}
+      - run: make deps_go_test
+      - run: make install
+      - run: make test_cli
   test_javascript:
     executor: base
     steps:
@@ -45,7 +55,7 @@ jobs:
             - v1-go-src-{{ .Branch }}-{{ .Revision }}
       - run: make deps_gopherjs
       - run: make deps_javascript
-      - run: npm run test:clean
+      - run: npm run build:clean
       - run: make run_example_c
       - run: make run_example_cpp
       - run: make run_example_javascript
@@ -93,6 +103,9 @@ workflows:
       - test_go:
           requires:
             - pre_deps_golang
+      - test_cli:
+          requires:
+            - pre_deps_golang
       - test_javascript:
           requires:
             - pre_deps_golang

Makefile

@@ -55,18 +55,26 @@ deps_javascript:  ## Install dependencies for JavaScript tests
 # Go building, formatting, testing, and installing
 #
 
+.PHONY: fmt
 fmt:  ## Format Go source code
 	go fmt $$(go list ./... )
 
+.PHONY: imports
 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')
+	goimports -w -local github.com/spatialcurrent/go-simple-serializer,github.com/spatialcurrent/ $$(find . -iname '*.go')
 
+.PHONY: vet
 vet: ## Vet Go source code
 	go vet $$(go list ./...)
 
+.PHONY: test_go
 test_go: ## Run Go tests
 	bash scripts/test.sh
+	
+.PHONY: test_cli
+test_cli: ## Run CLI tests
+	bash scripts/test-cli.sh
 
 build: build_cli build_javascript build_so build_android  ## Build CLI, Shared Objects (.so), JavaScript, and Android
 

README.md

@@ -4,55 +4,23 @@
 
 # Description
 
-**go-simple-serializer** (aka GSS) is a simple library for serializing/deserializing objects that aims to decrease the burden on developers to support multiple serialization formats in their applications.  GSS supports a variety of operating systems, architectures, and use cases.  A CLI is released for Microsoft Windows, Linux distributions, and [Darwin](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29) platforms.
+**go-simple-serializer** (aka GSS) is a simple library to easily convert data between formats that aims to decrease the burden on developers to support multiple serialization formats in their applications.  GSS supports a variety of operating systems, architectures, and use cases.  A CLI is released for Microsoft Windows, Linux distributions, and [Darwin](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29) platforms.
 
 Using cross compilers, this library can also be called by other languages, including `C`, `C++`, `Python`, and `JavaScript`.  This library is cross compiled into a Shared Object file (`*.so`), which can be called by `C`, `C++`, and `Python` on Linux machines.  This library is also compiled to pure `JavaScript` using [GopherJS](https://github.com/gopherjs/gopherjs), which can be called by [Node.js](https://nodejs.org) and loaded in the browser.  See the examples folder for patterns that you can use.
 
 **Formats**
 
-GSS supports the following formats.
-
-| Format | Description |
-| ---- | ------ |
-| bson | [Binary JSON](https://en.wikipedia.org/wiki/BSON) |
-| csv | [Comma-Separated Values](https://en.wikipedia.org/wiki/Comma-separated_values) |
-| hcl | HashiCorp Configuration Language |
-| hcl2 | HashiCorp Configuration Language (version 2.x) |
-| json | [JSON](http://json.org/) |
-| jsonl | [JSON Lines](http://jsonlines.org/) |
-| properties | [Properties](https://en.wikipedia.org/wiki/.properties) |
-| tags | single-line key=value tags |
-| toml | [TOML](https://github.com/toml-lang/toml) |
-| tsv | Tab-Separated Values |
-| yaml | [YAML](https://yaml.org/) |
-
-`hcl` and `hcl2` implementation is fragile and very much in `alpha`.  The other formats are well-supported.
+GSS supports many common formats, including CSV, JSON, and YAML.  Pull requests to support other formats are welcome!  See the [Formats.md](docs/Formats.md) document for a full list of supported formats.
 
 **Packages**
 
-The main public api for GSS is in the `gss` package.  However, this library does ship with lower-level packages that can be imported directly as well.
-
-| Package | Purpose |
-| ---- | ------ |
-| bson | Binary JSON |
-| escaper | Escape/unescape strings |
-| gss | The main public API |
-| inspector | Reusable functions for inspecting objects |
-| iterator | Wrapper for iterable formats |
-| json | JSON |
-| jsonl | JSON Lines |
-| properties | Properties Files |
-| scanner | Scanning through a stream of bytes |
-| splitter | Creating custom bufio.SplitFunc |
-| sv | Separated-Values formats, i.e., CSV and TSV. |
-| toml | TOML |
-| yaml | YAML |
+The main public api for GSS is in the `gss` package.  However, this library does ship with internal packages under `/pkg/...` that can be imported and used directly.
 
 # Usage
 
 **CLI**
 
-The command line tool, `gss`, can be used to easily covert data between formats.  We currently support the following platforms.
+The command line tool, `gss`, can be used to easily convert data between formats.  We currently support the following platforms.
 
 | GOOS | GOARCH |
 | ---- | ------ |
@@ -61,7 +29,7 @@ The command line tool, `gss`, can be used to easily covert data between formats.
 | windows | amd64 |
 | linux | arm64 |
 
-Pull requests to support other platforms are welcome!  See the [examples](#examples) section below for usage.
+Pull requests to support other platforms are welcome!  See the [CLI.md](docs/CLI.md) document for detailed usage and examples.
 
 **Go**
 
@@ -196,6 +164,14 @@ The default destination for build artifacts is `go-simple-serializer/bin`, but y
 
 # Testing
 
+**CLI**
+
+To run CLI testes use `make test_cli`, which uses [shUnit2](https://github.com/kward/shunit2).  If you recive a `shunit2:FATAL Please declare TMPDIR with path on partition with exec permission.` error, you can modify the `TMPDIR` environment variable in line or with `export TMPDIR=<YOUR TEMP DIRECTORY HERE>`. For example:
+
+```
+TMPDIR="/usr/local/tmp" make test_cli
+```
+
 **Go**
 
 To run Go tests use `make test_go` (or `bash scripts/test.sh`), which runs unit tests, `go vet`, `go vet with shadow`, [errcheck](https://github.com/kisielk/errcheck), [ineffassign](https://github.com/gordonklaus/ineffassign), [staticcheck](https://staticcheck.io/), and [misspell](https://github.com/client9/misspell).

cmd/gss.global.js/main.go

@@ -40,6 +40,7 @@ package main
 
 import (
 	"github.com/gopherjs/gopherjs/js"
+
 	"github.com/spatialcurrent/go-simple-serializer/pkg/gssjs"
 )
 

cmd/gss.mod.js/main.go

@@ -37,6 +37,7 @@ package main
 
 import (
 	"github.com/gopherjs/gopherjs/js"
+
 	"github.com/spatialcurrent/go-simple-serializer/pkg/gssjs"
 )