Add new config vars enabled in 07b50a07e0

Addons can be placed in subfolders with the same name as the action,
in order to be able to e.g. clone git repos into the TODO_ACTIONS_DIR
rather than having to download addons and manage updates manually.

Closes #120

.travis.yml

@@ -0,0 +1,6 @@
+# Note: "shell" would be more appropriate
+language: python
+
+install: make dist && sudo make install
+
+script: make test

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# DO NOT ENTER AN ISSUE UNTIL IT'S BEEN VERIFIED
+
+Please do not enter feature requests or bug reports here until you have joined the mailing list and submitted it there for verification and discussion first.
+
+http://tech.groups.yahoo.com/group/todotxt/
+
+Then, include a link to the mailing list discussion once the issue has been verified as something that needs to be fixed/added to the core script (and not an add-on or otherwise). Thanks!

Makefile

@@ -1,6 +1,7 @@
 #
 # Makefile for todo.txt
 #
+INSTALL_DIR=/usr/local/bin
 
 # Dynamically detect/generate version file as necessary
 # This file will define a variable called VERSION.
@@ -29,7 +30,12 @@ dist: $(DISTFILES) todo.sh
 clean:
 	rm -f $(DISTNAME).tar.gz $(DISTNAME).zip
 
-
+install:
+	install --mode=755 todo.sh $(INSTALL_DIR)
+	install --mode=644 todo_completion /etc/bash_completion.d/todo
+	mkdir -p /etc/todo
+	[ -e /etc/todo/config ] || \
+		sed "s/^\(export[ \t]*TODO_DIR=\).*/\1~\/.todo/" todo.cfg > /etc/todo/config
 #
 # Testing
 #

README.textile

@@ -1,4 +1,4 @@
-h1. TODO.TXT Command Line Interface
+h1. TODO.TXT Command Line Interface !https://secure.travis-ci.org/ginatrapani/todo.txt-cli.png?branch=master(Build Status)!:http://travis-ci.org/ginatrapani/todo.txt-cli
 
 A simple and extensible shell script for managing your todo.txt file.
 
@@ -23,5 +23,5 @@ h2. Quick Links
 * Licensed under the "GPL":http://www.gnu.org/copyleft/gpl.html
 * "Add-on Directory":https://github.com/ginatrapani/todo.txt-cli/wiki/Todo.sh-Add-on-Directory
 https://github.com/ginatrapani/todo.txt-cli/wiki/Creating-and-Installing-Add-ons
-* "Changelog":http://wiki.github.com/ginatrapani/todo.txt-cli/todosh-changelog
+* "Changelog":https://github.com/ginatrapani/todo.txt-cli/wiki/Todo.sh-Changelog
 * "Known Bugs":http://github.com/ginatrapani/todo.txt-cli/issues

tests/actions-test-lib.sh

@@ -16,3 +16,21 @@ echo "custom action $1"
 EOF
 chmod +x ".todo.actions.d/$1"
 }
+
+make_action_in_folder()
+{
+    unset TODO_ACTIONS_DIR
+    [ -d .todo.actions.d ] || mkdir .todo.actions.d
+    mkdir .todo.actions.d/$1
+    cat > ".todo.actions.d/$1/$1" <<EOF
+#!/bin/bash
+[ "\$1" = "usage" ] && {
+    echo "    $1 ITEM#[, ITEM#, ...] [TERM...]"
+    echo "      This custom action does $1."
+    echo ""
+    exit
+}
+echo "custom action $1 in folder $1"
+EOF
+chmod +x ".todo.actions.d/$1/$1"
+}

tests/t0000-config.sh

@@ -8,6 +8,10 @@ to find it somewhere else.
 '
 . ./test-lib.sh
 
+
+# Override default global config file
+export TODOTXT_GLOBAL_CFG_FILE=global.cfg
+
 # Remove the pre-created todo.cfg to test behavior in its absence
 rm -f todo.cfg
 echo "Fatal Error: Cannot read configuration file $HOME/.todo/config" > expect
@@ -55,6 +59,14 @@ test_expect_success 'config file (default location 3)' '
         rm -f .todo.cfg
 '
 
