Create dedicated test file for report tests.

When the last reported values are identical to the current values, do not append the same information (just with a new timestamp) to the report. Instead, just print the last report line.

With this, the report action can be scheduled periodically (e.g. via cron) without artificially inflating the report file.

README.textile

@@ -21,7 +21,6 @@ h2. Quick Links
 * Original anemic release by "Gina Trapani":http://ginatrapani.org on 5/11/2006.
 * Raised to great heights by "brainy and dedicated volunteers":http://github.com/ginatrapani/todo.txt-cli/network.
 * 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
+* "Add-on Directory":http://wiki.github.com/ginatrapani/todo.txt-cli/todosh-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
 * "Known Bugs":http://github.com/ginatrapani/todo.txt-cli/issues

tests/t0001-null.sh

@@ -45,8 +45,6 @@ test_expect_success 'null listpri a' '
 cat > expect <<EOF
 --
 TODO: 0 of 0 tasks shown
-DONE: 0 of 0 tasks shown
-total 0 of 0 tasks shown
 EOF
 
 test_expect_success 'null lsa' '

tests/t1300-ls.sh

@@ -53,18 +53,6 @@ test_todo_session 'checking TODOTXT_FINAL_FILTER' <<EOF
 TODO: 3 of 3 tasks shown
 EOF
 
-#
-# check the custom hiding
-#
-test_todo_session 'checking HIDE_CUSTOM_SUBSTITUTION' <<EOF
->>> HIDE_CUSTOM_SUBSTITUTION='[tT]h' todo.sh ls
-2 aaa zzz is line should be first.
-3 bbb yyy is line should be second.
-1 ccc xxx is line should be ird.
---
-TODO: 3 of 3 tasks shown
-EOF
-
 #
 # check the filtering of TERM
 #

tests/t1350-listall.sh

@@ -1,150 +0,0 @@
-#!/bin/sh
-
-test_description='listall functionality
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-smell the uppercase Roses +flowers @outside
-x 2011-08-08 tend the garden @outside
-notice the sunflowers
-x 2011-12-26 go outside +wakeup
-(A) stop
-EOF
-cat > done.txt <<EOF
-x 2011-12-01 eat breakfast
-x 2011-12-05 smell the coffee +wakeup
-EOF
-
-test_todo_session 'basic listall' <<EOF
->>> todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 2 of 2 tasks shown
-total 7 of 7 tasks shown
-EOF
-
-test_todo_session 'listall highlighting' <<EOF
->>> todo.sh listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 2 of 2 tasks shown
-total 7 of 7 tasks shown
-EOF
-
-test_todo_session 'listall nonverbose' <<EOF
->>> TODOTXT_VERBOSE=0 todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
-EOF
-
-test_todo_session 'listall filtering' <<EOF
->>> todo.sh -p listall @outside
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
---
-TODO: 2 of 5 tasks shown
-DONE: 0 of 2 tasks shown
-total 2 of 7 tasks shown
-
->>> todo.sh -p listall the
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-05 smell the coffee +wakeup
---
-TODO: 3 of 5 tasks shown
-DONE: 1 of 2 tasks shown
-total 4 of 7 tasks shown
-
->>> todo.sh -p listall breakfast
-0 x 2011-12-01 eat breakfast
---
-TODO: 0 of 5 tasks shown
-DONE: 1 of 2 tasks shown
-total 1 of 7 tasks shown
-
->>> todo.sh -p listall doesnotmatch
---
-TODO: 0 of 5 tasks shown
-DONE: 0 of 2 tasks shown
-total 0 of 7 tasks shown
-EOF
-
-cat >> done.txt <<EOF
-x 2010-01-01 old task 1
-x 2010-01-01 old task 2
-x 2010-01-01 old task 3
-x 2010-01-01 old task 4
-EOF
-test_todo_session 'listall number width' <<EOF
->>> todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-0 x 2010-01-01 old task 1
-0 x 2010-01-01 old task 2
-0 x 2010-01-01 old task 3
-0 x 2010-01-01 old task 4
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 6 of 6 tasks shown
-total 11 of 11 tasks shown
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 1
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 2
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 3
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 4
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 5
-
->>> todo.sh -p listall
-05 (A) stop
-06 new task 1
-07 new task 2
-08 new task 3
-09 new task 4
-10 new task 5
-03 notice the sunflowers
-01 smell the uppercase Roses +flowers @outside
-00 x 2010-01-01 old task 1
-00 x 2010-01-01 old task 2
-00 x 2010-01-01 old task 3
-00 x 2010-01-01 old task 4
-02 x 2011-08-08 tend the garden @outside
-00 x 2011-12-01 eat breakfast
-00 x 2011-12-05 smell the coffee +wakeup
-04 x 2011-12-26 go outside +wakeup
---
-TODO: 10 of 10 tasks shown
-DONE: 6 of 6 tasks shown
-total 16 of 16 tasks shown
-EOF
-
-test_done

