Merge lp:~rohanm/gtimelog/custom-date-range-report into lp:~gtimelog-dev/gtimelog/trunk

[Rohan Mitchell]

Added a custom date range report so that you can generate a report between any two dates.
This feature can be reached at Report -> Report for a Custom Date Range.
This branch includes tests for the new report.

[Marius Gedminas (mgedmin)]

Looks good, thanks!

I'd like to play with Glade and create a single dialog for selecting both the start and end dates in one go, instead of dealing with two distinct unlabeled popup dialogs asking for same thing. Or maybe you'd care to do that? ;-)

review: Approve

[Rohan Mitchell (rohanm)]

I'll see if I can find some time to hack on it, perhaps Monday :)

> Looks good, thanks!
>
> I'd like to play with Glade and create a single dialog for selecting both the
> start and end dates in one go, instead of dealing with two distinct unlabeled
> popup dialogs asking for same thing. Or maybe you'd care to do that? ;-)

[Marius Gedminas (mgedmin)]

No need any more, I found some time to play with Glade today.

=== modified file 'NEWS.txt'
--- NEWS.txt	2013-02-10 19:56:21 +0000
+++ NEWS.txt	2013-05-06 00:11:25 +0000
@@ -1,6 +1,6 @@
 0.8.2 (unreleased)
 ==================
-
+* New custom date range report
 
 0.8.1 (2013-02-10)
 ==================
 
=== modified file 'src/gtimelog/gtimelog.ui'
--- src/gtimelog/gtimelog.ui	2012-08-23 05:20:13 +0000
+++ src/gtimelog/gtimelog.ui	2013-05-06 00:11:25 +0000
@@ -425,6 +425,17 @@
                       </object>
                     </child>
                     <child>
+                      <object class="GtkImageMenuItem" id="custom_range_report">
+                        <property name="label">Report for a Custom Date Range...</property>
+                        <property name="visible">True</property>
+                        <property name="can_focus">False</property>
+                        <property name="use_action_appearance">False</property>
+                        <property name="use_underline">True</property>
+                        <property name="use_stock">True</property>
+                        <signal name="activate" handler="on_custom_range_report_activate" swapped="no"/>
+                      </object>
+                    </child>
+                    <child>
                       <object class="GtkSeparatorMenuItem" id="separator1">
                         <property name="visible">True</property>
                         <property name="can_focus">False</property>
 
=== modified file 'src/gtimelog/main.py'
--- src/gtimelog/main.py	2013-02-07 08:33:21 +0000
+++ src/gtimelog/main.py	2013-05-06 00:11:25 +0000
@@ -738,6 +738,17 @@
                                   period_name='month',
                                   estimated_column=estimated_column)
 
+    def custom_range_report_categorized(self, output, email, who,
+                                        estimated_column=False):
+        """Format a custom range report with entries displayed  under categories."""
+        min = self.window.min_timestamp.strftime('%Y-%m-%d')
+        max = self.window.max_timestamp - datetime.timedelta(1)
+        max = max.strftime('%Y-%m-%d')
+        subject = u'Custom date range report for %s (%s - %s)' % (who, min, max)
+        return self._categorizing_report(output, email, who, subject,
+                                         period_name='custom range',
+                                         estimated_column=estimated_column)
+
     def daily_report(self, output, email, who):
         """Format a daily report.
 
@@ -884,6 +895,12 @@
             first_of_next_month, self.virtual_midnight)
         return self.window_for(min, max)
 
+    def window_for_date_range(self, min, max):
+        min = datetime.datetime.combine(min, self.virtual_midnight)
+        max = datetime.datetime.combine(max, self.virtual_midnight)
+        max = max + datetime.timedelta(1)
+        return self.window_for(min, max)
+
     def whole_history(self):
         """Return a TimeWindow for the whole history."""
         # XXX I don't like this solution.  Better make the min/max filtering
@@ -1967,6 +1984,23 @@
             report = reports.monthly_report_plain
         self.mail(report)
 
+    def range_window(self, min, max):
+        if not min:
+            min = self.timelog.day
+        if not max:
+            max = self.timelog.day
+        if max < min:
+            max = min
+        return self.timelog.window_for_date_range(min, max)
+
+    def on_custom_range_report_activate(self, widget):
+        """File -> Report for a Custom Date Range"""
+        min = self.choose_date()
+        max = self.choose_date()
+        if min and max:
+            reports = Reports(self.range_window(min, max))
+            self.mail(reports.custom_range_report_categorized)
+
     def on_open_complete_spreadsheet_activate(self, widget):
         """Report -> Complete Report in Spreadsheet"""
         tempfn = tempfile.mktemp(suffix='gtimelog.csv') # XXX unsafe!
 
=== modified file 'src/gtimelog/test_gtimelog.py'
--- src/gtimelog/test_gtimelog.py	2013-02-06 09:26:32 +0000
+++ src/gtimelog/test_gtimelog.py	2013-05-06 00:11:25 +0000
@@ -587,6 +587,74 @@
 
     """
 
+def doctest_Reports_custom_range_report_categorized():
+    r"""Tests for Reports.custom_range_report_categorized
+
+        >>> import sys
+
+        >>> from datetime import datetime, time
+        >>> from tempfile import NamedTemporaryFile
+        >>> from gtimelog.main import TimeWindow, Reports
+
+        >>> vm = time(2, 0)
+        >>> min = datetime(2010, 1, 25)
+        >>> max = datetime(2010, 2, 1)
+        >>> fh = NamedTemporaryFile()
+
+        >>> window = TimeWindow(fh.name, min, max, vm)
+        >>> reports = Reports(window)
+        >>> reports.custom_range_report_categorized(sys.stdout, '[e-mail]',
+        ...                                         'Bob Jones')
+        To: [e-mail]
+        Subject: Custom date range report for Bob Jones (2010-01-25 - 2010-01-31)
+        <BLANKLINE>
+        No work done this custom range.
+
+        >>> _ = [fh.write(s + '\n') for s in [
+        ...    '2010-01-20 09:00: arrived',
+        ...    '2010-01-20 09:30: asdf',
+        ...    '2010-01-20 10:00: Bar: Foo',
+        ...    ''
+        ...    '2010-01-30 09:00: arrived',
+        ...    '2010-01-30 09:23: Bing: stuff',
+        ...    '2010-01-30 12:54: Bong: other stuff',
+        ...    '2010-01-30 13:32: lunch **',
+        ...    '2010-01-30 23:46: misc',
+        ...    '']]
+        >>> fh.flush()
+
+        >>> window = TimeWindow(fh.name, min, max, vm)
+        >>> reports = Reports(window)
+        >>> reports.custom_range_report_categorized(sys.stdout, '[e-mail]',
+        ...                                         'Bob Jones')
+        To: [e-mail]
+        Subject: Custom date range report for Bob Jones (2010-01-25 - 2010-01-31)
+        <BLANKLINE>
+                                                                          time
+        Bing:
+          Stuff                                                           0:23
+        ----------------------------------------------------------------------
+                                                                          0:23
+        <BLANKLINE>
+        Bong:
+          Other stuff                                                     3:31
+        ----------------------------------------------------------------------
+                                                                          3:31
+        <BLANKLINE>
+        No category:
+          Misc                                                           10:14
+        ----------------------------------------------------------------------
+                                                                         10:14
+        <BLANKLINE>
+        Total work done this custom range: 14:08
+        <BLANKLINE>
+        Categories by time spent:
+          No category     10:14
+          Bong             3:31
+          Bing             0:23
+
+    """
+
 def doctest_Settings_get_config_dir():
     """Test for Settings.get_config_dir