+rm -f used_config
+test_expect_success 'config file (global config file)' '
+    cp test.cfg "$TODOTXT_GLOBAL_CFG_FILE"
+    todo.sh > output;
+    test_cmp expect output && test -f used_config &&
+        rm -f "$TODOTXT_GLOBAL_CFG_FILE"
+'
+
 rm -f used_config
 test_expect_success 'config file (command line)' '
     todo.sh -d test.cfg > output;

tests/t1320-listproj.sh

@@ -114,4 +114,9 @@ test_todo_session 'listproj from combined open + done tasks' <<'EOF'
 +prj01
 EOF
 
+test_todo_session 'listproj with GREP_OPTIONS disruption' <<'EOF'
+>>> GREP_OPTIONS=-n todo.sh listproj
++prj01
+EOF
+
 test_done

tests/t1360-ls-project-context-highlighting.sh

@@ -0,0 +1,91 @@
+#!/bin/bash
+#
+
+test_description='highlighting projects and contexts
+
+This test checks the highlighting (with colors) of projects and contexts.
+'
+. ./test-lib.sh
+
+# Prioritized tasks with projects and contexts
+cat > todo.txt <<EOF
+(A) prioritized @con01 context
+(B) prioritized +prj02 project
+(C) prioritized context at EOL @con03
+(D) prioritized project at EOL +prj04
++prj05 non-prioritized project at BOL
+@con06 non-prioritized context at BOL
+multiple @con_ @texts and +pro_ +jects
+non-contexts: seti@home @ @* @(foo)
+non-projects: lost+found + +! +(bar)
+EOF
+
+# config file specifying COLOR_PROJECT and COLOR_CONTEXT
+#
+TEST_TODO_LABEL_COLORS=todo-colors.cfg
+cat todo.cfg > "$TEST_TODO_LABEL_COLORS"
+
+echo "export COLOR_CONTEXT='\\\\033[1m'" >>"$TEST_TODO_LABEL_COLORS"
+echo "export COLOR_PROJECT='\\\\033[2m'" >>"$TEST_TODO_LABEL_COLORS"
+
+test_todo_session 'highlighting for contexts and projects' <<'EOF'
+>>> todo.sh -d "$TEST_TODO_LABEL_COLORS" ls
+1 (A) prioritized @con01 context
+2 (B) prioritized +prj02 project
+3 (C) prioritized context at EOL @con03
+4 (D) prioritized project at EOL +prj04
+5 +prj05 non-prioritized project at BOL
+6 @con06 non-prioritized context at BOL
+7 multiple @con_ @texts and +pro_ +jects
+8 non-contexts: seti@home @ @* @(foo)
+9 non-projects: lost+found + +! +(bar)
+--
+TODO: 9 of 9 tasks shown
+EOF
+
+test_todo_session 'suppressing highlighting for contexts and projects' <<'EOF'
+>>> todo.sh -p -d "$TEST_TODO_LABEL_COLORS" ls
+1 (A) prioritized @con01 context
+2 (B) prioritized +prj02 project
+3 (C) prioritized context at EOL @con03
+4 (D) prioritized project at EOL +prj04
+5 +prj05 non-prioritized project at BOL
+6 @con06 non-prioritized context at BOL
+7 multiple @con_ @texts and +pro_ +jects
+8 non-contexts: seti@home @ @* @(foo)
+9 non-projects: lost+found + +! +(bar)
+--
+TODO: 9 of 9 tasks shown
+EOF
+
+test_todo_session 'suppressing display of contexts' <<'EOF'
+>>> todo.sh -@ -d "$TEST_TODO_LABEL_COLORS" ls
+1 (A) prioritized context
+2 (B) prioritized +prj02 project
+3 (C) prioritized context at EOL
+4 (D) prioritized project at EOL +prj04
+5 +prj05 non-prioritized project at BOL
+6 non-prioritized context at BOL
+7 multiple and +pro_ +jects
+8 non-contexts: seti@home @
+9 non-projects: lost+found + +! +(bar)
+--
+TODO: 9 of 9 tasks shown
+EOF
+
+test_todo_session 'suppressing display of projects' <<'EOF'
+>>> todo.sh -+ -d "$TEST_TODO_LABEL_COLORS" ls
+1 (A) prioritized @con01 context
+2 (B) prioritized project
+3 (C) prioritized context at EOL @con03
+4 (D) prioritized project at EOL
+5 non-prioritized project at BOL
+6 @con06 non-prioritized context at BOL
+7 multiple @con_ @texts and
+8 non-contexts: seti@home @ @* @(foo)
+9 non-projects: lost+found +
+--
+TODO: 9 of 9 tasks shown
+EOF
+
+test_done

