comments: update comments email templates.

- use status prefix
- use more readable texts

rhodecode/apps/repository/tests/test_repo_commit_comments.py

@@ -1,313 +1,314 b''
 # -*- coding: utf-8 -*-
 
 # Copyright (C) 2010-2018 RhodeCode GmbH
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License, version 3
 # (only), as published by the Free Software Foundation.
 #
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
 #
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 # This program is dual-licensed. If you wish to learn more about the
 # RhodeCode Enterprise Edition, including its added features, Support services,
 # and proprietary license terms, please see https://rhodecode.com/licenses/
 
 import pytest
 
 from rhodecode.tests import TestController
 
 from rhodecode.model.db import (
     ChangesetComment, Notification, UserNotification)
 from rhodecode.model.meta import Session
 from rhodecode.lib import helpers as h
 
 
 def route_path(name, params=None, **kwargs):
     import urllib
 
     base_url = {
         'repo_commit': '/{repo_name}/changeset/{commit_id}',
         'repo_commit_comment_create': '/{repo_name}/changeset/{commit_id}/comment/create',
         'repo_commit_comment_preview': '/{repo_name}/changeset/{commit_id}/comment/preview',
         'repo_commit_comment_delete': '/{repo_name}/changeset/{commit_id}/comment/{comment_id}/delete',
     }[name].format(**kwargs)
 
     if params:
         base_url = '{}?{}'.format(base_url, urllib.urlencode(params))
     return base_url
 
 
 @pytest.mark.backends("git", "hg", "svn")
 class TestRepoCommitCommentsView(TestController):
 
     @pytest.fixture(autouse=True)
     def prepare(self, request, baseapp):
         for x in ChangesetComment.query().all():
             Session().delete(x)
         Session().commit()
 
         for x in Notification.query().all():
             Session().delete(x)
         Session().commit()
 
         request.addfinalizer(self.cleanup)
 
     def cleanup(self):
         for x in ChangesetComment.query().all():
             Session().delete(x)
         Session().commit()
 
         for x in Notification.query().all():
             Session().delete(x)
         Session().commit()
 
     @pytest.mark.parametrize('comment_type', ChangesetComment.COMMENT_TYPES)
     def test_create(self, comment_type, backend):
         self.log_user()
         commit = backend.repo.get_commit('300')
         commit_id = commit.raw_id
         text = u'CommentOnCommit'
 
         params = {'text': text, 'csrf_token': self.csrf_token,
                   'comment_type': comment_type}
         self.app.post(
             route_path('repo_commit_comment_create',
                        repo_name=backend.repo_name, commit_id=commit_id),
             params=params)
 
         response = self.app.get(
             route_path('repo_commit',
                        repo_name=backend.repo_name, commit_id=commit_id))
 
         # test DB
         assert ChangesetComment.query().count() == 1
         assert_comment_links(response, ChangesetComment.query().count(), 0)
 
         assert Notification.query().count() == 1
         assert ChangesetComment.query().count() == 1
 
         notification = Notification.query().all()[0]
 
         comment_id = ChangesetComment.query().first().comment_id
         assert notification.type_ == Notification.TYPE_CHANGESET_COMMENT
 
