aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/components/measure/utils.ts
blob: dfa433847a4d7992157571554e3367add865a6b1 (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
///
/// SonarQube
/// Copyright (C) 2009-2018 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.
///

/*
 * 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 {
  formatMeasure,
  formatMeasureVariation,
  getRatingTooltip as nextGetRatingTooltip,
  isDiffMetric
} from '../../helpers/measures';
import { Metric } from '../../app/types';

const KNOWN_RATINGS = ['sqale_rating', 'reliability_rating', 'security_rating'];

export interface MeasureIntern {
  value?: string;
  periods?: Array<{ index: number; value: string }>;
}

export interface Measure extends MeasureIntern {
  metric: string;
}

export interface MeasureEnhanced extends MeasureIntern {
  metric: { key: string; type: string };
  leak?: string | undefined | undefined;
}

export function enhanceMeasure(
  measure: Measure,
  metrics: { [key: string]: Metric }
): MeasureEnhanced {
  return {
    value: measure.value,
    periods: measure.periods,
    metric: metrics[measure.metric],
    leak: getLeakValue(measure)
  };
}

export function formatLeak(
  value: string | undefined,
  metricKey: string,
  metricType: string,
  options: any
): string {
  if (isDiffMetric(metricKey)) {
    return formatMeasure(value, metricType, options);
  } else {
    return formatMeasureVariation(value, metricType, options);
  }
}

export function getLeakValue(measure: Measure | undefined): string | undefined {
  if (!measure || !measure.periods) {
    return undefined;
  }
  const period = measure.periods.find(period => period.index === 1);
  return period && period.value;
}

export function getRatingTooltip(metricKey: string, value: number): string | undefined {
  const finalMetricKey = isDiffMetric(metricKey) ? metricKey.substr(4) : metricKey;
  if (KNOWN_RATINGS.includes(finalMetricKey)) {
    return nextGetRatingTooltip(finalMetricKey, value);
  }
  return undefined;
}