Ticket #2314: mstone_stat_ext_r4086.patch

trac/ticket/tests/__init__.py

@@ -1 +1 @@
 import unittest
 
 from trac.ticket.tests import api, model, query, wikisyntax, notification, \
-                              conversion, report
+                              conversion, report, roadmap
 
 def suite():
     suite = unittest.TestSuite()
@@ -12 +12 @@
     suite.addTest(notification.suite())
     suite.addTest(conversion.suite())
     suite.addTest(report.suite())
+    suite.addTest(roadmap.suite())
     return suite
 
 if __name__ == '__main__':

trac/ticket/tests/roadmap.py

@@ +1 @@
+from trac.config import Configuration
+from trac.test import EnvironmentStub
+from trac.ticket.roadmap import *
+from trac.core import ComponentManager
+
+import unittest
+
+class TicketGroupStatsTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.stats = TicketGroupStats('title', 'unit')
+
+    def test_init(self):
+        self.assertEquals('title', self.stats.title, 'title incorrect')
+        self.assertEquals('unit', self.stats.unit, 'unit incorrect')
+        self.assertEquals(0, self.stats.count, 'count not zero')
+        self.assertEquals(0, len(self.stats.intervals), 'intervals not empty')
+
+    def test_add_iterval(self):
+        self.stats.add_interval('intTitle', 3, {'k1': 'v1'}, 'css', 0)
+        self.assertEquals(3, self.stats.count, 'count not incremented')
+        int = self.stats.intervals[0]
+        self.assertEquals('intTitle', int['title'], 'title incorrect')
+        self.assertEquals(3, int['count'], 'count incorrect')
+        self.assertEquals({'k1': 'v1'}, int['qry_args'], 'query args incorrect')
+        self.assertEquals('css', int['css_class'], 'css class incorrect')
+        self.assertEquals(100, int['percent'], 'percent incorrect')
+        self.stats.add_interval('intTitle', 3, {'k1': 'v1'}, 'css', 0)
+        self.assertEquals(50, int['percent'], 'percent not being updated')
+
+    def test_add_interval_no_prog(self):
+        self.stats.add_interval('intTitle', 3, {'k1': 'v1'}, 'css', 0)
+        self.stats.add_interval('intTitle', 5, {'k1': 'v1'}, 'css', 0)
+        int = self.stats.intervals[1]
+        self.assertEquals(0, self.stats.done_count, 'count added for no prog')
+        self.assertEquals(0, self.stats.done_percent, 'percent incremented')
+
+    def test_add_interval_prog(self):
+        self.stats.add_interval('intTitle', 3, {'k1': 'v1'}, 'css', 0)
+        self.stats.add_interval('intTitle', 1, {'k1': 'v1'}, 'css', 1)
+        self.assertEquals(4, self.stats.count, 'count not incremented')
+        self.assertEquals(1, self.stats.done_count, 'count not added to prog')
+        self.assertEquals(25, self.stats.done_percent, 'done percent not incr')
+
+    def test_add_interval_fudging(self):
+        self.stats.add_interval('intTitle', 3, {'k1': 'v1'}, 'css', 0)
+        self.stats.add_interval('intTitle', 5, {'k1': 'v1'}, 'css', 1)
+        self.assertEquals(8, self.stats.count, 'count not incremented')
+        self.assertEquals(5, self.stats.done_count, 'count not added to prog')
+        self.assertEquals(62, self.stats.done_percent,
+                          'done percnt not fudged downward')
+        self.assertEquals(62, self.stats.intervals[1]['percent'],
+                          'interval percent not fudged downward')
+        self.assertEquals(38, self.stats.intervals[0]['percent'],
+                          'interval percent not fudged upward')
+
+
+class DefaultTicketGroupStatsProviderTestCase(unittest.TestCase):
+
+    def setUp(self):
+        self.env = EnvironmentStub(default_data=True)
+
+        self.milestone1 = Milestone(self.env)
+        self.milestone1.name = 'Test'
+        self.milestone1.insert()
+        self.milestone2 = Milestone(self.env)
+        self.milestone2.name = 'Test2'
+        self.milestone2.insert()
+
+        tkt1 = Ticket(self.env)
+        tkt1.populate({'summary': 'Foo', 'milestone': 'Test', 'owner': 'foman',
+                        'status': 'open'})
+        tkt1.insert()
+        tkt2 = Ticket(self.env)
+        tkt2.populate({'summary': 'Bar', 'milestone': 'Test',
+                        'status': 'closed', 'owner': 'barman'})
+        tkt2.insert()
+        tkt3 = Ticket(self.env)
+        tkt3.populate({'summary': 'Sum', 'milestone': 'Test', 'owner': 'suman',
+                        'status': 'reopened'})
+        tkt3.insert()
+        self.tkt1 = tkt1
+        self.tkt2 = tkt2
+        self.tkt3 = tkt3
+        
+        prov = DefaultTicketGroupStatsProvider(ComponentManager())
+        prov.env = self.env
+        self.stats = prov.get_ticket_group_stats([tkt1.id, tkt2.id, tkt3.id])
+
+    def test_stats(self):
+        self.assertEquals(self.stats.title, 'ticket status', 'title incorrect')
+        self.assertEquals(self.stats.unit, 'ticket', 'unit incorrect')
+        self.assertEquals(2, len(self.stats.intervals), 'more than 2 intervals')
+
+    def test_closed_interval(self):
+        closed = self.stats.intervals[0]
+        self.assertEquals('closed', closed['title'], 'closed title incorrect')
+        self.assertEquals('closed', closed['css_class'], 'closed class incorrect')
+        self.assertEquals(True, closed['countsToProg'],
+                          'closed not count to prog')
+        self.assertEquals({'status': 'closed'}, closed['qry_args'],
+                          'qry_args incorrect')
+        self.assertEquals(1, closed['count'], 'closed count incorrect')
+        self.assertEquals(33, closed['percent'], 'closed percent incorrect')
+
+    def test_open_interval(self):
+        open = self.stats.intervals[1]
+        self.assertEquals('active', open['title'], 'open title incorrect')
+        self.assertEquals('open', open['css_class'], 'open class incorrect')
+        self.assertEquals(False, open['countsToProg'],
+                          'open not count to prog')
+        self.assertEquals({'status': ['new', 'assigned', 'reopened']},
+                          open['qry_args'], 'qry_args incorrect')
+        self.assertEquals(2, open['count'], 'open count incorrect')
+        self.assertEquals(67, open['percent'], 'open percent incorrect')
+
+
+def in_tlist(ticket, list):
+    return len([t for t in list if t['id'] == ticket.id]) > 0
+
+def suite():
+    suite = unittest.TestSuite()
+    suite.addTest(unittest.makeSuite(TicketGroupStatsTestCase, 'test'))
+    suite.addTest(unittest.makeSuite(DefaultTicketGroupStatsProviderTestCase,
+                                      'test'))
+    return suite
+
+if __name__ == '__main__':
+    unittest.main(defaultTest='suite')
+ No newline at end of file

