Bug Fix - annual recurrence due-date creep

- Fixed bug where annual recurring tasks exhibit due-date creep
  (thanks to T. Charles Yun).

AUTHORS

@@ -28,4 +28,5 @@ With thanks to:
   Paolo Marsi
   Eric Farris
   Bruce Dillahunty
+  Askme Too
 

ChangeLog

@@ -36,6 +36,9 @@
     has any tags.  This column can be added to any custom report.
   + Fixed bug where sometimes a task description was concatenated oddly if
     there was a colon somewhere in the description.
+  + Fixed bug that caused recurring annual tasks to exhibit a creeping due
+    date, because of an assumption of 365 days per year, which failed to
+    consider leap years (thanks to T. Charles Yun).
 
 ------ old releases ------------------------------
 

html/task.html

@@ -141,6 +141,9 @@
                       has any tags.  This column can be added to any custom report.
                   <li>Fixed bug where sometimes a task description was concatenated oddly if
                       there was a colon somewhere in the description.
+                  <li>Fixed bug that caused recurring annual tasks to exhibit a creeping due
+                      date, because of an assumption of 365 days per year, which failed to
+                      consider leap years (thanks to T. Charles Yun).
                 </ul>
 
                 <p>

src/T.cpp

@@ -691,6 +691,7 @@ int T::determineVersion (const std::string& line)
 bool T::validate () const
 {
   // TODO Verify until > due
+  // TODO Verify entry < until, due, start, end
   return true;
 }
 

src/task.cpp

@@ -674,6 +674,19 @@ Date getNextRecurrence (Date& current, std::string& period)
     return Date (m, d, y);
   }
 
+  else if (period == "annual" ||
+           period == "yearly")
+  {
+    y += 1;
+
+    // If the due data just happens to be 2/29 in a leap year, then simply
+    // incrementing y is going to create an invalid date.
+    if (m == 2 && d == 29)
+      d = 28;
+
+    return Date (m, d, y);
+  }
+
   // If the period is an 'easy' one, add it to current, and we're done.
   int days = convertDuration (period);
   return current + (days * 86400);

src/tests/bug.annual.t

@@ -0,0 +1,79 @@
+#! /usr/bin/perl
+################################################################################
+## task - a command line task list manager.
+##
+## Copyright 2006 - 2009, Paul Beckingham.
+## 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 => 14;
+
+# Create the rc file.
+if (open my $fh, '>', 'annual.rc')
+{
+  print $fh "data.location=.\n";
+  close $fh;
+  ok (-r 'annual.rc', 'Created annual.rc');
+}
+
+# If a task is added with a due date ten years ago, with an annual recurrence,
+# then the synthetic tasks in between then and now have a due date that creeps.
+#
+# ID Project Pri Due        Active Age Description
+# -- ------- --- ---------- ------ --- -----------
+#  2               1/1/2000          - foo
+#  3             12/31/2000          - foo
+#  4             12/31/2001          - foo
+#  5             12/31/2002          - foo
+#  6             12/31/2003          - foo
+#  7             12/30/2004          - foo
+#  8             12/30/2005          - foo
+#  9             12/30/2006          - foo
+# 10             12/30/2007          - foo
+# 11             12/29/2008          - foo
+# 12             12/29/2009          - foo
+
+qx{../task rc:annual.rc add foo due:1/1/2000 recur:annual until:1/1/2009};
+my $output = qx{../task rc:annual.rc list};
+like ($output, qr/2\s+1\/1\/2000\s+- foo/, 'synthetic 1 no creep');
+like ($output, qr/3\s+1\/1\/2001\s+- foo/, 'synthetic 2 no creep');
+like ($output, qr/4\s+1\/1\/2002\s+- foo/, 'synthetic 3 no creep');
+like ($output, qr/5\s+1\/1\/2003\s+- foo/, 'synthetic 4 no creep');
+like ($output, qr/6\s+1\/1\/2004\s+- foo/, 'synthetic 5 no creep');
+like ($output, qr/7\s+1\/1\/2005\s+- foo/, 'synthetic 6 no creep');
+like ($output, qr/8\s+1\/1\/2006\s+- foo/, 'synthetic 7 no creep');
+like ($output, qr/9\s+1\/1\/2007\s+- foo/, 'synthetic 8 no creep');
+like ($output, qr/10\s+1\/1\/2008\s+- foo/, 'synthetic 9 no creep');
+like ($output, qr/11\s+1\/1\/2009\s+- foo/, 'synthetic 10 no creep');
+
+# Cleanup.
+unlink 'pending.data';
+ok (!-r 'pending.data', 'Removed pending.data');
+
+unlink 'annual.rc';
+ok (!-r 'annual.rc', 'Removed annual.rc');
+
+exit 0;
+