nobacktick code check: Skip entire comment lines, too.

Pull request #26 by trajano (e24777fa2c) changed `...` to $(...), but the following commit 7900ad7e1b already added another old-style one. I think the tests can also be used for some simple enforcement of coding style, so here is a first shot at it.

Closes #46

tests/t0100-code-nobacktick.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+test_description='no old-style backtick command substitution
+
+This test checks the todo.sh script itself for occurrences
+of old-style backtick command substitution, which should be
+replaced with $(...).
+On failure, it will print each offending line number and line.
+'
+. ./test-lib.sh
+
+test_todo_session 'no old-style backtick command substitution' <<EOF
+>>> sed -n -e 's/\(^\|[ \t]\)#.*//' -e '/\d96/{=;p}' "$(which todo.sh)"
+EOF
+# Note: Must encode backtick as \d96 to avoid error in the test framework.
+
+test_done

tests/t1000-addlist.sh

@@ -77,4 +77,37 @@ TODO: 5 added.
 TODO: 5 of 5 tasks shown
 EOF
 
+#
+# Advanced add
+#
+
+cat /dev/null > todo.txt
+test_todo_session 'add with spaces' <<EOF
+>>> todo.sh add "notice the   three   spaces"
+1 notice the   three   spaces
+TODO: 1 added.
+
+>>> todo.sh add notice how the   spaces    get lost
+2 notice how the spaces get lost
+TODO: 2 added.
+
+>>> todo.sh list
+2 notice how the spaces get lost
+1 notice the   three   spaces
+--
+TODO: 2 of 2 tasks shown
+EOF
+
+cat /dev/null > todo.txt
+test_todo_session 'add with CR' <<EOF
+>>> todo.sh add "smell the
+Carriage Return"
+1 smell the Carriage Return
+TODO: 1 added.
+
+>>> todo.sh list
+1 smell the Carriage Return
+--
+TODO: 1 of 1 tasks shown
+EOF
 

tests/t1010-add-date.sh

@@ -21,6 +21,22 @@ TODO: 1 added.
 TODO: 1 of 1 tasks shown
 EOF
 
+test_todo_session 'cmd line first day with priority' <<EOF
+>>> todo.sh -pt add '(A) notice the daisies'
+2 (A) 2009-02-13 notice the daisies
+TODO: 2 added.
+
+>>> todo.sh -p list
+2 (A) 2009-02-13 notice the daisies
+1 2009-02-13 notice the daisies
+--
+TODO: 2 of 2 tasks shown
+
+>>> todo.sh -npf del 2
+2 (A) 2009-02-13 notice the daisies
+TODO: 2 deleted.
+EOF
+
 test_tick
 
 test_todo_session 'cmd line second day' <<EOF

tests/t1100-replace.sh

@@ -45,6 +45,12 @@ grow some corn
 thrash some hay
 chase the chickens
 EOF
+test_todo_session 'replace error' << EOF
+>>> todo.sh replace 10 "hej!"
+=== 1
+TODO: No task 10.
+EOF
+
 test_todo_session 'replace in multi-item file' <<EOF
 >>> todo.sh replace 1 smell the cheese
 1 smell the cows
@@ -62,33 +68,59 @@ TODO: Replaced task with:
 4 collect the eggs
 EOF
 
+echo '(A) collect the eggs' > todo.txt
 test_todo_session 'replace with priority' <<EOF
->>> todo.sh pri 4 a
-4 (A) collect the eggs
-TODO: 4 prioritized (A).
-
->>> todo.sh replace 4 "collect the bread"
-4 (A) collect the eggs
+>>> todo.sh replace 1 "collect the bread"
+1 (A) collect the eggs
 TODO: Replaced task with:
-4 (A) collect the bread
+1 (A) collect the bread
 
->>> todo.sh replace 4 collect the eggs
-4 (A) collect the bread
+>>> todo.sh replace 1 collect the eggs
+1 (A) collect the bread
 TODO: Replaced task with:
-4 (A) collect the eggs
+1 (A) collect the eggs
 EOF
 
+echo 'jump on hay' > todo.txt
 test_todo_session 'replace with &' << EOF
->>> todo.sh replace 3 "thrash the hay & thresh the wheat"
-3 jump on hay
+>>> todo.sh replace 1 "thrash the hay & thrash the wheat"
+1 jump on hay
 TODO: Replaced task with:
-3 thrash the hay & thresh the wheat
+1 thrash the hay & thrash the wheat
 EOF
 
