Merge branch 'docopts-go'

Author: Sylvain Viart

.travis.yml

@@ -1,15 +1,22 @@
 language: go
+os:
+  - linux
+  - osx
 go:
   - "1.10.1"
 before_install:
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew update ; fi
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then brew install bash; fi
+  - bash --version ; type bash
   - go get github.com/docopt/docopt-go
+  # get our official repos to
+  - go get github.com/docopt/docopts
 branches:
   only:
     - docopts-go
+    - master
 notifications:
   email:
     on_success: never
 script:
-  - go build docopts.go
-  - go test -v .
-  - python language_agnostic_tester.py ./testee.sh
+  - make test

PROGRESS.md

@@ -1,15 +1,16 @@
 # current work in PROGRRESS
 
-finish examples/
-make repository cleanup
+old style loop bash examples
 
 # next
 
-## CI
-integration with automated tests
+## release and binary
+
+publish release and pre-build binaries
 
 ## provide test on old environment
 
 docker?
 32bist
 bash 3
+

TODO.md

@@ -12,7 +12,7 @@ See [API_proposal.md](API_proposal.md)
 
 ## build and publish binary
 
-reuse build.sh to build golang binary and pubilsh it as a new release too.
+Reuse build.sh to build golang binary and pubilsh it as a new release too.
 
 ## generate bash completion from usage
 
@@ -22,7 +22,7 @@ docopts -h "$help" --generate-completion
 
 ## embed test routine (validation)?
 