trac/ticket/roadmap.py

@@ -26 +26 @@
 from trac.util.html import html, unescape, Markup
 from trac.util.text import shorten_line, CRLF, to_unicode
 from trac.ticket import Milestone, Ticket, TicketSystem
+from trac.ticket.query import Query
 from trac.Timeline import ITimelineEventProvider
 from trac.web import IRequestHandler
 from trac.web.chrome import add_link, add_stylesheet, INavigationContributor
 from trac.wiki import wiki_to_html, wiki_to_oneliner, IWikiSyntaxProvider
+from trac.config import ExtensionOption
 
+class ITicketGroupStatsProvider(Interface):
+    def get_ticket_group_stats(self, ticket_ids):
+        """ Gather statistics on a group of tickets.
 
+        This method returns a valid TicketGroupStats object.
+        """
+
+class TicketGroupStats(object):
+    """Encapsulates statistics on a group of tickets."""
+
+    def __init__(self, title, unit):
+        """Creates a new TicketGroupStats object.
+        title is the display name of this group of stats (eg 'ticket status').
+        unit is the display name of the units for these stats (eg 'hour').
+        """
+        self.title = title
+        self.unit = unit
+        self.count = 0
+        self.qry_args = {}
+        self.intervals = []
+        self.done_percent = 0
+        self.done_count = 0
+
+    def add_interval(self, title, count, qry_args, css_class, countsToProg=0):
+        """Adds a division to this stats' group's progress bar.
+
+        title is the display name (eg 'closed', 'spent effort') of this interval
+          that will be displayed in front of the unit name.
+        count is the number of units in the interval.
+        qry_args is a dict of extra params that will yield the subset of
+          tickets in this interval on a query.
+        css_class is the css class that will be used to display the division.
+        countsToProg can be set to true to make this interval count towards
+          overall completion of this group of tickets.
+        """
+        self.intervals.append({
+            'title': title,
+            'count': count,
+            'qry_args': qry_args,
+            'css_class': css_class,
+            'percent': None,
+            'countsToProg': countsToProg
+        })
+        self.count = self.count + count
+        self._refresh_calcs()
+
+    def _refresh_calcs(self):
+        if self.count < 1:
+            return
+        total_percent = 0
+        self.done_percent = 0
+        self.done_count = 0
+        for interval in self.intervals:
+            interval['percent'] = round(float(interval['count'] / 
+                                        float(self.count) * 100))
+            total_percent = total_percent + interval['percent']
+            if interval['countsToProg']:
+                self.done_percent += interval['percent']
+                self.done_count += interval['count']
+
+        if self.done_count and total_percent != 100:
+            fudge_int = [i for i in self.intervals if i['countsToProg']][0]
+            fudge_amt = 100 - total_percent
+            fudge_int['percent'] += fudge_amt
+            self.done_percent += fudge_amt
+
+class DefaultTicketGroupStatsProvider(Component):
+    implements(ITicketGroupStatsProvider)
+
+    def get_ticket_group_stats(self, ticket_ids):
+        total_cnt = len(ticket_ids)
+        if total_cnt:
+            cursor = self.env.get_db_cnx().cursor()
+            str_ids = [str(x) for x in ticket_ids]
+            active_cnt = cursor.execute("SELECT count(1) FROM ticket "
+                                    "WHERE status <> 'closed' AND id IN "
+                                    "(%s)" % ",".join(str_ids))
+            active_cnt = 0
+            for cnt, in cursor:
+                active_cnt = cnt
+        else:
+            active_cnt = 0
+
+        closed_cnt = total_cnt - active_cnt
+
+        stat = TicketGroupStats('ticket status', 'ticket')
+        stat.add_interval('closed', closed_cnt, {'status': 'closed'},
+                          'closed', True)
+        stat.add_interval('active', active_cnt,
+                     {'status': ['new', 'assigned', 'reopened']}, 'open', False)
+        return stat
+
+def get_ticket_stats(provider, tickets):
+    return provider.get_ticket_group_stats([t['id'] for t in tickets])
+
 def get_tickets_for_milestone(env, db, milestone, field='component'):
     cursor = db.cursor()
     fields = TicketSystem(env).get_ticket_fields()