tests/t2120-shorthelp.sh

@@ -45,6 +45,9 @@ mv todo.cfg custom.cfg
 mv .todo.actions.d custom.actions
 echo 'export TODO_ACTIONS_DIR=$HOME/custom.actions' >> custom.cfg
 
+# Avoid the use of global config file, if it exists
+export TODOTXT_GLOBAL_CFG_FILE=global.cfg
+
 test_todo_session '-h and fatal error without config' <<EOF
 >>> todo.sh -h | sed '/^ \\{0,2\\}[A-Z]/!d'
   Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]

tests/t2200-no-done-report-files.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+#
+
+test_description='todo.sh configuration with a sole todo.txt data file.
+
+This test covers turning off done.txt and report.txt, and
+checks that no such empty files are created.
+'
+. ./test-lib.sh
+
+cat > test.cfg << EOF
+export TODO_DIR=.
+export TODO_FILE="\$TODO_DIR/todo.txt"
+export DONE_FILE=/dev/null
+export REPORT_FILE=/dev/null
+export TMP_FILE="\$TODO_DIR/todo.tmp"
+touch used_config
+EOF
+
+test_todo_session 'invoke todo.sh' <<EOF
+>>> todo.sh -d test.cfg add notice the daisies
+1 notice the daisies
+TODO: 1 added.
+EOF
+
+test_expect_success 'the todo file has been created' '[ -e todo.txt ]'
+test_expect_success 'no done file has been created' '[ ! -e done.txt ]'
+test_expect_success 'no report file has been created' '[ ! -e report.txt ]'
+
+test_todo_session 'perform archive' <<EOF
+>>> todo.sh -A -d test.cfg do 1
+1 x 2009-02-13 notice the daisies
+TODO: 1 marked as done.
+x 2009-02-13 notice the daisies
+TODO: ./todo.txt archived.
+EOF
+
+test_expect_success 'no done file has been created by the archiving' '[ ! -e done.txt ]'
+
+test_todo_session 'perform report' <<EOF
+>>> todo.sh -d test.cfg report
+TODO: ./todo.txt archived.
+2009-02-13T04:40:00 0 0
+TODO: Report file updated.
+EOF
+
+test_expect_success 'no report file has been created by the reporting' '[ ! -e report.txt ]'
+
+test_done

tests/t6050-completion-addons.sh

@@ -11,6 +11,8 @@ readonly ACTIONS='add a addto addm append app archive command del rm depri dp do
 readonly OPTIONS='-@ -@@ -+ -++ -d -f -h -p -P -PP -a -n -t -v -vv -V -x'
 
 readonly ADDONS='bar baz foobar'
