improve MacOS compatibility

Author: sebthom

.github/workflows/build.yml

@@ -6,6 +6,10 @@ on:
     paths-ignore:
     - '**/*.md'
   pull_request:
+    paths-ignore:
+    - '**/*.md'
+  workflow_dispatch:
+    # https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/
 
 jobs:
 
@@ -39,6 +43,10 @@ jobs:
       if: startsWith(matrix.os, 'ubuntu')
       run: sudo apt-get --no-install-recommends install -y bc rng-tools
 
+    - name: Install coreutils, ioping
+      if: startsWith(matrix.os, 'macos')
+      run: brew install coreutils ioping
+
     - name: Test bash-funk
       shell: bash
       env:

docs/ansi.md

@@ -542,8 +542,6 @@ Options:
         Assigns the current cursor position to the variable with the given name.
 -d, --down [LINES] (default: '1', integer: ?-?)
         Moves the cursor n lines down.
-    --fd [NUM] (default: '1', integer: ?-?)
-        Send the ANSI sequences to the given file descriptor.
 -l, --left [COLUMNS] (default: '1', integer: ?-?)
         Move the cursor n columns forward.
     --print
@@ -570,40 +568,40 @@ Options:
 *Implementation:*
 ```bash
 if [[ $_save ]]; then
-   >&$_fd echo -en "\033[s"
+   echo -en "\033[s"
 fi
 
 if [[ $_restore ]]; then
-   >&$_fd echo -en "\033[u"
+   echo -en "\033[u"
 fi
 
 if [[ $_up ]]; then
-   >&$_fd echo -en "\033[${_up}A"
+   echo -en "\033[${_up}A"
 fi
 
 if [[ $_down ]]; then
-   >&$_fd echo -en "\033[${_up}B"
+   echo -en "\033[${_down}B"
 fi
 
 if [[ $_right ]]; then
-   >&$_fd echo -en "\033[${_right}C"
+   echo -en "\033[${_right}C"
 fi
 
 if [[ $_left ]]; then
-   >&$_fd echo -en "\033[${_left}D"
+   echo -en "\033[${_left}D"
 fi
 
 if [[ $_set ]]; then
-   >&$_fd echo -en "\033[${_set//:/;}H"
+   echo -en "\033[${_set//:/;}H"
 fi
 
 if [[ $_print || $_assign ]]; then
    local pos
-   >&$_fd echo -en "\E[6n" && read -sdR pos
+   echo -en "\E[6n" && read -sdR pos
    pos=${pos#*[}
    pos=${pos//;/:}
    if [[ $_print ]]; then
-      >&$_fd echo $pos
+      echo $pos
    fi
    if [[ $_assign ]]; then
       eval "$_assign=\"$pos\""

docs/docker.md

@@ -16,10 +16,10 @@ function -docker-debug() {
    if [[ ! -e ~/.docker-debug/docker-debug.bin ]]; then
       echo "Installing the docker-debug tool (https://github.com/zeromake/docker-debug)..."
       mkdir -p ~/.docker-debug
-      if [[ $OSTYPE =~ "darwin" ]]; then
+      if [[ $OSTYPE == "darwin"* ]]; then
          curl -Lo ~/.docker-debug/docker-debug.bin https://github.com/zeromake/docker-debug/releases/download/0.6.3/docker-debug-darwin-amd64-upx
          chmod 700 ~/.docker-debug/docker-debug.bin
-      elif [[ $OSTYPE =~ "linux" ]]; then
+      elif [[ $OSTYPE == "linux"* ]]; then
          curl -Lo ~/.docker-debug/docker-debug.bin https://github.com/zeromake/docker-debug/releases/download/0.6.3/docker-debug-linux-amd64-upx
          chmod 700 ~/.docker-debug/docker-debug.bin
       else

docs/filesystem.md

@@ -536,7 +536,7 @@ Options:
 [[ ! $_PATH ]] && _PATH=(.) || true
 
 local _ls="command ls -lAph \"${_PATH[@]}\""
-[[ ${OSTYPE} =~ "darwin" ]] && _ls="$_ls -G" || _ls="$_ls -I lost+found --color=always"
+[[ $OSTYPE == "darwin"* ]] && _ls="$_ls -G" || _ls="$_ls -I lost+found --color=always"
 eval $_ls | awk '
    BEGIN { dotDirs = ""; dirs = ""; dotFiles = ""; files = "" }
    /^total/                                                                                       { total = $0 }                    # capture total line

docs/memory.md

@@ -285,8 +285,8 @@ Options:
 *Implementation:*
 ```bash
 -alloc-mem --selftest && echo || return 1