tests/t1950-report.sh

@@ -0,0 +1,91 @@
+#!/bin/sh
+
+test_description='report functionality
+
+This test checks the reporting and the format of the report file.
+'
+. ./test-lib.sh
+
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +flowers @outside
+stop and think
+smell the coffee +wakeup
+make the coffee +wakeup
+visit http://example.com
+EOF
+
+test_todo_session 'create new report' <<EOF
+>>> todo.sh report
+2009-02-13T04:40:00 5 0
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+4 make the coffee +wakeup
+3 smell the coffee +wakeup
+2 stop and think
+5 visit http://example.com
+--
+TODO: 5 of 5 tasks shown
+EOF
+
+test_todo_session 'report of done tasks' <<EOF
+>>> todo.sh -A do 3
+3 x 2009-02-13 smell the coffee +wakeup
+TODO: 3 marked as done.
+x 2009-02-13 smell the coffee +wakeup
+TODO: $HOME/todo.txt archived.
+
+>>> todo.sh report
+2009-02-13T04:40:00 4 1
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+3 make the coffee +wakeup
+2 stop and think
+4 visit http://example.com
+--
+TODO: 4 of 4 tasks shown
+EOF
+
+test_todo_session 'report performs archiving' <<EOF
+>>> todo.sh -a do 3
+3 x 2009-02-13 make the coffee +wakeup
+TODO: 3 marked as done.
+
+>>> todo.sh report
+2009-02-13T04:40:00 3 2
+TODO: Report file updated.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+2 stop and think
+3 visit http://example.com
+--
+TODO: 3 of 3 tasks shown
+
+>>> todo.sh -p listfile done.txt
+2 x 2009-02-13 make the coffee +wakeup
+1 x 2009-02-13 smell the coffee +wakeup
+--
+DONE: 2 of 2 tasks shown
+EOF
+
+test_todo_session 'report is unchanged when no changes' <<EOF
+>>> cat report.txt
+2009-02-13T04:40:00 5 0
+2009-02-13T04:40:00 4 1
+2009-02-13T04:40:00 3 2
+
+>>> todo.sh report
+2009-02-13T04:40:00 3 2
+TODO: Report file is up-to-date.
+
+>>> cat report.txt
+2009-02-13T04:40:00 5 0
+2009-02-13T04:40:00 4 1
+2009-02-13T04:40:00 3 2
+EOF
+
+test_done

tests/t9999-testsuite_example.sh

@@ -85,13 +85,8 @@ TODO: $HOME/todo.txt archived.
 TODO: 5 of 5 tasks shown
 
 >>> todo.sh report
+2009-02-13T04:40:00 5 1
 TODO: Report file updated.
-2009-02-13-04:40:00 5 1
-
->>> todo.sh report
-TODO: Report file updated.
-2009-02-13-04:40:00 5 1
-2009-02-13-04:40:00 5 1
 
 >>> todo.sh append g a
 usage: todo.sh append ITEM# "TEXT TO APPEND"

todo.sh

@@ -67,8 +67,6 @@ shorthelp()
 		    report
 		    shorthelp
 
-		  Actions can be added and overridden using scripts in the actions
-		  directory.
 	EndHelp
 
     # Only list the one-line usage from the add-on actions. This assumes that
@@ -164,6 +162,7 @@ help()
 		      Adds FIRST THING I NEED TO DO to your todo.txt on its own line and
 		      Adds SECOND THING I NEED TO DO to you todo.txt on its own line.
 		      Project and context notation optional.
+		      Quotes optional.
 
 		    addto DEST "TEXT TO ADD"
 		      Adds a line of text to any file located in the todo.txt directory.
@@ -200,19 +199,13 @@ help()
 		    list [TERM...]
 		    ls [TERM...]
 		      Displays all tasks that contain TERM(s) sorted by priority with line
-		      numbers.  Each task must match all TERM(s) (logical AND); to display
+		      numbers.  If no TERM specified, lists entire todo.txt.
-		      tasks that contain any TERM (logical OR), use
-		      "TERM1\|TERM2\|..." (with quotes), or TERM1\\\|TERM2 (unquoted).
-		      Hides all tasks that contain TERM(s) preceded by a
-		      minus sign (i.e. -TERM). If no TERM specified, lists entire todo.txt.
 
 		    listall [TERM...]
 		    lsa [TERM...]
 		      Displays all the lines in todo.txt AND done.txt that contain TERM(s)
