1.0.0 release

Author: nodesocket

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+## 1.0.0 - *2/12/2017* **(BREAKING CHANGE)**
+
+- Depreciated `JSONLITE_PATH` environment variable. `JSONLITE_DATA_DIR` should be used instead.
+- Minor documentation cleanup.
+
 ## 0.8.0 - *5/15/2016*
 
 - The `set` command now supports piping into it. Closes [issue #14](https://github.com/nodesocket/jsonlite/issues/14).

LICENSE.txt

@@ -186,7 +186,7 @@
  same "printed page" as the copyright notice for easier
  identification within third-party archives.
 
- Copyright 2016 Justin Keller
+ Copyright 2017 Justin Keller
 
  Licensed under the Apache License, Version 2.0 (the "License");
  you may not use this file except in compliance with the License.

README.md

@@ -2,14 +2,13 @@
 
 ##### A simple, self-contained, serverless, zero-configuration, [json](http://www.json.org/) document store.
 
-JSONlite sandboxes the current working directory just like [SQLite](https://www.sqlite.org/). The data directory is named `jsonlite.data`, and each json document is saved pretty printed as a uuid.
+JSONlite sandboxes the current working similar to [SQLite](https://www.sqlite.org/). The JSONlite data directory is named `jsonlite.data`, and each json document is saved pretty printed as a uuid.
 
 ## Installation
 
 ````
 git clone https://github.com/nodesocket/jsonlite.git
-cd jsonlite
-ln -s $PWD/jsonlite.bash /usr/local/bin/jsonlite
+ln -s "$PWD"/jsonlite/jsonlite.bash /usr/local/bin/jsonlite
 ````
 
 ## Requirements
@@ -21,14 +20,14 @@ ln -s $PWD/jsonlite.bash /usr/local/bin/jsonlite
 
 ## Configuration
 
-You may optionally set the path to the data directory. It defaults to `$PWD/jsonlite.data` but can manually be set with the `JSONLITE_PATH` environment variable.
+You may optionally set the path to the data directory. It defaults to `$PWD/jsonlite.data` but can manually be set with the `JSONLITE_DATA_DIR` environment variable.
 
 ````
 # default
-export JSONLITE_PATH=$PWD/jsonlite.data
+export JSONLITE_DATA_DIR="$PWD"/jsonlite.data
 
-# manually set to /tmp/jsonlite.data
-export JSONLITE_PATH=/tmp/jsonlite.data
+# manually set the data directory
+export JSONLITE_DATA_DIR=/tmp/jsonlite.data
 ````
 
 ## API/Commands
@@ -154,7 +153,7 @@ For more information on semantic versioning, visit http://semver.org/.
 
 ## License & Legal
 
-Copyright 2016 Justin Keller
+Copyright 2017 Justin Keller
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

jsonlite.bash

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 ###############################################################################
-# Copyright 2016 Justin Keller
+# Copyright 2017 Justin Keller
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,16 +18,16 @@
 
 set -eo pipefail; [[ $TRACE ]] && set -x
 
-readonly VERSION="0.8.0"
-export JSONLITE_PATH=${JSONLITE_PATH:="$PWD/jsonlite.data"}
+readonly VERSION="1.0.0"
+export JSONLITE_DATA_DIR=${JSONLITE_DATA_DIR:="$PWD/jsonlite.data"}
 
 jsonlite_version() {
  echo "JSONlite $VERSION"
 }
 
 jsonlite_info() {
  jsonlite_version
- echo "JSONLITE_PATH=$JSONLITE_PATH"
+ echo "JSONLITE_DATA_DIR=$JSONLITE_DATA_DIR"
  echo
 }
 
@@ -70,21 +70,21 @@ jsonlite_set() {
  exit 4
  fi
 
- if [[ ! -d "$JSONLITE_PATH" ]]; then
- mkdir -p "$JSONLITE_PATH"
+ if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then
+ mkdir -p "$JSONLITE_DATA_DIR"
  fi
 
  local uuid
  uuid=$(uuidgen | awk '{print toupper($0)}')
 
  if command -v json_reformat > /dev/null 2>&1; then
- echo "$value" | json_reformat > "$JSONLITE_PATH/$uuid"
+ echo "$value" | json_reformat > "$JSONLITE_DATA_DIR/$uuid"
  elif command -v jq > /dev/null 2>&1; then
  # use the not-as-fast jq library if available
- echo "$value" | jq '.' > "$JSONLITE_PATH/$uuid"
+ echo "$value" | jq '.' > "$JSONLITE_DATA_DIR/$uuid"
  else
  # fallback to the slowest json.tool
- echo "$value" | python -m json.tool > "$JSONLITE_PATH/$uuid"
+ echo "$value" | python -m json.tool > "$JSONLITE_DATA_DIR/$uuid"
  fi
 
  echo "$uuid"
@@ -102,19 +102,19 @@ jsonlite_get() {
  exit 6
  fi
 
- if [[ -f "$JSONLITE_PATH/$document_id" ]]; then
- cat "$JSONLITE_PATH/$document_id"
+ if [[ -f "$JSONLITE_DATA_DIR/$document_id" ]]; then
+ cat "$JSONLITE_DATA_DIR/$document_id"
  fi
 }
 
 jsonlite_count() {
- if [[ ! -d "$JSONLITE_PATH" ]]; then
+ if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then
  echo 0
  exit 0
  fi
 
  local count
- count=$(find "$JSONLITE_PATH" -type f | wc -l)
+ count=$(find "$JSONLITE_DATA_DIR" -type f | wc -l)
 
  # piping to xargs is a trick to trim (remove leading & trailing whitespace)
  echo "$count" | xargs
@@ -132,24 +132,24 @@ jsonlite_delete() {
  exit 6
  fi
 
- if [[ -f "$JSONLITE_PATH/$document_id" ]]; then
- rm -f "$JSONLITE_PATH/$document_id"
+ if [[ -f "$JSONLITE_DATA_DIR/$document_id" ]]; then
+ rm -f "$JSONLITE_DATA_DIR/$document_id"
  fi
 }
 
 jsonlite_drop() {
- if [[ ! -d "$JSONLITE_PATH" ]]; then
+ if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then
  return $?
  fi
 
  if [[ "$1" == "--force" ]]; then
- rm -rf "$JSONLITE_PATH"
+ rm -rf "$JSONLITE_DATA_DIR"
  return $?
  fi
 
- read -rp "Drop database '$JSONLITE_PATH'? [Y/n] " confirm
+ read -rp "Drop database '$JSONLITE_DATA_DIR'? [Y/n] " confirm
  case "$confirm" in
- y|Y|yes|YES ) rm -rf "$JSONLITE_PATH";;
+ y|Y|yes|YES ) rm -rf "$JSONLITE_DATA_DIR";;
  * ) exit 7;;
  esac
 }

tests/set_500.bash

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $TRACE ]] && set -x
 
-export JSONLITE_PATH
-JSONLITE_PATH="$(dirname "$0")/jsonlite.data"
+export JSONLITE_DATA_DIR
+JSONLITE_DATA_DIR="$(dirname "$0")/jsonlite.data"
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/../jsonlite.bash"
 
 ITERATIONS=500

tests/set_get_delete_500.bash

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 set -eo pipefail; [[ $TRACE ]] && set -x
 
-export JSONLITE_PATH
-JSONLITE_PATH="$(dirname "$0")/jsonlite.data"
+export JSONLITE_DATA_DIR
+JSONLITE_DATA_DIR="$(dirname "$0")/jsonlite.data"
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/../jsonlite.bash"
 
 ITERATIONS=500