-may we cat interract with the caller to eval some validation…
+May we can interract with the caller to eval some validation…
 It is needed? Is it our goal?
 
 ```
@@ -38,3 +38,6 @@ if docopts test -- num:gt:1:--count file_exists:INFILE
 ## config file parse config to option format
 
 À la nslcd… ?
+
+* json merge
+* toml merge (ini)

docopts.sh

@@ -1,4 +1,4 @@
-#!/bin/bash
+#!/usr/bin/env bash
 # vim: set et sw=4 ts=4 sts=4:
 #
 # docopts helper for bash
@@ -125,7 +125,7 @@ docopt_print_ARGS() {
     # inspired by:
     # https://stackoverflow.com/questions/6660010/bash-how-to-assign-an-associative-array-to-another-variable-name-e-g-rename-t#8881121
     declare -A myassoc
-    eval $(typeset -A -p $tab|sed "s/ $assoc=/ myassoc=/")
+    eval $(typeset -A -p $assoc|sed "s/ $assoc=/ myassoc=/")
 
     # loop on keys
     echo "docopt_print_ARGS => $assoc"

examples/legacy_bash/sshdiff.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+#
+# Show file differences between 2 hosts.
+# Usage: sshdiff.sh [-h] [-s] <host1> <host2> <file> [<lines_context>]
+#
+# If not specified, <lines_context> defaults to 3.
+#
+# Use colordiff if available.
+#
+# Options:
+#     -h       display this help and exit
+#     -s       use sort instead of cat to show remote <file>
+#
+# Examples:
+#     sshdiff.sh server1 hostname2 /etc/hostname
+
+PATH=../..:$PATH
+source docopts.sh --auto "$@"
+
+docopt_print_ARGS
+
+

examples/naval_fate.sh

@@ -17,12 +17,15 @@
 #   --drifting    Drifting mine.
 #
 
-VERSION='Naval Fate 2.0'
 
 # if docopts is in PATH, not needed.
 # Note: docopts.sh is also found in PATH
 PATH=..:$PATH
-# auto parse the header above, See: docopt_get_help_string
-source docopts.sh --auto "$@"
+
+VERSION='Naval Fate 2.0'
+source docopts.sh
+# no vesion support in docopt_auto_parse() so we call docopts directly
+usage=$(docopt_get_help_string "$0")
+eval "$(docopts -A ARGS -V "$VERSION" -h "$usage" : "$@")"
 
 docopt_print_ARGS

examples/without_docopts_sh_lib/arguments_example.sh

@@ -0,0 +1,33 @@
+#!/bin/bash
+
+usage() {
+  cat << EOU
+Usage: arguments_example.sh [-vqrh] [FILE] ...
+          arguments_example.sh (--left | --right) CORRECTION FILE
+
+Process FILE and optionally apply correction to either left-hand side or
+right-hand side.
+
+Arguments:
+  FILE        optional input file
+  CORRECTION  correction angle, needs FILE, --left or --right to be present
+
+Options:
+  -h --help
+  -v       verbose mode
+  -q       quiet mode
+  -r       make report
+  --left   use left-hand side
+  --right  use right-hand side
+EOU
+}
+
+# not needed if docopts already in PATH
+PATH=../..:$PATH
+eval "$(docopts -A ARGS -h "$(usage)" : "$@")"
+
+# main code
+# on assoc array '!' before nane gike hash keys
+for a in ${!ARGS[@]} ; do
+    echo "$a = ${ARGS[$a]}"
+done

examples/without_docopts_sh_lib/calculator_example.sh

@@ -0,0 +1,30 @@
+#!/bin/bash
+usage() {
+  cat << EOU
+Not a serious example.
+
+Usage:
+  calculator_example.sh <value> ( ( + | - | * | / ) <value> )...
+  calculator_example.sh <function> <value> [( , <value> )]...
+  calculator_example.sh (-h | --help)
+
+Examples:
+  calculator_example.sh 1 + 2 + 3 + 4 + 5
+  calculator_example.sh 1 + 2 '*' 3 / 4 - 5    # note quotes around '*'
+  calculator_example.sh sum 10 , 20 , 30 , 40
+
+Options:
+  -h, --help
+
+Example:
+  ./calculator_example.sh 30 + 23 - 22
+EOU
+}
+
+# not needed if docopts is in PATH
+PATH=../..:$PATH
+version='0.1'
+parsed=$(docopts -A args -h "$(usage)" -V $version : "$@")
+echo "$parsed"
+echo "================================================================================"
+eval "$parsed"

examples/without_docopts_sh_lib/cat-n_wrapper_example.sh

@@ -0,0 +1,45 @@
+
+usage() {
+  cat << EOU
+
+cat -n all files
+
+Usage: cat-n_wrapper_example.sh [--count=N] FILE...
+
+Arguments:
+  FILE     input file
+
+Options:
+  --count=N   limit the number of line to display
+
+Examples:
+   ./cat-n_wrapper.sh --count=3 cat-n_wrapper.sh  quick_example.sh 
+EOU
+}
+
+
+# no PATH changes required if docopts binary is in the PATH already
+PATH=../..:$PATH
+help=$(usage)
+version='0.1'
+
+parsed=$(docopts -A args -h "$help" -V $version : "$@")
+#echo "$parsed"
+eval "$parsed"
+
+cat_limit() {
+    if [[ -z "${args[--count]}" ]] ; then
+        cat -n "$1"
+    else
+        cat -n "$1" | head -"${args[--count]}"
+    fi
+}
+
+# current docopts multiple argument wrapper
+n=${args[FILE,#]}
+for i in $(seq 0 $(($n - 1)))
+do
+    f="${args[FILE,$i]}"
+    echo "----- $f -------"
+    cat_limit  "$f"
+done

examples/without_docopts_sh_lib/counted_example.sh

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+usage() {
+  cat << EOU
+Usage: counted_example.sh --help
+       counted_example.sh -v...
+       counted_example.sh go [go]
+       counted_example.sh (--path=<path>)...
+       counted_example.sh <file> <file>
+
+Try: counted_example.sh -vvvvvvvvvv
+     counted_example.sh go go
+     counted_example.sh --path ./here --path ./there
+     counted_example.sh this.txt that.txt
+EOU
+}
+
+# if docopts is in PATH, not needed.
+PATH=../..:$PATH
+eval "$(docopts -A ARGS -h "$(usage)" : "$@")"
+
+# docopt_auto_parse use ARGS bash 4 global assoc array
+# main code
+# on assoc array '!' before nane gike hash keys
+for a in ${!ARGS[@]} ; do
+    echo "$a = ${ARGS[$a]}"
+done