-		      sorted by priority with line  numbers.  Hides all tasks that
+		      sorted by priority with line  numbers.  If no TERM specified, lists
-		      contain TERM(s) preceded by a minus sign (i.e. -TERM).  If no
+		      entire todo.txt AND done.txt concatenated and sorted.
-		      TERM specified, lists entire todo.txt AND done.txt
-		      concatenated and sorted.
 
 		    listcon
 		    lsc
@@ -222,8 +215,7 @@ help()
 		    lf [SRC [TERM...]]
 		      Displays all the lines in SRC file located in the todo.txt directory,
 		      sorted by priority with line  numbers.  If TERM specified, lists
-		      all lines that contain TERM(s) in SRC file.  Hides all tasks that
+		      all lines that contain TERM in SRC file.
-		      contain TERM(s) preceded by a minus sign (i.e. -TERM).  
 		      Without any arguments, the names of all text files in the todo.txt
 		      directory are listed.
 
@@ -231,14 +223,11 @@ help()
 		    lsp [PRIORITY] [TERM...]
 		      Displays all tasks prioritized PRIORITY.
 		      If no PRIORITY specified, lists all prioritized tasks.
-		      If TERM specified, lists only prioritized tasks that contain TERM(s).
+		      If TERM specified, lists only prioritized tasks that contain TERM.
-		      Hides all tasks that contain TERM(s) preceded by a minus sign
-		      (i.e. -TERM).  
 
 		    listproj
 		    lsprj
-		      Lists all the projects (terms that start with a + sign) in
+		      Lists all the projects that start with the + sign in todo.txt.
-		      todo.txt.
 
 		    move ITEM# DEST [SRC]
 		    mv ITEM# DEST [SRC]
@@ -256,7 +245,7 @@ help()
 		    p ITEM# PRIORITY
 		      Adds PRIORITY to task on line ITEM#.  If the task is already
 		      prioritized, replaces current priority with new PRIORITY.
-		      PRIORITY must be a letter between A and Z.
+		      PRIORITY must be an uppercase letter between A and Z.
 
 		    replace ITEM# "UPDATED TODO"
 		      Replaces task on line ITEM# with UPDATED TODO.
@@ -267,6 +256,7 @@ help()
 		    shorthelp
 		      List the one-line usage of all built-in and add-on actions.
 
+
 	EndActionsHelp
 
         addonHelp
