Import - todo.sh

- Wrote a todo.sh parser based on Gina's specs.
- Started unit tests (not finished).
This commit is contained in:
Paul Beckingham
2011-08-30 18:29:57 -04:00
parent 4f73d7232f
commit b4a583b951
4 changed files with 247 additions and 131 deletions

View File

@@ -1,16 +0,0 @@
External Scripts
----------------
Add-on scripts are executed via an alias mechanism in taskwarrior. This has the
effect of this command:
task <script> <arguments>
resulting in the ultimate execution of:
<script> <arguments>
All external scripts are treated in the same manner, and have no access to the
taskwarrior internals.
---

158
scripts/add-ons/import-todo.sh.pl Executable file
View File

@@ -0,0 +1,158 @@
#! /usr/bin/perl
################################################################################
## taskwarrior - a command line task list manager.
##
## Copyright 2006 - 2011, Paul Beckingham, Federico Hernandez.
## All rights reserved.
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 2 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
## FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, write to the
##
## Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor,
## Boston, MA
## 02110-1301
## USA
##
################################################################################
use strict;
use warnings;
use Time::Local;
# Priority mappings.
my %priority_map = (
'a' => 'H', 'b' => 'M', 'c' => 'L', 'd' => 'L', 'e' => 'L', 'f' => 'L',
'g' => 'L', 'h' => 'L', 'i' => 'L', 'j' => 'L', 'k' => 'L', 'l' => 'L',
'm' => 'L', 'n' => 'L', 'o' => 'L', 'p' => 'L', 'q' => 'L', 'r' => 'L',
's' => 'L', 't' => 'L', 'u' => 'L', 'v' => 'L', 'w' => 'L', 'x' => 'L',
'y' => 'L', 'z' => 'L');
my @tasks;
while (my $todo = <>)
{
my $status = 'pending';
my $priority = '';
my $entry = '';
my $end = '';
my @projects;
my @contexts;
my $description = '';
my $due = '';
# pending + pri + entry
if ($todo =~ /^(\([A-Z])\)\s(\d{4}-\d{2}-\d{2})\s(.+)$/i)
{
($status, $priority, $entry, $description) = ('pending', $1, epoch ($2), $3);
}
# pending + pri
elsif ($todo =~ /^(\([A-Z])\)\s(.+)$/i)
{
($status, $priority, $description) = ('pending', $1, $2);
}
# pending + entry
elsif ($todo =~ /^(\d{4}-\d{2}-\d{2})\s(.+)$/i)
{
($status, $entry, $description) = ('pending', epoch ($1), $2);
}
# done + end + entry
elsif ($todo =~ /^x\s(\d{4}-\d{2}-\d{2})\s(\d{4}-\d{2}-\d{2})\s(.+)$/i)
{
($status, $end, $entry, $description) = ('completed', epoch ($1), epoch ($2), $3);
}
# done + end
elsif ($todo =~ /^x\s(\d{4}-\d{2}-\d{2})\s(.+)$/i)
{
($status, $end, $description) = ('completed', epoch ($1), $2);
}
# done
elsif ($todo =~ /^x\s(.+)$/i)
{
($status, $description) = ('completed', $1);
}
# pending
elsif ($todo =~ /^(.+)$/i)
{
($status, $description) = ('pending', $1);
}
# Project
@projects = $description =~ /\+(\S+)/ig;
# Contexts
@contexts = $description =~ /\@(\S+)/ig;
# Due
$due = epoch ($1) if $todo =~ /\sdue:(\d{4}-\d{2}-\d{2})/i;
# Map priorities
$priority = $priority_map{lc $priority} if $priority ne '';
# Pick first project
my $first_project = shift @projects;
# Compose the JSON
my $json = '';
$json .= "{\"status\":\"${status}\"";
$json .= ",\"priority\":\"${priority}\"" if defined $priority && $priority ne '';
$json .= ",\"project\":\"${first_project}\"" if defined $first_project && $first_project ne '';
$json .= ",\"entry\":\"${entry}\"" if $entry ne '';
$json .= ",\"end\":\"${end}\"" if $end ne '';
$json .= ",\"due\":\"${due}\"" if $due ne '';
if (@contexts)
{
$json .= ",\"tags\":\"" . join (',', @contexts) . "\"";
}
$json .= ",\"description\":\"${description}\"}";
push @tasks, $json;
}
print "[\n", join (",\n", @tasks), "\n]\n";
exit 0;
################################################################################
sub epoch
{
my ($input) = @_;
my ($y, $m, $d) = $input =~ /(\d{4})-(\d{2})-(\d{2})/;
return timelocal (0, 0, 0, $d, $m-1, $y-1900);
}
################################################################################
__DATA__
(A) @phone thank Mom for the meatballs
(B) +GarageSale @phone schedule Goodwill pickup
+GarageSale @home post signs around the neighborhood
@shopping Eskimo pies
(A) Call Mom
Really gotta call Mom (A) @phone @someday
(b)->get back to the boss
2011-03-02 Document +TodoTxt task format
(A) 2011-03-02 Call Mom
(A) Call Mom 2011-03-02
(A) Call Mom +Family +PeaceLoveAndHappiness @iphone @phone
X 2011-03-03 Call Mom
xylophone lesson
x 2011-03-02 2011-03-01 Review Tim's pull request +TodoTxtTouch @github

