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

Description:

Added support for starring groups and review requests. Starring a group puts it on your dashboard under a "Watched Groups" list, which is useful when you want to keep track of a group but don't want the group's review requests appearing under your Incoming Reviews list or sending you e-mails.

Starring a review request puts it in your Starred Reviews list and sends any e-mails your way. This is useful if you're not a reviewer of a review request but want to keep track of what's going on with it without having to get involved.

Testing Done:

Tested that starring and unstarring works in each area, and that they appear on the dashboard.

Screenshots:

Dashboard

Group List

Review Request

Starred Reviews List

Diff revision 3 (Latest)

Jump to revision:	1 2 3
Changes between r3 and:	1 2 3

Files Changed:

/trunk/reviewboard/accounts/models.py: 3 changes [ 1 2 3 ]
/trunk/reviewboard/htdocs/css/common.css: 2 changes [ 1 2 ]
/trunk/reviewboard/htdocs/css/dashboard.css: 4 changes [ 1 2 3 4 ]
/trunk/reviewboard/htdocs/css/reviews.css: 2 changes [ 1 2 ]
/trunk/reviewboard/htdocs/images/star.png: binary file
/trunk/reviewboard/htdocs/images/star_off.png: binary file
/trunk/reviewboard/htdocs/images/star_on.png: binary file
/trunk/reviewboard/htdocs/scripts/rb/common.js: 2 changes [ 1 2 ]
/trunk/reviewboard/reviews/email.py: 1 change [ 1 ]
/trunk/reviewboard/reviews/json.py: 3 changes [ 1 2 3 ]
/trunk/reviewboard/reviews/views.py: 11 changes [ 1 2 3 4 5 6 7 8 9 10 11 ]
/trunk/reviewboard/reviews/templatetags/reviewtags.py: 7 changes [ 1 2 3 4 5 6 7 ]
/trunk/reviewboard/reviews/urls/json.py: 2 changes [ 1 2 ]
/trunk/reviewboard/templates/reviews/dashboard.html: 7 changes [ 1 2 3 4 5 6 7 ]
/trunk/reviewboard/templates/reviews/dashboard_entry.html: 1 change [ 1 ]
/trunk/reviewboard/templates/reviews/group_list.html: 5 changes [ 1 2 3 4 5 ]
/trunk/reviewboard/templates/reviews/review_list.html: 5 changes [ 1 2 3 4 5 ]
/trunk/reviewboard/templates/reviews/review_request_box.html: 1 change [ 1 ]
/trunk/reviewboard/templates/reviews/star.html: 1 change [ new content ]

Expand changes

 from datetime import datetime
 from django.db import models
 from django.contrib.auth.models import User
-from reviewboard.reviews.models import ReviewRequest
+from reviewboard.reviews.models import Group, ReviewRequest
 class ReviewRequestVisit(models.Model):
     """A review request visit."""
     user = models.ForeignKey(User, related_name="review_request_visits")
     #review_request_columns = models.CharField(maxlength=128, blank=True)
     #submitter_columns = models.CharField(maxlength=128, blank=True)
     #group_columns = models.CharField(maxlength=128, blank=True)
-    starred_review_requests = models.ManyToManyField(ReviewRequest, core=False,
+    starred_review_requests = models.ManyToManyField(
-                                                     blank=True)
+        ReviewRequest, core=False, blank=True,
         filter_interface=models.HORIZONTAL,
         related_name="starred_by")
     starred_groups = models.ManyToManyField(
         Group, core=False, blank=True, filter_interface=models.HORIZONTAL,
         related_name="starred_by")
     def __unicode__(self):
         return self.user.username
     class Admin:
         list_display = ('__unicode__', 'first_time_setup_done')

   padding: 0;
   position: relative;
   top: -23px;
+}
 .box .star {
   cursor: pointer;
+}
 .box h1.title,
 .box .titlebox {
   background: #a2bedc url('/images/title_box_top_bg.png') repeat-x top left;
   border-bottom: 1px #728eac solid;
   margin: 0;
-  padding: 5px 10px;
+  padding: 5px 10px 5px 5px;
+}
 .box h1.title {
   font-size: 120%;
+}

 #dashboard-navbar .main-item {
   font-weight: bold;
+}
 #dashboard-navbar .header {
   font-weight: bold;
   padding-top: 15px;
+}
 #dashboard-navbar .sub-item {
   padding-left: 25px;