+
+readonly CONTAINED='xeno zoolander'
 makeCustomActions()
 {
     set -e
@@ -31,12 +33,28 @@ makeCustomActions()
     chmod -x "$datafile"
     [ -x "$datafile" ] && rm "$datafile"    # Some file systems may always make files executable; then, skip this check.
 
+    # Add an executable file in a folder with the same name as the file,
+    # in order to ensure completion
+    for contained in $CONTAINED
+    do
+        mkdir "${1}/$contained"
+        > "${1}/$contained/$contained"
+        chmod u+x "${1}/$contained/$contained"
+    done
+
     set +e
 }
 removeCustomActions()
 {
     set -e
     rmdir "${1}/subdir"
+
+    for contained in $CONTAINED
+    do
+        rm "${1}/$contained/$contained"
+        rmdir "${1}/$contained"
+    done
+
     rm "${1:?}/"*
     rmdir "$1"
     set +e
@@ -46,8 +64,8 @@ removeCustomActions()
 # Test resolution of the default TODO_ACTIONS_DIR.
 #
 makeCustomActions "$HOME/.todo.actions.d"
-test_todo_completion 'all arguments' 'todo.sh ' "$ACTIONS $ADDONS $OPTIONS"
-test_todo_completion 'all arguments after option' 'todo.sh -a ' "$ACTIONS $ADDONS $OPTIONS"
+test_todo_completion 'all arguments' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
+test_todo_completion 'all arguments after option' 'todo.sh -a ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
 test_todo_completion 'all arguments beginning with b' 'todo.sh b' 'bar baz'
 test_todo_completion 'all arguments beginning with f after options' 'todo.sh -a -v f' 'foobar'
 test_todo_completion 'nothing after addon action' 'todo.sh foobar ' ''
@@ -58,7 +76,7 @@ removeCustomActions "$HOME/.todo.actions.d"
 #
 mkdir  "$HOME/.todo"
 makeCustomActions "$HOME/.todo/actions"
-test_todo_completion 'all arguments with actions from .todo/actions/' 'todo.sh ' "$ACTIONS $ADDONS $OPTIONS"
+test_todo_completion 'all arguments with actions from .todo/actions/' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
 removeCustomActions "$HOME/.todo/actions"
 
 #
@@ -68,7 +86,7 @@ makeCustomActions "$HOME/addons"
 cat >> todo.cfg <<'EOF'
 export TODO_ACTIONS_DIR="$HOME/addons"
 EOF
-test_todo_completion 'all arguments with actions from addons/' 'todo.sh ' "$ACTIONS $ADDONS $OPTIONS"
+test_todo_completion 'all arguments with actions from addons/' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
 removeCustomActions "$HOME/addons"
 
 test_done

tests/t8010-listaddons.sh

@@ -41,4 +41,44 @@ ls
 quux
 EOF
 
+make_action_in_folder "chuck"
+# Add a bit of cruft in the action folders in order to ensure that we only
+# care about the executables with the same name as the folder in which they
+# reside.
+touch .todo.actions.d/chuck/mc_hammer     # can't touch this
+chmod u+x .todo.actions.d/chuck/mc_hammer # better run, better run run
+touch .todo.actions.d/chuck/README
+
+make_action_in_folder "norris"
+
+test_todo_session 'custom actions in subfolders' <<EOF
+>>> test -f .todo.actions.d/chuck/README
+=== 0
+
+>>> test -x .todo.actions.d/chuck/mc_hammer
+=== 0
+
+>>> todo.sh listaddons
+bar
+chuck
+ls
+norris
+quux
+EOF
+
+# nthorne: shamelessly stolen from above..
+chmod -x .todo.actions.d/norris/norris
+# On Cygwin, clearing the executable flag may have no effect, as the Windows ACL
+# may still grant execution rights. In this case, we skip the test.
+if [ -x .todo.actions.d/norris/norris ]; then
+    SKIP_TESTS="${SKIP_TESTS}${SKIP_TESTS+ }t8010.8"
+fi
+test_todo_session 'nonexecutable action in subfolder' <<EOF
+>>> todo.sh listaddons
+bar
+chuck
+ls
+quux
+EOF
+
 test_done

todo.cfg

@@ -62,6 +62,11 @@ export REPORT_FILE="$TODO_DIR/report.txt"
 #
 # export COLOR_DONE=$LIGHT_GREY
 
+# There is highlighting for projects and contexts.
+#
+# export COLOR_PROJECT=$RED
+# export COLOR_CONTEXT=$RED
+
 # === BEHAVIOR ===
 
 ## customize list output

todo.sh

@@ -302,6 +302,14 @@ addonHelp()
                     didPrintAddonActionsHeader=1
                 fi
                 "$action" usage
+            elif [ -d "$action" -a -x "$action/$(basename $action)" ]; then
+                if [ ! "$didPrintAddonActionsHeader" ]; then
+                    cat <<-EndAddonActionsHeader
+		  Add-on Actions:
+	EndAddonActionsHeader
+                    didPrintAddonActionsHeader=1
+                fi
+                "$action/$(basename $action)" usage
             fi
         done
     fi
@@ -314,6 +322,8 @@ actionUsage()
         action="${TODO_ACTIONS_DIR}/${actionName}"
         if [ -f "$action" -a -x "$action" ]; then
             "$action" usage
+        elif [ -d "$action" -a -x "$action/$(basename $action)" ]; then
+            "$action/$(basename $action)" usage
         else
             builtinActionUsage=$(actionsHelp | sed -n -e "/^    ${actionName//\//\\/} /,/^\$/p" -e "/^    ${actionName//\//\\/}$/,/^\$/p")
             if [ "$builtinActionUsage" ]; then
@@ -467,6 +477,9 @@ OVR_TODOTXT_DEFAULT_ACTION="$TODOTXT_DEFAULT_ACTION"
 OVR_TODOTXT_SORT_COMMAND="$TODOTXT_SORT_COMMAND"
 OVR_TODOTXT_FINAL_FILTER="$TODOTXT_FINAL_FILTER"
 
+# Prevent GREP_OPTIONS from malforming grep's output
+GREP_OPTIONS=""
+
 # == PROCESS OPTIONS ==
 while getopts ":fhpcnNaAtTvVx+@Pd:" Option
 do
@@ -581,6 +594,7 @@ TODOTXT_DEFAULT_ACTION=${TODOTXT_DEFAULT_ACTION:-}
 TODOTXT_SORT_COMMAND=${TODOTXT_SORT_COMMAND:-env LC_COLLATE=C sort -f -k2}
 TODOTXT_DISABLE_FILTER=${TODOTXT_DISABLE_FILTER:-}
 TODOTXT_FINAL_FILTER=${TODOTXT_FINAL_FILTER:-cat}
+TODOTXT_GLOBAL_CFG_FILE=${TODOTXT_GLOBAL_CFG_FILE:-/etc/todo/config}
 
 # Export all TODOTXT_* variables
 export ${!TODOTXT_@}
@@ -611,6 +625,10 @@ export PRI_B=$GREEN         # color for B priority
 export PRI_C=$LIGHT_BLUE    # color for C priority
 export PRI_X=$WHITE         # color unless explicitly defined
 
+# Default project and context colors.
+export COLOR_PROJECT=$NONE
+export COLOR_CONTEXT=$NONE
+
 # Default highlight colors.
 export COLOR_DONE=$LIGHT_GREY   # color for done (but not yet archived) tasks
 
@@ -647,6 +665,15 @@ export SENTENCE_DELIMITERS=',.:;'
     fi
 }
 
