gabr 2.0.13 → 2.1.1

package/example/usage.sh

@@ -2,24 +2,13 @@
 # @file usage.sh
 #
 # @brief  Usage.sh contains a example on how to reimplement the usage behavior of gabr.
+
 set +x
 declare stack="$(declare -f -F)" # start keeping count of stack (usage.sh will do difference check)
 if [ -n "${GABR_DEBUG_MODE:-}" ]; then
     set -x
 fi
 
-
-usage() {
-    set +x
-    if [ $# -eq 0 ]; then
-        set -- ${prevArgs[@]:-}
-    fi
-    local stack="${stack:-$(declare -F)}"
-    local -a bashsource=(${BASH_SOURCE[@]} ${@})
-    local fullCommand="$(IFS=' '; echo ${@##*usage})" # strip 'usage' of $@
-    echo "Usage: ${fullCommand}$(_usageFiles)$(_usageScope) ${example:-}" >&2
-}
-
 function _filename(){
     local filename=${1:-$BASH_SOURCE}
     local pathJuggle=${filename##*/};
@@ -41,12 +30,13 @@ function _usageScope(){ # Prints all functions added to scope by gabr
             set -x
         fi
         if [ -n "${usageScope:-}" ] && [ ${#usageScope} -gt 1 ]; then
-            usageScope=" [${usageScope:0: -1}]" # strip last |
+            usageScope=" [${usageScope%|}]" # strip last |
         fi
     fi
     echo "${usageScope:-}"
 }
 
+
 function _usageFiles(){
     if ! [ "${usageFiles+set}" = "set" ]; then
         local findString=""
@@ -56,17 +46,28 @@ function _usageFiles(){
         done
         local usageFiles=$(
             IFS=' '
-            ! find . -maxdepth 1 ${findString} -name '*'${ext:-.sh} |
+            ! find . -maxdepth 1 ${findString} -type f \( -iname "*.sh" ! -iname ".*" \) |
                 cut -c3- | # cut ./
                 rev      | 
                 cut -c4- | # cut .sh
                 rev      |
-                awk '!/^\./{ print $0 }' | # hide dot prefixed
                 tr '\n' "|"
             );
         if [ -n "${usageFiles:-}" ] && [ ${#usageFiles} -gt 1 ]; then
-            usageFiles=" [${usageFiles:0: -1}]" # strip last |
+            usageFiles=" [${usageFiles%|}]" # strip last |
         fi
     fi
     echo "${usageFiles:-}"
-}
+}
+
+
+usage() {
+    set +x
+    if [ $# -eq 0 ]; then
+        set -- ${prevArgs[@]:-}
+    fi
+    local stack="${stack:-$(declare -F)}"
+    local -a bashsource=(${BASH_SOURCE[@]} ${@})
+    local fullCommand="$(IFS=' '; echo ${@##*usage})" # strip 'usage' of $@
+    echo "Usage: ${fullCommand}$(_usageFiles)$(_usageScope) ${example:-}" >&2
+}

package/gabr.linux.sh

@@ -15,7 +15,7 @@
 # @exitcode 0  If successfull
 # @exitcode >0 On failure
 #
-if [ ${BASH_VERSION:0:1} -ge 4 ] && [ ${BASH_VERSION:2:1} -ge 4 ]
+if [ ${BASH_VERSION:0:1} -ge 4 ]
 then
 function gabr() {  # A function to run other functions 
     local fn file
@@ -56,8 +56,17 @@ ${prevArgs[@]} [directory | file] function [arguments] -- A function to call oth
     ! [[ -v prevArgs ]] && local -a prevArgs=()
     # helpers
     _isFn(){    [[ $(type -t ${1:-$fn}) = function ]]; }
-    _canSource(){ ! [[ -v files[$file] ]] || ! [[ ${files[$file]} = $file ]]; }
     _isDebug(){ [[ -v GABR_DEBUG_MODE ]]; }
+    _listFiles(){ 
+        find . -maxdepth 3 -type f \( -iname "*${ext:-'.sh'}" ! -iname ".*" \) ! -path "*/.*"; # hide dot prefix
+    }
+    _listFunctions(){ 
+        declare -f -F   |
+            tr ' ' '\n' |
+            sort        |
+            uniq -u     |
+            awk '! /^_/{print $0}' # hide underscore prefix
+    }
     # begin processing arguments
     if [ $# -eq 0 ]; then
         set -- $default
@@ -82,30 +91,28 @@ ${prevArgs[@]} [directory | file] function [arguments] -- A function to call oth
             ${fn} ${@:-}; # call the function
             _isDebug && set +x
             break
-        elif [[ -f ./${fn}${ext} ]]; then # allow a file with extension
+        elif [[ ${#fn} -ge 2 && ${fn:0:2} = './' ]]; then  # allow redundant ./ in arguments
+            shift
+            set - ${fn:2} ${@:-}
+        elif [[ ${#fn} -ge ${#ext} && ${fn:$(( ${#fn}-${#ext} ))} = ${ext} ]]; then  # allow redundant .sh in arguments
+            shift
+            set - ${fn:: $(( - ${#ext} ))} ${@:-}
+        elif [[ -r ./${fn}${ext} ]]; then # allow a file with extension and read permissions
             file=${fn}${ext}
-            if ! _canSource; then
-                set -- '-' "'$file' is already sourced by argument $fn" 1>&2
-                continue
-            fi
             files+=([$file]=$file)
-            if ! [ -r "${file:-}" ]; then
-                set -- '-' "'$file' is not a readable file" 1>&2
-                continue
-            fi
             prevArgs+=($1)
             shift
             args=(${@:-})
-             _isDebug && set -x
-            . ${fn}${ext} # source the file
+            _isDebug && set -x
+            . ./${fn}${ext} # source the file
             _isDebug && set +x
             _isFn $fn && set -- $fn ${@:-}
             [ $# -eq 0 ] && _isFn $default && set -- ${default} ${prevArgs[@]}
-        elif [[ -f ./${fn} ]]; then # allow a file without extension
+        elif [[ -f ./${fn} && -x ./${fn} ]]; then # allow a file without extension and executable permissions
             prevArgs+=($1)
             shift
             args=(${@:-})
-            exec ${fn} $@ # execute the file
+            exec ./${fn} $@ # execute the file
             break
         elif [[ -d ./${fn} ]]; then # allow a directory
             cd ./$fn
@@ -122,19 +129,23 @@ $default() {
 EOF
             _isFn && continue
             set -- '-' "Could not generate default function"
-        elif [ $# -gt 1 ]; then # shift arguments
+        elif [[ $# -gt 1 ]]; then # shift arguments
             prevArgs+=($1)
             shift
-        elif [[ -f ./${default}${ext} ]] && [[ ${dir: $(( -${#fn}-1 ))} = /$fn ]]; then
+        elif [[ -r ./${default}${ext} && ${dir: $(( -${#fn}-1 ))} = /$fn ]]; then # allow a default fallback in a directory
             prevArgs+=($1)
             set -- ${default:-usage} ${prevArgs[@]}
-        elif [ $# -eq 1 ] && ! [[ ${#files[@]} -eq 0 ]]; then
-            set -- '-' "\
-'$fn' could not be used to call a function in file(s): $(echo ${!files[@]})"
-        elif [ $# -eq 1 ] && [[ -v dir ]]; then
-            set -- '-' "'$fn' could not be used to call a function in directory $dir"
+        elif [[ $# -eq 1 && ! ${#files[@]} -eq 0 ]]; then
+            set -- '-' \
+            "Argument '$fn' could not be used to call a function in file(s):" \
+            ${!files[@]} \
+            "Below options are valid:" \
+            $(_listFunctions)
         else
-            set -- '-'  "'$fn' could not be used as file, function or directory"
+            set -- '-' \
+            "Argument '$fn' could not be used as file, function or directory." \
+            "Below options are valid:" \
+            $(printf '  %s\n' $(_listFiles))
         fi
     done
     return;

package/gabr.sh

@@ -16,7 +16,7 @@
 # @exitcode >0 On failure
 #
 # we can source linux version if available (has minor benefits like file checking)
-if [ ${BASH_VERSION:0:1} -ge 4 ] && [ ${BASH_VERSION:2:1} -ge 4 ] && [[ -r "${BASH_SOURCE}.linux" || -r "${BASH_SOURCE%\.sh*}.linux.sh" ]]; then
+if { [ ${BASH_VERSION:0:1} -ge 5 ] || { [ ${BASH_VERSION:0:1} -eq 4 ] && [ ${BASH_VERSION:2:1} -ge 4 ]; }; } && [[ -r "${BASH_SOURCE}.linux" || -r "${BASH_SOURCE%\.sh*}.linux.sh" ]]; then
     . "${BASH_SOURCE%\.sh*}.linux$([ "${BASH_SOURCE}" != "${BASH_SOURCE%\.sh*}" ] && echo .sh)"
 else
 function gabr() {  # A function to run other functions 
@@ -57,16 +57,18 @@ ${prevArgs[@]} [directory | file] function [arguments] -- A function to call oth
     ! [ ${#prevArgs[@]} -eq 0 ] && local -a prevArgs=()
     # helpers
     _isFn(){    [ "$(type -t ${1:-$fn})" = 'function' ]; }
-    _canSource(){ 
-        for _file in ${files[@]:-}; do
-            if [ $_file = $file ]; then
-                [ $_file = $file ]
-            fi
-        done
-     }
     _isDebug(){ [ -n "${GABR_DEBUG_MODE:-}" ]; }
     _isRoot()( [ "${dir:0:${#root}}" = "$root" ] || [ "$root" = "$PWD" ] && [ "." = "." ]; )
-    
+    _listFiles(){ 
+        find . -maxdepth 3 -type f \( -iname "*${ext:-'.sh'}" ! -iname ".*" \) ! -path "*/.*"; # hide dot prefix
+    }
+    _listFunctions(){ 
+        declare -f -F   |
+            tr ' ' '\n' |
+            sort        |
+            uniq -u     |
+            awk '! /^_/{print $0}' # hide underscore prefix
+    }
     # begin processing arguments
     if [ $# -eq 0 ]; then
         set -- $default
@@ -91,17 +93,15 @@ ${prevArgs[@]} [directory | file] function [arguments] -- A function to call oth
             ${fn} ${@:-}; # call the function
             _isDebug && set +x
             break
-        elif [ -f "./${fn}${ext}" ]; then # allow a file with extension
+        elif [ ${#fn} -ge 2 ] && [ "${fn:0:2}" = './' ]; then  # allow redundant ./ in arguments
+            shift
+            set - ${fn:2} ${@:-}
+        elif [ ${#fn} -ge ${#ext} ] && [ "${fn:$(( ${#fn}-${#ext} ))}" = "${ext}" ]; then  # allow redundant .sh in arguments
+            shift
+            set - ${fn:0:$(( ${#fn}-${#ext} ))} ${@:-}
+        elif [ -r "./${fn}${ext}" ]; then # allow a file with extension and read permissions
             file=${fn}${ext}
-            if ! _canSource; then
-                set -- '-' "'$file' is already sourced by argument $fn" 1>&2
-                continue
-            fi
             files+=($file)
-            if ! [ -r "${file:-}" ]; then
-                set -- '-' "'$file' is not a readable file" 1>&2
-                continue
-            fi
             prevArgs+=($1)
             shift
             args=(${@:-})
@@ -110,11 +110,11 @@ ${prevArgs[@]} [directory | file] function [arguments] -- A function to call oth
             _isDebug && set +x
             _isFn && set -- $fn ${@:-}
             [ $# -eq 0 ] && set -- ${default} ${prevArgs[@]}
-        elif [ -f "./${fn}" ]; then # allow a file without extension
+        elif [ -f "./${fn}" ] && [ -x "./${fn}" ]; then # allow a file without extension and executable permissions
             prevArgs+=($1)
             shift
             args=(${@:-})
-            exec ${fn} $@ # execute the file
+            exec ./${fn} $@ # execute the file
             break
         elif [ -d "./${fn}" ]; then # allow a directory
             cd ./$fn
@@ -135,16 +135,20 @@ EOF
         elif [ $# -gt 1 ]; then # shift arguments
             prevArgs+=($1)
             shift
-        elif [ $# -eq 1 ] && [ -f "./${default}${ext}" ] && [ "${dir: $(( -${#fn}-1 ))}" = "/$fn" ]; then
+        elif [ $# -eq 1 ] && [ -r "./${default}${ext}" ] && [ "${dir: $(( -${#fn}-1 ))}" = "/$fn" ]; then
             prevArgs+=($1)
             set -- ${default:-usage} ${prevArgs[@]}
         elif [ $# -eq 1 ] && ! [ ${#files[@]} -eq 0 ]; then
-            set -- '-' "\
-'$fn' could not be used to call a function in file(s): $(echo ${!files[@]})"
-        elif [ $# -eq 1 ] && [ -n "${dir:-}" ]; then
-            set -- '-' "'$fn' could not be used to call a function in directory $dir"
+            set -- '-' \
+            "Argument '$fn' could not be used to call a function in file(s):" \
+            ${files[@]} \
+            "Below options are valid:" \
+            $(_listFunctions)
         else
-            set -- '-'  "'$fn' could not be used as file, function or directory"
+            set -- '-' \
+            "Argument '$fn' could not be used as file, function or directory." \
+            "Below options are valid:" \
+            $(printf '  %s\n' $(_listFiles))
         fi
     done
     return;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gabr",
-  "version": "2.0.13",
+  "version": "2.1.1",
   "description": "Make Bash functions accessible with gabr.sh",
   "main": "gabr.sh",
   "scripts": {
@@ -32,7 +32,6 @@
   },
   "homepage": "https://github.com/nicobrinkkemper/gabr.sh#readme",
   "devDependencies": {
-    "release-it": "^12.3.0"
-  },
-  "dependencies": {}
+    "release-it": "^19.2.4"
+  }
 }

package/say.sh

@@ -0,0 +1,10 @@
+printf '%s' 'saying '
+function hi(){
+    printf '%s' 'hi'
+}
+function greet(){
+    printf '%s' 'greetings'
+}
+function bye(){
+    printf '%s' 'bye'
+}

package/start/start.sh

@@ -0,0 +1,11 @@
+printf '%s' 'saying '
+function hi(){
+    printf '%s' 'hi'
+}
+function greet(){
+    printf '%s' 'greetings'
+}
+
+function start(){
+    printf '%s' 'start'
+}

package/test/gabr.bats

@@ -20,20 +20,23 @@ if ! [ -f "./gabr.sh" ]; then
 fi
 
 
-@test "Gabr can find a file and run it's functions" {
+@test "Gabr can find a file and run its functions" {
     echo "\
-printf %s sourced
-function sayhi(){
-    printf %s hi
+printf '%s' 'saying '
+function hi(){
+    printf '%s' 'hi'
 }
-function saybye(){
-    printf %s bye
-}" > ./sayhi.sh
+function greet(){
+    printf '%s' 'greetings'
+}
+function bye(){
+    printf '%s' 'bye'
+}" > ./say.sh
     source ./gabr.sh
-    local result="$(gabr ./sayhi sayhi) $(gabr ./sayhi) $(gabr sayhi) $(gabr ./sayhi saybye)"
+    local result="$(gabr say hi) $(gabr ./say greet) $(gabr ./say.sh bye)"
     echo failed-result="\"${result}\"" 1>&2
     trap 'rm -f ./sayhi.sh' RETURN
-    [ "$result"  = 'sourcedhi sourced sourcedhi sourcedbye' ]
+    [ "$result"  = 'saying hi saying greetings saying bye' ]
 }
 
 @test "Gabr errors the same return code" {
@@ -139,7 +142,7 @@ function baa()(
     [ "${output}" = "${hack}" ]
 }
 
-@test "gabr does not walk over a error" {
+@test "gabr does not walk over an error" {
     function dontwalkover()(
         return1
         echo nowido
@@ -163,10 +166,21 @@ function whatdidisay(){
     source ./gabr.sh
     run gabr whatdidisay ' jim ' " has long " " cheeks "
     debug
-    trap 'rm -f ./whatdidisay.sh' RETURN
     [ "$output"  = ' jim   has long   cheeks ' ]
 }
 
+@test "Gabr allows for redundant but more precise alternatives" {
+    source ./gabr.sh
+    run gabr whatdidisay.sh '.sh is redundant'
+    debug
+    [ "$output"  = '.sh is redundant' ]
+    run gabr ./whatdidisay.sh './ and .sh is redundant'
+    debug
+    trap 'rm -f ./whatdidisay.sh' RETURN
+    [ "$output"  = './ and .sh is redundant' ]
+}
+
+
 @test "Gabr sees tabs as separator" {
     echo "\
 function spectabular(){

package/usage.sh

@@ -8,9 +8,5 @@ Try out:
     - gabr test
     - gabr example docker test 3.2
 Usage: ${usage:-'not set'}" >&2
-    if [ -n "${GABR_ROOT:-}" ]; then
-        printf '%s\n' "\
-# You might be seeing this message because GABR_ROOT=$GABR_ROOT. It doesn't have to be set 
-to the location of this repository, but your own." >&2
-    fi
+    
 }

package/modules/bats-core/LICENSE.md

@@ -1,53 +0,0 @@
-Copyright (c) 2017 bats-core contributors
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
----
-
-* [bats-core] is a continuation of [bats]. Copyright for portions of the
-  bats-core project are held by Sam Stephenson, 2014 as part of the project
-  [bats], licensed under MIT:
-
-Copyright (c) 2014 Sam Stephenson
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-For details, please see the [version control history][commits].
-
-[bats-core]: https://github.com/bats-core/bats-core
-[bats]:https://github.com/sstephenson/bats
-[commits]:https://github.com/bats-core/bats-core/commits/master