Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.

Commit cd46dfc

Browse files
dkrutskikhdkrutskikh
committed
refactor: a small cleanup html reporter
1 parent e81eabb commit cd46dfc

File tree

10 files changed

+90
-245
lines changed

10 files changed

+90
-245
lines changed

‎lib/src/analyzers/lint_analyzer/lint_analyzer.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ class LintAnalyzer {
393393
MetricValue<double>(
394394
metricsId: 'maintainability-index',
395395
documentation: const MetricDocumentation(
396-
name: '',
396+
name: 'Maintainability index',
397397
shortName: '',
398398
brief: '',
399399
measuredType: EntityType.classEntity,

‎lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/lint_html_reporter.dart‎

Lines changed: 5 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import '../../../../../reporters/models/html_reporter.dart';
1010
import '../../../metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
1111
import '../../../metrics/models/metric_value_level.dart';
1212
import '../../../models/lint_file_report.dart';
13-
import '../../models/file_metrics_report.dart';
1413
import '../../utility_selector.dart';
14+
import 'models/file_metrics_report.dart';
1515
import 'utility_functions.dart';
1616

1717
const _violationLevelFunctionStyle = {
@@ -342,44 +342,9 @@ class LintHtmlReporter extends HtmlReporter<LintFileReport> {
342342

343343
var line = ' ';
344344
if (functionReport != null) {
345-
final report = UtilitySelector.functionMetricsReport(functionReport);
346-
347345
if (functionReport.location.start.line == i) {
348-
final complexityTooltip = Element.tag('div')
349-
..classes.add('metrics-source-code__tooltip')
350-
..append(Element.tag('div')
351-
..classes.add('metrics-source-code__tooltip-title')
352-
..text = 'Function stats:')
353-
..append(Element.tag('p')
354-
..classes.add('metrics-source-code__tooltip-text')
355-
..append(renderFunctionMetric(
356-
_cyclomaticComplexity,
357-
report.cyclomaticComplexity,
358-
)))
359-
..append(Element.tag('p')
360-
..classes.add('metrics-source-code__tooltip-text')
361-
..append(renderFunctionMetric(
362-
_sourceLinesOfCode,
363-
report.sourceLinesOfCode,
364-
)))
365-
..append(Element.tag('p')
366-
..classes.add('metrics-source-code__tooltip-text')
367-
..append(renderFunctionMetric(
368-
_maintainabilityIndex,
369-
report.maintainabilityIndex,
370-
)))
371-
..append(Element.tag('p')
372-
..classes.add('metrics-source-code__tooltip-text')
373-
..append(renderFunctionMetric(
374-
_numberOfArguments,
375-
report.argumentsCount,
376-
)))
377-
..append(Element.tag('p')
378-
..classes.add('metrics-source-code__tooltip-text')
379-
..append(renderFunctionMetric(
380-
_maximumNesting,
381-
report.maximumNestingLevel,
382-
)));
346+
final complexityTooltip =
347+
renderFunctionDetailsTooltip(functionReport);
383348

384349
final complexityIcon = Element.tag('div')
385350
..classes.addAll([
@@ -419,8 +384,8 @@ class LintHtmlReporter extends HtmlReporter<LintFileReport> {
419384
line += ' c';
420385
}
421386
*/
422-
final functionViolationLevel =
423-
UtilitySelector.functionMetricViolationLevel(report);
387+
388+
final functionViolationLevel = functionReport.metricsLevel;
424389

425390
final lineViolationStyle = lineWithComplexityIncrement > 0
426391
? _violationLevelLineStyle[functionViolationLevel]

‎lib/src/analyzers/lint_analyzer/reporters/models/file_metrics_report.dart‎ renamed to ‎lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/models/file_metrics_report.dart‎

File renamed without changes.

‎lib/src/analyzers/lint_analyzer/reporters/models/function_metrics_report.dart‎ renamed to ‎lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/models/function_metrics_report.dart‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import 'package:meta/meta.dart';
22

3-
import '../../metrics/models/metric_value.dart';
3+
import '../../../../metrics/models/metric_value.dart';
44

55
@immutable
66
class FunctionMetricsReport {

‎lib/src/analyzers/lint_analyzer/reporters/reporters_list/html/utility_functions.dart‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import 'package:html/dom.dart';
22

33
import '../../../metrics/models/metric_value.dart';
4+
import '../../../models/report.dart';
45
import 'lint_html_reporter.dart';
56

67
const _violations = 'violations';
@@ -28,8 +29,27 @@ Element renderSummaryMetric(
2829
..text = value);
2930
}
3031

31-
Element renderFunctionMetric(String name, MetricValue<num> metric) {
32-
final metricName = name.toLowerCase();
32+
Element renderFunctionDetailsTooltip(Report report) {
33+
final tooltip = Element.tag('div')
34+
..classes.add('metrics-source-code__tooltip')
35+
..append(Element.tag('div')
36+
..classes.add('metrics-source-code__tooltip-title')
37+
..text = 'Function stats:');
38+
39+
final metrics = report.metrics.toList()
40+
..sort((a, b) => a.documentation.name.compareTo(b.documentation.name));
41+
42+
for (final metric in metrics) {
43+
tooltip.append(Element.tag('p')
44+
..classes.add('metrics-source-code__tooltip-text')
45+
..append(renderFunctionDetailsTooltipMetric(metric)));
46+
}
47+
48+
return tooltip;
49+
}
50+
51+
Element renderFunctionDetailsTooltipMetric(MetricValue<num> metric) {
52+
final metricName = metric.documentation.name.toLowerCase();
3353
final violationLevel = metric.level.toString();
3454

3555
return Element.tag('div')

‎lib/src/analyzers/lint_analyzer/reporters/utility_selector.dart‎

Lines changed: 56 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import 'dart:math';
22

3-
import 'package:quiver/iterables.dart' as quiver;
3+
import 'package:collection/collection.dart';
44

55
import '../metrics/metric_utils.dart';
66
import '../metrics/metrics_list/cyclomatic_complexity/cyclomatic_complexity_metric.dart';
@@ -13,8 +13,8 @@ import '../metrics/models/metric_value_level.dart';
1313
import '../models/entity_type.dart';
1414
import '../models/lint_file_report.dart';
1515
import '../models/report.dart';
16-
import 'models/file_metrics_report.dart';
17-
import 'models/function_metrics_report.dart';
16+
import 'reporters_list/html/models/file_metrics_report.dart';
17+
import 'reporters_list/html/models/function_metrics_report.dart';
1818

1919
double log2(num a) => log(a) / ln2;
2020

@@ -30,7 +30,7 @@ class UtilitySelector {
3030

3131
static FileMetricsReport fileReport(LintFileReport record) {
3232
final functionMetricsReports =
33-
record.functions.values.map(functionMetricsReport);
33+
record.functions.values.map(_functionMetricsReport);
3434

3535
final averageArgumentCount =
3636
avg(functionMetricsReports.map((r) => r.argumentsCount.value));
@@ -77,69 +77,15 @@ class UtilitySelector {
7777
);
7878
}
7979

80-
static FunctionMetricsReport functionMetricsReport(Report function) {
81-
final cyclomaticComplexityMetric =
82-
function.metric(CyclomaticComplexityMetric.metricId) ??
83-
_buildMetricValueStub<int>(
84-
id: CyclomaticComplexityMetric.metricId,
85-
value: 0,
86-
);
87-
88-
final sourceLinesOfCodeMetric =
89-
function.metric(SourceLinesOfCodeMetric.metricId) ??
90-
_buildMetricValueStub<int>(
91-
id: SourceLinesOfCodeMetric.metricId,
92-
value: 0,
93-
);
94-
95-
final maintainabilityIndexMetric =
96-
function.metric('maintainability-index') ??
97-
_buildMetricValueStub<double>(
98-
id: 'maintainability-index',
99-
value: 100,
100-
);
101-
102-
final numberOfParametersMetric =
103-
function.metric(NumberOfParametersMetric.metricId) ??
104-
_buildMetricValueStub<int>(
105-
id: NumberOfParametersMetric.metricId,
106-
value: 0,
107-
);
108-
109-
final maximumNestingLevelMetric =
110-
function.metric(MaximumNestingLevelMetric.metricId) ??
111-
_buildMetricValueStub<int>(
112-
id: MaximumNestingLevelMetric.metricId,
113-
value: 0,
114-
);
115-
116-
return FunctionMetricsReport(
117-
cyclomaticComplexity: cyclomaticComplexityMetric as MetricValue<int>,
118-
sourceLinesOfCode: sourceLinesOfCodeMetric as MetricValue<int>,
119-
maintainabilityIndex: maintainabilityIndexMetric as MetricValue<double>,
120-
argumentsCount: numberOfParametersMetric as MetricValue<int>,
121-
maximumNestingLevel: maximumNestingLevelMetric as MetricValue<int>,
122-
);
123-
}
124-
125-
static MetricValueLevel functionMetricViolationLevel(
126-
FunctionMetricsReport report,
127-
) =>
128-
quiver.max([
129-
report.cyclomaticComplexity.level,
130-
report.sourceLinesOfCode.level,
131-
report.maintainabilityIndex.level,
132-
report.argumentsCount.level,
133-
report.maximumNestingLevel.level,
134-
])!;
135-
13680
static MetricValueLevel maxViolationLevel(Iterable<LintFileReport> records) =>
137-
quiver.max(records
138-
.expand(
139-
(fileRecord) =>
140-
fileRecord.functions.values.map(functionMetricsReport),
141-
)
142-
.map(functionMetricViolationLevel))!;
81+
records
82+
.expand((fileRecord) => [
83+
...fileRecord.classes.values
84+
.map((report) => report.metricsLevel),
85+
...fileRecord.functions.values
86+
.map((report) => report.metricsLevel),
87+
])
88+
.max;
14389

14490
static FileMetricsReport mergeFileReports(
14591
FileMetricsReport lhs,
@@ -193,3 +139,47 @@ MetricValue<T> _buildMetricValueStub<T>({
193139
level: level,
194140
comment: '',
195141
);
142+
143+
FunctionMetricsReport _functionMetricsReport(Report function) {
144+
final cyclomaticComplexityMetric =
145+
function.metric(CyclomaticComplexityMetric.metricId) ??
146+
_buildMetricValueStub<int>(
147+
id: CyclomaticComplexityMetric.metricId,
148+
value: 0,
149+
);
150+
151+
final sourceLinesOfCodeMetric =
152+
function.metric(SourceLinesOfCodeMetric.metricId) ??
153+
_buildMetricValueStub<int>(
154+
id: SourceLinesOfCodeMetric.metricId,
155+
value: 0,
156+
);
157+
158+
final maintainabilityIndexMetric = function.metric('maintainability-index') ??
159+
_buildMetricValueStub<double>(
160+
id: 'maintainability-index',
161+
value: 100,
162+
);
163+
164+
final numberOfParametersMetric =
165+
function.metric(NumberOfParametersMetric.metricId) ??
166+
_buildMetricValueStub<int>(
167+
id: NumberOfParametersMetric.metricId,
168+
value: 0,
169+
);
170+
171+
final maximumNestingLevelMetric =
172+
function.metric(MaximumNestingLevelMetric.metricId) ??
173+
_buildMetricValueStub<int>(
174+
id: MaximumNestingLevelMetric.metricId,
175+
value: 0,
176+
);
177+
178+
return FunctionMetricsReport(
179+
cyclomaticComplexity: cyclomaticComplexityMetric as MetricValue<int>,
180+
sourceLinesOfCode: sourceLinesOfCodeMetric as MetricValue<int>,
181+
maintainabilityIndex: maintainabilityIndexMetric as MetricValue<double>,
182+
argumentsCount: numberOfParametersMetric as MetricValue<int>,
183+
maximumNestingLevel: maximumNestingLevelMetric as MetricValue<int>,
184+
);
185+
}

‎pubspec.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ dependencies:
2020
html: ">=0.15.0 <1.0.0"
2121
meta: ^1.3.0
2222
path: ^1.8.0
23-
quiver: ^3.0.0
2423
source_span: ^1.8.0
2524
yaml: ^3.1.0
2625

‎test/analyzers/lint_analyzer/reporters/reporters_list/html/utility_functions_test.dart‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/models/met
33
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/models/metric_value.dart';
44
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/models/metric_value_level.dart';
55
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/models/entity_type.dart';
6-
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/reporters/models/file_metrics_report.dart';
76
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/reporters/reporters_list/html/lint_html_reporter.dart';
7+
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/reporters/reporters_list/html/models/file_metrics_report.dart';
88
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/reporters/reporters_list/html/utility_functions.dart';
99
import 'package:test/test.dart';
1010

@@ -44,15 +44,14 @@ void main() {
4444
});
4545

4646
test(
47-
'renderFunctionMetric returns dom elements for function metric in tooltip',
47+
'renderFunctionDetailsTooltipMetric returns dom elements for function metric in tooltip',
4848
() {
4949
expect(
50-
renderFunctionMetric(
51-
metricName,
50+
renderFunctionDetailsTooltipMetric(
5251
const MetricValue(
5352
metricsId: '',
5453
documentation: MetricDocumentation(
55-
name: '',
54+
name: metricName,
5655
shortName: '',
5756
brief: '',
5857
measuredType: EntityType.classEntity,

0 commit comments

Comments
 (0)