Convert to pure shellfu library

Move satcmd to other repo and distribute saturnin as a stand-alone
shellfu library.  Users can import just the library instead of
embedding it inside their source tree, which enables them to delegate
part of the job to package manager.

.gitignore

 .mkit/autoclean
-satcmd-*.tar.gz
+shellfu-bash-saturnin-*.tar.gz
 artifacts

mkit.ini

 [project]
     version     = 0.3.3
     codename    = StrycF
-    name        = SATCMD
+    name        = Saturnin
     tagline     = Spirit of your toolbox
-    pkgname     = satcmd
+    pkgname     = shellfu-bash-saturnin
     relsrc      = master
     reldst      = last
 
     PREFIX = /usr/local
 
 [roots]
-    bin     = [ENV:PREFIX]/bin
-    libexec = [ENV:PREFIX]/libexec/satcmd
-    share   = [ENV:PREFIX]/share/satcmd
-    doc     = [ENV:PREFIX]/share/doc/satcmd
-    etc     = /etc/satcmd
-    etc_bc  = /etc/bash_completion.d
-
-[tokens]
-    __SATURNIN_CACHE_HOME__     = $HOME/.cache/satcmd
-    __SATURNIN_CONFIG_USER__    = $HOME/.satcmd
-    __SATURNIN_CONFIG_LOCAL__   = [roots:etc]
-    __SATURNIN_LIBEXEC__        = [roots:libexec]
-    __SATURNIN_SHARE__          = [roots:share]
-    __SATURNIN_SHELLFU_DIR__    = [roots:share]/shellfu
-
-[modes]
-    bin     = 755
-    libexec = 755
-    share   = 644
+    sfmod   = [ENV:PREFIX]/share/shellfu/include-bash
 
 [files]
-    bin = src/bin/app satcmd
     doc = README.md
-    etc_bc = src/complete.bash          satcmd.bash
-    libexec = src/libexec/satcmd-dump
-    libexec = src/libexec/satcmd-echo
-    share = src/ini.d/main/echo.ini     ini.d/main/echo.ini
-    share = src/shellfu/saturnin.sh     shellfu/saturnin.sh
+    sfmod = src/saturnin.sh

packaging/debian/changelog

-satcmd (__MKIT_PROJ_VERSION__-1) UNRELEASED; urgency=medium
+shellfu-bash-saturnin (__MKIT_PROJ_VERSION__-1) UNRELEASED; urgency=medium
 
   * Initial release. (Closes: #XXXXXX)
 

packaging/debian/control

-Source: satcmd
+Source: shellfu-bash-saturnin
 Maintainer: Alois Mahdal <netvor@vornet.cz>
-Vcs-Browser: http://git.vornet.cz/cgit/saturnin.git/
+Vcs-Browser: http://git.vornet.cz/cgit/shellfu-bash-saturnin.git/
 Section: misc
 Priority: extra
 Standards-Version: 3.9.2
 Build-Depends: debhelper (>= 9)
 
-Package: satcmd
+Package: shellfu-bash-saturnin
 Architecture: all
 Depends: bash, shellfu-bash, shellfu-bash-core, shellfu-bash-extras
 Description: __MKIT_PROJ_TAGLINE__
  herd of untamed undocumented and hard-to-share scripts, with help of
  saturnin you can easily create and package a meta-command with a set
  of discoverable and maintainable sub-commands.
- .
- This package contains a demo meta-command built with saturnin; you can
- also re-use the source as template for your new toolkit.
 
 # control file built with MKit __MKIT_SELF_VERSION__

packaging/debian/satcmd.install

-/etc/bash_completion.d/satcmd.bash
-/usr/local/bin/satcmd
-/usr/local/libexec/satcmd/satcmd-dump
-/usr/local/libexec/satcmd/satcmd-echo
-/usr/local/share/doc/satcmd/README.md
-/usr/local/share/satcmd/ini.d/main/echo.ini
-/usr/local/share/satcmd/shellfu/saturnin.sh

packaging/debian/shellfu-bash-saturnin.install

+/usr/local/share/shellfu/include-bash/saturnin.sh

packaging/template.spec

 saturnin you can easily create and package a meta-command with a set
 of discoverable and maintainable sub-commands.
 
-This package contains a demo meta-command built with saturnin; you can
-also re-use the source as template for your new toolkit.
-
 %prep
 %setup -q
 
 %make_install
 
 %files
-%config %{_sysconfdir}/bash_completion.d/satcmd.bash
-%dir /usr/local/libexec/satcmd
-%dir /usr/local/share/satcmd
-%dir /usr/local/share/satcmd/ini.d
-%dir /usr/local/share/satcmd/ini.d/main
-%dir /usr/local/share/satcmd/shellfu
-%doc /usr/local/share/doc/satcmd/README.md
-/usr/local/bin/satcmd
-/usr/local/libexec/satcmd/satcmd-dump
-/usr/local/libexec/satcmd/satcmd-echo
-/usr/local/share/satcmd/ini.d/main/echo.ini
-/usr/local/share/satcmd/shellfu/saturnin.sh
+/usr/local/share/shellfu/include-bash/saturnin.sh
 
 
 %changelog

src/bin/app.skel

-#!/bin/bash
-
-. "$(shellfu-get path)" || exit 3
-
-#
-# =====BEGIN BUILT PART=====
-#
-
-#shellcheck disable=SC2034
-{
-    SATURNIN_APP_CODENAME="__MKIT_PROJ_CODENAME__"
-    SATURNIN_APP_TAGLINE="__MKIT_PROJ_TAGLINE__"
-    SATURNIN_APP_VERSION="__MKIT_PROJ_VERSION__"
-    SATURNIN_APP_GIT_HASH="__MKIT_PROJ_GIT_LASTHASH__"
-    SATURNIN_CACHE_HOME="__SATURNIN_CACHE_HOME__"
-    SATURNIN_LIBEXEC="__SATURNIN_LIBEXEC__"
-    SATURNIN_LIBEXEC_PREFIX="__MKIT_PROJ_PKGNAME__-"
-    SHELLFU_PATH="__SATURNIN_SHELLFU_DIR__"
-    PRETTY_USAGE="subcommand"
-}
-
-shellfu import saturnin
-
-SATURNIN_CONF_PATH="$(
-    saturnin__conf_mkpath \
-        __SATURNIN_CONFIG_USER__/ini.d \
-        __SATURNIN_CONFIG_USER__ \
-        __SATURNIN_CONFIG_LOCAL__ \
-        __SATURNIN_SHARE__/ini.d
-)"
-
-#
-# =====END BUILT PART=====
-#
-
-export SATURNIN_CONF_PATH SHELLFU_PATH PRETTY_USAGE \
-       SATURNIN_CACHE_HOME
-
-saturnin__main "$@"

