Rename ini.iniread to config.cfgrep

config.cfgrep does better job at hinting how the function works
(i.e. somehow similar to UNIX grep) and that the use is not limited to
INI files.

Also default config file suffix is now "conf".

doc/ffoo.3.sh

@@ -29,7 +29,7 @@ myfun                               # debug:myfun: num='42'
 #
 mkdir $HOME/.cfg
 cat >$HOME/.cfg/foo.ini <<EOF
-# a sample ini file
+# a sample INI file
 [foo]
     multiline = also possible
     multiline = like this :)
@@ -41,8 +41,8 @@ cat >$HOME/.cfg/foo.ini <<EOF
     s1 =def main():
     s1 =    print "will work!"
 EOF
-ffoo import ini
-FFOO_INI_PATH=$HOME/.cfg
+ffoo import config
+FFOO_CONFIG_PATH=$HOME/.cfg
 iniread -s foo.bar -k baz foo.ini       # prints "qux"
 iniread -p foo.bar.baz foo.ini          # ...short for above
 iniread -p foo.bar.baz                  # ...even shorter
@@ -51,7 +51,7 @@ python s1.py                            # << will work
 
 
 #
-# including runtime ini merging
+# including runtime INI merging
 #
 mkdir $HOME/.cfg/private
 cat >$HOME/.cfg/private/foo.ini <<EOF
@@ -61,7 +61,7 @@ cat >$HOME/.cfg/private/foo.ini <<EOF
 # this approach can make it easier
 # to sync private info separately
 EOF
-FFOO_INI_PATH=$HOME/.cfg:$HOME/.cfg-private
+FFOO_CONFIG_PATH=$HOME/.cfg:$HOME/.cfg-private
 iniread    -p foo.bar.baz2              # merges both paths -- prints 2 lines
 iniread -1 -p foo.bar.baz2              # ... last one wins -- prints "secret..."
 iniread -S foo.ini                      # merges both files verbatim

include/ini.sh → include/config.sh

@@ -6,26 +6,26 @@ ffoo import core
 #
 # Expected filename extension (for guessing from -p path head)
 #
-# If no filename to read is given, iniread will guess filename
-# as the path head plus this suffix (e.g. `foo.ini` for
-# `iniread -p foo.bar.baz`)
+# If no filename to read is given, cfgrep will guess filename
+# as the path head plus this suffix (e.g. `foo.conf` for
+# `cfgrep -p foo.bar.baz`)
 #
