├── .gitignore ├── AUTHORS.md ├── CHANGELOG.md ├── LICENSE.txt ├── Makefile ├── README.md ├── jsonlite.bash └── tests ├── set_1k.bash └── set_get_delete_1k.bash /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_STORE 2 | jsonlite.data 3 | -------------------------------------------------------------------------------- /AUTHORS.md: -------------------------------------------------------------------------------- 1 | - Justin Keller ([nodesocket](https://github.com/nodesocket)) 2 | - ([cbgbt](https://github.com/cbgbt)) 3 | - Jose Diaz-Gonzalez ([josegonzalez](https://github.com/josegonzalez)) 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | CHANGELOG 2 | ========= 3 | 4 | ## 1.1.5 - *7/24/2022* 5 | 6 | - Documentation cleanup. 7 | 8 | ## 1.1.4 - *4/20/2022* 9 | 10 | - Documentation cleanup. 11 | - Bump copyrights to 2022. 12 | - Removed miscellaneous unnecessary files. 13 | - Cleanup of Makefile. 14 | 15 | ## 1.1.3 - *1/26/2021* 16 | 17 | - Documentation cleanup. 18 | 19 | ## 1.1.2 - *1/26/2021* 20 | 21 | - Documentation cleanup. 22 | - Bump copyrights to 2021. 23 | 24 | ## 1.1.1 - *9/23/2017* 25 | 26 | - Changed text from `set is using` to `json formatter` in `jsonlite_info()`. 27 | - Changed text from `data directory path` to `data directory` in `jsonlite_info()`. 28 | - Show a notice when calling `jsonlite_info()` if using the slowest json formatter `python -m json.tool`. 29 | 30 | ## 1.1.0 - *2/12/2017* 31 | 32 | - Fixed a bug where providing invalid json to `set` would write an empty file with a uuid filename to the data directory. Now providing invalid json to `set` errors with no file written to the data directory. 33 | 34 | ## 1.0.0 - *2/12/2017* **(BREAKING CHANGE)** 35 | 36 | - **(BREAKING)** Deprecated `JSONLITE_PATH` environment variable. Use `JSONLITE_DATA_DIR` instead. 37 | - Added default command to `README.md` documentation. 38 | - When there is no data directory and `drop` is invoked, hard code an exit code of `0` instead of using `$?`. 39 | - Documentation cleanup. 40 | - Bump copyrights to 2017. 41 | 42 | ## 0.8.0 - *5/15/2016* 43 | 44 | - The `set` command now supports piping into it. Closes [issue #14](https://github.com/nodesocket/jsonlite/issues/14). 45 | 46 | ```` 47 | echo '{"key":"value"}' | jsonlite set 48 | 4472B861-4C10-4C0A-A63B-E5D45AA679C0 49 | ```` 50 | ```` 51 | cat foobar.json | jsonlite set 52 | 9DF4DC1F-121E-46DC-B580-E1663B645AED 53 | ```` 54 | 55 | - Documentation cleanup. 56 | 57 | ## 0.7.1 - *5/15/2016* 58 | 59 | - Running `jsonlite` with no command displays the current version, `JSONLITE_PATH` environment variable, and invokes the `help` command. 60 | 61 | ## 0.7.0 - *5/14/2016* 62 | 63 | - Added a new command `count` which displays the total number of json documents in the database. 64 | - Return exit codes changed to ovoid using `1` and `2` which are reserved. Closes [issue #13](https://github.com/nodesocket/jsonlite/issues/13). 65 | 66 | ```` 67 | 0 => Success 68 | 3 => Invalid command 69 | 4 => Missing required argument json document 70 | 5 => Missing required argument document id 71 | 6 => Invalid argument document id 72 | 7 => Failure confirming drop 73 | ```` 74 | 75 | - Invoking `jsonlite` without any commands now invokes the `help` command. 76 | - Updated the `drop` command confirmation prompt. 77 | - Added a new test `tests/set_500.bash`. 78 | - Documentation cleanup. 79 | 80 | ## 0.6.3 - *5/14/2016* 81 | 82 | - Documentation cleanup. No code changes. 83 | 84 | ## 0.6.2 - *5/14/2016* 85 | 86 | - Globally replaced text JSONLite to JSONlite *(lowercase l)*. 87 | - Shellcheck and cleanup. 88 | - Documentation cleanup. 89 | 90 | ## 0.6.1 - *9/26/2015* 91 | 92 | - Documentation cleanup. No code changes. 93 | 94 | ## 0.6.0 - *9/26/2015* (thanks [josegonzalez](https://github.com/josegonzalez)) 95 | 96 | - You can now define the data directory path using the `JSONLITE_PATH` environment variable. It defaults to `$PWD/jsonlite.data`. 97 | 98 | - JSONlite has been transformed such that it can be used as a library. To do so, simply source in all the methods at the top of your script. 99 | 100 | - Support for [yajl](http://lloyd.github.io/yajl/) `json_reformat` and [jq](https://github.com/stedolan/jq) pretty printing when setting. JSONlite will automatically detect if you have either, if not, it falls back to `python -m json.tool`. `json_reformat` and `jq` provide roughly a 3x performance improvement setting documents. 101 | 102 | - Added `help` command. 103 | 104 | - Bashisms and best practice cleanup. 105 | 106 | - Added `Makefile` and `.travis.yml`. 107 | 108 | ## 0.4.2 - *9/22/2015* 109 | 110 | - Changed the regular expression in function `is_valid_uuid` to `^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$`. 111 | 112 | - Changed test from 1,000 to 500 iterations. 113 | 114 | ## 0.4.1 - *9/22/2015* (thanks [cbgbt](https://github.com/cbgbt)) 115 | 116 | - Support distros where `uuidgen` is lowercase by forcing uppercase. `awk '{print toupper($0)}'` 117 | 118 | ## 0.4.0 - *9/22/2015* 119 | 120 | - Renamed the `destroy` command to `drop`. 121 | 122 | ## 0.3.0 - *9/22/2015* 123 | 124 | - Renamed `jsonlite` to `jsonlite.sh` to clearify it is a shell script. 125 | 126 | - Updated the installation section in `README.md` related to creating the symbolic link. The new `ln` command is: 127 | 128 | ```` 129 | ln -s $PWD/jsonlite.sh /usr/local/bin/jsonlite 130 | ```` 131 | 132 | ## 0.2.0 - *9/21/2015* 133 | 134 | - `get` and `delete` are now idempotent. For example, if you call `get` and pass a uuid that doesn't exist, no error code is returned. Instead a **0** exit code is returned and nothing is written to `stdout`. 135 | 136 | - Now validates document id arguments passed into `get` and `delete` via regex. If invalid, a exit code of **3** is returned. Closes [issue #1](https://github.com/nodesocket/jsonlite/issues/1). 137 | 138 | - Return exit codes changed and standardized. 139 | 140 | ```` 141 | 0 => Success 142 | 1 => Missing required argument json document 143 | 2 => Missing required argument document id 144 | 3 => Invalid argument document id 145 | 4 => Failure confirming destroy 146 | ```` 147 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2022 Justin Keller 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | shellcheck: 2 | ifeq ($(shell shellcheck > /dev/null 2>&1 ; echo $$?),127) 3 | ifeq ($(shell uname),Darwin) 4 | brew install shellcheck 5 | else 6 | sudo apt-get update -qq && sudo apt-get install -qq -y shellcheck 7 | endif 8 | endif 9 | 10 | bats: 11 | ifeq ($(shell bats > /dev/null 2>&1 ; echo $$?),127) 12 | ifeq ($(shell uname),Darwin) 13 | brew install bats 14 | else 15 | sudo add-apt-repository ppa:duggan/bats --yes 16 | sudo apt-get update -qq && sudo apt-get install -qq -y bats 17 | endif 18 | endif 19 | 20 | ci-dependencies: shellcheck bats 21 | 22 | setup: 23 | $(MAKE) ci-dependencies 24 | 25 | lint: 26 | @$(QUIET) find ./ -maxdepth 1 -not -path '*/\.*' | xargs file | egrep "shell|bash" | awk '{ print $$1 }' | sed 's/://g' | xargs shellcheck 27 | 28 | stresstest: 29 | bash tests/set_get_delete_500.bash 30 | 31 | test: setup lint stresstest 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # JSONlite 2 | 3 | ##### A simple, self-contained, serverless, zero-configuration, json document store. 4 | 5 | JSONlite sandboxes the current working directory similar to SQLite. The JSONlite data directory by default is named `jsonlite.data` and each json document is validated and saved pretty printed as a uuid. 6 | 7 | ## Requirements 8 | 9 | 1. bash 10 | 2. uuidgen 11 | 3. python -m json.tool 12 | - Alternatively, install [yajl](http://lloyd.github.io/yajl/) for `json_reformat` *or* [jq](https://github.com/stedolan/jq) to get a significant performance improvement setting documents. 13 | 14 | `json_reformat` is the fastest of the three by far. `jq` comes in second and `python -m json.tool` is the slowest. If possible, avoid using `python -m json.tool`. 15 | 16 | Benchmark [tests/set_1k.bash](https://github.com/nodesocket/jsonlite/blob/master/tests/set_1k.bash): 17 | 18 | # MacBook Pro 16" M1 Max 19 | json_reformat: 6s 20 | jq: 19s 21 | python -m json.tool: 28s 22 | 23 | ## Installation 24 | 25 | ````shell 26 | git clone https://github.com/nodesocket/jsonlite.git 27 | ln -s "$PWD"/jsonlite/jsonlite.bash /usr/local/bin/jsonlite 28 | ```` 29 | 30 | or grab the latest [release source code](https://github.com/nodesocket/jsonlite/releases). 31 | 32 | ## Configuration 33 | 34 | 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. 35 | 36 | ````shell 37 | # default 38 | export JSONLITE_DATA_DIR="$PWD"/jsonlite.data 39 | 40 | # manually set the data directory 41 | export JSONLITE_DATA_DIR=/tmp/jsonlite.data 42 | ```` 43 | 44 | ## API/Commands 45 | 46 | ### set 47 | 48 | > set \ - Writes a json document and returns the document id 49 | 50 | ```` 51 | ➜ jsonlite set '{"name":"John Doe","active":true,"permissions":{"read":true,"write":false}}' 52 | 666B81D6-3F8A-4D57-BA3F-11FA8FC47246 53 | ```` 54 | 55 | `set` also supports piping into it: 56 | 57 | ```` 58 | echo '{"key":"value"}' | jsonlite set 59 | 4472B861-4C10-4C0A-A63B-E5D45AA679C0 60 | ```` 61 | 62 | and reading from a file: 63 | 64 | ```` 65 | jsonlite set < file.json 66 | 9DF4DC1F-121E-46DC-B580-E1663B645AED 67 | ```` 68 | 69 | ### get 70 | 71 | > get \ - Retrieves a json document by document id 72 | 73 | ```` 74 | ➜ jsonlite get 666B81D6-3F8A-4D57-BA3F-11FA8FC47246 75 | { 76 | "active": true, 77 | "name": "John Doe", 78 | "permissions": { 79 | "read": true, 80 | "write": false 81 | } 82 | } 83 | ```` 84 | 85 | ### count 86 | 87 | > count - Total number of json documents in the database 88 | 89 | ```` 90 | ➜ jsonlite count 91 | 293 92 | ```` 93 | 94 | ### delete 95 | 96 | > delete \ - Deletes a json document by document id 97 | 98 | ```` 99 | ➜ jsonlite delete 666B81D6-3F8A-4D57-BA3F-11FA8FC47246 100 | ```` 101 | 102 | ### drop 103 | 104 | > drop (--force) - Drops the database 105 | 106 | ```` 107 | ➜ jsonlite drop 108 | Drop database '/tmp/jsonlite.data'? [Y/n] Y 109 | ```` 110 | 111 | ```` 112 | ➜ jsonlite drop --force 113 | ```` 114 | 115 | ### help 116 | 117 | > help - Displays help 118 | 119 | ```` 120 | ➜ jsonlite help 121 | Usage: jsonlite command 122 | 123 | set Writes a json document and returns a document id 124 | get Retrieves a json document by document id 125 | count Total number of json documents in the database 126 | delete Deletes a json document by document id 127 | drop (--force) Drops the database 128 | help Displays help 129 | version Displays the current version 130 | 131 | ```` 132 | 133 | ### version 134 | 135 | > version - Displays the current version 136 | 137 | ```` 138 | ➜ jsonlite version 139 | 1.1.5 140 | ```` 141 | 142 | ### default 143 | 144 | > default - Displays the current version, configuration, and help 145 | 146 | ``` 147 | ➜ jsonlite 148 | JSONlite 1.1.5 149 | json formatter: json_reformat (fastest) 150 | data directory: /tmp/jsonlite.data 151 | 152 | Usage: jsonlite command 153 | 154 | set Writes a json document and returns a document id 155 | get Retrieves a json document by document id 156 | count Total number of json documents in the database 157 | delete Deletes a json document by document id 158 | drop (--force) Drops the database 159 | help Displays help 160 | version Displays the current version 161 | 162 | ``` 163 | 164 | ## Changelog 165 | 166 | https://github.com/nodesocket/jsonlite/blob/master/CHANGELOG.md 167 | 168 | ## Support, Bugs, And Feature Requests 169 | 170 | Create issues here in GitHub (https://github.com/nodesocket/jsonlite/issues). 171 | 172 | ## Versioning 173 | 174 | For transparency and insight into the release cycle, and for striving to maintain backward compatibility, JSONlite will be maintained under the semantic versioning guidelines. 175 | 176 | Releases will be numbered with the follow format: 177 | 178 | `..` 179 | 180 | And constructed with the following guidelines: 181 | 182 | + Breaking backward compatibility bumps the major (and resets the minor and patch) 183 | + New additions without breaking backward compatibility bumps the minor (and resets the patch) 184 | + Bug fixes and misc changes bumps the patch 185 | 186 | For more information on semantic versioning, visit http://semver.org/. 187 | 188 | ## License & Legal 189 | 190 | Copyright 2022 Justin Keller 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /jsonlite.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | ############################################################################### 4 | # Copyright 2022 Justin Keller 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # http://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | ############################################################################### 18 | 19 | set -eo pipefail; [[ $TRACE ]] && set -x 20 | 21 | readonly VERSION="1.1.5" 22 | export JSONLITE_DATA_DIR=${JSONLITE_DATA_DIR:="$PWD/jsonlite.data"} 23 | 24 | jsonlite_version() { 25 | echo "JSONlite $VERSION" 26 | } 27 | 28 | jsonlite_info() { 29 | jsonlite_version 30 | 31 | if command -v json_reformat > /dev/null 2>&1; then 32 | echo " json formatter: json_reformat (fastest)" 33 | elif command -v jq > /dev/null 2>&1; then 34 | echo " json formatter: jq (fast)" 35 | else 36 | echo " json formatter: python -m json.tool (slowest)" 37 | echo " [notice] install yajl or jq for significantly improved set performance" 38 | fi 39 | 40 | echo " data directory: $JSONLITE_DATA_DIR" 41 | echo 42 | } 43 | 44 | jsonlite_help() { 45 | echo "Usage: jsonlite command " 46 | echo 47 | cat<, Writes a json document and returns a document id 49 | get , Retrieves a json document by document id 50 | count, Total number of json documents in the database 51 | delete , Deletes a json document by document id 52 | drop (--force), Drops the database 53 | help, Displays help 54 | version, Displays the current version 55 | EOF 56 | echo 57 | } 58 | 59 | jsonlite_is_valid_uuid() { 60 | if [[ "$1" =~ ^[A-F0-9]{8}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{4}-[A-F0-9]{12}$ ]]; then 61 | return 0 62 | fi 63 | 64 | return 1 65 | } 66 | 67 | jsonlite_set() { 68 | local value="$1" 69 | 70 | if [[ -z "$value" && ! -t 0 ]]; then 71 | while read -r piped; do 72 | value+=$piped 73 | done; 74 | fi 75 | 76 | if [[ -z "$value" ]]; then 77 | echo "Missing required argument json document" 1>&2 78 | exit 4 79 | fi 80 | 81 | local json_document 82 | 83 | # use the fastest json_reformat if available 84 | if command -v json_reformat > /dev/null 2>&1; then 85 | json_document=$(echo "$value" | json_reformat) 86 | # use the not-as-fast jq if available 87 | elif command -v jq > /dev/null 2>&1; then 88 | json_document=$(echo "$value" | jq '.') 89 | # fallback to the slowest python -m json.tool 90 | else 91 | json_document=$(echo "$value" | python -m json.tool) 92 | fi 93 | 94 | if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then 95 | mkdir -p "$JSONLITE_DATA_DIR" 96 | fi 97 | 98 | local uuid 99 | uuid=$(uuidgen | awk '{print toupper($0)}') 100 | 101 | echo "$json_document" > "$JSONLITE_DATA_DIR/$uuid" 102 | echo "$uuid" 103 | } 104 | 105 | jsonlite_get() { 106 | local document_id="$1" 107 | if [[ -z "$document_id" ]]; then 108 | echo "Missing required argument document id" 1>&2 109 | exit 5 110 | fi 111 | 112 | if ! jsonlite_is_valid_uuid "$document_id"; then 113 | echo "Invalid argument document id" 1>&2 114 | exit 6 115 | fi 116 | 117 | if [[ -f "$JSONLITE_DATA_DIR/$document_id" ]]; then 118 | cat "$JSONLITE_DATA_DIR/$document_id" 119 | fi 120 | } 121 | 122 | jsonlite_count() { 123 | if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then 124 | echo 0 125 | exit 0 126 | fi 127 | 128 | # piping to xargs is a trick to trim (remove leading & trailing whitespace) 129 | find "$JSONLITE_DATA_DIR" -type f | wc -l | xargs 130 | } 131 | 132 | jsonlite_delete() { 133 | local document_id="$1" 134 | if [[ -z "$document_id" ]]; then 135 | echo "Missing required argument document id" 1>&2 136 | exit 5 137 | fi 138 | 139 | if ! jsonlite_is_valid_uuid "$document_id"; then 140 | echo "Invalid argument document id" 1>&2 141 | exit 6 142 | fi 143 | 144 | if [[ -f "$JSONLITE_DATA_DIR/$document_id" ]]; then 145 | rm -f "$JSONLITE_DATA_DIR/$document_id" 146 | fi 147 | } 148 | 149 | jsonlite_drop() { 150 | if [[ ! -d "$JSONLITE_DATA_DIR" ]]; then 151 | exit 0 152 | fi 153 | 154 | if [[ "$1" == "--force" ]]; then 155 | rm -rf "$JSONLITE_DATA_DIR" 156 | exit $? 157 | fi 158 | 159 | read -rp "Drop database '$JSONLITE_DATA_DIR'? [Y/n] " confirm 160 | case "$confirm" in 161 | Y|y|YES|yes ) rm -rf "$JSONLITE_DATA_DIR";; 162 | * ) exit 7;; 163 | esac 164 | } 165 | 166 | jsonlite_main() { 167 | local COMMAND="$1" 168 | 169 | if [[ -z $COMMAND ]]; then 170 | jsonlite_info 171 | jsonlite_help 172 | exit 0 173 | fi 174 | 175 | shift 1 176 | case "$COMMAND" in 177 | "set") 178 | jsonlite_set "$@" 179 | ;; 180 | 181 | "get") 182 | jsonlite_get "$@" 183 | ;; 184 | 185 | "count") 186 | jsonlite_count 187 | ;; 188 | 189 | "delete") 190 | jsonlite_delete "$@" 191 | ;; 192 | 193 | "drop") 194 | jsonlite_drop "$@" 195 | ;; 196 | 197 | "version") 198 | jsonlite_version 199 | ;; 200 | 201 | "help") 202 | jsonlite_help 203 | ;; 204 | 205 | *) 206 | jsonlite_help >&2 207 | exit 3 208 | esac 209 | } 210 | 211 | if [[ "$0" == "$BASH_SOURCE" ]]; then 212 | jsonlite_main "$@" 213 | fi 214 | -------------------------------------------------------------------------------- /tests/set_1k.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -eo pipefail; [[ $TRACE ]] && set -x 3 | 4 | export JSONLITE_DATA_DIR="/tmp/jsonlite.data" 5 | ITERATIONS=1000 6 | 7 | jsonlite drop --force 8 | 9 | for i in $(seq 1 $ITERATIONS); do 10 | jsonlite set '{"name":"John Doe","active":true,"permissions":{"read":true,"write":false}}' > /dev/null 11 | done 12 | 13 | jsonlite drop --force 14 | -------------------------------------------------------------------------------- /tests/set_get_delete_1k.bash: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -eo pipefail; [[ $TRACE ]] && set -x 3 | 4 | export JSONLITE_DATA_DIR="/tmp/jsonlite.data" 5 | ITERATIONS=1000 6 | 7 | jsonlite drop --force 8 | 9 | for i in $(seq 1 $ITERATIONS); do 10 | ID=$(jsonlite set '{"name":"John Doe","active":true,"permissions":{"read":true,"write":false}}') 11 | jsonlite get "$ID" > /dev/null 12 | jsonlite delete "$ID" 13 | done 14 | 15 | jsonlite drop --force 16 | --------------------------------------------------------------------------------