+}
-#dashboard-navbar .sub-sub-item {
+#dashboard-navbar .star-item {
-  padding-left: 45px;
+  background: url("/images/star_on.png") no-repeat 5px 4px;
   padding-left: 25px;
+}
 #dashboard-navbar tr,
 #dashboard-wrapper {
   background-color: #E9E9E9;
+}
 #dashboard-navbar tr.selected {
   background: #b2ceec;
+}
 #dashboard-navbar td img {
   vertical-align: bottom;
+}
 #dashboard-navbar tbody {
+}

 .review-request .header {
   margin: 5px;
+}
 .review-request .star {
   float: left;
   margin-right: 10px;
+}
 .review-request #details {
   border-bottom: 1px #c2c1b0 solid;
   border-spacing: 8px;
   border-top: 1px #c2c1b0 solid;
   margin-top: 5px;
 .review-request #summary_wrapper {
   margin-right: 10em;
   padding: 0px;
+}
 .review-request #summary_wrapper label {
   font-size: 130%;
+}
 .review-request #topcontrols {
   float: right;
   list-style: none;
   margin: -1px -1px 0 0;
   padding: 0px;

/trunk/reviewboard/htdocs/images/star.png
Revision UNKNOWN		New Change
This is a binary file. The content cannot be displayed.

/trunk/reviewboard/htdocs/images/star_off.png
Revision UNKNOWN		New Change
This is a binary file. The content cannot be displayed.

/trunk/reviewboard/htdocs/images/star_on.png
Revision UNKNOWN		New Change
This is a binary file. The content cannot be displayed.

 RB = {utils: {}}
 // Constants
 var STAR_ON_IMG = "/images/star_on.png";
 var STAR_OFF_IMG = "/images/star_off.png";
 RB.utils.String = function() {};
 RB.utils.String.prototype = {
 	strip: function() {
 		return this.replace(/^\s+/, '').replace(/\s+$/, '');
 	},
                 callbacks.failure(res.statusText);
+            }
+        }
     }, postData || "dummy");
 };
 /*
  * Toggles whether an object is starred. Right now, we support
  * "reviewrequests" and "groups" types.
+ *
  * @param {HTMLElement} el     The star img element.
  * @param {string}      type   The type used for constructing the path.
  * @param {string}      objid  The object ID to star/unstar.
  */
 function toggleStar(el, type, objid) {
   var isStarred = (el.src.indexOf(STAR_ON_IMG) != -1);
   var url = "/api/json/" + type + "/" + objid + "/";
   if (isStarred) {
     url += "unstar/";
   } else {
     url += "star/";
+  }
   asyncJsonRequest("GET", url, {
     success: function(rsp) {
       if (isStarred) {
         el.src = STAR_OFF_IMG;
       } else {
         el.src = STAR_ON_IMG;
+      }
     },
     failure: function(errmsg) {
       alert(errmsg);
+    }
   });
+}

     for group in review_request.target_groups.all():
         for address in get_email_addresses_for_group(group):
             recipient_table[address] = 1
     for profile in review_request.starred_by.all():
         recipient_table[get_email_address_for_user(profile.user)] = 1
     if extra_recipients:
         for recipient in extra_recipients:
             recipient_table[get_email_address_for_user(recipient)] = 1
     recipient_list = recipient_table.keys()

 from django.template.defaultfilters import timesince
 from django.utils import simplejson
 from django.views.decorators.http import require_POST
 from djblets.util.decorators import simple_decorator
 from reviewboard.accounts.models import Profile
 from reviewboard.diffviewer.forms import UploadDiffForm, EmptyDiffError
 from reviewboard.diffviewer.models import FileDiff, DiffSet
 from reviewboard.reviews.email import mail_review, mail_review_request, \
                                       mail_reply, mail_diff_update
 from reviewboard.reviews.forms import UploadScreenshotForm
         'repositories': Repository.objects.all(),
     })
 @json_login_required
 def group_star(request, group_name):
     try:
         group = Group.objects.get(name=group_name)
     except Group.DoesNotExist:
         return JsonResponseError(request, DOES_NOT_EXIST)
     profile, profile_is_new = Profile.objects.get_or_create(user=request.user)
     profile.starred_groups.add(group)
     profile.save()
     return JsonResponse(request)
 @json_login_required
 def group_unstar(request, group_name):
     try:
         group = Group.objects.get(name=group_name)
     except Group.DoesNotExist:
         return JsonResponseError(request, DOES_NOT_EXIST)
     profile, profile_is_new = Profile.objects.get_or_create(user=request.user)
     if not profile_is_new:
         profile.starred_groups.remove(group)
         profile.save()
     return JsonResponse(request)
 @json_login_required
 @require_POST
 def new_review_request(request):
     try:
         repository_path = request.POST.get('repository_path',
                                            settings.DEFAULT_REPOSITORY_PATH)
         return JsonResponse(request, {'review_request': review_request})
     except ReviewRequest.DoesNotExist:
         return JsonResponseError(request, INVALID_CHANGE_NUMBER)
 @json_login_required
 def review_request_star(request, review_request_id):
     try:
         review_request = ReviewRequest.objects.get(pk=review_request_id)
     except ReviewRequest.DoesNotExist:
         return JsonResponseError(request, DOES_NOT_EXIST)
     profile, profile_is_new = Profile.objects.get_or_create(user=request.user)
     profile.starred_review_requests.add(review_request)
     profile.save()
     return JsonResponse(request)
 @json_login_required
 def review_request_unstar(request, review_request_id):
     try:
         review_request = ReviewRequest.objects.get(pk=review_request_id)
     except ReviewRequest.DoesNotExist:
         return JsonResponseError(request, DOES_NOT_EXIST)
     profile, profile_is_new = Profile.objects.get_or_create(user=request.user)
     if not profile_is_new:
         profile.starred_review_requests.remove(review_request)
         profile.save()
     return JsonResponse(request)
 @json_permission_required('reviews.delete_reviewrequest')
 def review_request_delete(request, review_request_id):
     try:
         review_request = ReviewRequest.objects.get(pk=review_request_id)
         review_request.delete()

 @login_required
 @valid_prefs_required
 def dashboard(request, template_name='reviews/dashboard.html'):
     view = request.GET.get('view', 'incoming')
     group = request.GET.get('group', "")
     user = request.user
     if view == 'outgoing':
