aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/coffee/libs/widgets/treemap.coffee
blob: 9a78011c8be17ee2c53f15e17b6ebacb960d2120 (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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
#
# 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.
#

class Treemap extends window.SonarWidgets.BaseWidget
  sizeLow: 11
  sizeHigh: 18


  constructor: ->
    @addField 'width', null
    @addField 'height', null
    @addField 'maxResultsReached', false
    super


  getNodes: ->
    @treemap.nodes(children: @components()).filter (d) -> !d.children


  renderTreemap: ->
    nodes = @getNodes()
    @cells = @box.selectAll('.treemap-cell').data nodes
    @cells.exit().remove()

    cellsEnter = @cells.enter().append 'div'
    cellsEnter.classed 'treemap-cell', true
    cellsEnter.append('div').classed 'treemap-inner', true
    cellsEnter.append('a').classed 'treemap-link', true

    @cells.attr 'title', (d) => @tooltip d
    @cells.style 'background-color', (d) =>
      if @colorMetric.value(d)? then @color @colorMetric.value(d) else @colorUnknown
    @cells.classed 'treemap-cell-drilldown', (d) ->
      d.qualifier? && d.qualifier != 'FIL' && d.qualifier != 'CLA'

    prefix = @mostCommonPrefix _.pluck @components(), 'longName'
    prefixLength = prefix.length
    @cellsInner = @box.selectAll('.treemap-inner').data nodes
    @cellsInner.html (d) ->
      if prefixLength > 0
        "#{prefix}<br>#{d.longName.substr prefixLength}"
      else d.longName

    @cellsLink = @box.selectAll('.treemap-link').data nodes
    @cellsLink.html '<i class="icon-link"></i>'
    @cellsLink.attr 'href', (d) =>
      @options().baseUrl + '?id=' + encodeURIComponent(d.key)

    @attachEvents cellsEnter

    @maxResultsReachedLabel.style 'display', if @maxResultsReached() then 'block' else 'none'


  updateTreemap: (components, maxResultsReached) ->
    @components components
    @maxResultsReached maxResultsReached

    @renderTreemap()
    @positionCells()


  attachEvents: (cells) ->
    cells.on 'click', (d) => @requestChildren d


  positionCells: ->
    @cells.style 'left', (d) -> "#{d.x}px"
    @cells.style 'top', (d) -> "#{d.y}px"
    @cells.style 'width', (d) -> "#{d.dx}px"
    @cellsInner.style 'max-width', (d) -> "#{d.dx}px"
    @cells.style 'height', (d) -> "#{d.dy}px"
    @cells.style 'line-height', (d) -> "#{d.dy}px"
    @cells.style 'font-size', (d) => "#{@size (d.dx / d.longName.length)}px"
    @cellsLink.style 'font-size', (d) => "#{@sizeLink Math.min(d.dx, d.dy)}px"
    @cells.classed 'treemap-cell-small', (d) -> (d.dx / d.longName.length) < 1 || d.dy < 40
    @cells.classed 'treemap-cell-very-small', (d) -> d.dx < 24 || d.dy < 24


  renderLegend: (box) ->
    @legend = box.insert 'div', ':first-child'
    @legend.classed 'legend', true
    @legend.classed 'legend-html', true
    @legend.append('span').classed('legend-text', true).html "Size: <span class='legend-text-main'>#{@sizeMetric.name}</span>"
    @legend.append('span').classed('legend-text', true).html "Color: <span class='legend-text-main'>#{@colorMetric.name}</span>"


  renderBreadcrumbs: (box) ->
    @breadcrumbsBox = box.append('div').classed 'treemap-breadcrumbs', true
    @breadcrumbs = []
    d = name: '<i class="icon-home"></i>', components: @components(), maxResultsReached: @maxResultsReached()
    @addToBreadcrumbs d


  updateBreadcrumbs: ->
    breadcrumbs = @breadcrumbsBox.selectAll('.treemap-breadcrumbs-item').data @breadcrumbs
    breadcrumbs.exit().remove()
    breadcrumbsEnter = breadcrumbs.enter().append('span').classed 'treemap-breadcrumbs-item', true
    breadcrumbsEnter.attr 'title', (d) =>
      if d.longName? then d.longName else @options().resource
    breadcrumbsEnter.append('i').classed('icon-chevron-right', true).style 'display', (d, i) ->
      if i > 0 then 'inline' else 'none'
    breadcrumbsEnter.append('i').attr 'class', (d) ->
      if d.qualifier? then "icon-qualifier-#{d.qualifier.toLowerCase()}" else ''
    breadcrumbsEnterLinks = breadcrumbsEnter.append 'a'
    breadcrumbsEnterLinks.html (d) -> d.name
    breadcrumbsEnterLinks.on 'click', (d) =>
      @updateTreemap d.components, d.maxResultsReached
      @cutBreadcrumbs d
    @breadcrumbsBox.style 'display', if @breadcrumbs.length < 2 then 'none' else 'block'


  addToBreadcrumbs: (d) ->
    @breadcrumbs.push d
    @updateBreadcrumbs()


  cutBreadcrumbs: (lastElement) ->
    index = null
    @breadcrumbs.forEach (d, i) ->
      index = i if d.key == lastElement.key
    if index?
      @breadcrumbs = _.initial @breadcrumbs, @breadcrumbs.length - index - 1
      @updateBreadcrumbs()


  getColorScale: ->
    return @getLevelColorScale() if @colorMetric.type == 'LEVEL'
    return @getRatingColorScale() if @colorMetric.type == 'RATING'
    @getPercentColorScale()


  getPercentColorScale: ->
    color = d3.scale.linear().domain([0, 25, 50, 75, 100])
    color.range if @colorMetric.direction == 1 then @colors5 else @colors5r
    color


  getRatingColorScale: ->
    domain = [1, 2, 3, 4, 5]
    if @components().length > 0
      colorMetricSample = @colorMetric.value _.first @components()
      if typeof colorMetricSample == 'string'
        domain = ['A', 'B', 'C', 'D', 'E']
    color = d3.scale.ordinal().domain(domain).range @colors5r
    color


  getLevelColorScale: ->
    color = d3.scale.ordinal().domain(['ERROR', 'WARN', 'OK', 'NONE']).range @colorsLevel
    color


  render: (container) ->
    box = d3.select(container).append('div')
    box.classed 'sonar-d3', true
    @box = box.append('div').classed 'treemap-container', true

    # Configure metrics
    @addMetric 'colorMetric', 0
    @addMetric 'sizeMetric', 1

    # Configure scales
    @color = @getColorScale()

    @size = d3.scale.linear().domain([3, 15]).range([@sizeLow, @sizeHigh]).clamp true
    @sizeLink = d3.scale.linear().domain([60, 100]).range([12, 14]).clamp true

    @treemap = d3.layout.treemap()
    @treemap.sort (a, b) -> a.value - b.value
    @treemap.round true

    @treemap.value (d) => @sizeMetric.value d

    @maxResultsReachedLabel = box.append('div').text @options().maxItemsReachedMessage
    @maxResultsReachedLabel.classed 'max-results-reached-message', true

    @renderLegend box
    @renderBreadcrumbs box
    @renderTreemap()
    super


  update: ->
    @width @box.property 'offsetWidth'
    @height (@width() / 100.0 * @options().heightInPercents)
    @box.style 'height', "#{@height()}px"
    @treemap.size [@width(), @height()]
    @cells.data @getNodes()
    @positionCells()


  formatComponents: (data) ->
    components = _.filter data, (component) =>
      hasSizeMetric = => _.findWhere component.msr, key: @sizeMetric.key
      _.isArray(component.msr) && component.msr.length > 0 && hasSizeMetric()

    if _.isArray(components) && components.length > 0
      components.map (component) =>
        measures = {}
        component.msr.forEach (measure) ->
          measures[measure.key] = val: measure.val, fval: measure.frmt_val

        key: if component.copy? then component.copy else component.key
        name: component.name
        longName: component.lname
        qualifier: component.qualifier
        measures: measures


  requestChildren: (d) ->
    metrics = @metricsPriority().join ','
    RESOURCES_URL = "#{baseUrl}/api/resources/index"
    jQuery.get(RESOURCES_URL, resource: d.key, depth: 1, metrics: metrics).done (r) =>
      components = @formatComponents r
      if components?
        components = _.sortBy components, (d) => -@sizeMetric.value d
        components = _.initial components, components.length - @options().maxItems - 1
        @updateTreemap components, components.length > @options().maxItems
        @addToBreadcrumbs _.extend d, components: components, maxResultsReached: @maxResultsReached()


  mostCommonPrefix: (strings) ->
    sortedStrings = strings.slice(0).sort()
    firstString = sortedStrings[0]
    firstStringLength = firstString.length
    lastString = sortedStrings[sortedStrings.length - 1]
    i = 0
    while i < firstStringLength && firstString.charAt(i) == lastString.charAt(i)
      i++
    prefix = firstString.substr 0, i
    lastPrefixPart = _.last prefix.split /[\s\\\/]/
    prefix.substr 0, prefix.length - lastPrefixPart.length




window.SonarWidgets.Treemap = Treemap