+[ -e "$TODOTXT_CFG_FILE" ] || {
+    CFG_FILE_ALT="$TODOTXT_GLOBAL_CFG_FILE"
+
+    if [ -e "$CFG_FILE_ALT" ]
+    then
+        TODOTXT_CFG_FILE="$CFG_FILE_ALT"
+    fi
+}
+
 
 if [ -z "$TODO_ACTIONS_DIR" -o ! -d "$TODO_ACTIONS_DIR" ]
 then
@@ -703,12 +730,12 @@ fi
 ACTION=${1:-$TODOTXT_DEFAULT_ACTION}
 
 [ -z "$ACTION" ]    && usage
-[ -d "$TODO_DIR" ]  || dieWithHelp "$1" "Fatal Error: $TODO_DIR is not a directory"
+[ -d "$TODO_DIR" ]  || mkdir -p $TODO_DIR 2> /dev/null || dieWithHelp "$1" "Fatal Error: $TODO_DIR is not a directory"
 ( cd "$TODO_DIR" )  || dieWithHelp "$1" "Fatal Error: Unable to cd to $TODO_DIR"
 
-[ -f "$TODO_FILE" ] || cp /dev/null "$TODO_FILE"
-[ -f "$DONE_FILE" ] || cp /dev/null "$DONE_FILE"
-[ -f "$REPORT_FILE" ] || cp /dev/null "$REPORT_FILE"
+[ -f "$TODO_FILE" -o -c "$TODO_FILE" ] || > "$TODO_FILE"
+[ -f "$DONE_FILE" -o -c "$DONE_FILE" ] || > "$DONE_FILE"
+[ -f "$REPORT_FILE" -o -c "$REPORT_FILE" ] || > "$REPORT_FILE"
 
 if [ $TODOTXT_PLAIN = 1 ]; then
     for clr in ${!PRI_@}; do
