aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/apps/coding-rules/rule/rule-description-view.js
blob: c84213c614df620ac50e433e4a0231f183e36509 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
define([
  '../templates'
], function () {

  return Marionette.ItemView.extend({
    template: Templates['coding-rules-rule-description'],

    modelEvents: {
      'change': 'render'
    },

    ui: {
      descriptionExtra: '#coding-rules-detail-description-extra',
      extendDescriptionLink: '#coding-rules-detail-extend-description',
      extendDescriptionForm: '.coding-rules-detail-extend-description-form',
      extendDescriptionSubmit: '#coding-rules-detail-extend-description-submit',
      extendDescriptionRemove: '#coding-rules-detail-extend-description-remove',
      extendDescriptionText: '#coding-rules-detail-extend-description-text',
      cancelExtendDescription: '#coding-rules-detail-extend-description-cancel'
    },

    events: {
      'click @ui.extendDescriptionLink': 'showExtendDescriptionForm',
      'click @ui.cancelExtendDescription': 'hideExtendDescriptionForm',
      'click @ui.extendDescriptionSubmit': 'submitExtendDescription',
      'click @ui.extendDescriptionRemove': 'removeExtendedDescription'
    },

    showExtendDescriptionForm: function () {
      this.ui.descriptionExtra.addClass('hidden');
      this.ui.extendDescriptionForm.removeClass('hidden');
      this.ui.extendDescriptionText.focus();
    },

    hideExtendDescriptionForm: function () {
      this.ui.descriptionExtra.removeClass('hidden');
      this.ui.extendDescriptionForm.addClass('hidden');
    },

    submitExtendDescription: function () {
      var that = this;
      this.ui.extendDescriptionForm.addClass('hidden');
      return jQuery.ajax({
        type: 'POST',
        url: baseUrl + '/api/rules/update',
        dataType: 'json',
        data: {
          key: this.model.get('key'),
          markdown_note: this.ui.extendDescriptionText.val()
        }
      }).done(function (r) {
        that.model.set({
          htmlNote: r.rule.htmlNote,
          mdNote: r.rule.mdNote
        });
        that.render();
      }).fail(function () {
        that.render();
      });
    },

    removeExtendedDescription: function () {
      var that = this;
      window.confirmDialog({
        html: t('coding_rules.remove_extended_description.confirm'),
        yesHandler: function () {
          that.ui.extendDescriptionText.val('');
          that.submitExtendDescription();
        }
      });
    },

    serializeData: function () {
      var isEditable = this.options.app.canWrite && (this.model.get('isManual') || this.model.get('isCustom'));

      return _.extend(Marionette.ItemView.prototype.serializeData.apply(this, arguments), {
        isEditable: isEditable,
        canWrite: this.options.app.canWrite
      });
    }
  });

});