diff options
| -rw-r--r-- | LICENSE | 201 | ||||
| -rw-r--r-- | README.md | 52 | ||||
| -rwxr-xr-x | install.sh | 24 | ||||
| -rwxr-xr-x | tools/each | 21 | ||||
| -rwxr-xr-x | tools/filter | 25 | ||||
| -rwxr-xr-x | tools/map | 21 | ||||
| -rwxr-xr-x | tools/reduce | 27 | ||||
| -rwxr-xr-x | tools/splitat | 14 | ||||
| -rwxr-xr-x | tools/words | 13 |
9 files changed, 398 insertions, 0 deletions
@@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..790d3e5 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +# pipetools + +A collection of familiar and intuitive shell tools for processing text data in a pipeline. The only dependencies are POSIX utilities such as `tr` that should be available on any POSIX-compliant system. + +## Examples + +```sh +echo foo bar baz | words +# Output: +foo +bar +baz +``` + +```sh +echo foo bar baz | words | map '$IDX $ELEM' | filter '$IDX -gt 0' +# Output: +1 bar +2 baz +``` + +```sh +echo foo bar baz | words | map '$IDX $ELEM' | map '$IDX $(( $X0 + 10 )) $X1' +# Output: +0 10 foo +1 11 bar +2 12 baz +``` + +```sh +echo foo bar baz | words | map '$(( $IDX + 1 ))' | reduce 1 '$(( $ACC * $ELEM ))' +# Output: +6 +``` + +The tools all follow the same conventions: + +- Input is line-based (newline-separated). You can use `words` to convert whitespace to newlines. +- `$IDX` is the index of the element in the input stream. +- `$ELEM` is the element itself. +- `$X0`, `$X1`, etc. are the whitespace separated words in the current element (think columns in a table). +- `$ACC` is the accumulator for the reduce operation. + +The `$(( $X0 + $X1 ))` syntax is called arithmetic expansion, which allows for basic arithmetic operations within a shell script. + +## Installation + +Copy the contents of the `tools` directory to a directory in your PATH, or run the `install.sh` script to create symlinks automatically to your selected target directory. + +## Author + +Jan Tuomi <<jan@jantuomi.fi>> diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..ca562df --- /dev/null +++ b/install.sh @@ -0,0 +1,24 @@ +#!/bin/sh + +set -e + +if [ -z tools ]; then + echo "Error: tools directory not found. Run this script from the root directory." + exit 1 +fi + +cd tools + +# read TARGET without newline after prompt +read -p "Install to? [default:/usr/local/bin] " TARGET + +if [ -z "$TARGET" ]; then + TARGET="/usr/local/bin" +fi +TARGET="$(eval echo "$TARGET")" + +(set -x; mkdir -p "$TARGET") + +for file in *; do + (set -x; ln -s "$(realpath "$file")" "$TARGET/$file") || true +done diff --git a/tools/each b/tools/each new file mode 100755 index 0000000..da5ce84 --- /dev/null +++ b/tools/each @@ -0,0 +1,21 @@ +#!/bin/sh + +if [ -z "$1" ]; then + echo "Usage: $0 <command>" + echo "" + echo "Run the given command for each newline-separated line in stdin (think for-each in many programming languages)." + echo 'The iterator variable is called "$ELEM", and the index variable is called "$IDX".' + exit 1 +fi + +i=0 +while IFS=$'\n' read -r line; do + j=0 + for item in $line; do + eval "X${j}='$item'" + j=$((j+1)) + done + + IDX=$i ELEM="$line" eval "$1" + i=$((i+1)) +done diff --git a/tools/filter b/tools/filter new file mode 100755 index 0000000..94258d0 --- /dev/null +++ b/tools/filter @@ -0,0 +1,25 @@ +#!/bin/sh + +if [ -z "$1" ]; then + echo "Usage: $0 <command>" + echo "" + echo "Run the given test expression for each newline-separated line in stdin, and echo only the lines that return zero." + echo "(Think filter in many programming languages)." + echo 'The iterator variable is called "$ELEM", and the index variable is called "$IDX".' + exit 1 +fi + +i=0 +while IFS=$'\n' read -r line; do + j=0 + for item in $line; do + eval "X${j}='$item'" + j=$((j+1)) + done + + IDX=$i ELEM="$line" eval "test $1" + if [ $? -eq 0 ]; then + echo "$line" + fi + i=$((i+1)) +done diff --git a/tools/map b/tools/map new file mode 100755 index 0000000..8c4e5ef --- /dev/null +++ b/tools/map @@ -0,0 +1,21 @@ +#!/bin/sh + +if [ -z "$1" ]; then + echo "Usage: $0 <expr>" + echo "" + echo "Give the given expression for each newline-separated line in stdin as an argument to echo (think map in many programming languages)." + echo 'The iterator variable is called "$ELEM", and the index variable is called "$IDX".' + exit 1 +fi + +i=0 +while IFS=$'\n' read -r line; do + j=0 + for item in $line; do + eval "X${j}='$item'" + j=$((j+1)) + done + + IDX=$i ELEM="$line" eval "echo $1" + i=$((i+1)) +done diff --git a/tools/reduce b/tools/reduce new file mode 100755 index 0000000..effb98d --- /dev/null +++ b/tools/reduce @@ -0,0 +1,27 @@ +#!/bin/sh + +if [ "$#" -ne 2 ]; then + echo "Usage: $0 <init> <expr>" + echo "" + echo "Run the given command for each newline-separated line in stdin." + echo 'The expression computes the next value of "$ACC" (think reduce in many programming languages).' + echo 'The initial value of "$ACC" is the first argument to the script.' + echo 'The iterator variable is called "$ELEM", and the index variable is called "$IDX".' + echo 'The final value of "$ACC" is printed after all lines have been processed.' + exit 1 +fi + +i=0 +ACC="$1" +while IFS=$'\n' read -r line; do + j=0 + for item in $line; do + eval "X${j}='$item'" + j=$((j+1)) + done + + IDX=$i ELEM="$line" eval "ACC=\"$2\"" + i=$((i+1)) +done + +echo "$ACC" diff --git a/tools/splitat b/tools/splitat new file mode 100755 index 0000000..d41521e --- /dev/null +++ b/tools/splitat @@ -0,0 +1,14 @@ +#!/bin/sh + +if [ "$#" -ne 1 ]; then + echo "Usage: $0 <separator>" + echo "" + echo "Split the stdin into lines, splitting at the given separator character." + exit 1 +fi + +while IFS=$'\n' read -r line; do + for part in $(echo "$line" | tr "$1" '\n'); do + echo "$part" + done +done diff --git a/tools/words b/tools/words new file mode 100755 index 0000000..ac76d0d --- /dev/null +++ b/tools/words @@ -0,0 +1,13 @@ +#!/bin/sh + +if [ "$#" -ne 0 ]; then + echo "Usage: $0" + echo "" + echo "Echo each whitespace-separated word in stdin on a new line." + exit 1 +fi + +i=0 +for word in $(cat); do + echo "$word" +done |