Update own dogfood

utils/mkit/include/build.sh

@@ -81,6 +81,7 @@ _expand_tokens() {
         done
         echo "s|__MKIT_PROJ_NAME__|$(ini 1value project:name | _qfs)|g;"
         echo "s|__MKIT_PROJ_CODENAME__|$(ini 1value project:codename | _qfs)|g;"
+        echo "s|__MKIT_PROJ_LICENSE__|$(ini 1value project:license | _qfs)|g;"
         echo "s|__MKIT_PROJ_PKGNAME__|$(ini 1value project:pkgname | _qfs)|g;"
         echo "s|__MKIT_PROJ_TAGLINE__|$(ini 1value project:tagline | _qfs)|g;"
         echo "s|__MKIT_PROJ_MAINTAINER__|$(ini 1value project:maintainer | _qfs)|g;"

utils/mkit/include/ini.sh

@@ -90,7 +90,7 @@ _ini_lskeys() {
     # List keys from a section
     #
     local sct=$1    # section of interest
-    _ini_grepsec "$sct" | cut -d= -f1 | sort | uniq
+    _ini_grepsec "$sct" | cut -d= -f1 | awk '!x[$0]++'
 }
 
 _ini_maybe_expand() {

utils/mkit/include/vars.sh

@@ -57,4 +57,4 @@ MKIT_PROJ_PKGNAME=""
 #
 # This MKit version
 #
-MKIT_VERSION=0.0.20+devel.g7c137e5
+MKIT_VERSION=0.0.21+HEAD.g47f8848

utils/mkit/newstub → utils/mkit/stub

@@ -21,21 +21,25 @@ MKIT_DIR=${MKIT_DIR:-$(dirname "$0")}
 
 init_core
 
-declare -A MKIT_INIT_LICENSES
-MKIT_INIT_LICENSES[GPLv1]="http://www.gnu.org/licenses/old-licenses/gpl-1.0.md"
-MKIT_INIT_LICENSES[GPLv2]="http://www.gnu.org/licenses/old-licenses/gpl-2.0.md"
-MKIT_INIT_LICENSES[GPLv3]="http://www.gnu.org/licenses/gpl-3.0.md"
-MKIT_INIT_LICENSES[LGPLv2]="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.md"
-MKIT_INIT_LICENSES[LGPLv3]="http://www.gnu.org/licenses/lgpl-3.0.md"
-MKIT_INIT_LICENSES[AGPLv3]="http://www.gnu.org/licenses/agpl-3.0.md"
-MKIT_INIT_LICENSES[FDLv1.3]="http://www.gnu.org/licenses/fdl-1.3.md"
-MKIT_INIT_LICENSES[FDLv1.2]="http://www.gnu.org/licenses/old-licenses/fdl-1.2.md"
-MKIT_INIT_LICENSES[FDLv1.1]="http://www.gnu.org/licenses/old-licenses/fdl-1.1.md"
+mkit_import ini
+
+declare -A MKIT_STUB_LICENSES
+MKIT_STUB_LICENSES[GPLv1]="http://www.gnu.org/licenses/old-licenses/gpl-1.0.md"
+MKIT_STUB_LICENSES[GPLv2]="http://www.gnu.org/licenses/old-licenses/gpl-2.0.md"
+MKIT_STUB_LICENSES[GPLv3]="http://www.gnu.org/licenses/gpl-3.0.md"
+MKIT_STUB_LICENSES[LGPLv2]="http://www.gnu.org/licenses/old-licenses/lgpl-2.1.md"
+MKIT_STUB_LICENSES[LGPLv3]="http://www.gnu.org/licenses/lgpl-3.0.md"
+MKIT_STUB_LICENSES[AGPLv3]="http://www.gnu.org/licenses/agpl-3.0.md"
+MKIT_STUB_LICENSES[FDLv1.3]="http://www.gnu.org/licenses/fdl-1.3.md"
+MKIT_STUB_LICENSES[FDLv1.2]="http://www.gnu.org/licenses/old-licenses/fdl-1.2.md"
+MKIT_STUB_LICENSES[FDLv1.1]="http://www.gnu.org/licenses/old-licenses/fdl-1.1.md"
 
 
 deploy() {
     local file=$1       # which known file?
     local any_name=${NiceName:-$PackageName}
+    local tmp
+    tmp=$(mktemp -t mkit.stub.deploy.XXXXXXX)
     mkdir -p "$(dirname "$file")"
     case $file in
 
@@ -62,11 +66,9 @@ deploy() {
             fi
             ;;
 
-        mkit.ini)
-            echo "#mkit version=$MKIT_VERSION"
-            echo ""
+        */mkit.ini|mkit.ini)
             echo "[project]"
-            echo "    version     = 0.0.0"
+            echo "    version     = $Version"
             test -n "$Codename"     && echo "    codename    = $Codename"
             test -n "$NiceName"     && echo "    name        = $NiceName"
             test -n "$Tagline"      && echo "    tagline     = $Tagline"
@@ -75,37 +77,48 @@ deploy() {
             test -n "$VcsBrowser"   && echo "    vcs_browser = $VcsBrowser"
             test -n "$RelSrc"       && echo "    relsrc      = $RelSrc"
             test -n "$RelDst"       && echo "    reldst      = $RelDst"
+            if updating; then
+                remake_section dist
+                remake_section ENV
+                remake_section roots
+                remake_section tokens
+                remake_section modes
+                remake_section files
+            else
+                echo ""
+                echo "[dist]"
+                $MkLicense  && echo "    tarball = LICENSE.md"
+                $MkMakefile && echo "    tarball = Makefile"
+                $MkReadme   && echo "    tarball = README.md"
+                echo "    tarball = mkit.ini"
+                $MkPackaging && echo "    tarball = packaging"
+                echo "    tarball = src"
+                echo "    tarball = tests"
+                echo "    tarball = utils"
+                $MkPackaging && echo "    rpmstuff = packaging/template.spec"
+                $MkPackaging && echo "    debstuff = packaging/debian"
+                echo ""
+                echo "[ENV]"
+                echo "    PREFIX = /usr/local"
+                echo ""
+                echo "[roots]"
+                echo "    bin     = [ENV:PREFIX]/bin"
+                echo "    doc     = [ENV:PREFIX]/share/doc/$PackageName"
+                echo ""
+                echo "[tokens]"
+                echo "    __BIN_DIR__ = [roots:bin]"
+                echo ""
+                echo "[modes]"
+                echo "    bin     = 755"
+                echo "    doc     = 644"
+                echo ""
+                echo "[files]"
+                echo "    bin      = src/$PackageName"
+                $MkLicense && echo "    doc      = LICENSE.md"
+                $MkReadme  && echo "    doc      = README.md"
+            fi
             echo ""
-            echo "[dist]"
-            echo "    tarball = LICENSE.md"
-            $MkMakefile && echo "    tarball = Makefile"
-            $MkReadme   && echo "    tarball = README.md"
-            echo "    tarball = mkit.ini"
-            $MkPackaging && echo "    tarball = packaging"
-            echo "    tarball = src"
-            echo "    tarball = tests"
-            echo "    tarball = utils"
-            $MkPackaging && echo "    rpmstuff = packaging/template.spec"
-            $MkPackaging && echo "    debstuff = packaging/debian"
-            echo ""
-            echo "[ENV]"
-            echo "    PREFIX = /usr/local"
-            echo ""
-            echo "[roots]"
-            echo "    bin     = [ENV:PREFIX]/bin"
-            echo "    doc     = [ENV:PREFIX]/share/doc/$PackageName"
-            echo ""
-            echo "[tokens]"
-            echo "    __BIN_DIR__ = [roots:bin]"
-            echo ""
-            echo "[modes]"
-            echo "    bin     = 755"
-            echo "    doc     = 644"
-            echo ""
-            echo "[files]"
-            echo "    bin      = src/$PackageName"
-            $MkReadme && echo "    doc      = LICENSE.md"
-            test -n "$License" && echo "    doc      = README.md"
+            echo "#mkit version=$MKIT_VERSION"
             ;;
 
         packaging/template.spec)
@@ -114,15 +127,15 @@ deploy() {
             echo 'Release:	1%{?dist}'
             echo 'Summary:	__MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
             echo ''
-            echo "License:	$License"
+            $MkLicense && echo "License:	$License"
             echo 'Source0:	%{name}-%{version}.tar.gz'
             echo ''
             echo 'BuildArch:	noarch'
             echo 'BuildRequires:	coreutils git'
-            echo 'Requires:	MKIT_NEWSTUB_REQUIRES'
+            echo 'Requires:	MKIT_STUB_REQUIRES'
             echo ''
             echo '%description'
-            echo 'MKIT_NEWSTUB_DESCRIPTION'
+            echo 'MKIT_STUB_DESCRIPTION'
             echo ''
             echo '%prep'
             echo '%setup -q'
@@ -134,7 +147,7 @@ deploy() {
             echo '%make_install'
             echo ''
             echo '%files'
-            echo 'MKIT_NEWSTUB_FILELIST'
+            echo 'MKIT_STUB_FILELIST'
             echo ''
             echo '%changelog'
             echo ''
@@ -156,9 +169,9 @@ deploy() {
             echo ''
             echo 'Package: __MKIT_PROJ_PKGNAME__'
             echo 'Architecture: all'
-            echo 'Depends: MKIT_NEWSTUB_REQUIRES'
+            echo 'Depends: MKIT_STUB_REQUIRES'
             echo 'Description: __MKIT_PROJ_NAME__ - __MKIT_PROJ_TAGLINE__'
-            echo ' MKIT_NEWSTUB_DESCRIPTION'
+            echo ' MKIT_STUB_DESCRIPTION'
             echo ''
             echo '# control file built with MKit __MKIT_SELF_VERSION__'
             ;;
@@ -196,7 +209,7 @@ deploy() {
             ;;
 
         packaging/debian/*.install)
-            echo MKIT_NEWSTUB_FILELIST
+            echo MKIT_STUB_FILELIST
             ;;
 
         src/*.skel)
@@ -206,7 +219,7 @@ deploy() {
 
         LICENSE.md)
             local url   # license URL
-            url="${MKIT_INIT_LICENSES[$License]}"
+            url="${MKIT_STUB_LICENSES[$License]}"
             curl -sf "$url" \
              || die "failed to download license: $url"
             ;;
@@ -214,13 +227,13 @@ deploy() {
         .mkit/autoclean)
             ;;
 
-        MKIT_NEWSTUB_README.md)
+        MKIT_STUB_README.md)
             echo "FINISHING MKIT CONFIGURATION"
             echo "============================"
             echo ""
             echo "Congratulations, your new project has been configured!"
             echo ""
-            echo "However, the *newstub* script is not able to figure out"
+            echo "However, the *stub* script is not able to figure out"
             echo "everything, so few things still need to be done manually."
             echo "This document will guide you throught the rest of the"
             echo "process."
@@ -278,17 +291,17 @@ deploy() {
             echo "Placeholders"
             echo "------------"
             echo ""
-            echo "At places where *newstub* script did not have way to get all"
+            echo "At places where *stub* script did not have way to get all"
             echo "information automatically, it has inserted placeholders."
             echo "You will need to go through all of these placeholders and"
             echo "replace them with proper data."
             echo ""
             echo "Please follow instructions:"
             echo ""
-            echo " 1. Look for placeholders starting with \`MKIT_NEWSTUB_\`"
+            echo " 1. Look for placeholders starting with \`MKIT_STUB_\`"
             echo "    prefix by calling this command:"
             echo ""
-            echo "        grep -lw MKIT_NEWSTUB_ -r"
+            echo "        grep -lw MKIT_STUB_ -r"
             echo ""
             echo " 2. Go through each file and locate the placeholder.  (You"
             echo "    will also see placeholders like \`__MKIT_*__\`, you can"
@@ -296,13 +309,13 @@ deploy() {
             echo ""
             echo " 3. Replace placeholder with appropriate information:"
             echo ""
-            echo "     *  \`MKIT_NEWSTUB_REQUIRES\` - Requirements of your"
+            echo "     *  \`MKIT_STUB_REQUIRES\` - Requirements of your"
             echo "        project."
             echo ""
-            echo "     *  \`MKIT_NEWSTUB_DESCRIPTION\` - Description of your"
+            echo "     *  \`MKIT_STUB_DESCRIPTION\` - Description of your"
             echo "        project (few sentences to paragraphs)."
             echo ""
-            echo "     *  \`MKIT_NEWSTUB_FILELIST\` - List of full paths to"
+            echo "     *  \`MKIT_STUB_FILELIST\` - List of full paths to"
             echo "        your files after installation."
             echo ""
             echo "    Refer to these documents for further details:"
@@ -399,7 +412,7 @@ deploy() {
             echo "Makefile"
             echo "--------"
             echo ""
-            echo "*newstub* script also created a Makefile for you, but all"
+            echo "*stub* script also created a Makefile for you, but all"
             echo "it really does is include MKit's own mkit.mk, which in turn"
             echo "only maps \`make\` targets to actual mkit script calls."
             echo "Unless your project already uses GNU Make, you should not"
@@ -413,7 +426,7 @@ deploy() {
             echo "---------"
             echo ""
             echo "Each serious project needs a serious README.  Which is why"
-            echo "*newstub* has created a 'stub' of one for you."
+            echo "*stub* has created a 'stub' of one for you."
             fi
 
             echo ""
@@ -424,13 +437,15 @@ deploy() {
             echo "Once you have reviewed everything, just delete this file!"
             ;;
 
-    esac >"$file"
+    esac >"$tmp"
+    cat "$tmp" > "$file"
+    rm "$tmp"
 }
 
 known_licenses() {
     local key
     local first=true
-    for key in "${!MKIT_INIT_LICENSES[@]}"; do
+    for key in "${!MKIT_STUB_LICENSES[@]}"; do
         $first && echo "$key"  && continue
         echo ", $key"
     done
@@ -439,8 +454,9 @@ known_licenses() {
 usage() {
     {
         echo "Usage:"
-        echo "   newstub [options] NAME"
-        echo "   newstub -L"
+        echo "   stub [options] new PKGNAME"
+        echo "   stub [options] update"
+        echo "   stub -L"
         echo ""
         echo "Options:"
         echo ""
@@ -452,6 +468,7 @@ usage() {
         echo "    -l LICENSE    your options's license (see -L)"
         echo "    -m MAINT      project maintainer's name and e-mail"
         echo "    -v URL        URL to public code browser"
+        echo "    -V VERSION    initial version (default: 0.0.0)"
         echo "    -a            enable autoclean ('make clean' after"
         echo "                  each 'make install')"
         echo "    -g            make git commits before and adter"
@@ -462,7 +479,7 @@ usage() {
         echo "    -P            skip creating packaging templates"
         echo "    -L            list know licenses and exit"
         echo ""
-        echo "NAME should be packaging-friendly name, ie. consist"
+        echo "PKGNAME should be packaging-friendly name, ie. consist"
         echo "only of small letters, numbers, underscore and dash."
         echo "For your 'real' name, use NICENAME, which can be any"
         echo "string."
@@ -478,10 +495,10 @@ confirm() {
         echo "current codebase.  At least following files will be"
         echo "created or overwritten:"
         echo ""
-        $MkPackaging        && echo " *  'packaging' directory (pass -P to avoid)"
-        $MkMakefile         && echo " *  'Makefile' (pass -M to avoid)"
-        $MkReadme           && echo " *  'README.md' (pass -R to avoid)"
-        test -n "$License"  && echo " *  'LICENSE.md' (omit -l to avoid)"
+        $MkPackaging    && echo " *  'packaging' directory (pass -P to avoid)"
+        $MkMakefile     && echo " *  'Makefile' (pass -M to avoid)"
+        $MkReadme       && echo " *  'README.md' (pass -R to avoid)"
+        $MkLicense      && echo " *  'LICENSE.md' (omit -l to avoid)"
         echo " *  'mkit.ini'"
         echo ""
         read -p "Type 'yes' to proceed: " -r response
@@ -497,20 +514,25 @@ mkcommit_backup() {
      || { warn "nothing to back up"; return 0; }
     git add .                           || return
     git rm -r --cached utils/mkit       || return
-    git commit -m "WIP [mkit/newstub] backup"   || return
+    git commit -m "WIP [mkit/stub] backup" || return
 }
 
 mkcommit_mkit_code() {
     git ls-files --others \
       | grep -q -e '^utils/mkit$' -e '^utils/mkit/' \
      || return 0
-    git add utils/mkit                                         || return
-    git commit -m "WIP [mkit/newstub] Add MKit version v$MKIT_VERSION" || return
+    git add utils/mkit || return
+    git commit -m "WIP [mkit/stub] Add MKit version v$MKIT_VERSION" || return
 }
 
 mkcommit_mkit_conf() {
-    git add .                                                  || return
-    git commit -m "WIP [mkit/newstub] Add MKit configuration stub" || return
+    local msg       # commit message (the important art
+    git add . || return
+    case $Action in
+        new)    msg="Add MKit configuration stub" ;;
+        update) msg="Update MKit configuration"   ;;
+    esac
+    git commit -m "WIP [mkit/stub] $msg" || return
 }
 
 deploy_packaging() {
@@ -526,6 +548,69 @@ deploy_packaging() {
     deploy packaging/template.spec
 }
 
+init_from_existing() {
+    #
+    # Initialize variables from old mkit.ini
+    #
+    test -f "$MKIT_INI" \
+     || die "mkit.ini not found; aborting update: $MKIT_INI"
+    user_gave Codename    || Codename=$(ini_raw1v project:codename)
+    user_gave License     || License=$(ini_raw1v project:license)
+    user_gave Maintainer  || Maintainer=$(ini_raw1v project:maintainer)
+    user_gave NiceName    || NiceName=$(ini_raw1v project:name)
+    user_gave PackageName || PackageName=$(ini_raw1v project:pkgname)
+    user_gave RelDst      || RelDst=$(ini_raw1v project:reldst)
+    user_gave RelSrc      || RelSrc=$(ini_raw1v project:relsrc)
+    user_gave Tagline     || Tagline=$(ini_raw1v project:tagline)
+    user_gave VcsBrowser  || VcsBrowser=$(ini_raw1v project:vcs_browser)
+    user_gave Version     || Version=$(ini_raw1v project:version)
+}
+
+ini_raw1v() {
+    #
+    # Read raw scalar from mkit.ini
+    #
+    local path=$1
+    MKIT_INI_EXPAND=0 ini 1value "$path"
+}
+
+user_gave() {
+    #
+    # True if user gave value to variable $1
+    #
+    local var=$1    # name of the variable
+    { test "${UserGave[$var]}" == 1; } 2>/dev/null
+}
+
+updating() {
+    #
+    # Are we updating?
+    #
+    test "$Action" == update
+}
+
+remake_section() {
+    #
+    # Re-compose mkit.ini section $1
+    #
+    local section=$1
+    local key
+    local value
+    ini lskeys "$section" | grep -q . \
+     || return 1
+    echo ""
+    echo "[$section]"
+    ini lskeys "$section" \
+      | while read -r key; do
+            MKIT_INI_EXPAND=0 ini values "$section:$key" \
+              | while read -r value; do
+                    echo "$key = $value"
+                done
+        done \
+      | column -to' ' \
+      | sed 's/^/    /'
+}
+
 main() {
     local NiceName          # human-readable project name
     local PackageName       # machine-safe project (package) name
@@ -535,21 +620,27 @@ main() {
     local Tagline           # project tagline
     local Maintainer        # project maintainer (Name + e-mail)
     local VcsBrowser        # VCS browser (eg. GitHub URL)
+    local Version=0.0.0     # project version
     local AutoClean=false   # touch .mkit/autoclean?
     local MkCommits=false   # create pre/post git commits?
     local Force=false       # go without asking?
     local MkReadme=true     # create README.md?
     local MkMakefile=true   # create Makefile?
     local MkPackaging=true  # create packaging templates?
+    local MkLicense=false   # create LICENSE.md file
+    local Action            # 'update' to respect existing, 'new' to force
+                            # rewrite incl. MKIT_STUB_* placeholders
+    declare -A UserGave
     while true; do case $1 in
-        -n) NiceName=$2;        shift 2 || usage ;;
-        -b) RelSrc=$2;          shift 2 || usage ;;
-        -B) RelDst=$2;          shift 2 || usage ;;
-        -c) Codename=$2;        shift 2 || usage ;;
-        -t) Tagline=$2;         shift 2 || usage ;;
-        -l) License=$2;         shift 2 || usage ;;
-        -m) Maintainer=$2;      shift 2 || usage ;;
-        -v) VcsBrowser=$2;      shift 2 || usage ;;
+        -n) NiceName=$2;   UserGave[NiceName]=1;   shift 2 || usage ;;
+        -b) RelSrc=$2;     UserGave[RelSrc]=1;     shift 2 || usage ;;
+        -B) RelDst=$2;     UserGave[RelDst]=1;     shift 2 || usage ;;
+        -c) Codename=$2;   UserGave[Codename]=1;   shift 2 || usage ;;
+        -t) Tagline=$2;    UserGave[Tagline]=1;    shift 2 || usage ;;
+        -l) License=$2;    UserGave[License]=1;    shift 2 || usage ;;
+        -m) Maintainer=$2; UserGave[Maintainer]=1; shift 2 || usage ;;
+        -v) VcsBrowser=$2; UserGave[VcsBrowser]=1; shift 2 || usage ;;
+        -V) Version=$2;    UserGave[Version]=1;    shift 2 || usage ;;
         -M) MkMakefile=false;   shift ;;
         -R) MkReadme=false;     shift ;;
         -a) AutoClean=true;     shift ;;
@@ -560,31 +651,39 @@ main() {
         -*) usage ;;
         *)  break ;;
     esac done
-    PackageName="$1"
-    test -n "$PackageName" || usage
-    if test -n "$License"; then
+    Action=$1; PackageName=$2
+    case $Action:$PackageName in
+        new:)     usage ;;
+        new:*)    :     ;;
+        update:)  :     ;;
+        update:*) usage ;;
+        *)        usage ;;
+    esac
+    updating && init_from_existing
+    if $MkLicense; then
         known_licenses | grep -qxF "$License" \
          || die "unknown license (use -L to get list): $License"
+        MkLicense=true
     fi
     if $MkCommits; then
         mkcommit_backup || die "failed creating backup commit"
         Force=true
     fi
     confirm            || return 1
-    deploy mkit.ini
+    deploy "$MKIT_INI"
     deploy src/"$PackageName".skel
-    $MkMakefile        && deploy Makefile
-    $MkReadme          && deploy README.md
-    test -n "$License" && deploy LICENSE.md
-    $AutoClean         && deploy .mkit/autoclean
-    $MkPackaging       && deploy_packaging
+    $MkMakefile     && deploy Makefile
+    $MkReadme       && deploy README.md
+    $MkLicense      && deploy LICENSE.md
+    $AutoClean      && deploy .mkit/autoclean
+    $MkPackaging    && deploy_packaging
     if $MkCommits; then
         mkcommit_mkit_code || die "failed creating post-commit"
         mkcommit_mkit_conf || die "failed creating post-commit"
     fi
-    deploy MKIT_NEWSTUB_README.md
+    deploy MKIT_STUB_README.md
     warn "Configuration stub built, follow instructions in"
-    warn "MKIT_NEWSTUB_README.md to finish configuration."
+    warn "MKIT_STUB_README.md to finish configuration."
     return 0
 }