@@ -47 +143 @@
         tickets.append({'id': tkt_id, 'status': status, field: fieldval})
     return tickets
 
-def get_query_links(req, milestone, grouped_by='component', group=None):
-    q = {}
-    if not group:
-        q['all_tickets'] = req.href.query(milestone=milestone)
-        q['active_tickets'] = req.href.query(
-            milestone=milestone, status=('new', 'assigned', 'reopened'))
-        q['closed_tickets'] = req.href.query(
-            milestone=milestone, status='closed')
-    else:
-        q['all_tickets'] = req.href.query(
-            {grouped_by: group}, milestone=milestone)
-        q['active_tickets'] = req.href.query(
-            {grouped_by: group}, milestone=milestone,
-            status=('new', 'assigned', 'reopened'))
-        q['closed_tickets'] = req.href.query(
-            {grouped_by: group}, milestone=milestone, status='closed')
-    return q
-
-def calc_ticket_stats(tickets):
-    total_cnt = len(tickets)
-    active = [ticket for ticket in tickets if ticket['status'] != 'closed']
-    active_cnt = len(active)
-    closed_cnt = total_cnt - active_cnt
-
-    percent_active, percent_closed = 0, 0
-    if total_cnt > 0:
-        percent_active = round(float(active_cnt) / float(total_cnt) * 100)
-        percent_closed = round(float(closed_cnt) / float(total_cnt) * 100)
-        if percent_active + percent_closed > 100:
-            percent_closed -= 1
-
-    return {
-        'total_tickets': total_cnt,
-        'active_tickets': active_cnt,
-        'percent_active': percent_active,
-        'closed_tickets': closed_cnt,
-        'percent_closed': percent_closed
-    }
-
 def milestone_to_hdf(env, db, req, milestone):
     safe_name = None
     if milestone.exists:
@@ -101 +158 @@
         hdf['late'] = milestone.is_late
     return hdf
 
+def milestone_stat_to_hdf(env, stat, name, grouped_by='component', group=None):
+    def merge_cp(dict1, dict2):
+        cp = dict1.copy()
+        cp.update(dict2)
+        return cp
+
+    hdf = {}
+    base_args = {'milestone': name, grouped_by: group}
+    hdf['title'] = stat.title
+    hdf['caps_title'] = stat.title.capitalize()
+    hdf['count'] = stat.count
+    hdf['unit']= stat.unit
+    hdf['href'] = env.href.query(merge_cp(base_args, stat.qry_args))
+    hdf['done_percent'] = stat.done_percent
+    hdf['done_count'] = stat.done_count
+    hdf['intervals'] = []
+    i = 0
+    for i in range(len(stat.intervals)):
+        interval = stat.intervals[i]
+        int_hdf = {}
+        for (key,val) in interval.items():
+            if key != 'qry_args':
+                int_hdf[key] = val
+        int_hdf['href'] = env.href.query(
+                                    merge_cp(base_args, interval['qry_args']))
+        int_hdf['caps_title'] = interval['title'].capitalize()
+        int_hdf['last'] = i == len(stat.intervals) - 1
+        hdf['intervals'].append(int_hdf)
+        i += 1
+    return hdf
+
 def _get_groups(env, db, by='component'):
     for field in TicketSystem(env).get_ticket_fields():
         if field['name'] == by:
@@ -117 +205 @@
 class RoadmapModule(Component):
 
     implements(INavigationContributor, IPermissionRequestor, IRequestHandler)
+    stats_provider = ExtensionOption('trac', 'roadmap_stats', ITicketGroupStatsProvider,
+                            'DefaultTicketGroupStatsProvider',
+        """Name of the component implementing `ITicketGroupStatsProvider`, 
+        which is used to collect statistics on groups of tickets for display
+        in the roadmap views.""")
 
     # INavigationContributor methods
 
@@ -155 +248 @@
             milestone_name = unescape(milestone['name']) # Kludge
             tickets = get_tickets_for_milestone(self.env, db, milestone_name,
                                                 'owner')
-            milestone['stats'] = calc_ticket_stats(tickets)
-            milestone['queries'] = get_query_links(req, milestone_name)
+            stat = get_ticket_stats(self.stats_provider, tickets)
+            milestone['stats'] = milestone_stat_to_hdf(self.env, stat, milestone_name)
             milestone['tickets'] = tickets # for the iCalendar view
 
         if req.args.get('format') == 'ics':
@@ -279 +372 @@
 
     implements(INavigationContributor, IPermissionRequestor, IRequestHandler,
                ITimelineEventProvider, IWikiSyntaxProvider)
+ 
+    stats_provider = ExtensionOption('trac', 'milestone_stats', ITicketGroupStatsProvider,
+                            'DefaultTicketGroupStatsProvider',
+        """Name of the component implementing `ITicketGroupStatsProvider`, 
+        which is used to collect statistics on groups of tickets for display
+        in the milestone views.""")
+    
 
     # INavigationContributor methods
 
@@ -471 +571 @@
             by = req.args.get('by', available_groups[0]['name'])
 
         tickets = get_tickets_for_milestone(self.env, db, milestone.name, by)
-        data['stats'] = calc_ticket_stats(tickets)
-        data['stats']['available_groups'] = available_groups
-        data['stats']['grouped_by'] = by
-        data['queries'] = get_query_links(req, milestone.name)
 
+        stat = get_ticket_stats(self.stats_provider, tickets)
+        data['stats'] = {'available_groups': available_groups, 
+                         'grouped_by': by}
+        data['stats'].update(milestone_stat_to_hdf(self.env, stat,
+                                                  milestone.name))
+
         data['stats']['groups'] = []
         groups = _get_groups(self.env, db, by)
