kallithea Changeset - 2e72d2d16a0f

Changeset - 2e72d2d16a0f

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Andrew Shadura - 8 years ago 2017-07-10 20:13:10
andrew@shadura.me

comments: display comment previews while submitting

Instead of just saying 'Submitting' and not showing any progress to
the user until the comment has been accepted by the server, show a
preview of the comment above the comment box in a way which is makes
it obvious to the user the comment is being submitted. Apart from
that, also clear the comment box so that a repeated clicking the
submit button doesn't result in a duplicate comment.

The preview doesn't highlight URLs or support @mentions or *bold*,
which is a good enough approximation in this case. When/if we (re-)add
the rST/Markdown support, we will need a client-side parser for the
syntax we choose.

When the submission fails, display a message and offer the user to
retry or cancel the submission.

4 files changed with 115 insertions and 12 deletions:

kallithea/public/css/style.css

kallithea/public/js/base.js

kallithea/templates/base/root.html

kallithea/templates/changeset/changeset_file_comment.html

0 comments (0 inline, 0 general)

kallithea/public/css/style.css

➞

Show inline comments

@@ @@ -2787,24 +2787,58 @@ input.status_change_checkbox, @@
 input.status_change_radio {
     margin: 0 0 5px 15px;
+}
 .badge {
     padding: 4px 4px !important;
     text-align: center;
     color: #888 !important;
     background-color: #DEDEDE !important;
     border-radius: 4px !important;
+}
 @keyframes animated-comment-background {
 % { background-position: 0 0; }
 % { background-position: 20px 0; }
+}
 .comment-preview.failed .user,
 .comment-preview.failed .panel-body {
     color: #666;
+}
 .comment-preview .comment-submission-status {
     float: right;
+}
 .comment-preview .comment-submission-status .btn-group {
     margin-left: 10px;
+}
 .comment-preview.submitting .panel-body {
     background-image: linear-gradient(
         -45deg,
         #FAFAFA,
         #FAFAFA 25%,
         #FFF 25%,
         #FFF 50%,
         #FAFAFA 50%,
         #FAFAFA 75%,
         #FFF 75%,
         #FFF 100%
     );
     background-size: 20px 20px;
     animation: animated-comment-background 0.4s linear infinite;
+}
 /****
 PULL REQUESTS
 *****/
 .pullrequests_section_head {
     padding: 10px 10px 10px 0px;
     margin: 0 15px;
     font-size: 16px;
     font-weight: bold;
+}
 div.pr-details-title.closed {
     color: #555;

kallithea/public/js/base.js

➞

Show inline comments

@@ @@ -638,24 +638,25 @@ function _comment_div_append_add($commen @@
     $comment_div.append($add);
     $add.children('.add-button').click(function(e) {
         comment_div_state($comment_div, f_path, line_no, true);
     });
+}
 // append a comment form to $comment_div
 function _comment_div_append_form($comment_div, f_path, line_no) {
     var $form_div = $('#comment-inline-form-template').children()
         .clone()
         .addClass('comment-inline-form');
     $comment_div.append($form_div);
     var $preview = $comment_div.find("div.comment-preview");
     var $form = $comment_div.find("form");
     var $textarea = $form.find('textarea');
     $form.submit(function(e) {
         e.preventDefault();
         var text = $textarea.val();
         var review_status = $form.find('input:radio[name=changeset_status]:checked').val();
         var pr_close = $form.find('input:checkbox[name=save_close]:checked').length ? 'on' : '';
         var pr_delete = $form.find('input:checkbox[name=save_delete]:checked').length ? 'delete' : '';
         if (!text && !review_status && !pr_close && !pr_delete) {
@@ @@ -669,49 +670,86 @@ function _comment_div_append_form($comme @@
                 return false;
+            }
             if (!confirm('Confirm to delete this pull request')) {
                 return false;
+            }
             var comments = $('.comment').size();
             if (comments > 0 &&
                 !confirm('Confirm again to delete this pull request with {0} comments'.format(comments))) {
                 return false;
+            }
+        }
         $form.find('.submitting-overlay').show();
         if (review_status) {
             var $review_status = $preview.find('.automatic-comment');
             var review_status_lbl = $("#comment-inline-form-template input.status_change_radio[value='" + review_status + "']").parent().text().strip();
             $review_status.find('.comment-status-label').text(review_status_lbl);
             $review_status.show();
+        }
         $preview.find('.comment-text div').text(text);
         $preview.show();
         $textarea.val('');
         if (f_path && line_no) {
             $form.hide();
+        }
         var postData = {
             'text': text,
             'f_path': f_path,
             'line': line_no,
             'changeset_status': review_status,
             'save_close': pr_close,
             'save_delete': pr_delete
         };
         var success = function(json_data) {
             if (pr_delete) {
                 location = json_data['location'];
             } else {
                 $comment_div.append(json_data['rendered_text']);
                 comment_div_state($comment_div, f_path, line_no);
                 linkInlineComments($('.firstlink'), $('.comment:first-child'));
                 if ((review_status || pr_close) && !f_path && !line_no) {
                     // Page changed a lot - reload it after closing the submitted form
                     comment_div_state($comment_div, f_path, line_no, false);
                     location.reload(true);
+                }
+            }
         };
         ajaxPOST(AJAX_COMMENT_URL, postData, success);
         var failure = function(x, s, e) {
             $preview.removeClass('submitting').addClass('failed');
             var $status = $preview.find('.comment-submission-status');
             $('<span>', {
                 'title': e,
                 text: _TM['Unable to post']
             }).replaceAll($status.contents());
             $('<div>', {
                 'class': 'btn-group'
             }).append(
                 $('<button>', {
                     'class': 'btn btn-default btn-xs',
                     text: _TM['Retry']
                 }).click(function() {
                     $status.text(_TM['Submitting ...']);
                     $preview.addClass('submitting').removeClass('failed');
                     ajaxPOST(AJAX_COMMENT_URL, postData, success, failure);
                 }),
                 $('<button>', {
                     'class': 'btn btn-default btn-xs',
                     text: _TM['Cancel']
                 }).click(function() {
                     comment_div_state($comment_div, f_path, line_no);
                 })
             ).appendTo($status);
         };
         ajaxPOST(AJAX_COMMENT_URL, postData, success, failure);
     });
     // add event handler for hide/cancel buttons
     $form.find('.hide-inline-form').click(function(e) {
         comment_div_state($comment_div, f_path, line_no);
     });
     tooltip_activate();
     if ($textarea.length > 0) {
         MentionsAutoComplete($textarea, _USERS_AC_DATA);
+    }
     if (f_path) {

kallithea/templates/base/root.html

➞

Show inline comments

@@ @@ -13,31 +13,35 @@ @@
         <link rel="stylesheet" type="text/css" href="${h.url('/css/bootstrap.css', ver=c.kallithea_version)}"/>
         <link rel="stylesheet" type="text/css" href="${h.url('/js/select2/select2-bootstrap.css', ver=c.kallithea_version)}"/>
         <link rel="stylesheet" type="text/css" href="${h.url('/css/pygments.css', ver=c.kallithea_version)}"/>
         <link rel="stylesheet" type="text/css" href="${h.url('/css/style.css', ver=c.kallithea_version)}" media="screen"/>
         <link rel="stylesheet" type="text/css" href="${h.url('/css/contextbar.css', ver=c.kallithea_version)}" media="screen"/>
         <link rel="stylesheet" type="text/css" href="${h.url('/fontello/css/kallithea.css', ver=c.kallithea_version)}">
         <%block name="css_extra"/>
         ## JAVASCRIPT ##
         <script type="text/javascript">
             ## JS translations map
             var TRANSLATION_MAP = {
                 'Add Another Comment':${h.jshtml(_("Add Another Comment"))},
                 'Stop following this repository':${h.jshtml(_('Stop following this repository'))},
                 'Start following this repository':${h.jshtml(_('Start following this repository'))},
                 'Group':${h.jshtml(_('Group'))},
                 'members':${h.jshtml(_('members'))},
                 'Loading ...':${h.jshtml(_('Loading ...'))},
                 'loading ...':${h.jshtml(_('loading ...'))},
                 'Cancel': ${h.jshtml(_("Cancel"))},
                 'Retry': ${h.jshtml(_("Retry"))},
                 'Submitting ...': ${h.jshtml(_("Submitting ..."))},
                 'Unable to post': ${h.jshtml(_("Unable to post"))},
                 'Add Another Comment': ${h.jshtml(_("Add Another Comment"))},
                 'Stop following this repository': ${h.jshtml(_('Stop following this repository'))},
                 'Start following this repository': ${h.jshtml(_('Start following this repository'))},
                 'Group': ${h.jshtml(_('Group'))},
                 'members': ${h.jshtml(_('members'))},
                 'Loading ...': ${h.jshtml(_('Loading ...'))},
                 'loading ...': ${h.jshtml(_('loading ...'))},
                 'Search truncated': ${h.jshtml(_('Search truncated'))},
                 'No matching files': ${h.jshtml(_('No matching files'))},
                 'Open New Pull Request from {0}': ${h.jshtml(_('Open New Pull Request from {0}'))},
                 'Open New Pull Request for {0} &rarr; {1}': ${h.js(_('Open New Pull Request for {0} &rarr; {1}'))},
                 'Show Selected Changesets {0} &rarr; {1}': ${h.js(_('Show Selected Changesets {0} &rarr; {1}'))},
                 'Selection Link': ${h.jshtml(_('Selection Link'))},
                 'Collapse Diff': ${h.jshtml(_('Collapse Diff'))},
                 'Expand Diff': ${h.jshtml(_('Expand Diff'))},
                 'Type name of user or member to grant permission': ${h.jshtml(_('Type name of user or member to grant permission'))},
                 'Failed to revoke permission': ${h.jshtml(_('Failed to revoke permission'))},
                 'Confirm to revoke permission for {0}: {1} ?': ${h.jshtml(_('Confirm to revoke permission for {0}: {1} ?'))},
                 'Enabled': ${h.jshtml(_('Enabled'))},

kallithea/templates/changeset/changeset_file_comment.html

➞

Show inline comments

@@ @@ -25,40 +25,68 @@ @@
           </span>
           %if co.author_id == request.authuser.user_id or h.HasRepoPermissionLevel('admin')(c.repo_name):
             %if co.deletable():
               <button type="button" onClick="confirm('${_('Delete comment?')}') && deleteComment(${co.comment_id})" class="pull-right buttons delete-comment btn btn-default btn-xs">${_('Delete')}</button>
             %endif
           %endif
       </div>
       <div class="panel-body">
         %if co.status_change:
            <div class="automatic-comment">
              <p>
                ${_("Status change")}: ${co.status_change[0].status_lbl}
+               ${_("Status change")}: <span class="comment-status-label">${co.status_change[0].status_lbl}</span>
                <i class="icon-circle changeset-status-${co.status_change[0].status}"></i>
              </p>
            </div>
         %endif
         <div class="comment-text">
         %if co.text:
           ${h.render_w_mentions(co.text, c.repo_name)|n}
         %endif
         </div>
       </div>
     </div>
   </div>
 </%def>
 <%def name="comment_inline_form()">
 <div id='comment-inline-form-template' style="display:none">
 <div id='comment-inline-form-template' style="display: none;">
   <div class="comment comment-preview submitting" style="display: none;">
     <div class="panel panel-default">
       <div class="panel-heading">
           ${h.gravatar_div(request.authuser.email, size=20)}
           <span class="user">
               ${request.authuser.full_name_or_username}
           </span>
           <span class="comment-submission-status">
               ${_('Submitting ...')}
           </span>
       </div>
       <div class="panel-body">
            <div class="automatic-comment" style="display: none;">
              <p>
                ${_("Status change")}: <span class="comment-status-label"></span>
                <i class="icon-circle"></i>
              </p>
            </div>
            <div class="comment-text">
              <div class="formatted-fixed">
              </div>
            </div>
       </div>
     </div>
   </div>
   <div class="ac">
   %if request.authuser.username != 'default':
     ${h.form('#', class_='inline-form')}
       <div class="well well-sm clearfix">
         <div class="comment-help">${_('Commenting on line.')}
           <span class="text-muted">${_('Comments are in plain text. Use @username inside this text to notify another user.')|n}</span>
         </div>
         <textarea name="text" class="form-control comment-block-ta yui-ac-input"></textarea>
         <div id="status_block_container" class="status-block general-only hidden">
                 %if c.pull_request is None:
                   ${_('Set changeset status')}:
@@ @@ -88,25 +116,24 @@ @@
                     ${_("Close")}
                   </label>
                   <label class="checkbox-inline">
                     <input id="save_delete" type="checkbox" name="save_delete" value="delete" class="status_change_checkbox">
                     ${_("Delete")}
                   </label>
                 </div>
                 %endif
         </div>
       </div>
       <div class="comment-button">
         <div class="submitting-overlay" style="display:none">${_('Submitting ...')}</div>
         ${h.submit('save', _('Comment'), class_='btn btn-default btn-sm save-inline-form')}
         ${h.reset('hide-inline-form', _('Cancel'), class_='btn btn-default btn-sm hide-inline-form')}
       </div>
     ${h.end_form()}
   %else:
       ${h.form('')}
       <div class="clearfix">
           <div class="comment-help">
             ${_('You need to be logged in to comment.')} <a href="${h.url('login_home', came_from=request.path_qs)}">${_('Login now')}</a>
           </div>
       </div>
       <div class="comment-button">

0 comments (0 inline, 0 general)