Submitter:	Christian Hammond	Reviewers
Branch:	trunk	Groups:	reviewboard
Bugs:		People:
Change Number:	None	Repository:	Review Board SVN

Description:

Added support for sorting review requests in the dashboard and various lists (submitters, groups, all). The columns are now clickable and will cause the list to sort.

Up to three columns can be taken into consideration for sorting at any given point. We update the columns when clicked as follows:

* If the column is not in the existing sort list, it becomes the primary sort column and we display a large down arrow.
* If the column is in the existing sort list and is the primary sort column, we reverse the order of the column and display a large up arrow.
* If the column is in the sort list but is not the primary sort column, we make it the primary sort column, and we don't reverse the order.

We save a cookie every time the order changes and use that next time unless a ?sort= parameter is set.

Testing Done:

Sorted various columns and messed with each case above. Appears to work correctly.

Diff revision 5 (Latest)

Jump to revision:	1 2 3 4 5
Changes between r5 and:	1 2 3 4 5

Files Changed:

/trunk/reviewboard/urls.py: 10 changes [ 1 2 3 4 5 6 7 8 9 10 ]
/trunk/reviewboard/accounts/models.py: 1 change [ 1 ]
/trunk/reviewboard/htdocs/css/common.css: 2 changes [ 1 2 ]
/trunk/reviewboard/reviews/views.py: 22 changes [ 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 ]
/trunk/reviewboard/templates/reviews/dashboard.html: 1 change [ 1 ]
/trunk/reviewboard/templates/reviews/review_list.html: 1 change [ 1 ]
/trunk/reviewboard/utils/views.py: 1 change [ new content ]
/trunk/reviewboard/utils/templatetags/htmlutils.py: 5 changes [ 1 2 3 4 5 ]

Expand changes

     (r'^$', 'django.views.generic.simple.redirect_to',
      {'url': '/dashboard/'}),
     # Review request browsing
-    (r'^dashboard/$', 'reviewboard.reviews.views.dashboard',
+    (r'^dashboard/$', 'reviewboard.reviews.views.dashboard'),
-     {'template_name': 'reviews/dashboard.html'}),
-    (r'^r/$', 'reviewboard.reviews.views.all_review_requests',
+    (r'^r/$', 'reviewboard.reviews.views.all_review_requests'),
-     {'template_name': 'reviews/review_list.html'}),
     # Review request creation
     (r'^r/new/$', 'reviewboard.reviews.views.new_review_request'),
     # Review request detail
      'reviewboard.reviews.views.preview_review_email'),
     (r'^r/(?P<review_request_id>[0-9]+)/reviews/(?P<review_id>[0-9]+)/replies/(?P<reply_id>[0-9]+)/preview-email/$',
      'reviewboard.reviews.views.preview_reply_email'),
     # Users
-    (r'^users/$', 'reviewboard.reviews.views.submitter_list',
+    (r'^users/$', 'reviewboard.reviews.views.submitter_list'),
-     {'template_name': 'reviews/submitter_list.html'}),
     (r'^users/(?P<username>[A-Za-z0-9_-]+)/$',
-     'reviewboard.reviews.views.submitter',
+     'reviewboard.reviews.views.submitter'),
-     {'template_name': 'reviews/review_list.html'}),
     # Groups