-        sbj = 'left {0} on commit `{1}` in the {2} repository'.format(
-            comment_type, h.show_id(commit), backend.repo_name)
-        assert sbj in notification.subject
+        author = notification.created_by_user.username_and_name
+        sbj = '{0} left a {1} on commit `{2}` in the {3} repository'.format(
+            author, comment_type, h.show_id(commit), backend.repo_name)
+        assert sbj == notification.subject
 
         lnk = (u'/{0}/changeset/{1}#comment-{2}'.format(
             backend.repo_name, commit_id, comment_id))
         assert lnk in notification.body
 
     @pytest.mark.parametrize('comment_type', ChangesetComment.COMMENT_TYPES)
     def test_create_inline(self, comment_type, backend):
         self.log_user()
         commit = backend.repo.get_commit('300')
         commit_id = commit.raw_id
         text = u'CommentOnCommit'
         f_path = 'vcs/web/simplevcs/views/repository.py'
         line = 'n1'
 
         params = {'text': text, 'f_path': f_path, 'line': line,
                   'comment_type': comment_type,
                   'csrf_token': self.csrf_token}
 
         self.app.post(
             route_path('repo_commit_comment_create',
                        repo_name=backend.repo_name, commit_id=commit_id),
             params=params)
 
         response = self.app.get(
             route_path('repo_commit',
                        repo_name=backend.repo_name, commit_id=commit_id))
 
         # test DB
         assert ChangesetComment.query().count() == 1
         assert_comment_links(response, 0, ChangesetComment.query().count())
 
         if backend.alias == 'svn':
             response.mustcontain(
                 '''data-f-path="vcs/commands/summary.py" '''
                 '''id="a_c--ad05457a43f8"'''
             )
         else:
             response.mustcontain(
                 '''data-f-path="vcs/backends/hg.py" '''
                 '''id="a_c--9c390eb52cd6"'''
             )
 
         assert Notification.query().count() == 1
         assert ChangesetComment.query().count() == 1
 
         notification = Notification.query().all()[0]
         comment = ChangesetComment.query().first()
         assert notification.type_ == Notification.TYPE_CHANGESET_COMMENT
 
         assert comment.revision == commit_id
-        sbj = 'left {comment_type} on commit `{commit}` ' \
-              '(file: `{f_path}`) in the {repo} repository'.format(
-            commit=h.show_id(commit),
-            f_path=f_path, line=line, repo=backend.repo_name,
-            comment_type=comment_type)
-        assert sbj in notification.subject
+
+        author = notification.created_by_user.username_and_name
+        sbj = '{0} left a {1} on file `{2}` in commit `{3}` in the {4} repository'.format(
+            author, comment_type, f_path, h.show_id(commit), backend.repo_name)
+
+        assert sbj == notification.subject
 
         lnk = (u'/{0}/changeset/{1}#comment-{2}'.format(
             backend.repo_name, commit_id, comment.comment_id))
         assert lnk in notification.body
         assert 'on line n1' in notification.body
 
     def test_create_with_mention(self, backend):
         self.log_user()
 
         commit_id = backend.repo.get_commit('300').raw_id
         text = u'@test_regular check CommentOnCommit'
 
         params = {'text': text, 'csrf_token': self.csrf_token}
         self.app.post(
             route_path('repo_commit_comment_create',
                        repo_name=backend.repo_name, commit_id=commit_id),
             params=params)
 
         response = self.app.get(
             route_path('repo_commit',
                        repo_name=backend.repo_name, commit_id=commit_id))
         # test DB
         assert ChangesetComment.query().count() == 1
         assert_comment_links(response, ChangesetComment.query().count(), 0)
 
         notification = Notification.query().one()
 
         assert len(notification.recipients) == 2
         users = [x.username for x in notification.recipients]
 
         # test_regular gets notification by @mention
         assert sorted(users) == [u'test_admin', u'test_regular']
 
     def test_create_with_status_change(self, backend):
         self.log_user()
         commit = backend.repo.get_commit('300')
         commit_id = commit.raw_id
         text = u'CommentOnCommit'
         f_path = 'vcs/web/simplevcs/views/repository.py'
         line = 'n1'
 
         params = {'text': text, 'changeset_status': 'approved',
                   'csrf_token': self.csrf_token}
 
         self.app.post(
             route_path(
                 'repo_commit_comment_create',
                 repo_name=backend.repo_name, commit_id=commit_id),
             params=params)
 
         response = self.app.get(
             route_path('repo_commit',
                        repo_name=backend.repo_name, commit_id=commit_id))
 
         # test DB
         assert ChangesetComment.query().count() == 1
         assert_comment_links(response, ChangesetComment.query().count(), 0)
 
         assert Notification.query().count() == 1
         assert ChangesetComment.query().count() == 1
 
         notification = Notification.query().all()[0]
 
         comment_id = ChangesetComment.query().first().comment_id
         assert notification.type_ == Notification.TYPE_CHANGESET_COMMENT
 
