Commit: 840d748a54b1464890e283a04546d17fa13bc4e5 - allura (git)

allura

Commit MetaInfo

• Revisión: 840d748a54b1464890e283a04546d17fa13bc4e5 (tree)
• Tiempo: 2012-07-18 04:25:21
• Autor: Igor Bondarenko <jetmind2@gmai...>
• Commiter: Cory Johns

Log Message

[#4181] ticket:100 Implemented ability to vote for a ticket.

Cambiar Resumen

• modified: Allura/allura/lib/widgets/__init__.py
• add: Allura/allura/lib/widgets/resources/css/vote.css
• add: Allura/allura/lib/widgets/resources/js/vote.js
• add: Allura/allura/lib/widgets/vote.py
• modified: Allura/allura/model/artifact.py
• add: Allura/allura/templates/widgets/vote.html
• modified: ForgeTracker/forgetracker/templates/tracker/ticket.html
• modified: ForgeTracker/forgetracker/tests/functional/test_root.py
• modified: ForgeTracker/forgetracker/tracker_main.py

Diferencia incremental

--- a/Allura/allura/lib/widgets/__init__.py
+++ b/Allura/allura/lib/widgets/__init__.py
@@ -2,3 +2,4 @@ from .discuss import Post, Thread, Discussion
 from .subscriptions import SubscriptionForm
 from .oauth_widgets import OAuthApplicationForm, OAuthRevocationForm
 from .auth_widgets import LoginForm
+from .vote import VoteForm

--- /dev/null
+++ b/Allura/allura/lib/widgets/resources/css/vote.css
@@ -0,0 +1,22 @@
+#vote {
+	display: block;
+	float: right;
+	margin-right: .5em
+	padding: .5em;
+	text-align: center;
+	width: 12em;
+}
+
+#vote .vote-uparrow {
+	color: red;
+	cursor: pointer;
+}
+
+#vote .vote-downarrow {
+	color: blue;
+	cursor: pointer;
+}
+
+#vote .voted {
+	color: red;
+}

--- /dev/null
+++ b/Allura/allura/lib/widgets/resources/js/vote.js
@@ -0,0 +1,41 @@
+$(document).ready(function() {
+  function vote(vote) {
+    var $form = $('#vote form');
+    var url = $form.attr('action');
+    var method = $form.attr('method');
+    var _session_id = $form.find('input[name="_session_id"]').val();
+    $.ajax({
+      url: url,
+      type: method,
+      data: {
+        vote: vote,
+        _session_id: _session_id
+      },
+      success: function(data) {
+        if (data.status == 'ok') {
+          $('#vote .votes-up').text(data.votes_up);
+          $('#vote .votes-down').text(data.votes_down);
+        }
+      }
+    });
+  }
+
+  function set_voted(vote) {
+    if (vote == 'u') {
+      $('#vote .votes-down').removeClass('voted');
+      $('#vote .votes-up').addClass('voted');
+    } else if (vote == 'd') {
+      $('#vote .votes-up').removeClass('voted');
+      $('#vote .votes-down').addClass('voted');
+    }
+  }
+
+  $('#vote .vote-up').click(function() {
+    vote('u');
+    set_voted('u')
+  });
+  $('#vote .vote-down').click(function() {
+    vote('d');
+    set_voted('d');
+  });
+});

--- /dev/null
+++ b/Allura/allura/lib/widgets/vote.py
@@ -0,0 +1,15 @@
+import ew as ew_core
+import ew.jinja2_ew as ew
+
+
+class VoteForm(ew_core.Widget):
+    template = 'jinja:allura:templates/widgets/vote.html'
+    defaults = dict(
+        ew_core.Widget.defaults,
+        action='vote',
+        artifact=None
+    )
+
+    def resources(self):
+        yield ew.CSSLink('css/vote.css')
+        yield ew.JSLink('js/vote.js')

--- a/Allura/allura/model/artifact.py
+++ b/Allura/allura/model/artifact.py
@@ -693,3 +693,17 @@ class VotableArtifact(MappedClass):
             self.votes_up = self.votes_up - 1
         self.votes_down_users.append(user.username)
         self.votes_down += 1
+
+    def user_voted(self, user):
+        """Check that user voted for this artifact.
+
+        Return:
+        1 if user voted up
+        -1 if user voted down
+        0 if user doesn't vote
+        """
+        if user.username in self.votes_up_users:
+            return 1
+        if user.username in self.votes_down_users:
+            return -1
+        return 0