--memfree --selftest && echo || return 1
--meminfo --selftest && echo || return 1
--memtotal --selftest && echo || return 1
+if [ -e /proc/meminfo ]; then -memfree --selftest && echo || return 1; fi
+if [ -e /proc/meminfo ]; then -meminfo --selftest && echo || return 1; fi
+if [ -e /proc/meminfo ]; then -memtotal --selftest && echo || return 1; fi
 -procmem --selftest && echo || return 1
 ```

docs/misc.md

@@ -11,8 +11,15 @@ function -timeout() {
       echo "Executes the COMMAND and aborts if it does not finish within the given TIMEOUT in seconds."
       [[ ${1:-} == "--help" ]] && return 0 || return 1
    fi
-   # see: http://mywiki.wooledge.org/BashFAQ/068
-   perl -e 'alarm shift; exec @ARGV' "$@";
+   if hash timeout 2>/dev/null; then
+      timeout "$@"
+   elif hash gtimeout 2>/dev/null; then
+      # MacOS: https://stackoverflow.com/a/21118126/5116073
+      gtimeout "$@"
+   else
+      # see: http://mywiki.wooledge.org/BashFAQ/068
+      perl -e 'alarm shift; exec @ARGV' "$@"
+   fi
 }
 ```
 
@@ -62,14 +69,14 @@ Parameters:
       Allowed options to choose from.
 
 Options:
-    --assign VARNAME 
+    --assign VARNAME
         Assigns the selected value to the variable with the given name instead of printing to stdout.
-    --default OPTION 
+    --default OPTION
         The option to pre-selected.
     -----------------------------
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -157,9 +164,9 @@ Usage: -help [OPTION]...
 Prints the online help of all bash-funk commands.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -184,9 +191,9 @@ Requirements:
   + Command 'sudo' must be available.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -217,9 +224,9 @@ Usage: -reload [OPTION]...
 Reloads bash-funk.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -249,9 +256,9 @@ Usage: -root [OPTION]...
 Starts an interactive shell as root user. Same as 'sudo -i'.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -271,9 +278,9 @@ Usage: -test-all-misc [OPTION]...
 Performs a selftest of all functions of this module by executing each function with option '--selftest'.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -301,12 +308,12 @@ Usage: -tweak-bash [OPTION]...
 Performs some usability configurations of Bash.
 
 Options:
--v, --verbose 
+-v, --verbose
         Prints additional information during command execution.
     -----------------------------
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -339,7 +346,7 @@ if [[ $- == *i* ]]; then
 fi
 
 # make ls colorful by default except on MacOS where it is not supported
-[[ ${OSTYPE} =~ "darwin" ]] || alias -- ls="command ls --color=auto"
+[[ $OSTYPE == "darwin"* ]] || alias -- ls="command ls --color=auto"
 
 #
 # aliases
@@ -408,14 +415,14 @@ Usage: -update [OPTION]...
 Updates bash-funk to the latest code from github (https://github.com/vegardit/bash-funk). All local modifications are overwritten.
 
 Options:
--r, --reload 
+-r, --reload
         Reloads the bash-funk after updating.
--y, --yes 
+-y, --yes
         Answer interactive prompts with 'yes'.
     -----------------------------
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -486,12 +493,12 @@ Parameters:
       Name of the Bash variable to check.
 
 Options:
--v, --verbose 
+-v, --verbose
         Prints additional information during command execution.
     -----------------------------
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.
@@ -529,9 +536,9 @@ Parameters:
       Number of seconds to wait.
 
 Options:
-    --help 
+    --help
         Prints this help.
-    --selftest 
+    --selftest
         Performs a self-test.
     --
         Terminates the option list.

docs/performance.md

@@ -54,7 +54,7 @@ $ -cpu-count
 
 *Implementation:*
 ```bash
-[[ "$OSTYPE" != "darwin"* ]] && grep processor /proc/cpuinfo | wc -l || sysctl -n hw.logicalcpu
+[[ $OSTYPE != "darwin"* ]] && grep processor /proc/cpuinfo | wc -l || sysctl -n hw.logicalcpu
 ```
 
 
@@ -97,7 +97,7 @@ case $_mode in
          echo "-cpu-perf: Required command '${_mode#dd-}' is not available."
          return 1
       fi
-      [[ "$OSTYPE" == "darwin"* ]] && local _bs=1m || local _bs=1M
+      [[ $OSTYPE == "darwin"* ]] && local _bs=1m || local _bs=1M
       dd if=/dev/zero bs=$_bs count=1024 2> >(head -3 | tail -1) > >(${_mode#dd-} >/dev/null)
      ;;
 esac