-    (r'^groups/$', 'reviewboard.reviews.views.group_list',
+    (r'^groups/$', 'reviewboard.reviews.views.group_list'),
-     {'template_name': 'reviews/group_list.html'}),
+    (r'^groups/(?P<name>[A-Za-z0-9_-]+)/$', 'reviewboard.reviews.views.group'),
-    (r'^groups/(?P<name>[A-Za-z0-9_-]+)/$',
-     'reviewboard.reviews.views.group',
-     {'template_name': 'reviews/review_list.html'}),
     # Feeds
     (r'^feeds/rss/(?P<url>.*)/$', 'django.contrib.syndication.views.feed',
      {'feed_dict': rss_feeds}),
     (r'^feeds/atom/(?P<url>.*)/$', 'django.contrib.syndication.views.feed',

     collapsed_diffs = models.BooleanField(default=True)
     wordwrapped_diffs = models.BooleanField(default=True)
     syntax_highlighting = models.BooleanField(default=True)
     sort_columns = models.CharField(maxlength=128, blank=True)
     columns = models.CharField(maxlength=128, blank=True)
     starred_review_requests = models.ManyToManyField(ReviewRequest, core=False,
                                                      blank=True)
     def __str__(self):
         return self.user.username
     class Admin:
         list_display = ('__str__', 'first_time_setup_done')

   background: url("/images/ui/header_bg.png") repeat-x bottom left;
   border-top: 1px #999999 solid;
   border-bottom: 1px #999999 solid;
   border-left: 1px #CCCCCC solid;
   border-right: 1px #CCCCCC solid;
   color: #444444;
   cursor: pointer;
+}
 table.list tr.headers th a {
   color: black;
   text-decoration: none;
+}
 table.list tr.headers th a.unsort {
   color: #444444;
+}
 table.list tr.headers th a:hover {
   text-decoration: underline;
+}
 table.list tr:hover.headers {
   background-color: transparent;
+}
 table.list tr.headers th:hover {
   background: url("/images/ui/header_bg_primary.png") repeat-x bottom left;
+}
 table.list tr.headers th:hover a {
   text-decoration: underline;
+}
 table.list tr:hover .age1 {
   background: #abd5a9;
+}
 table.list tr:hover .age2 {

 from urllib import quote
 from django.conf import settings
 from django.contrib.auth import REDIRECT_FIELD_NAME
 from django.contrib.auth.models import User
 from django.contrib.sites.models import Site
 from django.db.models import Q
 from django.http import HttpResponse, HttpResponseRedirect, Http404, \
                         HttpResponseForbidden
 from django.shortcuts import get_object_or_404, render_to_response
 from django.template.context import RequestContext
 from django.template.loader import render_to_string
 from django.utils import simplejson
-from django.views.generic.list_detail import object_list
 from djblets.auth.util import login_required
 from djblets.util.decorators import simple_decorator
 from djblets.util.misc import get_object_or_none
 from reviewboard.accounts.models import Profile
                                       UploadScreenshotForm, \
                                       OwnershipError
 from reviewboard.reviews.email import mail_review_request, \
                                       mail_diff_update
 from reviewboard.scmtools.models import Repository
 from reviewboard.utils.views import sortable_object_list
 import reviewboard.reviews.db as reviews_db
 @simple_decorator
 def valid_prefs_required(view_func):
         'request': request,
     }))
 def review_list(request, queryset, template_name, extra_context={}):
-    return object_list(request,
+    return sortable_object_list(request,
         queryset=queryset.filter(Q(status='P') |
                                  Q(status='S')).order_by('-last_updated'),
-        paginate_by=50,
-        allow_empty=True,
         template_name=template_name,
-        extra_context=dict(
+        extra_context=extra_context)
-            {'app_path': request.path},
-            **extra_context
-        ))
 @login_required
-def all_review_requests(request, template_name):
+def all_review_requests(request, template_name='reviews/review_list.html'):
     return review_list(request,
         queryset=reviews_db.get_all_review_requests(request.user, status=None),
         template_name=template_name)
 @login_required
-def submitter_list(request, template_name):
+def submitter_list(request, template_name='reviews/submitter_list.html'):
-    return object_list(request,
+    return sortable_object_list(request,
         queryset=User.objects.filter(),
-        template_name=template_name,
+        template_name=template_name)
-        paginate_by=50,
-        allow_empty=True,
-        extra_context={
-            'app_path': request.path,
-        })
 @login_required
-def group_list(request, template_name):
+def group_list(request, template_name='reviews/group_list.html'):
-    return object_list(request,
+    return sortable_object_list(request,
         queryset=Group.objects.all(),
-        template_name=template_name,
+        template_name=template_name)
-        paginate_by=50,
-        allow_empty=True,
-        extra_context={
-            'app_path': request.path,
-        })
 @login_required
 @valid_prefs_required
 def dashboard(request, template_name='reviews/dashboard.html'):
     view = request.GET.get('view', 'incoming')
     group = request.GET.get('group', "")
     if view == 'outgoing':
         review_requests = \
             reviews_db.get_review_requests_from_user(request.user.username,
                                                      request.user)
-        title = "All Outgoing Review Requests";
+        title = "All Outgoing Review Requests"
     elif view == 'to-me':
         review_requests = reviews_db.get_review_requests_to_user_directly(
             request.user.username, request.user)
-        title = "Incoming Review Requests to Me";
+        title = "Incoming Review Requests to Me"
     elif view == 'to-group':
         if group != "":
             review_requests = reviews_db.get_review_requests_to_group(
                 group, request.user)