@@ -717,8 +744,13 @@ if [ $TODOTXT_PLAIN = 1 ]; then
     PRI_X=$NONE
     DEFAULT=$NONE
     COLOR_DONE=$NONE
+    COLOR_PROJECT=$NONE
+    COLOR_CONTEXT=$NONE
 fi
 
+[[ "$HIDE_PROJECTS_SUBSTITUTION" ]] && COLOR_PROJECT="$NONE"
+[[ "$HIDE_CONTEXTS_SUBSTITUTION" ]] && COLOR_CONTEXT="$NONE"
+
 _addto() {
     file="$1"
     input="$2"
@@ -865,15 +897,38 @@ _format()
                 return color
             }
             {
+                clr = ""
                 if (match($0, /^[0-9]+ x /)) {
-                    print highlight("COLOR_DONE") $0 highlight("DEFAULT")
+                    clr = highlight("COLOR_DONE")
                 } else if (match($0, /^[0-9]+ \([A-Z]\) /)) {
                     clr = highlight("PRI_" substr($0, RSTART + RLENGTH - 3, 1))
-                    print \
-                        (clr ? clr : highlight("PRI_X")) \
-                        (ENVIRON["HIDE_PRIORITY_SUBSTITUTION"] == "" ? $0 : substr($0, 1, RLENGTH - 4) substr($0, RSTART + RLENGTH)) \
-                        highlight("DEFAULT")
-                } else { print }
+                    clr = (clr ? clr : highlight("PRI_X"))
+                    if (ENVIRON["HIDE_PRIORITY_SUBSTITUTION"] != "") {
+                        $0 = substr($0, 1, RLENGTH - 4) substr($0, RSTART + RLENGTH)
+                    }
+                }
+                end_clr = (clr ? highlight("DEFAULT") : "")
+
+                prj_beg = highlight("COLOR_PROJECT")
+                prj_end = (prj_beg ? (highlight("DEFAULT") clr) : "")
+
+                ctx_beg = highlight("COLOR_CONTEXT")
+                ctx_end = (ctx_beg ? (highlight("DEFAULT") clr) : "")
+
+                gsub(/[ \t][ \t]*/, "\n&\n")
+                len = split($0, words, /\n/)
+
+                printf "%s", clr
+                for (i = 1; i <= len; ++i) {
+                    if (words[i] ~ /^[+].*[A-Za-z0-9_]$/) {
+                        printf "%s", prj_beg words[i] prj_end
+                    } else if (words[i] ~ /^[@].*[A-Za-z0-9_]$/) {
+                        printf "%s", ctx_beg words[i] ctx_end
+                    } else {
+                        printf "%s", words[i]
+                    }
+                }
+                printf "%s\n", end_clr
             }
           '''  \
         | sed '''
@@ -919,6 +974,10 @@ then
     shift
     ## Reset action to new first argument
     action=$( printf "%s\n" "$1" | tr 'A-Z' 'a-z' )
+elif [ -d "$TODO_ACTIONS_DIR/$action" -a -x "$TODO_ACTIONS_DIR/$action/$action" ]
+then
+    "$TODO_ACTIONS_DIR/$action/$action" "$@"
+    exit $?
 elif [ -d "$TODO_ACTIONS_DIR" -a -x "$TODO_ACTIONS_DIR/$action" ]
 then
     "$TODO_ACTIONS_DIR/$action" "$@"
@@ -1360,6 +1419,8 @@ note: PRIORITY must be anywhere from A to Z."
         do
             if [ -f "$action" -a -x "$action" ]; then
                 echo "$action"
+            elif [ -d "$action" -a -x "$action/$action" ]; then
+                echo "$action"
             fi
         done
     fi