-        review_requests = \
+        review_requests = ReviewRequest.objects.from_user(user.username, user)
-            ReviewRequest.objects.from_user(request.user.username,
-                                            request.user)
         title = "All Outgoing Review Requests"
     elif view == 'to-me':
-        review_requests = ReviewRequest.objects.to_user_directly(
+        review_requests = \
-            request.user.username, request.user)
+            ReviewRequest.objects.to_user_directly(user.username, user)
         title = "Incoming Review Requests to Me"
     elif view == 'to-group':
         if group != "":
-            review_requests = ReviewRequest.objects.to_group(group,
+            review_requests = ReviewRequest.objects.to_group(group, user)
-                                                             request.user)
             title = "Incoming Review Requests to %s" % group
         else:
-            review_requests = ReviewRequest.objects.to_user_groups(
+            review_requests = \
-                request.user.username, request.user)
+                ReviewRequest.objects.to_user_groups(user.username, user)
             title = "All Incoming Review Requests to My Groups"
     elif view == 'starred':
         review_requests = \
             user.get_profile().starred_review_requests.public(user)
         title = "Starred Review Requests"
     else: # "incoming" or invalid
-        review_requests = ReviewRequest.objects.to_user(request.user.username,
+        review_requests = ReviewRequest.objects.to_user(user.username, user)
-                                                        request.user)
         title = "All Incoming Review Requests"
     class BogusQuerySet:
         """
         Simple class to fool the object_list generic view into thinking a
     return review_list(request,
         queryset=ReviewRequest.objects.to_group(name, status=None),
         template_name=template_name,
         extra_context={
             'source': name,
             'group': get_object_or_none(Group, name=name),
         })
 @check_login_required
 def submitter(request, username, template_name='reviews/review_list.html'):

 from django import template
 from django.db.models import Q
 from django.db.models.query import QuerySet
 from django.template import resolve_variable
 from django.template import NodeList, TemplateSyntaxError, VariableDoesNotExist
 from django.template.loader import render_to_string
 from django.utils import simplejson
 from djblets.util.decorators import blocktag
-from reviewboard.accounts.models import ReviewRequest, ReviewRequestVisit
+from djblets.util.misc import get_object_or_none
 from reviewboard.reviews.models import ReviewRequestDraft, ScreenshotComment
 from reviewboard.accounts.models import Profile, ReviewRequestVisit
 from reviewboard.reviews.models import Group, ReviewRequest, \
                                        ReviewRequestDraft, ScreenshotComment

Review Board

beta

This change has been marked as submitted.

Add support for starring groups and review requests

Diff revision 3 (Latest)