--- /dev/null
+++ b/Allura/allura/templates/widgets/vote.html
@@ -0,0 +1,17 @@
+{% set can_vote = c.user and c.user != c.user.anonymous()
+                  and h.has_access(artifact, 'post')() %}
+{% set voted = artifact.user_voted(c.user) %}
+
+<div id="vote" class="info message">
+  Vote for this ticket:
+  <br />
+  <span class='vote-uparrow {% if can_vote %}vote-up{% endif %}'>&uArr;</span>
+  <span class='votes-up {% if voted == 1 %}voted{% endif %}'>{{artifact.votes_up}}</span> up&nbsp;
+  <span class='vote-downarrow {% if can_vote %}vote-down{% endif %}'>&dArr;</span>
+  <span class='votes-down {% if voted == -1 %}voted{% endif %}'>{{artifact.votes_down}}</span> down
+  {% if can_vote %}
+  <form action="{{ action }}" method="POST">
+    {# csrf protection will be automatically inserted here (_session_id field) #}
+  </form>
+  {% endif %}
+</div>

--- a/ForgeTracker/forgetracker/templates/tracker/ticket.html
+++ b/ForgeTracker/forgetracker/templates/tracker/ticket.html
@@ -110,6 +110,7 @@
 {% endblock %}
 
 {% block content %}
+{{ c.vote_form.display(artifact=ticket) }}
 <div id="ticket_content">
   {{g.markdown.convert(ticket.description)|safe}}
   {% if ticket.attachments %}

--- a/ForgeTracker/forgetracker/tests/functional/test_root.py
+++ b/ForgeTracker/forgetracker/tests/functional/test_root.py
@@ -1,6 +1,7 @@
 # -*- coding: utf-8 -*-
 import os
 import time
+import json
 import Image, StringIO
 import allura
 
@@ -830,6 +831,39 @@ class TestFunctionalController(TrackerTestController):
         assert_in('test second ticket', str(ticket_rows))
         assert_false('test third ticket' in str(ticket_rows))
 
+    def test_vote(self):
+        r = self.new_ticket(summary='test vote').follow()
+        vote = r.html.find('div', {'id': 'vote'})
+        assert_in('0 up', str(vote))
+        assert_in('0 down', str(vote))
+
+        # invalid vote
+        r = self.app.post('/bugs/1/vote', dict(vote='invalid'))
+        expected_resp = json.dumps(
+                            dict(status='error', votes_up=0, votes_down=0))
+        assert r.response.content == expected_resp
+
+        # vote up
+        r = self.app.post('/bugs/1/vote', dict(vote='u'))
+        expected_resp = json.dumps(
+                            dict(status='ok', votes_up=1, votes_down=0))
+        assert r.response.content == expected_resp
+
+        # vote down by another user
+        r = self.app.post('/bugs/1/vote', dict(vote='d'),
+                          extra_environ=dict(username='test-user-0'))
+
+        expected_resp = json.dumps(
+                            dict(status='ok', votes_up=1, votes_down=1))
+        assert r.response.content == expected_resp
+
+        # make sure that on the page we see the same result
+        r = self.app.get('/bugs/1/')
+        vote = r.html.find('div', {'id': 'vote'})
+        assert_in('1 up', str(vote))
+        assert_in('1 down', str(vote))
+
+
     @td.with_tool('test', 'Tickets', 'tracker',
             post_install_hook=post_install_create_ticket_permission)
     def test_create_permission(self):

--- a/ForgeTracker/forgetracker/tracker_main.py
+++ b/ForgeTracker/forgetracker/tracker_main.py
@@ -27,7 +27,8 @@ from allura.lib import helpers as h
 from allura.app import Application, SitemapEntry, DefaultAdminController, ConfigOption
 from allura.lib.search import search_artifact
 from allura.lib.decorators import require_post
-from allura.lib.security import require_access, has_access, require
+from allura.lib.security import (require_access, has_access, require,
+                                 require_authenticated)
 from allura.lib import widgets as w
 from allura.lib import validators as V
 from allura.lib.widgets import form_fields as ffw
@@ -98,6 +99,7 @@ class W:
     ticket_custom_field = TicketCustomField
     options_admin = OptionsAdmin()
     search_help_modal = SearchHelp()
+    vote_form = w.VoteForm()
 
 class ForgeTrackerApp(Application):
     __version__ = version.__version__
@@ -978,6 +980,7 @@ class TicketController(BaseController):
             c.attachment_list = W.attachment_list
             c.subscribe_form = W.ticket_subscribe_form
             c.ticket_custom_field = W.ticket_custom_field
+            c.vote_form = W.vote_form
             tool_subscribed = M.Mailbox.subscribed()
             if tool_subscribed:
                 subscribed = False
@@ -1152,6 +1155,24 @@ class TicketController(BaseController):
             self.ticket.unsubscribe()
         redirect(request.referer)
 
+    @expose('json')
+    @require_post()
+    def vote(self, vote):
+        require_authenticated()
+        require_access(self.ticket, 'post')
+        status = 'ok'
+        if vote == 'u':
+            self.ticket.vote_up(c.user)
+        elif vote == 'd':
+            self.ticket.vote_down(c.user)
+        else:
+            status = 'error'
+        return dict(
+            status=status,
+            votes_up=self.ticket.votes_up,
+            votes_down=self.ticket.votes_down)
+
+
 class AttachmentController(ac.AttachmentController):
     AttachmentClass = TM.TicketAttachment
     edit_perm = 'update'