@@ -785,12 +775,8 @@ _list() {
     fi
     items=$(
         sed = "$src"                                            \
-        | sed -e '''
+        | sed "N; s/^/     /; s/ *\(.\{$PADDING,\}\)\n/\1 /"    \
-            N
+        | grep -v "^[ 0-9]\+ *$"
-            s/^/     /
-            s/ *\([ 0-9]\{'"$PADDING"',\}\)\n/\1 /
-            /^[ 0-9]\{1,\} *$/d
-         '''
     )
     if [ "${filter_command}" ]; then
         filtered_items=$(echo -n "$items" | eval "${filter_command}")
@@ -826,9 +812,8 @@ _list() {
             }
           '''  \
         | sed '''
-            s/'"${HIDE_PROJECTS_SUBSTITUTION:-^}"'//g
+            s/'${HIDE_PROJECTS_SUBSTITUTION:-^}'//g
-            s/'"${HIDE_CONTEXTS_SUBSTITUTION:-^}"'//g
+            s/'${HIDE_CONTEXTS_SUBSTITUTION:-^}'//g
-            s/'"${HIDE_CUSTOM_SUBSTITUTION:-^}"'//g
           '''                                                   \
         | eval ${TODOTXT_FINAL_FILTER}                          \
     )
@@ -1006,7 +991,7 @@ case $action in
 
     # Split multiple depri's, if comma separated change to whitespace separated
     # Loop the 'depri' function for each item
-    for item in ${*//,/ }; do
+    for item in $(echo $* | tr ',' ' '); do
         getTodo "$item"
 
 	if [[ "$todo" = \(?\)\ * ]]; then
@@ -1030,7 +1015,7 @@ case $action in
 
     # Split multiple do's, if comma separated change to whitespace separated
     # Loop the 'do' function for each item
-    for item in ${*//,/ }; do
+    for item in $(echo $* | tr ',' ' '); do
         getTodo "$item"
 
         # Check if this item has already been done
@@ -1083,20 +1068,7 @@ case $action in
     shift  ## Was lsa; new $1 is first search term
 
     cat "$TODO_FILE" "$DONE_FILE" > "$TMP_FILE"
-    TOTAL=$( sed -n '$ =' "$TODO_FILE" )
+    _list "$TMP_FILE" "$@"
-
-    post_filter_command="awk -v TOTAL=$TOTAL -v PADDING=${#TOTAL} '{ \$1 = sprintf(\"%\" PADDING \"d\", (\$1 > TOTAL ? 0 : \$1)); print }' "
-    TODOTXT_VERBOSE=0 _list "$TMP_FILE" "$@"
-
-    if [ $TODOTXT_VERBOSE -gt 0 ]; then
-        TDONE=$( sed -n '$ =' "$DONE_FILE" )
-        TASKNUM=$(TODOTXT_PLAIN=1 TODOTXT_VERBOSE=0 _list "$TODO_FILE" "$@" | sed -n '$ =')
-        DONENUM=$(TODOTXT_PLAIN=1 TODOTXT_VERBOSE=0 _list "$DONE_FILE" "$@" | sed -n '$ =')
-        echo "--"
-        echo "$(getPrefix "$TODO_FILE"): ${TASKNUM:-0} of ${TOTAL:-0} tasks shown"
-        echo "$(getPrefix "$DONE_FILE"): ${DONENUM:-0} of ${TDONE:-0} tasks shown"
-        echo "total $((TASKNUM + DONENUM)) of $((TOTAL + TDONE)) tasks shown"
-    fi
     ;;
 
 "listfile" | "lf" )
@@ -1219,18 +1191,20 @@ note: PRIORITY must be anywhere from A to Z."
     sed '/^x /!d' "$TODO_FILE" >> "$DONE_FILE"
     sed -i.bak '/^x /d' "$TODO_FILE"
 
-    NUMLINES=$( sed -n '$ =' "$TODO_FILE" )
-    if [ ${NUMLINES:-0} = "0" ]; then
-         echo "datetime todos dones" >> "$REPORT_FILE"
-    fi
-    #now report
     TOTAL=$( sed -n '$ =' "$TODO_FILE" )
     TDONE=$( sed -n '$ =' "$DONE_FILE" )
-    TECHO=$(echo $(date +%Y-%m-%d-%T); echo ' '; echo ${TOTAL:-0}; echo ' ';
+    NEWDATA="${TOTAL:-0} ${TDONE:-0}"
-    echo ${TDONE:-0})
+    LASTREPORT=$(sed -ne '$p' "$REPORT_FILE")
-    echo $TECHO >> "$REPORT_FILE"
+    LASTDATA=${LASTREPORT#* }   # Strip timestamp.
+    if [ "$LASTDATA" = "$NEWDATA" ]; then
+        echo "$LASTREPORT"
+        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file is up-to-date."
+    else
+        NEWREPORT="$(date +%Y-%m-%dT%T) ${NEWDATA}"
+        echo "${NEWREPORT}" >> "$REPORT_FILE"
+        echo "${NEWREPORT}"
         [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-    cat "$REPORT_FILE"
+    fi
     ;;
 
 * )

todo_completion

@@ -38,28 +38,20 @@ _todo()
                     +*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listproj);;
                     @*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listcon);;
                     *)  if [[ "$cur" =~ ^[0-9]+$ ]]; then
+                            local item=$(TODOTXT_VERBOSE=0 todo.sh -@ -+ -p -x command ls "^ *${cur} " | head -n 1)
+
                             # Remove the (padded) task number; we prepend the
-                            # user-provided $cur instead.
+                            # user-provided $cur.
-                            # Remove the timestamp prepended by the -t option,
+                            item=${item#* }
-                            # and the done date (for done tasks); there's no
+
-                            # todo.txt option for that yet.
+                            # Remove the timestamp prepended by the -t option;
-                            # But keep priority and "x"; they're short and may
+                            # there's no todo.txt option for that yet.
-                            # provide useful context.
+                            item=${item#[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] }
-                            # Remove any trailing whitespace; the Bash
+
-                            # completion inserts a trailing space itself.
-                            # Finally, limit the output to a single line just as
-                            # a safety check of the ls action output.
-                            local todo=$( \
-                                TODOTXT_VERBOSE=0 todo.sh -@ -+ -p -x command ls "^ *${cur} " | \
-                                sed -e 's/^ *[0-9]\+ //' -e 's/\((.) \)[0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} /\1/' \
-                                    -e 's/\([xX] \)\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{1,2\}/\1/' \
-                                    -e 's/[[:space:]]*$//' \
-                                    -e '1q' \
-                            )
                             # Append task text as a shell comment. This
                             # completion can be a safety check before a
                             # destructive todo.txt operation.
-                            [ "$todo" ] && COMPREPLY[0]="$cur # $todo"
+                            [ "$item" ] && COMPREPLY[0]="$cur # $item"
                             return 0
                         else
                             return 0