89
test/import.todo.sh.t Executable file
View File

@@ -0,0 +1,89 @@
#! /usr/bin/perl
################################################################################
## taskwarrior - a command line task list manager.
##
## Copyright 2006 - 2011, Paul Beckingham, Federico Hernandez.
## All rights reserved.
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 2 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
## FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, write to the
##
## Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor,
## Boston, MA
## 02110-1301
## USA
##
################################################################################
use strict;
use warnings;
use Test::More tests => 5;
# Create the rc file.
if (open my $fh, '>', 'import.rc')
{
print $fh "data.location=.\n",
"json.array=on\n",
"dateformat=YYYY-M-D\n";
close $fh;
ok (-r 'import.rc', 'Created import.rc');
}
# Create import file.
if (open my $fh, '>', 'import.txt')
{
print $fh "(A) \@phone thank Mom for the meatballs\n",
"(B) +GarageSale \@phone schedule Goodwill pickup\n",
"+GarageSale \@home post signs around the neighborhood\n",
"\@shopping Eskimo pies\n",
"(A) Call Mom\n",
"Really gotta call Mom (A) \@phone \@someday\n",
"(b)->get back to the boss\n",
"2011-03-02 Document +TodoTxt task format\n",
"(A) 2011-03-02 Call Mom\n",
"(A) Call Mom 2011-03-02\n",
"(A) Call Mom +Family +PeaceLoveAndHappiness \@iphone \@phone\n",
"X 2011-03-03 Call Mom\n",
"xylophone lesson\n",
"x 2011-03-02 2011-03-01 Review Tim's pull request +TodoTxtTouch \@github\n";
close $fh;
ok (-r 'import.txt', 'Created sample import data');
}
# Convert todo.sh --> task JSON.
my $output = qx{../scripts/add-ons/import-todo.sh.pl <import.txt >json.txt};
diag ($output);
# Import the JSON.
$output = qx{../src/task rc:import.rc import json.txt};
diag ($output);
$output = qx{../src/task rc:import.rc info 1};
diag ($output);
like ($output, qr/^Priority.+H/ms, '1 pri:H');
# Cleanup.
unlink qw(pending.data completed.data undo.data backlog.data synch.key import.rc import.txt json.txt);
ok (! -r 'pending.data' &&
! -r 'completed.data' &&
! -r 'undo.data' &&
! -r 'backlog.data' &&
! -r 'synch_key.data' &&
! -r 'import.rc' &&
! -r 'import.txt' &&
! -r 'json.txt', 'Cleanup');
exit 0;

View File

