Fix lexigraphical ordering of base64 encoded values

__WHAT__
* use custom base64 codec that gurantiees ordering
* use common test for testing
* integrate CI and test coverage
* clean-up code

Author: fogfish

.travis.yml

@@ -0,0 +1,12 @@
+language: erlang
+dist: trusty
+
+script:
+   - make
+   - ./rebar3 coveralls send
+
+otp_release:
+   - 20.1
+   - 20.0
+   - 19.2
+

Emakefile

@@ -1,214 +1,5 @@
-## @author     Dmitry Kolesnikov, <[email protected]>
-## @copyright  (c) 2012 - 2014 Dmitry Kolesnikov. All Rights Reserved
-##
-## @description
-##   Makefile to build and release Erlang applications using standard development tools
-##
-## @version 0.11.5
-
-#####################################################################
-##
-## application config
-##
-#####################################################################
-PREFIX ?= /usr/local
-APP    ?= $(notdir $(CURDIR))
-ARCH   ?= $(shell uname -m)
-PLAT   ?= $(shell uname -s)
-VSN    ?= $(shell test -z "`git status --porcelain`" && git describe --tags --long | sed -e 's/-g[0-9a-f]*//' | sed -e 's/-0//' || echo "`git describe --abbrev=0 --tags`-SNAPSHOT")
-REL     = ${APP}-${VSN}
-PKG    ?= ${REL}+${ARCH}.${PLAT}
-TEST   ?= ${APP}
-S3     ?=
-VMI    ?= fogfish/erlang
-NET    ?= lo0
-URL 	 ?= undefined
-LATEST ?= latest
-
-## root path to benchmark framework
-BB     = ../basho_bench
-SSHENV = /tmp/ssh-agent.conf
-COOKIE?= nocookie
-
-## erlang runtime flags use by `make run`
-ROOT   = $(shell pwd)
-ADDR   = $(shell ifconfig ${NET} | sed -En 's/^${NET}:.*inet (addr:)?(([0-9]*\.){3}[0-9]*).*/\2/p' && echo "127.0.0.1")
-EFLAGS = \
-	-name ${APP}@${ADDR} \
-	-setcookie ${COOKIE} \
-	-pa ${ROOT}/_build/default/lib/*/ebin \
-	-pa ${ROOT}/rel \
-	-kernel inet_dist_listen_min 32100 \
-	-kernel inet_dist_listen_max 32199 \
-	+P 1000000 \
-	+K true +A 160 -sbt ts
-
-## self-extracting bundle wrapper
-BUNDLE_INIT = PREFIX=${PREFIX}\nREL=${PREFIX}/${REL}\nAPP=${APP}\nVSN=${VSN}\nLINE=`grep -a -n "BUNDLE:$$" $$0`\nmkdir -p $${REL}\ntail -n +$$(( $${LINE%%%%:*} + 1)) $$0 | gzip -vdc - | tar -C $${REL} -xvf - > /dev/null\n
-BUNDLE_FREE = exit\nBUNDLE:\n
-BUILDER = FROM ${VMI}\nRUN mkdir ${APP}\nCOPY . ${APP}/\nRUN cd ${APP} && make && make rel\n
-CTRUN   = \
-	-module(test). \
-	-export([run/1]). \
-	run(Spec) -> \
-   	{ok, Test} = file:consult(Spec), \
-   	case lists:keyfind(node, 1, Test) of \
-      	false -> ct:run_test([{spec, Spec}]); \
-         true  -> ct_master:run(Spec) \
-   	end, \
-		erlang:halt().
-
-#####################################################################
-##
-## build
-##
-#####################################################################
-all: rebar3 compile
-
-compile:
-	@./rebar3 compile
-
-clean:
-	@./rebar3 clean ;\
-	rm -Rf _build/default/rel ;\
-	rm -rf test.*-temp-data ;\
-	rm -rf tests ;\
-	rm -rf log ;\
-	rm -f  relx.config ;\
-	rm -f  *.tar.gz ;\
-	rm -f  *.bundle
-
-distclean: clean 
-	@./rebar3 unlock ;\
-	rm -Rf _build ;\
-	rm -Rf rebar3
-
-##
-## execute unit test
-unit: all
-	@./rebar3 skip_deps=true eunit
-
-##
-## execute common test and terminate node
-test: _build/test.beam
-	@mkdir -p /tmp/test/${APP} ;\
-	erl ${EFLAGS} -pa _build/ -pa test/ -run test run test/${TEST}.config
-
-_build/test.beam: _build/test.erl
-	erlc -o _build $<
-
-_build/test.erl:
-	echo "${CTRUN}" > $@
-
-
-#####################################################################
-##
-## release 
-##
-#####################################################################
-rel: ${PKG}.tar.gz
-
-## assemble VM release
-ifeq (${PLAT},$(shell uname -s))
-${PKG}.tar.gz: relx.config
-	@./rebar3 tar -n ${APP} -v ${VSN} ;\
-	cp _build/default/rel/${APP}/${APP}-${VSN}.tar.gz $@ ;\
-	echo "==> tarball: $@"
-
-relx.config: rel/relx.config.src
-	@cat $< | sed 's/release/release, {${APP}, "${VSN}"}/' > $@ 
-else
-${PKG}.tar.gz: _build/dockermake
-	@docker build --file=$< --force-rm=true	--tag=build/${APP}:latest . ;\
-	I=`docker create build/${APP}:latest` ;\
-	docker cp $$I:/${APP}/$@ $@ ;\
-	docker rm -f $$I ;\
-	docker rmi build/${APP}:latest ;\
-	test -f $@ && echo "==> tarball: $@"
-
-_build/dockermake:
-	@echo "${BUILDER}" > $@
-endif
-
-## build docker image
-docker: rel/Dockerfile
-	docker build \
-		--build-arg APP=${APP} \
-		--build-arg VSN=${VSN} \
-		-t ${URL}/${APP}:${VSN} -f $< .
-	docker tag -f ${URL}/${APP}:${VSN} ${URL}/${APP}:${LATEST}
-
-
-
-#####################################################################
-##
-## package / bundle
-##
-#####################################################################
-pkg: ${PKG}.tar.gz ${PKG}.bundle
-
-${PKG}.bundle: rel/deploy.sh
-	@printf '${BUNDLE_INIT}' > $@ ;\
-	cat $<  >> $@ ;\
-	printf  '${BUNDLE_FREE}' >> $@ ;\
-	cat  ${PKG}.tar.gz >> $@ ;\
-	chmod ugo+x $@ ;\
-	echo "==> bundle: $@"
-
-## copy 'package' to s3
-s3: ${PKG}.bundle
-	aws s3 cp $< ${S3}/$<
-
-s3-latest: ${PKG}.bundle
-	aws s3 cp $< ${S3}/${APP}-latest${VARIANT}.bundle
-
-#####################################################################
-##
-## deploy
-##
-#####################################################################
-ifneq (${host},)
-${SSHENV}:
-	@echo "==> ssh: config keys" ;\
-	ssh-agent -s > ${SSHENV}
-
-node: ${PKG}.bundle ${SSHENV}
-	@echo "==> deploy: ${host}" ;\
-	. ${SSHENV} ;\
-	k=`basename ${pass}` ;\
-	l=`ssh-add -l | grep $$k` ;\
-	if [ -z "$$l" ] ; then \
-		ssh-add ${pass} ;\
-	fi ;\
-	rsync -cav --rsh=ssh --progress $< ${host}:$< ;\
-	ssh -t ${host} "sudo sh ./$<"
-endif
-
-#####################################################################
-##
-## debug
-##
-#####################################################################
-run:
-	@erl ${EFLAGS}
-
-benchmark:
-	@echo "==> benchmark: ${TEST}" ;\
-	$(BB)/basho_bench -N [email protected] -C nocookie priv/${TEST}.benchmark ;\
-	$(BB)/priv/summary.r -i tests/current ;\
-	open tests/current/summary.png
-
-console: ${PKG}.tar.gz
-	@_build/default/rel/${APP}/bin/${APP} console
-
-#####################################################################
-##
-## dependencies
-##
-#####################################################################
-rebar3:
-	@curl -L -O https://s3.amazonaws.com/rebar3/rebar3 ; \
-	chmod ugo+x $@
-
-.PHONY: test rel deps all pkg 
+APP = uid
+ORG = 
+URI = 
 
+include beam.mk

Makefile

@@ -1,6 +1,10 @@
 # k-ordered unique identity
 
-The library develops an identity schema suitable for rough, lexicographical objects ordering.
+The library develops an identity schema suitable for rough, lexicographical objects ordering in distributed systems.
+
+[![Build Status](https://secure.travis-ci.org/fogfish/uid.svg?branch=master)](http://travis-ci.org/fogfish/uid) 
+[![Coverage Status](https://coveralls.io/repos/github/fogfish/uid/badge.svg?branch=master)](https://coveralls.io/github/fogfish/uid?branch=master) 
+[![Hex.pm](https://img.shields.io/hexpm/v/uid.svg)](https://hex.pm/packages/uid) 
 
 
 ## Inspiration
@@ -26,9 +30,9 @@ The library has developed a dual schema: 64-bit unique identity to be used withi
 
 The k-ordered value consists of time-stamp with millisecond resolution (50-bit) that is used to roughly sort events. The time-stamp ensures distinct sorting within virtual machine where system clock is controlled by operation system. A locally monotonic padding (14-bits) prevents the collisions (Note: 14-bits allows to have about 16K allocations per millisecond). 
 
-The time-stamp based sorting fails on distributed systems unless it implements precises time synchronization protocol. Therefore, it was decided to uses location aspect (node fingerprint) as component of k-ordered value. This component allows to keep ordering consistent even if clocks on other node is skewed. The developed schema allows to control the quality of the ordering (precision) depending on the length of _neighborhood interval_. The neighborhood interval is a time span where the location has higher priority then time.
+The time-stamp based sorting fails on distributed systems unless it implements precises time synchronization protocol. Therefore, it was decided to uses location aspect (node fingerprint) as component of k-ordered value. This component allows to keep ordering consistent even if clocks on other node is skewed. The developed schema allows to control the quality of the ordering (precision) depending on the length of _neighborhood interval_. The neighborhood interval is a time span where the location has higher priority then time. The usage of this time interval relaxes a clock synchronization requirements while preserving an ordering.  
 
-The library represents k-ordered values as tuples but implements binary and url friendly base64 encoding. The serialization protocol has been changed after library version `1.2.0`. New serialization improves allocation performance of k-order values. It uses Erlang OTP/18 feature `erlang:unique_integer(...)` to generate locally monotonic value. The library allocates about 13M k-ordered values per second on reference hardware.
+The library represents k-ordered values as tuples but implements binary and url friendly encoding similar to base64. The serialization protocol has been changed after library version `1.2.0`. New serialization improves allocation performance of k-order values. It uses Erlang OTP/18 feature `erlang:unique_integer(...)` to generate locally monotonic value. The library allocates about 13M k-ordered values per second on reference hardware.
 
 ### 64-bit, local
 
@@ -101,17 +105,19 @@ uid:encode(B).
 
 %%
 %% encode value to base64
-%%   <<"AGA5igPrJzJ7aYAB">>
+%%   <<".5.tXVEf8n8vPN.0">>
 uid:encode64(B).
 ```
 
 ## How To Contribute
 
 The library is Apache 2.0 licensed and accepts contributions via GitHub pull requests:
 
-* Fork the repository on GitHub
-* Read build instructions
-* Make a pull request
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
 
 The build process requires [Erlang/OTP](http://www.erlang.org/downloads) version 19.0 or later and essential build tools.
 
@@ -156,9 +162,4 @@ If you experience any issues with the library, please let us know via [GitHub is
 
 ## License
 
-Copyright 2012 Dmitry Kolesnikov
-
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
-
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
-
+[![See LICENSE](https://img.shields.io/github/license/fogfish/uid.svg?style=for-the-badge)](LICENSE)