src/complete.bash

-#!/bin/bash
-
-__SATURNIN_COMPLETE_CMDNAME=satcmd
-
-#shellcheck disable=SC2016
-__SATURNIN_COMPLETE_CODETMPL='
-__%s() {
-    local cur opts sopts
-    COMPREPLY=()
-    cur="${COMP_WORDS[COMP_CWORD]}"
-    sopts="-d -h -v"
-    opts="--help --verbose --debug --version --version-semver"
-    case "$cur" in
-        -*)
-            COMPREPLY=(
-                $(compgen -W "$sopts $opts" -- "${cur}")
-            )
-            ;;
-        --*)
-            COMPREPLY=(
-                $(compgen -W "$opts" -- "${cur}")
-            )
-            ;;
-        *)
-            COMPREPLY=(
-                $(compgen -W "$(%s _ls_sc)" "${cur}")
-            )
-    esac
-}'
-
-eval "$(
-    #shellcheck disable=SC2059
-    printf "$__SATURNIN_COMPLETE_CODETMPL" \
-        $__SATURNIN_COMPLETE_CMDNAME \
-        $__SATURNIN_COMPLETE_CMDNAME
-)"
-
-complete -F "__$__SATURNIN_COMPLETE_CMDNAME" "$__SATURNIN_COMPLETE_CMDNAME"

src/ini.d/main/echo.ini

-
-[echo]
-
-    #
-    # default prefix
-    #
-    prefix = so:

src/libexec/satcmd-dump

-#!/bin/bash
-
-. "$(shellfu-get path)" || exit 3
-
-env | sort | xargs -L 1 satcmd echo

src/libexec/satcmd-echo

-#!/bin/bash
-
-. "$(shellfu-get path)" || exit 3
-
-shellfu import saturnin
-
-SATCMD_ECHO__PREFIX="${SATCMD_ECHO__PREFIX:-$(saturnin__conf "echo.prefix")}"
-
-echo -n "$SATCMD_ECHO__PREFIX"
-echo "$@"

src/shellfu/saturnin.sh → src/saturnin.sh

 shellfu import inigrep
 shellfu import pretty
 