@@ -1,115 +0,0 @@
#! /usr/bin/perl
################################################################################
## taskwarrior - a command line task list manager.
##
## Copyright 2006 - 2011, Paul Beckingham, Federico Hernandez.
## All rights reserved.
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 2 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
## FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, write to the
##
## Free Software Foundation, Inc.,
## 51 Franklin Street, Fifth Floor,
## Boston, MA
## 02110-1301
## USA
##
################################################################################
use strict;
use warnings;
use Test::More tests => 32;
# Create the rc file.
if (open my $fh, '>', 'import.rc')
{
print $fh "data.location=.\n",
"dateformat=YYYY-M-D\n";
close $fh;
ok (-r 'import.rc', 'Created import.rc');
}
# Create import file.
if (open my $fh, '>', 'import.txt')
{
print $fh "(A) Prioritized todo\n",
"(B) 2011-05-09 Prioritized with entry date\n",
"2011-05-09 Not prioritized with entry date\n",
"(C) +Project \@Context Priority with Project and context t:2011-05-11 < due date\n",
"(D) 2011-05-09 +Project +OtherProject \@Context \@OtherContext Two Projects and Context with date\n",
"x 2011-05-11 2011-05-09 +Project +OtherProject \@Context with date and completion date\n";
close $fh;
ok (-r 'import.txt', 'Created sample import data');
}
my $output = qx{../src/task rc:import.rc import import.txt};
like ($output, qr/Imported 6 tasks successfully, with 0 errors./, 'no errors');
$output = qx{../src/task rc:import.rc info 1};
like ($output, qr/^Priority.+H.*$/m, 'priority (A) -> pri:H');
like ($output, qr/^Description.+Prioritized todo.*$/m, '... -> desc:...');
$output = qx{../src/task rc:import.rc info 2};
like ($output, qr/^Priority.+M.*$/m, 'priority (B) -> pri:M');
like ($output, qr/^Description.+Prioritized with entry Date.*$/m, '... -> desc:...');
$output = qx{../src/task rc:import.rc info 3};
like ($output, qr/^Project.+Project.*$/m, '+Project -> pro:Project');
like ($output, qr/^Description.+Not prioritized with entry Date.*$/m, '... -> desc:...');
$output = qx{../src/task rc:import.rc info 4};
like ($output, qr/^Priority.+L.*$/m, 'priority (C) -> pri:L');
like ($output, qr/^Project.+Project.*$/m, '+Project -> pro:Project');
like ($output, qr/^Description.+Priority with Project and context.*$/m, '... -> desc:...');
like ($output, qr/^Tags.+\@Context.*$/m, '@Context -> +@Context');
like ($output, qr/^Due.+2011-05-11.*$/m, 't:2011-05-11 -> due:2011-05-11');
$output = qx{../src/task rc:import.rc info 5};
unlike ($output, qr/^Priority/m, 'priority (D) -> pri:');
like ($output, qr/^Project.+Project.*$/m, '+Project -> pro:Project');
like ($output, qr/^Description.+Two Projects and Context with date.*$/m, '... -> desc:...');
like ($output, qr/^Tags.+\@Context.*$/m, '@Context -> +@Context');
like ($output, qr/^Entry.+2011-05-09.*$/m, '2011-05-09 -> entry:2011-05-09');
$output = qx{../src/task rc:import.rc info 6};
like ($output, qr/^Description.+With date and completion date.*$/m, '... -> desc:...');
like ($output, qr/^Description.+With date and completion date.*$/m, '... -> desc:...');
like ($output, qr/^Tags.+\@Context.*$/m, '@Context -> +@Context');
like ($output, qr/^Entry.+2011-05-09.*$/m, '2011-05-09 -> entry:2011-05-09');
like ($output, qr/^End.+2011-05-11.*$/m, '2011-05-11 -> end:2011-05-11');
like ($output, qr/^Status.+Completed.*$/m, 'x -> status:Completed');
# Cleanup.
unlink 'import.txt';
ok (!-r 'import.txt', 'Removed import.txt');
unlink 'pending.data';
ok (!-r 'pending.data', 'Removed pending.data');
unlink 'completed.data';
ok (!-r 'completed.data', 'Removed completed.data');
unlink 'undo.data';
ok (!-r 'undo.data', 'Removed undo.data');
unlink 'backlog.data';
ok (!-r 'backlog.data', 'Removed backlog.data');
unlink 'synch.key';
ok (!-r 'synch.key', 'Removed synch.key');
unlink 'import.rc';
ok (!-r 'import.rc', 'Removed import.rc');
exit 0;