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.

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/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

@@ -1068,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" )
-
-    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
+    _list "$TMP_FILE" "$@"
     ;;
 
 "listfile" | "lf" )
@@ -1204,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 ' ';
-    echo ${TDONE:-0})
-    echo $TECHO >> "$REPORT_FILE"
-    [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-    cat "$REPORT_FILE"
+    NEWDATA="${TOTAL:-0} ${TDONE:-0}"
+    LASTREPORT=$(sed -ne '$p' "$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."
+    fi
     ;;
 
 * )