-        sbj = 'left note on commit `{0}` (status: Approved) ' \
-              'in the {1} repository'.format(
-            h.show_id(commit), backend.repo_name)
-        assert sbj in notification.subject
+        author = notification.created_by_user.username_and_name
+        sbj = '[status: Approved] {0} left a note on commit `{1}` in the {2} repository'.format(
+            author, h.show_id(commit), backend.repo_name)
+        assert sbj == notification.subject
 
         lnk = (u'/{0}/changeset/{1}#comment-{2}'.format(
             backend.repo_name, commit_id, comment_id))
         assert lnk in notification.body
 
     def test_delete(self, backend):
         self.log_user()
         commit_id = backend.repo.get_commit('300').raw_id
         text = u'CommentOnCommit'
 
         params = {'text': text, 'csrf_token': self.csrf_token}
         self.app.post(
             route_path(
                 'repo_commit_comment_create',
                 repo_name=backend.repo_name, commit_id=commit_id),
             params=params)
 
         comments = ChangesetComment.query().all()
         assert len(comments) == 1
         comment_id = comments[0].comment_id
 
         self.app.post(
             route_path('repo_commit_comment_delete',
                        repo_name=backend.repo_name,
                        commit_id=commit_id,
                        comment_id=comment_id),
             params={'csrf_token': self.csrf_token})
 
         comments = ChangesetComment.query().all()
         assert len(comments) == 0
 
         response = self.app.get(
             route_path('repo_commit',
                        repo_name=backend.repo_name, commit_id=commit_id))
         assert_comment_links(response, 0, 0)
 
     @pytest.mark.parametrize('renderer, input, output', [
         ('rst', 'plain text', '<p>plain text</p>'),
         ('rst', 'header\n======', '<h1 class="title">header</h1>'),
         ('rst', '*italics*', '<em>italics</em>'),
         ('rst', '**bold**', '<strong>bold</strong>'),
         ('markdown', 'plain text', '<p>plain text</p>'),
         ('markdown', '# header', '<h1>header</h1>'),
         ('markdown', '*italics*', '<em>italics</em>'),
         ('markdown', '**bold**', '<strong>bold</strong>'),
     ], ids=['rst-plain', 'rst-header', 'rst-italics', 'rst-bold', 'md-plain',
             'md-header', 'md-italics', 'md-bold', ])
     def test_preview(self, renderer, input, output, backend, xhr_header):
         self.log_user()
         params = {
             'renderer': renderer,
             'text': input,
             'csrf_token': self.csrf_token
         }
         commit_id = '0' * 16  # fake this for tests
         response = self.app.post(
             route_path('repo_commit_comment_preview',
-                        repo_name=backend.repo_name, commit_id=commit_id,),
+                       repo_name=backend.repo_name, commit_id=commit_id,),
             params=params,
             extra_environ=xhr_header)
 
         response.mustcontain(output)
 
 
 def assert_comment_links(response, comments, inline_comments):
     if comments == 1:
         comments_text = "%d Commit comment" % comments
     else:
         comments_text = "%d Commit comments" % comments
 
     if inline_comments == 1:
         inline_comments_text = "%d Inline Comment" % inline_comments
     else:
         inline_comments_text = "%d Inline Comments" % inline_comments
 
     if comments:
         response.mustcontain('<a href="#comments">%s</a>,' % comments_text)
     else:
         response.mustcontain(comments_text)
 
     if inline_comments:
         response.mustcontain(
             'id="inline-comments-counter">%s</' % inline_comments_text)
     else:
         response.mustcontain(inline_comments_text)

rhodecode/templates/email_templates/commit_comment.mako