-test_todo_session 'replace error' << EOF
->>> todo.sh replace 10 "hej!"
-=== 1
-TODO: No task 10.
+echo 'jump on hay' > todo.txt
+test_todo_session 'replace with spaces' <<EOF
+>>> todo.sh replace 1 "notice the   three   spaces"
+1 jump on hay
+TODO: Replaced task with:
+1 notice the   three   spaces
+EOF
+
+cat > todo.txt <<EOF
+smell the cows
+grow some corn
+thrash some hay
+chase the chickens
+EOF
+test_todo_session 'replace with symbols' <<EOF
+>>> todo.sh replace 1 "~@#$%^&*()-_=+[{]}|;:',<.>/?"
+1 smell the cows
+TODO: Replaced task with:
+1 ~@#$%^&*()-_=+[{]}|;:',<.>/?
+
+>>> todo.sh replace 2 '\`!\\"'
+2 grow some corn
+TODO: Replaced task with:
+2 \`!\\"
+
+>>> todo.sh list
+4 chase the chickens
+3 thrash some hay
+2 \`!\\"
+1 ~@#$%^&*()-_=+[{]}|;:',<.>/?
+--
+TODO: 4 of 4 tasks shown
 EOF
 
 cat /dev/null > todo.txt
@@ -124,6 +156,7 @@ TODO: Replaced task with:
 1 (A) 2009-02-13 this is just a new one
 EOF
 
+echo '(A) 2009-02-13 this is just a new one' > todo.txt
 test_todo_session 'replace with prepended date replaces existing date' <<EOF
 >>> todo.sh replace 1 2010-07-04 this also has a new date
 1 (A) 2009-02-13 this is just a new one

tests/t1200-pri.sh

@@ -55,7 +55,7 @@ TODO: 3 of 3 tasks shown
 
 >>> todo.sh pri 2 A
 2 (A) notice the sunflowers
-TODO: 2 prioritized (A).
+TODO: 2 re-prioritized from (C) to (A).
 
 >>> todo.sh -p list
 2 (A) notice the sunflowers
@@ -66,7 +66,7 @@ TODO: 3 of 3 tasks shown
 
 >>> todo.sh pri 2 a
 2 (A) notice the sunflowers
-TODO: 2 prioritized (A).
+TODO: 2 already prioritized (A).
 
 >>> todo.sh -p listpri
 2 (A) notice the sunflowers

tests/t1250-listpri.sh

@@ -0,0 +1,71 @@
+#!/bin/sh
+
+test_description='list priority functionality
+'
+. ./test-lib.sh
+
+test_todo_session 'listpri usage' <<EOF
+>>> todo.sh listpri ?
+usage: todo.sh listpri PRIORITY
+note: PRIORITY must a single letter from A to Z.
+=== 1
+EOF
+
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +flowers @outside
+(C) notice the sunflowers
+stop
+EOF
+test_todo_session 'basic listpri' <<EOF
+>>> todo.sh listpri A
+--
+TODO: 0 of 3 tasks shown
+
+>>> todo.sh -p listpri c
+2 (C) notice the sunflowers
+--
+TODO: 1 of 3 tasks shown
+EOF
+
+test_todo_session 'listpri highlighting' <<EOF
+>>> todo.sh listpri
+1 (B) smell the uppercase Roses +flowers @outside
+2 (C) notice the sunflowers
+--
+TODO: 2 of 3 tasks shown
+EOF
+
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +flowers @outside
+(C) notice the sunflowers
+(m)others will notice this
+(n) not a prioritized task
+notice the (C)opyright
+EOF
+test_todo_session 'listpri filtering' <<EOF
+>>> todo.sh -p listpri
+1 (B) smell the uppercase Roses +flowers @outside
+2 (C) notice the sunflowers
+--
+TODO: 2 of 5 tasks shown
+
+>>> todo.sh -p listpri b
+1 (B) smell the uppercase Roses +flowers @outside
+--
+TODO: 1 of 5 tasks shown
+
+>>> todo.sh -p listpri c
+2 (C) notice the sunflowers
+--
+TODO: 1 of 5 tasks shown
+
+>>> todo.sh -p listpri m
+--
+TODO: 0 of 5 tasks shown
+
+>>> todo.sh -p listpri n
+--
+TODO: 0 of 5 tasks shown
+EOF
+
+test_done

tests/t1400-prepend.sh

@@ -57,6 +57,34 @@ test_todo_session 'prepend with &' <<EOF
 3 no running & jumping now stop
 EOF
 
+echo 'jump on hay' > todo.txt
+test_todo_session 'prepend with spaces' <<EOF
+>>> todo.sh prepend 1 "notice the   three   spaces and"
+1 notice the   three   spaces and jump on hay
+EOF
+
+cat > todo.txt <<EOF
+smell the cows
+grow some corn
+thrash some hay
+chase the chickens
+EOF
+test_todo_session 'prepend with symbols' <<EOF
+>>> todo.sh prepend 1 "~@#$%^&*()-_=+[{]}|;:',<.>/?"
+1 ~@#$%^&*()-_=+[{]}|;:',<.>/? smell the cows
+
+>>> todo.sh prepend 2 '\`!\\"'
+2 \`!\\" grow some corn
+
+>>> todo.sh list
+4 chase the chickens
+3 thrash some hay
+2 \`!\\" grow some corn
+1 ~@#$%^&*()-_=+[{]}|;:',<.>/? smell the cows
+--
+TODO: 4 of 4 tasks shown
+EOF
+
 cat /dev/null > todo.txt
 test_todo_session 'prepend handling prepended date on add' <<EOF
 >>> todo.sh -t add "new task"

tests/t1500-do.sh

@@ -81,6 +81,6 @@ test_todo_session 'fail multiple do attempts' <<EOF
 TODO: 3 marked as done.
 
 >>> todo.sh -a do 3
-3 is already marked done
+TODO: 3 is already marked done.
 EOF
 test_done

tests/t1600-append.sh

@@ -17,6 +17,12 @@ test_todo_session 'append usage' <<EOF
 usage: todo.sh append ITEM# "TEXT TO APPEND"
 EOF
 
+test_todo_session 'append error' << EOF
+>>> todo.sh append 10 "hej!"
+=== 1
+TODO: No task 10.
+EOF
+
 test_todo_session 'basic append' <<EOF
 >>> todo.sh append 1 "smell the roses"
 1 notice the daisies smell the roses
@@ -37,11 +43,32 @@ test_todo_session 'basic append with &' <<EOF
 TODO: 1 of 1 tasks shown
 EOF
 
+echo 'jump on hay' > todo.txt
+test_todo_session 'append with spaces' <<EOF
+>>> todo.sh append 1 "and notice the   three   spaces"
+1 jump on hay and notice the   three   spaces
+EOF
 
-test_todo_session 'append error' << EOF
->>> todo.sh append 10 "hej!"
-=== 1
-TODO: No task 10.
+cat > todo.txt <<EOF
+smell the cows
+grow some corn
+thrash some hay
+chase the chickens
+EOF
+test_todo_session 'append with symbols' <<EOF
+>>> todo.sh append 1 "~@#$%^&*()-_=+[{]}|;:',<.>/?"
+1 smell the cows ~@#$%^&*()-_=+[{]}|;:',<.>/?
+
+>>> todo.sh append 2 '\`!\\"'
+2 grow some corn \`!\\"
+
+>>> todo.sh list
+4 chase the chickens
+2 grow some corn \`!\\"
+1 smell the cows ~@#$%^&*()-_=+[{]}|;:',<.>/?
+3 thrash some hay
+--
+TODO: 4 of 4 tasks shown
 EOF
 
 cat > todo.txt <<EOF

tests/t1700-depri.sh

@@ -68,4 +68,30 @@ TODO: 2 deprioritized.
 TODO: 3 of 3 tasks shown
 EOF
 
+cat > todo.txt <<EOF
+(B) smell the uppercase Roses +flowers @outside
+(A) notice the sunflowers
+stop
+EOF
+test_todo_session 'depriority of unprioritized task' <<EOF
+>>> todo.sh -p list
+2 (A) notice the sunflowers
+1 (B) smell the uppercase Roses +flowers @outside
+3 stop
+--
+TODO: 3 of 3 tasks shown
+
+>>> todo.sh depri 3 2
+TODO: 3 is not prioritized.
+2 notice the sunflowers
+TODO: 2 deprioritized.
+
+>>> todo.sh -p list
+1 (B) smell the uppercase Roses +flowers @outside
+2 notice the sunflowers
+3 stop
+--
+TODO: 3 of 3 tasks shown
+EOF
+
 test_done

todo.sh

@@ -1,7 +1,7 @@
 #! /bin/bash
 
 # === HEAVY LIFTING ===
-shopt -s extglob
+shopt -s extglob extquote
 
 # NOTE:  Todo.sh requires the .todo/config configuration file to run.
 # Place the .todo/config file in your home directory or use the -d option for a custom location.
@@ -58,7 +58,7 @@ shorthelp()
 		    listall|lsa [TERM...]
 		    listcon|lsc
 		    listfile|lf SRC [TERM...]
-		    listpri|lsp [PRIORITY]
+		    listpri|lsp [PRIORITY] [TERM...]
 		    listproj|lsprj
 		    move|mv ITEM# DEST [SRC]
 		    prepend|prep ITEM# "TEXT TO PREPEND"
@@ -143,10 +143,11 @@ help()
 		      sorted by priority with line  numbers.  If TERM specified, lists
 		      all lines that contain TERM in SRC file.
 
-		    listpri [PRIORITY]
-		    lsp [PRIORITY]
+		    listpri [PRIORITY] [TERM...]
+		    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.
 
 		    listproj
 		    lsprj
@@ -267,16 +268,17 @@ cleanup()
 
 cleaninput()
 {
-    # Cleanup the input
-    # Replace newlines with spaces Always
-    input=`echo $input | tr -d '\r\n'`
+    # Replace CR and LF with space; tasks always comprise a single line.
+    input=${input//$'\r'/ }
+    input=${input//$'\n'/ }
 
-    action_regexp="^\(append\|app\|prepend\|prep\|replace\)$"
-
-    # Check which action we are being used in as this affects what cleaning we do
-    if [ `echo $action | grep -c $action_regexp` -eq 1 ]; then
-        # These actions use sed and & as the matched string so escape it
-        input=`echo $input | sed 's/\&/\\\&/g'`
+    if [ "$1" = "for sed" ]; then
+        # This action uses sed with "|" as the substitution separator, and & as
+        # the matched string; these must be escaped.
+        # Backslashes must be escaped, too, and before the other stuff.
+        input=${input//\\/\\\\}
+        input=${input//|/\\|}
+        input=${input//&/\\&}
     fi
 }
 
@@ -321,11 +323,11 @@ replaceOrPrepend()
   else
     input=$*
   fi
-  cleaninput $input
+  cleaninput "for sed"
 
   # Retrieve existing priority and prepended date
-  priority=$(sed -e "$item!d" -e $item's/^\(([A-Z]) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\1/' "$TODO_FILE")
-  prepdate=$(sed -e "$item!d" -e $item's/^\(([A-Z]) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\2/' "$TODO_FILE")
+  priority=$(sed -e "$item!d" -e $item's/^\((.) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\1/' "$TODO_FILE")
+  prepdate=$(sed -e "$item!d" -e $item's/^\((.) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\2/' "$TODO_FILE")
 
   if [ "$prepdate" -a "$action" = "replace" ] && [ "$(echo "$input"|sed -e 's/^\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\}\)\{0,1\}.*/\1/')" ]; then
     # If the replaced text starts with a date, it will replace the existing
@@ -531,7 +533,7 @@ export SENTENCE_DELIMITERS=',.:;'
 }
 
 [ -e "$TODOTXT_CFG_FILE" ] || {
-    CFG_FILE_ALT=`dirname "$0"`"/todo.cfg"
+    CFG_FILE_ALT=$(dirname "$0")"/todo.cfg"
 
     if [ -e "$CFG_FILE_ALT" ]
     then
@@ -615,11 +617,11 @@ fi
 _addto() {
     file="$1"
     input="$2"
-    cleaninput $input
+    cleaninput
 
     if [[ $TODOTXT_DATE_ON_ADD = 1 ]]; then
-        now=`date '+%Y-%m-%d'`
-        input="$now $input"
+        now=$(date '+%Y-%m-%d')
+        input=$(echo "$input" | sed -e 's/^\(([A-Z]) \)\{0,1\}/\1'"$now /")
     fi
     echo "$input" >> "$file"
     if [ $TODOTXT_VERBOSE -gt 0 ]; then
@@ -750,7 +752,7 @@ _list() {
     fi
 }
 
-export -f _list die
+export -f cleaninput _list die
 
 # == HANDLE ACTION ==
 action=$( printf "%s\n" "$ACTION" | tr 'A-Z' 'a-z' )
@@ -842,7 +844,7 @@ case $action in
       [$SENTENCE_DELIMITERS]*)  appendspace=;;
       *)                        appendspace=" ";;
     esac
-    cleaninput $input
+    cleaninput "for sed"
 
     if sed -i.bak $item" s|^.*|&${appendspace}${input}|" "$TODO_FILE"; then
         if [ $TODOTXT_VERBOSE -gt 0 ]; then
@@ -916,15 +918,12 @@ case $action in
 
     # Split multiple depri's, if comma separated change to whitespace separated
     # Loop the 'depri' function for each item
-    for item in `echo $* | tr ',' ' '`; do
+    for item in $(echo $* | tr ',' ' '); do
 	[[ "$item" = +([0-9]) ]] || die "$errmsg"
 	todo=$(sed "$item!d" "$TODO_FILE")
 	[ -z "$todo" ] && die "TODO: No task $item."
 
-	sed -e $item"s/^(.) //" "$TODO_FILE" > /dev/null 2>&1
-
-	if [ "$?" -eq 0 ]; then
-	    #it's all good, continue
+	if sed "$item!d" "$TODO_FILE" | grep "^(.) " > /dev/null; then
 	    sed -i.bak -e $item"s/^(.) //" "$TODO_FILE"
 	    if [ $TODOTXT_VERBOSE -gt 0 ]; then
 		NEWTODO=$(sed "$item!d" "$TODO_FILE")
@@ -932,7 +931,7 @@ case $action in
 		echo "TODO: $item deprioritized."
 	    fi
 	else
-	    die "$errmsg"
+	    echo "TODO: $item is not prioritized."
 	fi
     done
     ;;
@@ -945,7 +944,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 `echo $* | tr ',' ' '`; do 
+    for item in $(echo $* | tr ',' ' '); do 
         [ -z "$item" ] && die "$errmsg"
         [[ "$item" = +([0-9]) ]] || die "$errmsg"
 
@@ -953,8 +952,8 @@ case $action in
         [ -z "$todo" ] && die "TODO: No task $item."
 
         # Check if this item has already been done
-        if [ `echo $todo | grep -c "^x "` -eq 0 ] ; then
-            now=`date '+%Y-%m-%d'`
+        if [ "${todo:0:2}" != "x " ]; then
+            now=$(date '+%Y-%m-%d')
             # remove priority once item is done
             sed -i.bak $item"s/^(.) //" "$TODO_FILE"
             sed -i.bak $item"s|^|x $now |" "$TODO_FILE"
@@ -964,7 +963,7 @@ case $action in
                 echo "TODO: $item marked as done."
 	    fi
         else
-            echo "$item is already marked done"
+            echo "TODO: $item is already marked done."
         fi
     done
 
@@ -1012,7 +1011,7 @@ case $action in
     ;;
 
 "listpri" | "lsp" )
-    shift ## was "listpri", new $1 is priority to list
+    shift ## was "listpri", new $1 is priority to list or first TERM
 
     if [ "${1:-}" ]
     then
@@ -1023,11 +1022,11 @@ case $action in
         }
     else
         ## No priority specified; show all priority tasks
-        pri="[[:upper:]]"
+        pri="[A-Z]"
     fi
-    pri="($pri)"
 
-    _list "$TODO_FILE" "$pri"
+    post_filter_command="grep '^ *[0-9]\+ (${pri}) '"
+    _list "$TODO_FILE" "$@"
     ;;
 
 "move" | "mv" )
@@ -1089,18 +1088,23 @@ note: PRIORITY must be anywhere from A to Z."
     [[ "$item" = +([0-9]) ]] || die "$errmsg"
     [[ "$newpri" = @([A-Z]) ]] || die "$errmsg"
 
-    sed -e $item"s/^(.) //" -e $item"s/^/($newpri) /" "$TODO_FILE" > /dev/null 2>&1
-
-    if [ "$?" -eq 0 ]; then
-        #it's all good, continue
+    oldpri=$(sed -ne $item's/^(\(.\)) .*/\1/p' "$TODO_FILE")
+    if [ "$oldpri" != "$newpri" ]; then
         sed -i.bak -e $item"s/^(.) //" -e $item"s/^/($newpri) /" "$TODO_FILE"
+    fi
     if [ $TODOTXT_VERBOSE -gt 0 ]; then
         NEWTODO=$(sed "$item!d" "$TODO_FILE")
         echo "$item $NEWTODO"
+        if [ "$oldpri" != "$newpri" ]; then
+            if [ "$oldpri" ]; then
+                echo "TODO: $item re-prioritized from ($oldpri) to ($newpri)."
+            else
                 echo "TODO: $item prioritized ($newpri)."
             fi
-    else
-        die "$errmsg"
+        fi
+    fi
+    if [ "$oldpri" = "$newpri" ]; then
+        echo "TODO: $item already prioritized ($newpri)."
     fi
     ;;