aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/apps/coding-rules/rule-details-view.js
blob: 2fa5eb3f2f4039e5ad1b84125460ceb9983f294a (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
/*
 * SonarQube
 * Copyright (C) 2009-2017 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * 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
 * 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.
 */
import $ from 'jquery';
import { union } from 'lodash';
import Backbone from 'backbone';
import Marionette from 'backbone.marionette';
import Rules from './models/rules';
import MetaView from './rule/rule-meta-view';
import DescView from './rule/rule-description-view';
import ParamView from './rule/rule-parameters-view';
import ProfilesView from './rule/rule-profiles-view';
import CustomRulesView from './rule/custom-rules-view';
import CustomRuleCreationView from './rule/custom-rule-creation-view';
import DeleteRuleView from './rule/delete-rule-view';
import IssuesView from './rule/rule-issues-view';
import Template from './templates/coding-rules-rule-details.hbs';

export default Marionette.LayoutView.extend({
  className: 'coding-rule-details',
  template: Template,

  regions: {
    metaRegion: '.js-rule-meta',
    descRegion: '.js-rule-description',
    paramRegion: '.js-rule-parameters',
    profilesRegion: '.js-rule-profiles',
    customRulesRegion: '.js-rule-custom-rules',
    issuesRegion: '.js-rule-issues'
  },

  events: {
    'click .js-edit-custom': 'editCustomRule',
    'click .js-delete': 'deleteRule'
  },

  initialize() {
    this.bindShortcuts();
    this.customRules = new Rules();
    if (this.model.get('isTemplate')) {
      this.fetchCustomRules();
    }
    this.listenTo(this.options.app.state, 'change:selectedIndex', this.select);
  },

  onRender() {
    this.metaRegion.show(
      new MetaView({
        app: this.options.app,
        model: this.model
      })
    );
    this.descRegion.show(
      new DescView({
        app: this.options.app,
        model: this.model
      })
    );
    this.paramRegion.show(
      new ParamView({
        app: this.options.app,
        model: this.model
      })
    );
    this.profilesRegion.show(
      new ProfilesView({
        app: this.options.app,
        model: this.model,
        collection: new Backbone.Collection(this.getQualityProfiles())
      })
    );
    this.customRulesRegion.show(
      new CustomRulesView({
        app: this.options.app,
        model: this.model,
        collection: this.customRules
      })
    );
    this.issuesRegion.show(
      new IssuesView({
        app: this.options.app,
        model: this.model
      })
    );
    this.$el.scrollParent().scrollTop(0);
  },

  onDestroy() {
    this.unbindShortcuts();
  },

  fetchCustomRules() {
    const that = this;
    const url = window.baseUrl + '/api/rules/search';
    const options = {
      template_key: this.model.get('key'),
      f: 'name,severity,params'
    };
    return $.get(url, options).done(data => {
      that.customRules.reset(data.rules);
    });
  },

  getQualityProfiles() {
    return this.model.getInactiveProfiles(this.options.actives, this.options.app.qualityProfiles);
  },

  bindShortcuts() {
    const that = this;
    key('up', 'details', () => {
      that.options.app.controller.selectPrev();
      return false;
    });
    key('down', 'details', () => {
      that.options.app.controller.selectNext();
      return false;
    });
    key('left, backspace', 'details', () => {
      that.options.app.controller.hideDetails();
      return false;
    });
  },

  unbindShortcuts() {
    key.deleteScope('details');
  },

  editCustomRule() {
    new CustomRuleCreationView({
      app: this.options.app,
      model: this.model
    }).render();
  },

  deleteRule() {
    const deleteRuleView = new DeleteRuleView({
      model: this.model
    }).render();

    deleteRuleView.on('delete', () => {
      const { controller } = this.options.app;
      if (controller.isRulePermalink()) {
        controller.newSearch();
      } else {
        controller.fetchList();
      }
    });
  },

  select() {
    const selected = this.options.app.state.get('selectedIndex');
    const selectedRule = this.options.app.list.at(selected);
    this.options.app.controller.showDetails(selectedRule);
  },

  serializeData() {
    const isCustom = this.model.has('templateKey');
    const isEditable = this.options.app.canWrite && isCustom;
    let qualityProfilesVisible = true;

    if (this.model.get('isTemplate')) {
      qualityProfilesVisible = Object.keys(this.options.actives).length > 0;
    }

    return {
      ...Marionette.ItemView.prototype.serializeData.apply(this, arguments),
      isEditable,
      qualityProfilesVisible,
      canWrite: this.options.app.canWrite,
      allTags: union(this.model.get('sysTags'), this.model.get('tags'))
    };
  }
});