-        max_percent_total = 0
+        max_count = 0
+        group_stats = []
+
         for group in groups:
             group_tickets = [t for t in tickets if t[by] == group]
             if not group_tickets:
                 continue
-            data['stats']['groups'].append({'name': group})
-            percent_total = 0
-            if len(tickets) > 0:
-                percent_total = float(len(group_tickets)) / float(len(tickets))
-                if percent_total > max_percent_total:
-                    max_percent_total = percent_total
-            data['stats']['groups'][-1]['percent_total'] = percent_total * 100
-            data['stats']['groups'][-1]['stats'] = calc_ticket_stats(group_tickets)
-            data['stats']['groups'][-1]['queries'] = get_query_links(req, milestone.name, by, group)
-        data['stats']['max_percent_total'] = max_percent_total * 100
 
+            gstat = get_ticket_stats(self.stats_provider, group_tickets)
+            
+            gs_dict = {'name': group} 
+            gs_dict['stats'] = milestone_stat_to_hdf(self.env, gstat,
+                                                 milestone.name, by, group)
+                
+            if gstat.count > max_count:
+                max_count = gstat.count
+             
+            group_stats.append(gstat)                
+            data['stats']['groups'].append(gs_dict)
+        
+        grp_no = 0
+        for gstat in group_stats:
+            d = data['stats']['groups'][grp_no]
+            d['percent_of_max_total'] = (float(gstat.count) /
+                                        float(max_count) * 100)
+            grp_no +=1
+
         return 'milestone_view.html', data, None
 
     # IWikiSyntaxProvider methods

templates/macros.html

@@ -180 +180 @@
     </py:choose>
   </py:def>
 
+  <!--!  Display a generic "progress bar", for use in roadmap and milestone.
+  -
+  -      Expected properties of the `stats` argument:
+  -       .intervals    list of intervals, each with:
+  -         .title        the common identifier for this group
+  -         .caps_title   same as above but capitalized
+  -         .css_class    the CSS class used to customize the look of the interval
+  -         .percent      the actual width in % of the interval
+  -         .count        the actual number of units taken by this interval
+  -      .unit         the name of the unit used
+  -      .done_percent the percent considered "done"
+  -      .count        the total number of units
+  -->
+  <py:def function="progress_bar(stats, percent=None, legend=True, style=None)">
+    <table class="progress" style="$style">
+      <tr>
+        <td py:for="interval in stats.intervals"
+            class="$interval.css_class" style="width: ${interval.percent}%">
+          <a href="$interval.href"
+            title="${interval.count} of ${stats.count} ${stats.unit}${
+            stats.count != 1 and 's' or ''} ${interval.title}"></a>
+        </td>
+      </tr>
+    </table>
+    <p class="percent">${percent is None and '%d%%' % stats.done_percent or percent}</p>
+    <dl py:if="legend">
+      <py:for each="interval in stats.intervals">
+        <dt>${interval.caps_title} ${stats.unit}s:</dt>
+        <dd><a href="$interval.href">${interval.count}</a></dd>
+      </py:for>
+    </dl>
+  </py:def>
+
 </div>

templates/milestone_view.html

@@ -5 +5 @@
       xmlns:py="http://genshi.edgewall.org/"
       xmlns:xi="http://www.w3.org/2001/XInclude">
   <xi:include href="layout.html" />
+  <xi:include href="macros.html" />
   <head>
     <title>Milestone ${milestone.name}</title>
     <link rel="stylesheet" type="text/css"
@@ -32 +33 @@
             No date set
           </p>
         </py:choose>
-        <py:if test="stats.total_tickets">
-          <table class="progress">
-            <td class="closed" style="width: ${stats.percent_closed}%">
-              <a href="$queries.closed_tickets"
-                 title="${stats.closed_tickets} of ${stats.total_tickets} ticket${stats.total_tickets != 1 and 's' or ''} closed"></a>
-            </td>
-            <td class="open" style="width: ${stats.percent_active}%">
-              <a href="$queries.active_tickets"
-                 title="${stats.active_tickets} of ${stats.total_tickets} ticket${stats.total_tickets != 1 and 's' or ''} active"></a>
-            </td>
-          </table>
-          <p class="percent">${stats.percent_closed}%</p>
-          <dl>
-            <dt>Closed tickets:</dt>
-            <dd><a href="$queries.closed_tickets">${stats.closed_tickets}</a></dd>
-            <dt>Active tickets:</dt>
-            <dd><a href="$queries.active_tickets">${stats.active_tickets}</a></dd>
-          </dl>
-        </py:if>
+        <py:if test="stats.count">${progress_bar(stats)}</py:if>
       </div>
 
       <form py:if="stats.available_groups" id="stats" action="">
         <fieldset>
           <legend>