-FFOO_INI_SUFFIX=".ini"
+FFOO_CONFIG_SUFFIX=".conf"
 
 
-__iniread__cat() {
+__cfgrep__cat() {
     # cat without starting a process
     while IFS= read line;
     do echos "$line"; done
 }
 
 
-__initead_fltcmt() {
+__cfgrep__fltcmt() {
     grep -v -e "^[[:space:]]*[#;]" -e "^[[:space:]]*$"
 }
 
 
-__iniread__fltkey() {
+__cfgrep__fltkey() {
     # filter values from key=value pair
     local line
     local key
@@ -48,7 +48,7 @@ __iniread__fltkey() {
 }
 
 
-__iniread__fltsct() {
+__cfgrep__fltsct() {
     # filter per section
     local sct_ok=false
     local line
@@ -69,7 +69,7 @@ __iniread__fltsct() {
 }
 
 
-__iniread__merge() {
+__cfgrep__merge() {
     local path
     debug -v strategy
     while read path;
@@ -95,12 +95,12 @@ __iniread__merge() {
 }
 
 
-__iniread__load() {
+__cfgrep__load() {
     if test -z "$1";
     then                # guess filename from section head
-        local guess="$(cut -d. -f1 <<<"$wntsct")$FFOO_INI_SUFFIX"
+        local guess="$(cut -d. -f1 <<<"$wntsct")$FFOO_CONFIG_SUFFIX"
         debug -v guess
-        __iniread__load "$guess"
+        __cfgrep__load "$guess"
     fi
     local arg trydir trypath
     for arg in "$@";
@@ -111,8 +111,8 @@ __iniread__load() {
                 cat "$arg"
             ;;
         *)              # name given, find all its incarnations
-            debug -v FFOO_INI_PATH
-            echos "$FFOO_INI_PATH" \
+            debug -v FFOO_CONFIG_PATH
+            echos "$FFOO_CONFIG_PATH" \
               | tr ':' '\n' \
               | while read trydir;
                 do
@@ -121,7 +121,7 @@ __iniread__load() {
                     debug -v trypath
                     echos "$trypath"
                 done \
-              |  __iniread__merge
+              |  __cfgrep__merge
             ;;
         esac
     done
@@ -129,13 +129,13 @@ __iniread__load() {
 }
 
 
-iniread() {
+cfgrep() {
     #
-    # A flexible (not just) .ini file reader
+    # A flexible (not just) .conf/.ini file reader
     #
     # Usage:
-    #   iniread [-S] [-1] [-j] [-s section] [-k key] [file...]
-    #   iniread [-S] [-1] [-j] [-p path] [file...]
+    #   cfgrep [-S] [-1] [-j] [-s section] [-k key] [file...]
+    #   cfgrep [-S] [-1] [-j] [-p path] [file...]
     #
     #
     # Selection
@@ -179,11 +179,11 @@ iniread() {
     #     path.
     #
     #  *  Otherwise, it is taken as filename and searched for
-    #     in directories given in `$FFOO_INI_PATH`.  (This can
+    #     in directories given in `$FFOO_CONFIG_PATH`.  (This can
     #     yield more than one path, which is equivalent as if
     #     all paths were provided.)
     #
-    #     Not all files expanded based on `$FFOO_INI_PATH`
+    #     Not all files expanded based on `$FFOO_CONFIG_PATH`
     #     are read by default; reading is governed by "merge
     #     strategy": the default strategy "first" reads only
     #     the first existing file.  "join" strategy means
@@ -200,7 +200,7 @@ iniread() {
     # Without *file* given at all, same procedure is used as in
     # case of filename without slash, except that *file* argument
     # is inferred by taking part of section name before first
-    # dot and adding `$FFOO_INI_SUFFIX`, (".ini" by default).
+    # dot and adding `$FFOO_CONFIG_SUFFIX`, (".conf" by default).
     # This allows for creating relatively rich config value
     # structure it divided in several files (e.g. by component)
     # but accessing them with as little typing as possible.
@@ -228,18 +228,18 @@ iniread() {
         first|join)                                   : ;;
         *) warn "invalid merge strategy: $strategy"; return 2 ;;
     esac
-    fltsct=__iniread__cat
-    fltkey=__iniread__cat
-    fltcmt=__initead_fltcmt
-    limit_line=__iniread__cat
-    test -n "$wntsct" && fltsct=__iniread__fltsct
-    test -n "$wntkey" && fltkey=__iniread__fltkey
+    fltsct=__cfgrep__cat
+    fltkey=__cfgrep__cat
+    fltcmt=__cfgrep__fltcmt
+    limit_line=__cfgrep__cat
+    test -n "$wntsct" && fltsct=__cfgrep__fltsct
+    test -n "$wntkey" && fltkey=__cfgrep__fltkey
     $one_line && limit_line="tail -1"
     $strict && grepex=""
-    $strict && fltcmt=__iniread__cat
+    $strict && fltcmt=__cfgrep__cat
     debug -v wntkey wntsct
     debug "\$@='$@'"
-    __iniread__load "$@" \
+    __cfgrep__load "$@" \
         | $fltcmt \
         | $fltsct \
         | $fltkey \

include/misc.sh

@@ -1,6 +1,7 @@
 #!/bin/bash
 
 ffoo import core
+ffoo import config
 
 
 append_if_missing() {
@@ -60,7 +61,7 @@ mute_known() {
     # For those yums and rpms that don't know theit manners.
     # Use with care!
     #
-    grep -vxf <(iniread -s mute -k $1 mute.ini)
+    grep -vxf <(cfgrep -s mute -k $1 mute.conf)
 }
 
 

test/data/ffoo_api/functions.oracle

@@ -1,4 +1,11 @@
 charmenu.charmenu
+config.__cfgrep__cat
+config.__cfgrep__fltcmt
+config.__cfgrep__fltkey
+config.__cfgrep__fltsct
+config.__cfgrep__load
+config.__cfgrep__merge
+config.cfgrep
 core.__cat
 core.__cut_stack
 core.__echo
@@ -17,13 +24,6 @@ core.think
 core.usage_is
 core.warn
 exit.exits
-ini.__iniread__cat
-ini.__iniread__fltkey
-ini.__iniread__fltsct
-ini.__iniread__load
-ini.__iniread__merge
-ini.__initead_fltcmt
-ini.iniread
 misc.append_if_missing
 misc.collapse_tilde
 misc.echo_hr

test/data/ffoo_api/modules.oracle

@@ -1,7 +1,7 @@
 charmenu
+config
 core
 exit
-ini
 misc
 mkpretty
 mkpretty_color

test/data/ini_iniread/both_keys_and_sections

@@ -1,5 +1,5 @@
 # desc: both keys and section
-# cmd: iniread -s section1 -k key1
+# cmd: cfgrep -s section1 -k key1
 
 [section1]
 free form in s1

test/data/ini_iniread/games_with_spaces

@@ -1,5 +1,5 @@
 # desc: games with spaces
-# cmd: iniread -s "maybe spaced" -k "spaced key"
+# cmd: cfgrep -s "maybe spaced" -k "spaced key"
 
 [maybe spaced]
 spaced key=value00000

test/data/ini_iniread/keys_only

@@ -1,5 +1,5 @@
 # desc: keys only's
-# cmd: iniread -k key1 ''
+# cmd: cfgrep -k key1 ''
 
 free form
 key1=value1

test/data/ini_iniread/keys_sections_spaces

@@ -1,5 +1,5 @@
 # desc: keys, sections and spaces
-# cmd: iniread -s section1 -k key1
+# cmd: cfgrep -s section1 -k key1
 
 [section1]
     free form in s1

test/data/ini_iniread/list_keys

@@ -1,5 +1,5 @@
 # desc: list keys
-# cmd: iniread -L keys
+# cmd: cfgrep -L keys
 
 [section1]
 free form in s1

test/data/ini_iniread/list_paths

@@ -1,5 +1,5 @@
 # desc: list paths
-# cmd: iniread -L paths
+# cmd: cfgrep -L paths
 
 [section1]
 free form in s1

test/data/ini_iniread/list_sections

@@ -1,5 +1,5 @@
 # desc: list sections
-# cmd: iniread -L sections
+# cmd: cfgrep -L sections
 
 [section1]
 free form in s1

test/data/ini_iniread/merge_first

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread t.ini
+# cmd: cfgrep t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b
+FFOO_CONFIG_PATH=merge-a:merge-b

test/data/ini_iniread/merge_first_no1

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread t.ini
+# cmd: cfgrep t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first_no1.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-x:merge-a:merge-b
+FFOO_CONFIG_PATH=merge-x:merge-a:merge-b

test/data/ini_iniread/merge_first_no2

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread t.ini
+# cmd: cfgrep t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first_no2.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-x:merge-b
+FFOO_CONFIG_PATH=merge-a:merge-x:merge-b

test/data/ini_iniread/merge_first_no3

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread t.ini
+# cmd: cfgrep t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first_no3.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b:merge-x
+FFOO_CONFIG_PATH=merge-a:merge-b:merge-x

test/data/ini_iniread/merge_first_none

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread t.ini
+# cmd: cfgrep t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first_none.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-x:merge-y:merge-z
+FFOO_CONFIG_PATH=merge-x:merge-y:merge-z

test/data/ini_iniread/merge_first_strict

@@ -1,5 +1,5 @@
 # desc: merge in strict mode
-# cmd: iniread -S t.ini
+# cmd: cfgrep -S t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_first_strict.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b
+FFOO_CONFIG_PATH=merge-a:merge-b

test/data/ini_iniread/merge_join

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread -j t.ini
+# cmd: cfgrep -j t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b
+FFOO_CONFIG_PATH=merge-a:merge-b

test/data/ini_iniread/merge_join_no1

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread -j t.ini
+# cmd: cfgrep -j t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join_no1.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-x:merge-a:merge-b
+FFOO_CONFIG_PATH=merge-x:merge-a:merge-b

test/data/ini_iniread/merge_join_no2

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread -j t.ini
+# cmd: cfgrep -j t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join_no2.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge:x:merge-b
+FFOO_CONFIG_PATH=merge-a:merge:x:merge-b

test/data/ini_iniread/merge_join_no3

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread -j t.ini
+# cmd: cfgrep -j t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join_no3.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b:merge:x
+FFOO_CONFIG_PATH=merge-a:merge-b:merge:x

test/data/ini_iniread/merge_join_none

@@ -1,5 +1,5 @@
 # desc: merge
-# cmd: iniread -j t.ini
+# cmd: cfgrep -j t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join_none.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-x:merge-y:merge-z
+FFOO_CONFIG_PATH=merge-x:merge-y:merge-z

test/data/ini_iniread/merge_join_strict

@@ -1,5 +1,5 @@
 # desc: merge in strict mode
-# cmd: iniread -j -S t.ini
+# cmd: cfgrep -j -S t.conf
 
 #   #
 # S #

test/data/ini_iniread/merge_join_strict.env

@@ -1 +1 @@
-FFOO_INI_PATH=merge-a:merge-b
+FFOO_CONFIG_PATH=merge-a:merge-b

test/data/ini_iniread/merge_join_strict.oracle

@@ -1,4 +1,4 @@
-# file: merge-a/t.ini
+# file: merge-a/t.conf
 #   #
 # A #
 #   #
@@ -9,7 +9,7 @@
 [s2]
     k1=file-a-s2k1
     k2=file-a-s2k2
-# file: merge-b/t.ini
+# file: merge-b/t.conf
 #   #
 # B #
 #   #

test/data/ini_iniread/path

@@ -1,5 +1,5 @@
 # desc: path
-# cmd: iniread -p section1.key1
+# cmd: cfgrep -p section1.key1
 
 [section1]
 free form in s1

test/data/ini_iniread/plain

@@ -1,5 +1,5 @@
 # desc: plain
-# cmd: iniread --
+# cmd: cfgrep --
 
 hello
 hello1

test/data/ini_iniread/plain_strict

@@ -1,5 +1,5 @@
 # desc: plain_strict
-# cmd: iniread -S
+# cmd: cfgrep -S
 
 # some strict-ish comments
 

test/data/ini_iniread/sections_only

@@ -1,5 +1,5 @@
 # desc: sections only
-# cmd: iniread -s section2
+# cmd: cfgrep -s section2
 
 [section1]
 line11

test/data/ini_iniread/strict_and_space

@@ -1,5 +1,5 @@
 # desc: tricks with strict and script
-# cmd: iniread -S -s myscript -k py
+# cmd: cfgrep -S -s myscript -k py
 
 [myscript]
 py =#!/usr/bin/python

test/data/ini_iniread/strict_and_tab

@@ -1,5 +1,5 @@
 # desc: tricks with strict and script
-# cmd: iniread -S -s my_script -k py
+# cmd: cfgrep -S -s my_script -k py
 
 [my_script]
 py =#!/usr/bin/python

test/data/ini_iniread/tricks_with_strange_naming

@@ -1,5 +1,5 @@
 # desc: tricks with strange naming
-# cmd: iniread -s "section with/ slash and spaces"
+# cmd: cfgrep -s "section with/ slash and spaces"
 
 [section with/ slash and spaces]
     [line starting with lbracket

test/scripts/ini_iniread

@@ -3,7 +3,7 @@
 . $TF_PROJDIR/test/include/simple.sh
 
 . <(ffoom init) || tf_exit_quit    "failed to init ffoo"
-ffoo import ini || tf_exit_bailout "failed to import ini"
+ffoo import config || tf_exit_bailout "failed to import config"
 
 tf_enum_subtests() {
     echo "both_keys_and_sections"