-            title = "Incoming Review Requests to %s" % group;
+            title = "Incoming Review Requests to %s" % group
         else:
             review_requests = reviews_db.get_review_requests_to_user_groups(
                 request.user.username, request.user)
             title = "All Incoming Review Requests to My Groups"
     else: # "incoming" or invalid
         list is a QuerySet.
         """
         def __init__(self, list):
             self.list = list
         def order_by(self, *field_names):
             return BogusQuerySet(sorted(self.list,
                 lambda a,b: self._sort_func(a, b, field_names)))
         def _sort_func(self, a, b, field_list):
             for field in field_list:
                 if field[0] == "-":
                     reverse = True
                     field = field[1:]
                 else:
                     reverse = False
                 try:
                     a_value = str(getattr(a, field))
                     b_value = str(getattr(b, field))
                     if reverse:
                         i = cmp(b_value, a_value)
                     else:
                         i = cmp(a_value, b_value)
                     if i != 0:
                         return i
                 except AttributeError:
                     # The field doesn't exist, so just ignore it.
                     pass
             # They're equal, so compare the objects themselves to "sort" it out.
             return cmp(a, b)
         def _clone(self):
             return self.list
-    return object_list(request,
+    if isinstance(review_requests, list):
-        queryset=BogusQuerySet(review_requests),
+        queryset = BogusQuerySet(review_requests)
     else:
         queryset = review_requests
     return sortable_object_list(request,
         queryset=queryset,
         template_name=template_name,
-        paginate_by=50,
-        allow_empty=True,
         template_object_name='review_request',
         extra_context={
             'title': title,
             'view': view,
             'group': group,
         })
 @login_required
-def group(request, name, template_name):
+def group(request, name, template_name='reviews/review_list.html'):
     return review_list(request,
         queryset=reviews_db.get_review_requests_to_group(name, status=None),
         template_name=template_name,
         extra_context={
             'source': name,
         })
 @login_required
-def submitter(request, username, template_name):
+def submitter(request, username, template_name='reviews/review_list.html'):
     return review_list(request,
         queryset=reviews_db.get_review_requests_from_user(username,
                                                           status=None),
         template_name=template_name,
         extra_context={

     <col class="posted" width="0%" />
     <col class="updated" width="0%" />
    </colgroup>
    <thead>
     <tr class="headers">
-     <th>Summary</th>
+     {% column_header "summary"      "Summary"      %}
-     <th>Submitter</th>
+     {% column_header "submitter"    "Submitter"    %}
-     <th>Posted</th>
+     {% column_header "time_added"   "Posted"       %}
-     <th>Last Updated</th>
+     {% column_header "last_updated" "Last Updated" %}
     </tr>
    </thead>
    <tbody>
 {% for review_request in review_request_list %}
     <tr>

   <col class="submitter" width="0%" />
   <col class="updated" width="0%" />
  </colgroup>
  <thead>
   <tr class="headers">
-   <th>Summary</th>
+   {% column_header "summary"      "Summary"      %}
-   <th>Submitter</th>
+   {% column_header "submitter"    "Submitter"    %}
-   <th>Posted</th>
+   {% column_header "time_added"   "Posted"       %}
-   <th>Last Updated</th>
+   {% column_header "last_updated" "Last Updated" %}
   </tr>
  </thead>
  <tbody>
 {%  for review in object_list %}
   <tr>

 from django.views.generic.list_detail import object_list
 from reviewboard.accounts.models import Profile
 def sortable_object_list(request, queryset, extra_context={}, *args, **kwargs):
     profile, profile_is_new = \
         Profile.objects.get_or_create(user=request.user)
     sort_list = None
     sort = request.GET.get('sort', profile.sort_columns)
     if sort:
         sort_list = sort.split(',')
         queryset = queryset.order_by(*sort_list)
     response = object_list(request,
                            queryset=queryset,
                            paginate_by=50,
                            allow_empty=True,
                            extra_context=dict(
                                {'app_path': request.path,
                                 'sort_list': sort_list},
                                **extra_context
                            ),
                            *args, **kwargs)
     if profile.sort_columns != sort:
         profile.sort_columns = sort
         profile.save()
     return response

 # vim: set fileencoding=utf-8 :
 import datetime
 import Image
 import os
-from django.conf import settings
 from django import template
 from django.conf import settings
 from django.template import resolve_variable
 from django.template import TemplateSyntaxError, VariableDoesNotExist
 from djblets.util.decorators import blocktag
 register = template.Library()
 class ColumnHeader(template

Review Board

beta

This change has been marked as submitted.

Add sortable columns to the dashboard and review request lists

Diff revision 5 (Latest)