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

Commit 72fb79b

Browse files
dkrutskikhdkrutskikh
authored
fix: compute NumberOfParametersMetric only for functions and methods (#486)
* fix: compute NumberOfParametersMetric only for functions and methods * chore: update changelog
1 parent 69678b6 commit 72fb79b

File tree

7 files changed

+191
-154
lines changed

7 files changed

+191
-154
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
* Improve static code diagnostic `prefer-extracting-callbacks`, don't trigger on empty function blocks.
77
* Improve unused files check, add support for `vm:entry-point` annotation.
88
* feat: ignore Flutter builder functions in `prefer-extracting-callbacks` rule.
9+
* fix: compute NumberOfParametersMetric only for functions and methods
910

1011
## 4.3.3
1112

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

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,14 @@ final _implementedMetrics = <String, Metric Function(Map<String, Object>)>{
3333

3434
Iterable<Metric> getMetrics({
3535
required Map<String, Object> config,
36+
Iterable<String> patternsDependencies = const [],
3637
EntityType? measuredType,
3738
}) {
38-
final _metrics =
39-
_implementedMetrics.keys.map((id) => _implementedMetrics[id]!(config));
39+
final _metrics = _implementedMetrics.keys.map(
40+
(id) => _implementedMetrics[id]!(
41+
!patternsDependencies.contains(id) ? config : {},
42+
),
43+
);
4044

4145
return measuredType != null
4246
? _metrics

‎lib/src/analyzers/lint_analyzer/metrics/metrics_list/number_of_parameters_metric.dart‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ class NumberOfParametersMetric extends FunctionMetric<int> {
3333
levelComputer: valueLevel,
3434
);
3535

36+
@override
37+
bool supports(
38+
Declaration node,
39+
Iterable<ScopedClassDeclaration> classDeclarations,
40+
Iterable<ScopedFunctionDeclaration> functionDeclarations,
41+
InternalResolvedUnitResult source,
42+
Iterable<MetricValue<num>> otherMetricsValues,
43+
) =>
44+
node is FunctionDeclaration || node is MethodDeclaration;
45+
3646
@override
3747
MetricComputationResult<int> computeImplementation(
3848
Declaration node,
@@ -42,6 +52,7 @@ class NumberOfParametersMetric extends FunctionMetric<int> {
4252
Iterable<MetricValue<num>> otherMetricsValues,
4353
) {
4454
int? parametersCount;
55+
4556
if (node is FunctionDeclaration) {
4657
parametersCount = node.functionExpression.parameters?.parameters.length;
4758
} else if (node is MethodDeclaration) {

‎lib/src/config_builder/config_builder.dart‎

Lines changed: 29 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -23,26 +23,35 @@ class ConfigBuilder {
2323
String excludesRootFolder, {
2424
Iterable<Metric<num>>? classMetrics,
2525
Iterable<Metric<num>>? functionMetrics,
26-
}) =>
27-
LintAnalysisConfig(
28-
prepareExcludes(config.excludePatterns, excludesRootFolder),
29-
getRulesById(config.rules),
30-
prepareExcludes(config.excludeForRulesPatterns, excludesRootFolder),
31-
getPatternsById(config),
32-
classMetrics ??
33-
getMetrics(
34-
config: config.metrics,
35-
measuredType: EntityType.classEntity,
36-
),
37-
functionMetrics ??
38-
getMetrics(
39-
config: config.metrics,
40-
measuredType: EntityType.methodEntity,
41-
),
42-
prepareExcludes(config.excludeForMetricsPatterns, excludesRootFolder),
43-
config.metrics,
44-
excludesRootFolder,
45-
);
26+
}) {
27+
final patterns = getPatternsById(config);
28+
final patternsDependencies = patterns
29+
.map((pattern) => pattern.dependentMetricIds)
30+
.expand((e) => e)
31+
.toSet();
32+
33+
return LintAnalysisConfig(
34+
prepareExcludes(config.excludePatterns, excludesRootFolder),
35+
getRulesById(config.rules),
36+
prepareExcludes(config.excludeForRulesPatterns, excludesRootFolder),
37+
patterns,
38+
classMetrics ??
39+
getMetrics(
40+
config: config.metrics,
41+
patternsDependencies: patternsDependencies,
42+
measuredType: EntityType.classEntity,
43+
),
44+
functionMetrics ??
45+
getMetrics(
46+
config: config.metrics,
47+
patternsDependencies: patternsDependencies,
48+
measuredType: EntityType.methodEntity,
49+
),
50+
prepareExcludes(config.excludeForMetricsPatterns, excludesRootFolder),
51+
config.metrics,
52+
excludesRootFolder,
53+
);
54+
}
4655

4756
static UnusedFilesConfig getUnusedFilesConfigFromArgs(
4857
Iterable<String> excludePatterns,

‎test/analyzers/lint_analyzer/lint_analyzer_test.dart‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ void main() {
7171
});
7272
});
7373

74-
test('should exceed source-lines-of-code metric', () async {
75-
final config = _createConfig(metrics: {'source-lines-of-code': 1});
74+
test('should exceed lines-of-code metric', () async {
75+
final config = _createConfig(metrics: {'lines-of-code': 4});
7676

7777
final result = await analyzer.runCliAnalysis(
7878
folders,
@@ -90,10 +90,10 @@ void main() {
9090
expect(metrics, {
9191
'cyclomatic-complexity': MetricValueLevel.none,
9292
'halstead-volume': MetricValueLevel.none,
93-
'lines-of-code': MetricValueLevel.none,
93+
'lines-of-code': MetricValueLevel.warning,
9494
'maximum-nesting-level': MetricValueLevel.none,
9595
'number-of-parameters': MetricValueLevel.none,
96-
'source-lines-of-code': MetricValueLevel.warning,
96+
'source-lines-of-code': MetricValueLevel.none,
9797
'maintainability-index': MetricValueLevel.none,
9898
});
9999
});

‎test/analyzers/lint_analyzer/metrics/metrics_list/number_of_parameters_metric_test.dart‎

Lines changed: 126 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
@TestOn('vm')
2+
import 'package:collection/src/iterable_extensions.dart';
23
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/metrics_list/number_of_parameters_metric.dart';
34
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/models/metric_value_level.dart';
45
import 'package:dart_code_metrics/src/analyzers/lint_analyzer/metrics/scope_visitor.dart';
@@ -19,127 +20,136 @@ Future<void> main() async {
1920
final example = await FileResolver.resolve(_examplePath);
2021
example.unit.visitChildren(scopeVisitor);
2122

22-
group('NumberOfParametersMetric computes parameters received by the', () {
23-
test('simple function', () {
24-
final metricValue = metric.compute(
25-
scopeVisitor.functions.first.declaration,
26-
scopeVisitor.classes,
27-
scopeVisitor.functions,
28-
example,
29-
[],
30-
);
31-
32-
expect(metricValue.metricsId, equals(metric.id));
33-
expect(metricValue.value, equals(0));
34-
expect(metricValue.level, equals(MetricValueLevel.none));
35-
expect(
36-
metricValue.comment,
37-
equals('This function has 0 parameters.'),
38-
);
39-
expect(metricValue.recommendation, isNull);
40-
expect(metricValue.context, isEmpty);
41-
});
42-
43-
test('simple function with arguments', () {
44-
final metricValue = metric.compute(
45-
scopeVisitor.functions.toList()[1].declaration,
46-
scopeVisitor.classes,
47-
scopeVisitor.functions,
48-
example,
49-
[],
50-
);
51-
52-
expect(metricValue.metricsId, equals(metric.id));
53-
expect(metricValue.value, equals(2));
54-
expect(metricValue.level, equals(MetricValueLevel.none));
55-
expect(
56-
metricValue.comment,
57-
equals('This function has 2 parameters.'),
58-
);
59-
expect(metricValue.recommendation, isNull);
60-
expect(metricValue.context, isEmpty);
23+
group('NumberOfParametersMetric', () {
24+
group('computes parameters received by the', () {
25+
test('simple function', () {
26+
final metricValue = metric.compute(
27+
scopeVisitor.functions.toList()[0].declaration,
28+
scopeVisitor.classes,
29+
scopeVisitor.functions,
30+
example,
31+
[],
32+
);
33+
34+
expect(metricValue.metricsId, equals(metric.id));
35+
expect(metricValue.value, equals(0));
36+
expect(metricValue.level, equals(MetricValueLevel.none));
37+
expect(metricValue.comment, equals('This function has 0 parameters.'));
38+
expect(metricValue.recommendation, isNull);
39+
expect(metricValue.context, isEmpty);
40+
});
41+
42+
test('simple function with arguments', () {
43+
final metricValue = metric.compute(
44+
scopeVisitor.functions.toList()[1].declaration,
45+
scopeVisitor.classes,
46+
scopeVisitor.functions,
47+
example,
48+
[],
49+
);
50+
51+
expect(metricValue.metricsId, equals(metric.id));
52+
expect(metricValue.value, equals(2));
53+
expect(metricValue.level, equals(MetricValueLevel.none));
54+
expect(metricValue.comment, equals('This function has 2 parameters.'));
55+
expect(metricValue.recommendation, isNull);
56+
expect(metricValue.context, isEmpty);
57+
});
58+
59+
test('simple setter', () {
60+
final metricValue = metric.compute(
61+
scopeVisitor.functions.toList()[2].declaration,
62+
scopeVisitor.classes,
63+
scopeVisitor.functions,
64+
example,
65+
[],
66+
);
67+
68+
expect(metricValue.metricsId, equals(metric.id));
69+
expect(metricValue.value, equals(1));
70+
expect(metricValue.level, equals(MetricValueLevel.none));
71+
expect(metricValue.comment, equals('This function has 1 parameter.'));
72+
expect(metricValue.recommendation, isNull);
73+
expect(metricValue.context, isEmpty);
74+
});
75+
76+
test('simple getter', () {
77+
final metricValue = metric.compute(
78+
scopeVisitor.functions.toList()[3].declaration,
79+
scopeVisitor.classes,
80+
scopeVisitor.functions,
81+
example,
82+
[],
83+
);
84+
85+
expect(metricValue.metricsId, equals(metric.id));
86+
expect(metricValue.value, equals(0));
87+
expect(metricValue.level, equals(MetricValueLevel.none));
88+
expect(metricValue.comment, equals('This function has 0 parameters.'));
89+
expect(metricValue.recommendation, isNull);
90+
expect(metricValue.context, isEmpty);
91+
});
92+
93+
test('class method : NumberOfParametersMetric.commentMessage', () {
94+
final metricValue = metric.compute(
95+
scopeVisitor.functions.toList()[5].declaration,
96+
scopeVisitor.classes,
97+
scopeVisitor.functions,
98+
example,
99+
[],
100+
);
101+
102+
expect(metricValue.metricsId, equals(metric.id));
103+
expect(metricValue.value, equals(3));
104+
expect(metricValue.level, equals(MetricValueLevel.noted));
105+
expect(metricValue.comment, equals('This method has 3 parameters.'));
106+
expect(metricValue.recommendation, isNull);
107+
expect(metricValue.context, isEmpty);
108+
});
109+
110+
test('class method : NumberOfParametersMetric.computeImplementation', () {
111+
final metricValue = metric.compute(
112+
scopeVisitor.functions.toList()[6].declaration,
113+
scopeVisitor.classes,
114+
scopeVisitor.functions,
115+
example,
116+
[],
117+
);
118+
119+
expect(metricValue.metricsId, equals(metric.id));
120+
expect(metricValue.value, equals(5));
121+
expect(metricValue.level, equals(MetricValueLevel.warning));
122+
expect(
123+
metricValue.comment,
124+
equals(
125+
'This method has 5 parameters, exceeds the maximum of 3 allowed.',
126+
),
127+
);
128+
expect(metricValue.recommendation, isNull);
129+
expect(metricValue.context, isEmpty);
130+
});
61131
});
62132

63-
test('simple setter', () {
64-
final metricValue = metric.compute(
65-
scopeVisitor.functions.toList()[2].declaration,
66-
scopeVisitor.classes,
67-
scopeVisitor.functions,
68-
example,
69-
[],
70-
);
71-
72-
expect(metricValue.metricsId, equals(metric.id));
73-
expect(metricValue.value, equals(1));
74-
expect(metricValue.level, equals(MetricValueLevel.none));
75-
expect(
76-
metricValue.comment,
77-
equals('This function has 1 parameter.'),
78-
);
79-
expect(metricValue.recommendation, isNull);
80-
expect(metricValue.context, isEmpty);
81-
});
133+
test('supports returns only for functions and methods', () {
134+
const supports = [true, true, true, true, false, true, true];
82135

83-
test('simple getter', () {
84-
final metricValue = metric.compute(
85-
scopeVisitor.functions.toList()[3].declaration,
86-
scopeVisitor.classes,
87-
scopeVisitor.functions,
88-
example,
89-
[],
136+
assert(
137+
scopeVisitor.functions.length == supports.length,
138+
'arrays must be same lengths',
90139
);
91140

92-
expect(metricValue.metricsId, equals(metric.id));
93-
expect(metricValue.value, equals(0));
94-
expect(metricValue.level, equals(MetricValueLevel.none));
95-
expect(
96-
metricValue.comment,
97-
equals('This function has 0 parameters.'),
98-
);
99-
expect(metricValue.recommendation, isNull);
100-
expect(metricValue.context, isEmpty);
101-
});
102-
103-
test('class method', () {
104-
final metricValue = metric.compute(
105-
scopeVisitor.functions.toList()[4].declaration,
106-
scopeVisitor.classes,
107-
scopeVisitor.functions,
108-
example,
109-
[],
110-
);
111-
112-
expect(metricValue.metricsId, equals(metric.id));
113-
expect(metricValue.value, equals(3));
114-
expect(metricValue.level, equals(MetricValueLevel.noted));
115-
expect(
116-
metricValue.comment,
117-
equals('This method has 3 parameters.'),
118-
);
119-
expect(metricValue.recommendation, isNull);
120-
expect(metricValue.context, isEmpty);
121-
});
122-
123-
test('class method 2', () {
124-
final metricValue = metric.compute(
125-
scopeVisitor.functions.last.declaration,
126-
scopeVisitor.classes,
127-
scopeVisitor.functions,
128-
example,
129-
[],
130-
);
131-
132-
expect(metricValue.metricsId, equals(metric.id));
133-
expect(metricValue.value, equals(4));
134-
expect(metricValue.level, equals(MetricValueLevel.warning));
135-
expect(
136-
metricValue.comment,
137-
equals(
138-
'This method has 4 parameters, exceeds the maximum of 3 allowed.',
139-
),
140-
);
141-
expect(metricValue.recommendation, isNull);
142-
expect(metricValue.context, isEmpty);
141+
scopeVisitor.functions.forEachIndexed((index, value) {
142+
expect(
143+
metric.supports(
144+
value.declaration,
145+
scopeVisitor.classes,
146+
scopeVisitor.functions,
147+
example,
148+
[],
149+
),
150+
equals(supports[index]),
151+
);
152+
});
143153
});
144154
});
145155
}

0 commit comments

Comments
 (0)