@@ -1,105 +1,108 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 <%namespace name="base" file="base.mako"/>
 
 ## EMAIL SUBJECT
 <%def name="subject()" filter="n,trim,whitespace_filter">
 <%
 data = {
     'user': h.person(user),
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${_('[mention]') if mention else ''} \
 
 % if comment_file:
-    ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s` (file: `%(comment_file)s`)') % data} ${_('in the %(repo_name)s repository') % data |n}
+    ${_('{user} left a {comment_type} on file `{comment_file}` in commit `{commit_id}`').format(**data)} ${_('in the {repo_name} repository').format(**data) |n}
 % else:
     % if status_change:
-    ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s` (status: %(status)s)') % data |n} ${_('in the %(repo_name)s repository') % data |n}
+    ${_('[status: {status}] {user} left a {comment_type} on commit `{commit_id}`').format(**data) |n} ${_('in the {repo_name} repository').format(**data) |n}
     % else:
-    ${_('%(user)s left %(comment_type)s on commit `%(commit_id)s`') % data |n} ${_('in the %(repo_name)s repository') % data |n}
+    ${_('{user} left a {comment_type} on commit `{commit_id}`').format(**data) |n} ${_('in the {repo_name} repository').format(**data) |n}
     % endif
 % endif
 
 </%def>
 
 ## PLAINTEXT VERSION OF BODY
 <%def name="body_plaintext()" filter="n,trim">
 <%
 data = {
     'user': h.person(user),
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${self.subject()}
 
 * ${_('Comment link')}: ${commit_comment_url}
 
 * ${_('Commit')}: ${h.show_id(commit)}
 
 %if comment_file:
-* ${_('File: %(comment_file)s on line %(comment_line)s') % data}
+* ${_('File: {comment_file} on line {comment_line}').format(**data)}
 %endif
 
 ---
 
 %if status_change:
     ${_('Commit status was changed to')}: *${status_change}*
 %endif
 
 ${comment_body|n}
 
 ${self.plaintext_footer()}
 </%def>
 
 
 <%
 data = {
     'user': h.person(user),
     'repo': commit_target_repo,
     'repo_name': repo_name,
     'commit_id': h.show_id(commit),
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;">
 
     % if comment_file:
-        <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on commit `%(commit_id)s` (file:`%(comment_file)s`)') % data}</a> ${_('in the %(repo)s repository') % data |n}</h4>
+        <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('{user} left a {comment_type} on file `{comment_file}` in commit `{commit_id}`').format(**data)}</a> ${_('in the {repo} repository').format(**data) |n}</h4>
     % else:
-        <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on commit `%(commit_id)s`') % data |n}</a> ${_('in the %(repo)s repository') % data |n}</h4>
+        <h4><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('{user} left a {comment_type} on commit `{commit_id}`').format(**data) |n}</a> ${_('in the {repo} repository').format(**data) |n}</h4>
     % endif
     </td></tr>
 
     <tr><td style="padding-right:20px;padding-top:15px;">${_('Commit')}</td><td style="padding-top:15px;"><a href="${commit_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${h.show_id(commit)}</a></td></tr>
     <tr><td style="padding-right:20px;">${_('Description')}</td><td style="white-space:pre-wrap">${h.urlify_commit_message(commit.message, repo_name)}</td></tr>
 
     % if status_change:
-        <tr><td style="padding-right:20px;">${_('Status')}</td>
-            <td>${_('The commit status was changed to')}: ${base.status_text(status_change, tag_type=status_change_type)}</td>
+        <tr>
+            <td style="padding-right:20px;">${_('Status')}</td>
+            <td>
+                ${_('The commit status was changed to')}: ${base.status_text(status_change, tag_type=status_change_type)}
+            </td>
         </tr>
     % endif
     <tr>
         <td style="padding-right:20px;">
             % if comment_type == 'todo':
-                ${(_('TODO comment on line: %(comment_line)s') if comment_file else _('TODO comment')) % data}
+                ${(_('TODO comment on line: {comment_line}') if comment_file else _('TODO comment')).format(**data)}
             % else:
-                ${(_('Note comment on line: %(comment_line)s') if comment_file else _('Note comment')) % data}
+                ${(_('Note comment on line: {comment_line}') if comment_file else _('Note comment')).format(**data)}
             % endif
         </td>
         <td style="line-height:1.2em;white-space:pre-wrap">${h.render(comment_body, renderer=renderer_type, mentions=True)}</td></tr>
 </table>

rhodecode/templates/email_templates/pull_request_comment.mako

@@ -1,114 +1,114 b''
 ## -*- coding: utf-8 -*-
 <%inherit file="base.mako"/>
 <%namespace name="base" file="base.mako"/>
 
 ## EMAIL SUBJECT
 <%def name="subject()" filter="n,trim,whitespace_filter">
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 
-${_('[mention]') if mention else ''} \
+${(_('[mention]') if mention else '')} \
 
 % if comment_file:
-    ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s" (file: `%(comment_file)s`)') % data |n}
+    ${_('{user} left a {comment_type} on file `{comment_file}` in pull request #{pr_id} "{pr_title}"').format(**data) |n}
 % else:
     % if status_change:
-    ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s" (status: %(status)s)') % data |n}
+    ${_('[status: {status}] {user} left a {comment_type} on pull request #{pr_id} "{pr_title}"').format(**data) |n}
     % else:
-    ${_('%(user)s left %(comment_type)s on pull request #%(pr_id)s "%(pr_title)s"') % data |n}
+    ${_('{user} left a {comment_type} on pull request #{pr_id} "{pr_title}"').format(**data) |n}
     % endif
 % endif
 </%def>
 
 ## PLAINTEXT VERSION OF BODY
 <%def name="body_plaintext()" filter="n,trim">
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 ${self.subject()}
 
 * ${_('Comment link')}: ${pr_comment_url}
 
 * ${_('Source repository')}: ${pr_source_repo_url}
 
 %if comment_file:
-* ${_('File: %(comment_file)s on line %(comment_line)s') % {'comment_file': comment_file, 'comment_line': comment_line}}
+* ${_('File: {comment_file} on line {comment_line}').format(comment_file=comment_file, comment_line=comment_line)}
 %endif
 
 ---
 
 %if status_change and not closing_pr:
-   ${_('%(user)s submitted pull request #%(pr_id)s status: *%(status)s*') % data}
+   ${_('{user} submitted pull request #{pr_id} status: *{status}*').format(**data)}
 %elif status_change and closing_pr:
-   ${_('%(user)s submitted pull request #%(pr_id)s status: *%(status)s and closed*') % data}
+   ${_('{user} submitted pull request #{pr_id} status: *{status} and closed*').format(**data)}
 %endif
 
-${comment_body|n}
+${comment_body |n}
 
 ${self.plaintext_footer()}
 </%def>
 
 
 <%
 data = {
     'user': h.person(user),
     'pr_title': pull_request.title,
     'pr_id': pull_request.pull_request_id,
     'status': status_change,
     'comment_file': comment_file,
     'comment_line': comment_line,
     'comment_type': comment_type,
 }
 %>
 <table style="text-align:left;vertical-align:middle;">
     <tr><td colspan="2" style="width:100%;padding-bottom:15px;border-bottom:1px solid #dbd9da;">
 
     % if comment_file:
-        <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on pull request #%(pr_id)s "%(pr_title)s" (file:`%(comment_file)s`)') % data |n}</a></h4>
+        <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('{user} left a {comment_type} on file `{comment_file}` in pull request #{pr_id} "{pr_title}"').format(**data) |n}</a></h4>
     % else:
-        <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('%(user)s commented on pull request #%(pr_id)s "%(pr_title)s"') % data |n}</a></h4>
+        <h4><a href="${pr_comment_url}" style="color:#427cc9;text-decoration:none;cursor:pointer">${_('{user} left a {comment_type} on pull request #{pr_id} "{pr_title}"').format(**data) |n}</a></h4>
     % endif
 
     </td></tr>
     <tr><td style="padding-right:20px;padding-top:15px;">${_('Source')}</td><td style="padding-top:15px;"><a style="color:#427cc9;text-decoration:none;cursor:pointer" href="${pr_source_repo_url}">${pr_source_repo.repo_name}</a></td></tr>
 
     % if status_change:
         <tr>
             <td style="padding-right:20px;">${_('Status')}</td>
             <td>
                 % if closing_pr:
                    ${_('Closed pull request with status')}: ${base.status_text(status_change, tag_type=status_change_type)}
                 % else:
                    ${_('Submitted review status')}: ${base.status_text(status_change, tag_type=status_change_type)}
                 % endif
             </td>
         </tr>
     % endif
     <tr>
         <td style="padding-right:20px;">
             % if comment_type == 'todo':
-                ${(_('TODO comment on line: %(comment_line)s') if comment_file else _('TODO comment')) % data}
+                ${(_('TODO comment on line: {comment_line}') if comment_file else _('TODO comment')).format(**data)}
             % else:
-                ${(_('Note comment on line: %(comment_line)s') if comment_file else _('Note comment')) % data}
+                ${(_('Note comment on line: {comment_line}') if comment_file else _('Note comment')).format(**data)}
             % endif
         </td>
         <td style="line-height:1.2em;white-space:pre-wrap">${h.render(comment_body, renderer=renderer_type, mentions=True)}</td>
     </tr>
 </table>