flo/todo.txt-cli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Refactoring: Extract getTodo() and getNewtodo() functions.

Browse Source 
The retrieval of a task text for $item and associated error handling so far was scattered around the individual actions. This is now consolidated in two new utility functions, which directly set $todo or $newtodo, respectively. (Inconsistent variable names like $NEWTODO have been adapted.) This ensures that all actions perform the same error checking, reduces a bit of duplication, and allows custom add-ons to benefit from these exported functions. Ah, and the error messages for the "move" action is now more in line with the other errors; unfortunately, this isn't yet covered by a test.

Note that the check whether $item is numeric must not use the +([0-9]) extglob any more, as such functions cannot be exported; a new Bash doesn't have the "shopt -s extglob" and complains with a syntax error. Fortunately, it is possible to perform the same check via standard Bash mechanisms.
This commit is contained in:
Ingo Karkat
2011-12-17 22:36:02 +01:00
parent 55679d136f
commit cb908bd454
1 changed files with 59 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
todo.sh
View File

@@ -296,6 +296,11 @@ cleanup()
cleaninput() cleaninput()
{ {
# Parameters: When $1 = "for sed", performs additional escaping for use
# in sed substitution with "|" separators.
# Precondition: $input contains text to be cleaned.
# Postcondition: Modifies $input.
# Replace CR and LF with space; tasks always comprise a single line. # Replace CR and LF with space; tasks always comprise a single line.
input=${input//$'\r'/ } input=${input//$'\r'/ }
input=${input//$'\n'/ } input=${input//$'\n'/ }
@@ -310,6 +315,35 @@ cleaninput()
fi fi
} }
getTodo()
{
# Parameters: $1: task number
# $2: Optional todo file
# Precondition: $errmsg contains usage message.
# Postcondition: $todo contains task text.
local item=$1
[ -z "$item" ] && die "$errmsg"
[ "${item//[0-9]/}" ] && die "$errmsg"
todo=$(sed "$item!d" "${2:-$TODO_FILE}")
[ -z "$todo" ] && die "TODO: No task $item${2:+ in $2}."
}
getNewtodo()
{
# Parameters: $1: task number
# $2: Optional todo file
# Precondition: None.
# Postcondition: $newtodo contains task text.
local item=$1
[ -z "$item" ] && die 'Programming error: $item should exist.'
[ "${item//[0-9]/}" ] && die 'Programming error: $item should be numeric.'
newtodo=$(sed "$item!d" "${2:-$TODO_FILE}")
[ -z "$newtodo" ] && die "TODO: No updated task $item${2:+ in $2}."
}
archive() archive()
{ {
#defragment blank lines #defragment blank lines
@@ -338,12 +372,7 @@ replaceOrPrepend()
;; ;;
esac esac
shift; item=$1; shift shift; item=$1; shift
getTodo "$item"
[ -z "$item" ] && die "$errmsg"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
todo=$(sed "$item!d" "$TODO_FILE")
[ -z "$todo" ] && die "TODO: No task $item."
if [[ -z "$1" && $TODOTXT_FORCE = 0 ]]; then if [[ -z "$1" && $TODOTXT_FORCE = 0 ]]; then
echo -n "$querytext" echo -n "$querytext"
@@ -368,7 +397,7 @@ replaceOrPrepend()
# date again. # date again.
sed -i.bak -e "$item s/^${priority}${prepdate}//" -e "$item s|^.*|${priority}${prepdate}${input}${backref}|" "$TODO_FILE" sed -i.bak -e "$item s/^${priority}${prepdate}//" -e "$item s|^.*|${priority}${prepdate}${input}${backref}|" "$TODO_FILE"
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
newtodo=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
case "$action" in case "$action" in
replace) replace)
echo "$item $todo" echo "$item $todo"
@@ -797,7 +826,7 @@ _list() {
fi fi
} }
export -f cleaninput shellquote filtercommand _list die export -f cleaninput getTodo getNewtodo shellquote filtercommand _list die
# == HANDLE ACTION == # == HANDLE ACTION ==
action=$( printf "%s\n" "$ACTION" | tr 'A-Z' 'a-z' ) action=$( printf "%s\n" "$ACTION" | tr 'A-Z' 'a-z' )
@@ -874,11 +903,8 @@ case $action in
"append" | "app" ) "append" | "app" )
errmsg="usage: $TODO_SH append ITEM# \"TEXT TO APPEND\"" errmsg="usage: $TODO_SH append ITEM# \"TEXT TO APPEND\""
shift; item=$1; shift shift; item=$1; shift
getTodo "$item"
[ -z "$item" ] && die "$errmsg"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
todo=$(sed "$item!d" "$TODO_FILE")
[ -z "$todo" ] && die "TODO: No task $item."
if [[ -z "$1" && $TODOTXT_FORCE = 0 ]]; then if [[ -z "$1" && $TODOTXT_FORCE = 0 ]]; then
echo -n "Append: " echo -n "Append: "
read input read input
@@ -893,7 +919,7 @@ case $action in
if sed -i.bak $item" s|^.*|&${appendspace}${input}|" "$TODO_FILE"; then if sed -i.bak $item" s|^.*|&${appendspace}${input}|" "$TODO_FILE"; then
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
newtodo=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
echo "$item $newtodo" echo "$item $newtodo"
fi fi
else else
@@ -908,14 +934,11 @@ case $action in
# replace deleted line with a blank line when TODOTXT_PRESERVE_LINE_NUMBERS is 1 # replace deleted line with a blank line when TODOTXT_PRESERVE_LINE_NUMBERS is 1
errmsg="usage: $TODO_SH del ITEM# [TERM]" errmsg="usage: $TODO_SH del ITEM# [TERM]"
item=$2 item=$2
[ -z "$item" ] && die "$errmsg" getTodo "$item"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
DELETEME=$(sed "$item!d" "$TODO_FILE")
[ -z "$DELETEME" ] && die "TODO: No task $item."
if [ -z "$3" ]; then if [ -z "$3" ]; then
if [ $TODOTXT_FORCE = 0 ]; then if [ $TODOTXT_FORCE = 0 ]; then
echo "Delete '$DELETEME'? (y/n)" echo "Delete '$todo'? (y/n)"
read ANSWER read ANSWER
else else
ANSWER="y" ANSWER="y"
@@ -929,7 +952,7 @@ case $action in
sed -i.bak -e $item"s/^.*//" "$TODO_FILE" sed -i.bak -e $item"s/^.*//" "$TODO_FILE"
fi fi
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
echo "$item $DELETEME" echo "$item $todo"
echo "TODO: $item deleted." echo "TODO: $item deleted."
fi fi
else else
@@ -943,13 +966,13 @@ case $action in
-e $item"s/ *$3 */ /g" \ -e $item"s/ *$3 */ /g" \
-e $item"s/$3//g" \ -e $item"s/$3//g" \
"$TODO_FILE" "$TODO_FILE"
newtodo=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
if [ "$DELETEME" = "$newtodo" ]; then if [ "$todo" = "$newtodo" ]; then
[ $TODOTXT_VERBOSE -gt 0 ] && echo "$item $DELETEME" [ $TODOTXT_VERBOSE -gt 0 ] && echo "$item $todo"
die "TODO: '$3' not found; no removal done." die "TODO: '$3' not found; no removal done."
fi fi
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
echo "$item $DELETEME" echo "$item $todo"
echo "TODO: Removed '$3' from task." echo "TODO: Removed '$3' from task."
echo "$item $newtodo" echo "$item $newtodo"
fi fi
@@ -964,15 +987,13 @@ case $action in
# Split multiple depri's, if comma separated change to whitespace separated # Split multiple depri's, if comma separated change to whitespace separated
# Loop the 'depri' function for each item # Loop the 'depri' function for each item
for item in $(echo $* | tr ',' ' '); do for item in $(echo $* | tr ',' ' '); do
[[ "$item" = +([0-9]) ]] || die "$errmsg" getTodo "$item"
todo=$(sed "$item!d" "$TODO_FILE")
[ -z "$todo" ] && die "TODO: No task $item."
if [[ "$todo" = \(?\)\ * ]]; then if [[ "$todo" = \(?\)\ * ]]; then
sed -i.bak -e $item"s/^(.) //" "$TODO_FILE" sed -i.bak -e $item"s/^(.) //" "$TODO_FILE"
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
NEWTODO=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
echo "$item $NEWTODO" echo "$item $newtodo"
echo "TODO: $item deprioritized." echo "TODO: $item deprioritized."
fi fi
else else
@@ -990,11 +1011,7 @@ case $action in
# Split multiple do's, if comma separated change to whitespace separated # Split multiple do's, if comma separated change to whitespace separated
# Loop the 'do' function for each item # Loop the 'do' function for each item
for item in $(echo $* | tr ',' ' '); do for item in $(echo $* | tr ',' ' '); do
[ -z "$item" ] && die "$errmsg" getTodo "$item"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
todo=$(sed "$item!d" "$TODO_FILE")
[ -z "$todo" ] && die "TODO: No task $item."
# Check if this item has already been done # Check if this item has already been done
if [ "${todo:0:2}" != "x " ]; then if [ "${todo:0:2}" != "x " ]; then
@@ -1003,7 +1020,7 @@ case $action in
sed -i.bak $item"s/^(.) //" "$TODO_FILE" sed -i.bak $item"s/^(.) //" "$TODO_FILE"
sed -i.bak $item"s|^|x $now |" "$TODO_FILE" sed -i.bak $item"s|^|x $now |" "$TODO_FILE"
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
newtodo=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
echo "$item $newtodo" echo "$item $newtodo"
echo "TODO: $item marked as done." echo "TODO: $item marked as done."
fi fi
@@ -1086,19 +1103,16 @@ case $action in
dest="$TODO_DIR/$3" dest="$TODO_DIR/$3"
src="$TODO_DIR/$4" src="$TODO_DIR/$4"
[ -z "$item" ] && die "$errmsg"
[ -z "$4" ] && src="$TODO_FILE" [ -z "$4" ] && src="$TODO_FILE"
[ -z "$dest" ] && die "$errmsg" [ -z "$dest" ] && die "$errmsg"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
[ -f "$src" ] || die "TODO: Source file $src does not exist." [ -f "$src" ] || die "TODO: Source file $src does not exist."
[ -f "$dest" ] || die "TODO: Destination file $dest does not exist." [ -f "$dest" ] || die "TODO: Destination file $dest does not exist."
MOVEME=$(sed "$item!d" "$src") getTodo "$item" "$src"
[ -z "$MOVEME" ] && die "$item: No such item in $src." [ -z "$todo" ] && die "$item: No such item in $src."
if [ $TODOTXT_FORCE = 0 ]; then if [ $TODOTXT_FORCE = 0 ]; then
echo "Move '$MOVEME' from $src to $dest? (y/n)" echo "Move '$todo' from $src to $dest? (y/n)"
read ANSWER read ANSWER
else else
ANSWER="y" ANSWER="y"
@@ -1111,10 +1125,10 @@ case $action in
# leave blank line behind (preserves line numbers) # leave blank line behind (preserves line numbers)
sed -i.bak -e $item"s/^.*//" "$src" sed -i.bak -e $item"s/^.*//" "$src"
fi fi
echo "$MOVEME" >> "$dest" echo "$todo" >> "$dest"
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
echo "$item $MOVEME" echo "$item $todo"
echo "TODO: $item moved from '$src' to '$dest'." echo "TODO: $item moved from '$src' to '$dest'."
fi fi
else else
@@ -1135,11 +1149,8 @@ case $action in
note: PRIORITY must be anywhere from A to Z." note: PRIORITY must be anywhere from A to Z."
[ "$#" -ne 3 ] && die "$errmsg" [ "$#" -ne 3 ] && die "$errmsg"
[[ "$item" = +([0-9]) ]] || die "$errmsg"
[[ "$newpri" = @([A-Z]) ]] || die "$errmsg" [[ "$newpri" = @([A-Z]) ]] || die "$errmsg"
getTodo "$item"
todo=$(sed "$item!d" "$TODO_FILE")
[ -z "$todo" ] && die "TODO: No task $item."
oldpri= oldpri=
if [[ "$todo" = \(?\)\ * ]]; then if [[ "$todo" = \(?\)\ * ]]; then
@@ -1150,8 +1161,8 @@ note: PRIORITY must be anywhere from A to Z."
sed -i.bak -e $item"s/^(.) //" -e $item"s/^/($newpri) /" "$TODO_FILE" sed -i.bak -e $item"s/^(.) //" -e $item"s/^/($newpri) /" "$TODO_FILE"
fi fi
if [ $TODOTXT_VERBOSE -gt 0 ]; then if [ $TODOTXT_VERBOSE -gt 0 ]; then
NEWTODO=$(sed "$item!d" "$TODO_FILE") getNewtodo "$item"
echo "$item $NEWTODO" echo "$item $newtodo"
if [ "$oldpri" != "$newpri" ]; then if [ "$oldpri" != "$newpri" ]; then
if [ "$oldpri" ]; then if [ "$oldpri" ]; then
echo "TODO: $item re-prioritized from ($oldpri) to ($newpri)." echo "TODO: $item re-prioritized from ($oldpri) to ($newpri)."