+
+#
+# Git commit hash of application source tree
+#
+# This is supposed to be set by your build scripts when building your
+# application.  The string is returned by calling your meta-command
+# with option --saturnin-app-git-hash.
+#
+# Look for 'satcmd' template for a working example.
+#
+SATURNIN_APP_GIT_HASH=${SATURNIN_APP_GIT_HASH:-}
+
+#
+# Your application version
+#
+# This is supposed to be set by your build scripts when building your
+# application.  The string is returned by calling your meta-command
+# with options --version, --version-semver or  --saturnin-app-version.
+#
+# Look for 'satcmd' template for a working example.
+#
+SATURNIN_APP_VERSION=${SATURNIN_APP_VERSION:-}
+
+#
+# Path to user cache
+#
+SATURNIN_CACHE_HOME=${SATURNIN_CACHE_HOME:-}
+
 #
 # Path where saturnin__conf should look for files
 #
 #
 SATURNIN_CONF_SUFFIX="${SATURNIN_CONF_SUFFIX:-.ini}"
 
+#
+# Directory where to look for subcommands
+#
+# Files here starting with $SATURNIN_LIBEXEC_PREFIX are considered subcommands
+#
+SATURNIN_LIBEXEC="${SATURNIN_LIBEXEC:-}"
+
+#
+# Subcommand file prefix
+#
+# This is recommended to be set to meta-command name plus dash.  For example,
+# if your meta-command is `mykit`, this should be set to `mykit-`.
+#
+SATURNIN_LIBEXEC_PREFIX="${SATURNIN_LIBEXEC_PREFIX:-}"
+
+
 saturnin__conf() {
     #
     # inigrep smart loader
     #
     local key=${1#--saturnin-get-}
     case "$key" in
-        shellfu-path)   echo "$SHELLFU_PATH"                ;;
         saturnin-conf-path) echo "$SATURNIN_CONF_PATH"      ;;
         app-git-hash)   echo "$SATURNIN_APP_GIT_HASH"       ;;
         app-version)    echo "$SATURNIN_APP_VERSION"        ;;
 }
 
 saturnin__main() {
+    #
+    # Main meta-command entry function
+    #
+    # After setting all mandatory environment variables, call this from
+    # your main meta-command script.
+    #
     local subcommand
+    test -n "$SATURNIN_CACHE_HOME"     || die "SATURNIN_CACHE_HOME is not set"
+    test -n "$SATURNIN_LIBEXEC"        || die "SATURNIN_LIBEXEC is not set"
+    test -n "$SATURNIN_LIBEXEC_PREFIX" || die "SATURNIN_LIBEXEC_PREFIX is not set"
     while true; do case $1 in
         -d|--debug)     export PRETTY_DEBUG=true;   shift ;;
         -v|--verbose)   export PRETTY_VERBOSE=true; shift ;;
         *)              break;                      ;;
     esac done
     subcommand="$1"; shift
-    debug -v SHELLFU_PATH SATURNIN_LIBEXEC SATURNIN_CONF_PATH
+    debug -v SATURNIN_LIBEXEC SATURNIN_CONF_PATH
     case "$subcommand" in
         conf)    saturnin__conf "$@"                ;;
         _ls_sc)  saturnin__lssc                     ;;

tests/TF_HEADER

-#!/bin/sh
-
-echo "version = $(satcmd --version-semver)"

tests/cli/TF_RUN

 . "$TF_DIR/include/subtest.sh"
 . "$TF_DIR/include/tools.sh"
 
+PRETTY=plain
+
+. "$(shellfu-get path)" || tf_exit_error "failed to init shellfu"
+shellfu import saturnin  || tf_exit_error "failed to import saturnin"
+
 tf_enum_subtests() {
     echo usage
 }
     local name=$1
     local cmd
     local o_err="oracle/$name.stderr"
+    SATURNIN_CACHE_HOME=chm
+    SATURNIN_LIBEXEC=lex
+    SATURNIN_LIBEXEC_PREFIX=lexpfx-
+    mkdir lex
+    touch lex/lexpfx-{foo,bar,baz}
+    chmod +x lex/lexpfx-{foo,bar,baz}
     case $name in
-        usage)  tf_testflt -n "$name" -E "$o_err" -S 2 satcmd ;;
+        usage)  tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main ;;
     esac
 }
 

tests/cli/oracle/usage.stderr

 usage:
-  satcmd [options] COMMAND [ARG...]
+  saturnin__usage [options] COMMAND [ARG...]
 
 options:
   -d, --debug    turn on debugging
 
 commands:
   conf
-  dump
-  echo
+  bar
+  baz
+  foo

tests/saturnin-conf/TF_RUN

 . "$TF_DIR/include/tools.sh"
 
 . "$(shellfu-get path)" || tf_exit_error "failed to init shellfu"