-            <label for="by">Ticket status by</label>
+            <label for="by">${stats.caps_title} by</label>
             <select id="by" name="by" onchange="this.form.submit()">
               <option py:for="group in stats.available_groups"
                       value="${group.name}" py:content="group.label"
@@ -67 +50 @@
           <table summary="Shows the milestone completion status grouped by ${stats.grouped_by}">
             <tr py:for="group in stats.groups">
               <th scope="row">
-                <a href="${group.queries.all_tickets}">${group.name}</a>
+                <a href="${group.stats.href}">${group.name}</a>
               </th>
               <td style="white-space: nowrap">
-                <table class="progress" style="width: ${group.percent_total * 80 / stats.max_percent_total}%">
-                  <td class="closed" style="width: ${group.stats.percent_closed}%">
-                    <a href="$group.queries.closed_tickets"
-                       title="${group.stats.closed_tickets} of ${group.stats.total_tickets} ticket${group.stats.total_tickets != 1 and 's' or ''} closed"></a>
-                  </td>
-                  <td class="open" style="width: ${group.stats.percent_active}%">
-                    <a href="$group.queries.active_tickets"
-                       title="${group.stats.active_tickets} of ${group.stats.total_tickets} ticket${group.stats.total_tickets != 1 and 's' or ''} active"></a>
-                  </td>
-                </table>
-                <p class="percent">${group.stats.closed_tickets} / ${group.stats.total_tickets}</p>
+                ${progress_bar(group.stats,'%d / %d' % (group.stats.done_count, group.stats.count),
+                               legend=False, style="width: %d%%" % (group.percent_of_max_total * 0.8))}
               </td>
             </tr>
           </table>

templates/roadmap.html

@@ -5 +5 @@
       xmlns:py="http://genshi.edgewall.org/"
       xmlns:xi="http://www.w3.org/2001/XInclude">
   <xi:include href="layout.html" />
+  <xi:include href="macros.html" />
   <head>
     <title>Roadmap</title>
     <link rel="stylesheet" type="text/css"
@@ -12 +13 @@
   </head>
 
   <body>
+
     <div id="ctxtnav" class="nav"></div>
 
     <div id="content" class="roadmap">
@@ -40 +42 @@
                  class="date">Due in ${pretty_timedelta(milestone.due + timedelta(days=1))}</p>
               <p py:otherwise="" class="date">No date set</p>
             </py:choose>
-            <py:if test="milestone.stats.total_tickets"
-                   py:with="stats = milestone.stats; queries = milestone.queries">
-              <table class="progress">
-                <td class="closed" style="width: ${stats.percent_closed}%">
-                  <a href="$queries.closed_tickets"
-                     title="${stats.closed_tickets} of ${stats.total_tickets} ticket${stats.total_tickets != 1 and 's' or ''} closed"></a>
-                </td>
-                <td class="open" style="width: ${stats.percent_active}%">
-                  <a href="$queries.active_tickets"
-                     title="${stats.active_tickets} of ${stats.total_tickets} ticket${stats.total_tickets != 1 and 's' or ''} active"></a>
-                </td>
-              </table>
-              <p class="percent">${stats.percent_closed}%</p>
-              <dl>
-                <dt>Closed tickets:</dt>
-                <dd><a href="$queries.closed_tickets">${stats.closed_tickets}</a></dd>
-                <dt>Active tickets:</dt>
-                <dd><a href="$queries.active_tickets">${stats.active_tickets}</a></dd>
-              </dl>
-            </py:if>
+            <py:if test="milestone.stats.count">${progress_bar(milestone.stats)}</py:if>
           </div>
 
           <div class="description">${milestone.description}</div>