Add filter parameters to milestone view

[techtonik <techtonik@…>]

Milestone view support only one milestone per page. Roadmap can display several milestones, but there is almost no control on order and scope of shown stats. The only option is to show completed milestones (show=all) or not.

I propose to extend "show=all" to allow queries like "show=^0.5" or "show=0.5|0.5.1", but it can create a conflict if somebody defines milestone named "all".

It can be convenient to extend milestone view as well to allow URLs like /milestone/6.0|6.2|6.4

Attached is a simple patch to select several milestones in roadmap using piped /roadmap?milestone=6.0|6.2|6.4 syntax. No advanced filtering using ~= or ^=

[Remy Blank]

Why not. However, the current patch requires editing the page URL, which is not really convenient. For this to be included, some more thought should be given to the user interface side.

[Christian Boos]

For example, the prefs form, in addition to the Show already completed milestones checkbox could have a Filter by name: field, which would accept a glob pattern. If you fill it with e.g. 0.11*, the roadmap module would show all the Milestone starting with 0.11.

[john.williams@…]

I'm interested in this (adding this comment so I can follow it)

[Christian Boos]

Milestone 2.0 deleted

[trac-delcock@…]

​RoadmapFilterPlugin might suit your needs, but it's for 0.11 only.

[Christian Boos]

Milestone triaging deleted

[anonymous]

​RoadmapPlugin might suit your needs (uses largely code of RoadmapFilterPlugin); but it's only available in English and German.

[Franz Mayer <franz.mayer@…>]

Is there any plan to implement this feature?

When many milestones are present (like at t.e.o or at our environment) I find it very useful to filter by milestone name (like ^1.1, which displays all milestones starting with "1.1"); this feature is already implemented by ​RoadmapPlugin. Maybe the filter can be implemented as in reports (with Drop-Down-Box staring, contains etc).

[anonymous]

Related: #2588, #11086

[anonymous]

trac/ticket/templates/roadmap.html

@@ -40 +40 @@
           <label for="hidenoduedate">${
             _("Hide milestones with no due date")}</label>
         </div>
+        <div>
+          <label for="filter">${
+            _("Filter:")}</label>
+          <input type="input" id="filter" name="filter" value="${filter}"/>
+        </div>
         <div class="buttons">
           <input type="submit" value="${_('Update')}"/>
         </div>

trac/ticket/roadmap.py

@@ -27 +27 @@
 from trac.perm import IPermissionRequestor
 from trac.resource import *
 from trac.search import ISearchSource, search_to_regexps, shorten_result
-from trac.util import as_bool, partition
+from trac.util import as_bool, MultiPartFilter, partition
 from trac.util.datefmt import (datetime_now, format_date, format_datetime,
                                from_utimestamp, get_datetime_format_hint,
                                parse_date, pretty_timedelta, to_datetime,
@@ -484 +484 @@
     def process_request(self, req):
         req.perm.require('ROADMAP_VIEW')
 
+        filter = req.args.get('filter', '')
         show = req.args.getlist('show')
         if 'all' in show:
             show = ['completed']
@@ -494 +495 @@
                           if m.due is not None or m.completed]
         milestones = [m for m in milestones
                       if 'MILESTONE_VIEW' in req.perm(m.resource)]
+        if filter:
+            f = MultiPartFilter(filter)
+            milestones = [m for m in milestones
+                          if f.matches(m.name)]
 
         stats = []
         queries = []
@@ -524 +529 @@
             'milestone_stats': stats,
             'queries': queries,
             'show': show,
+            'filter': filter,
         }
         add_stylesheet(req, 'common/css/roadmap.css')
         return 'roadmap.html', data

trac/util/__init__.py

@@ -1388 +1388 @@
     else:
         the_list[index] = item_to_add
 
+        
+class Filter(object):
+    """A simple text filter with optional leading operator:
+    ^  ("starts with")
+    !^ ("does not start with")
+    $  ("ends with")
+    !$ ("does not end with")
+    ~  ("contains")
+    !~ ("does not contain")
+    !  ("does not equal")
+    The default operator is "equals".
+    """
+
+    def __init__(self, pattern):
+        for op in ('^', '!^', '$', '!$', '~', '!~', '!'):
+            if pattern.startswith(op):
+                self.op = op
+                self.needle = pattern[len(op):]
+                break
+        else:
+            self.op = ''
+            self.needle = pattern
+        self.func = {
+            '^': lambda text: text.startswith(self.needle),
+            '!^': lambda text: not text.startswith(self.needle),
+            '$': lambda text: text.endswith(self.needle),
+            '!$': lambda text: not text.endswith(self.needle),
+            '~': lambda text: self.needle in text,
+            '!~': lambda text: self.needle not in text,
+            '': lambda text: text == self.needle,
+            '!': lambda text: text != self.needle,
+        }[self.op]
+        
+    def matches(self, text):
+        """Returns True if the text matches this filter"""
+        return self.func(text)
+
+
+class MultiPartFilter(object):
+    """A text filter consisting of multiple parts."""
+
+    def __init__(self, filters):
+        if isinstance(filters, basestring):
+            filters = map(Filter, to_list(filters, ' '))
+        self.excludes = [f for f in filters if f.op.startswith('!')]
+        self.includes = [f for f in filters if not f.op.startswith('!')]
+
+    def matches(self, text):
+        """Returns True if the text matches this filter."""
+        for exclude in self.excludes:
+            if not exclude.matches(text):
+                return False
+        for include in self.includes:
+            if include.matches(text):
+                return True
+        return not any(self.includes)
+
 
 # Imports for backward compatibility (at bottom to avoid circular dependencies)
 from trac.core import TracError

[Ryan J Ollos]

Please submit patches as attachments, per guidelines in TracDev/SubmittingPatches, rather than pasting inline.

[Ryan J Ollos]

I'm sorry for the very long delay to review this.

The query filter operators look similar to TracQuery#QueryLanguage.

I think ultimately we probably want a filter like on the TicketQuery page:

Maybe the roadmap could have query controls for Name, Due Date and Completed Date, similar to the TicketQuery module.

Otherwise, we are introducing a new query language that will be difficult to remember, especially lacking autocomplete for the field.

Well, maybe it's okay as an interim, but it seems like we should support globs (comment:2). Maybe a tooltip on hover of the field or help icon would be sufficient to help with the syntax. Some form of autocomplete would probably be ideal. Is this particular query language similar to that used elsewhere?