-SHELLFU_PATH=$(satcmd --saturnin-get-shellfu-path)
 shellfu import saturnin  || tf_exit_error "failed to import saturnin"
 
 tf_enum_subtests() {

tests/saturnin-get/TF_RUN

 . "$TF_DIR/include/subtest.sh"
 . "$TF_DIR/include/tools.sh"
 
+PRETTY=plain
+
+. "$(shellfu-get path)" || tf_exit_error "failed to init shellfu"
+shellfu import saturnin  || tf_exit_error "failed to import saturnin"
+
 tf_enum_subtests() {
     echo unknown
     echo unknown_dash1
     echo unknown_dash2
     echo unknown_none
     echo unknown_same
-    echo shellfu_path
     echo saturnin_conf_path
     echo app_version
     echo cache_home
 # warn "unknown devel key: $key"
 }
 
+rndtoken() {
+    head -c 100 /dev/urandom | md5sum | head -c 7
+}
+
 ckfuzzy() {
     local es
     local out="result/$name.stdout"
     mkdir -p result
     cat > "$out"
     case "$name" in
-        shellfu_path)   grep -q '^/usr/'                  ;;
-        saturnin_conf_path)  tr : '\n' | grep -q '^/usr/' ;;
+        saturnin_conf_path)  grep -qx "$SATURNIN_CONF_PATH" ;;
         app_version)    grep -q '[0-9]'                   ;;
-        cache_home)     grep -qx '/home/.*/.cache/satcmd' ;;
-        libexec)        grep -q '^/usr/'                  ;;
-        libexec_prefix) grep -q '.'                       ;;
+        cache_home)     grep -qx "$SATURNIN_CACHE_HOME"   ;;
+        libexec)        grep -qx "$SATURNIN_LIBEXEC"      ;;
+        libexec_prefix) grep -qx "$SATURNIN_LIBEXEC_PREFIX" ;;
     esac <"$out"; es=$?
     if test $es -gt 0;
     then
 tf_do_subtest() {
     local name=$1
     local o_err="oracle/$name.stderr"
+    SATURNIN_APP_VERSION=1.2.3
+    SATURNIN_CACHE_HOME=chm_$(rndtoken)
+    SATURNIN_CONF_PATH=cp_$(rndtoken)
+    SATURNIN_LIBEXEC=lex_$(rndtoken)
+    SATURNIN_LIBEXEC_PREFIX=lexpfx_$(rndtoken)
     case $name in
-        unknown)        tf_testflt -n "$name" -E "$o_err" -S 2 satcmd --saturnin-get-foo             ;;
-        unknown_dash1)  tf_testflt -n "$name" -E "$o_err" -S 2 satcmd --saturnin-get--               ;;
-        unknown_dash2)  tf_testflt -n "$name" -E "$o_err" -S 2 satcmd --saturnin-get---              ;;
-        unknown_none)   tf_testflt -n "$name" -E "$o_err" -S 2 satcmd --saturnin-get-                ;;
-        unknown_same)   tf_testflt -n "$name" -E "$o_err" -S 2 satcmd --saturnin-get---saturnin-get  ;;
-        shellfu_path)   satcmd --saturnin-get-shellfu-path    | ckfuzzy ;;
-        saturnin_conf_path)   satcmd --saturnin-get-saturnin-conf-path | ckfuzzy ;;
-        app_version)    satcmd --saturnin-get-app-version     | ckfuzzy ;;
-        cache_home)     satcmd --saturnin-get-cache-home      | ckfuzzy ;;
-        libexec)        satcmd --saturnin-get-libexec         | ckfuzzy ;;
-        libexec_prefix) satcmd --saturnin-get-libexec-prefix  | ckfuzzy ;;
+        unknown)        tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main --saturnin-get-foo             ;;
+        unknown_dash1)  tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main --saturnin-get--               ;;
+        unknown_dash2)  tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main --saturnin-get---              ;;
+        unknown_none)   tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main --saturnin-get-                ;;
+        unknown_same)   tf_testflt -n "$name" -E "$o_err" -S 2 saturnin__main --saturnin-get---saturnin-get  ;;
+        saturnin_conf_path)   saturnin__main --saturnin-get-saturnin-conf-path | ckfuzzy ;;
+        app_version)    saturnin__main --saturnin-get-app-version     | ckfuzzy ;;
+        cache_home)     saturnin__main --saturnin-get-cache-home      | ckfuzzy ;;
+        libexec)        saturnin__main --saturnin-get-libexec         | ckfuzzy ;;
+        libexec_prefix) saturnin__main --saturnin-get-libexec-prefix  | ckfuzzy ;;
     esac
 }