Skip to content
This repository was archived by the owner on Jul 16, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,5 @@ doc/api/
*.js_
*.js.deps
*.js.map

coverage
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Changelog

#Unreleased

# 1.2.1
- Validate root-folder argument
- Fix paths to analyze fail to validate with non-default root-folder
Expand Down
17 changes: 1 addition & 16 deletions lib/src/metrics_analyzer.dart
Original file line number Diff line number Diff line change
@@ -1,31 +1,16 @@
import 'package:analyzer/dart/analysis/features.dart';
import 'package:analyzer/dart/analysis/utilities.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:built_collection/built_collection.dart';
import 'package:dart_code_metrics/src/cyclomatic_complexity/control_flow_ast_visitor.dart';
import 'package:dart_code_metrics/src/cyclomatic_complexity/cyclomatic_config.dart';
import 'package:dart_code_metrics/src/cyclomatic_complexity/models/scoped_declaration.dart';
import 'package:dart_code_metrics/src/halstead_volume/halstead_volume_ast_visitor.dart';
import 'package:dart_code_metrics/src/lines_of_code/function_body_ast_visitor.dart';
import 'package:dart_code_metrics/src/metrics_analysis_recorder.dart';
import 'package:dart_code_metrics/src/metrics_analyzer_utils.dart';
import 'package:dart_code_metrics/src/models/function_record.dart';
import 'package:dart_code_metrics/src/scope_ast_visitor.dart';
import 'package:path/path.dart' as p;

String getQualifiedName(ScopedDeclaration dec) {
final declaration = dec.declaration;

if (declaration is FunctionDeclaration) {
return declaration.name.toString();
} else if (declaration is ConstructorDeclaration) {
return '${dec.declarationIdentifier}.${declaration.name}';
} else if (declaration is MethodDeclaration) {
return '${dec.declarationIdentifier}.${declaration.name}';
}

return null;
}

/// Performs code quality analysis on specified files
/// See [MetricsAnalysisRunner] to get analysis info
class MetricsAnalyzer {
Expand Down
16 changes: 16 additions & 0 deletions lib/src/metrics_analyzer_utils.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import 'package:analyzer/dart/ast/ast.dart';
import 'package:dart_code_metrics/src/cyclomatic_complexity/models/scoped_declaration.dart';

String getQualifiedName(ScopedDeclaration dec) {
final declaration = dec.declaration;

if (declaration is FunctionDeclaration) {
return declaration.name.toString();
} else if (declaration is ConstructorDeclaration) {
return '${dec.declarationIdentifier}.${declaration.name}';
} else if (declaration is MethodDeclaration) {
return '${dec.declarationIdentifier}.${declaration.name}';
}

return null;
}
23 changes: 15 additions & 8 deletions lib/src/reporters/console_reporter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,22 @@ class ConsoleReporter implements Reporter {
UtilitySelector.functionReport(functionReport, reportConfig);
final violationLevel = UtilitySelector.functionViolationLevel(report);

if (reportAll || _isIssueLevel(violationLevel)) {
if (reportAll || UtilitySelector.isIssueLevel(violationLevel)) {
final violations = [
if (reportAll ||
report.cyclomaticComplexityViolationLevel !=
ViolationLevel.none)
'cyclomatic complexity: ${_colorPens[report.cyclomaticComplexityViolationLevel]('${report.cyclomaticComplexity}')}',
if (reportAll ||
report.linesOfCodeViolationLevel != ViolationLevel.none)
'lines of code: ${_colorPens[report.linesOfCodeViolationLevel]('${report.linesOfCode}')}',
if (reportAll ||
report.maintainabilityIndexViolationLevel !=
ViolationLevel.none)
'maintainability index: ${_colorPens[report.maintainabilityIndexViolationLevel]('${report.maintainabilityIndex.toInt()}')}',
];
lines.add(
'${_colorPens[violationLevel](_humanReadableLabel[violationLevel]?.padRight(8))}$source - '
'cyclomatic complexity: ${_colorPens[report.cyclomaticComplexityViolationLevel]('${report.cyclomaticComplexity}')}, '
'lines of code: ${_colorPens[report.linesOfCodeViolationLevel]('${report.linesOfCode}')}, '
'maintainability index: ${_colorPens[report.maintainabilityIndexViolationLevel]('${report.maintainabilityIndex.toInt()}')}, ');
'${_colorPens[violationLevel](_humanReadableLabel[violationLevel]?.padRight(8))}$source - ${violations.join(', ')}');
}
});

Expand All @@ -63,7 +73,4 @@ class ConsoleReporter implements Reporter {

return reportStrings;
}

bool _isIssueLevel(ViolationLevel level) =>
level == ViolationLevel.warning || level == ViolationLevel.alarm;
}
20 changes: 9 additions & 11 deletions lib/src/reporters/utility_selector.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'package:dart_code_metrics/src/models/config.dart';
import 'package:dart_code_metrics/src/models/function_record.dart';
import 'package:dart_code_metrics/src/models/function_report.dart';
import 'package:dart_code_metrics/src/models/violation_level.dart';
import 'package:quiver/iterables.dart' as quiver;

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

Expand Down Expand Up @@ -150,21 +151,18 @@ class UtilitySelector {
static ViolationLevel functionViolationLevel(FunctionReport report) {
final values = ViolationLevel.values.toList();

final cyclomaticComplexityViolationLevelIndex =
values.indexOf(report.cyclomaticComplexityViolationLevel);
final linesOfCodeViolationLevelIndex =
values.indexOf(report.linesOfCodeViolationLevel);
final maintainabilityIndexViolationLevelIndex =
values.indexOf(report.maintainabilityIndexViolationLevel);

final highestLevelIndex = max(
max(cyclomaticComplexityViolationLevelIndex,
linesOfCodeViolationLevelIndex),
maintainabilityIndexViolationLevelIndex);
final highestLevelIndex = quiver.max([
report.cyclomaticComplexityViolationLevel,
report.linesOfCodeViolationLevel,
report.maintainabilityIndexViolationLevel,
].map(values.indexOf));

return values.elementAt(highestLevelIndex);
}

static bool isIssueLevel(ViolationLevel level) =>
level == ViolationLevel.warning || level == ViolationLevel.alarm;

static ViolationLevel _violationLevel(int value, int warningLevel) {
if (value > warningLevel * 2) {
return ViolationLevel.alarm;
Expand Down
1 change: 1 addition & 0 deletions pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ dependencies:
html: '>=0.13.0 < 1.0.0'
meta: ^1.1.0
path: ^1.6.0
quiver: ^2.1.0
resource: ^2.1.0

dev_dependencies:
Expand Down
49 changes: 49 additions & 0 deletions test/reporters/utility_selector_test.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
@TestOn('vm')
import 'package:dart_code_metrics/src/models/violation_level.dart';
import 'package:dart_code_metrics/src/reporters/utility_selector.dart';
import 'package:test/test.dart';

import '../stubs_builders.dart';

void main() {
group('UtilitySelector', () {
test(
'functionViolationLevel return aggregated violation level for function',
() {
expect(
UtilitySelector.functionViolationLevel(buildFunctionReportStub(
cyclomaticComplexityViolationLevel: ViolationLevel.warning,
linesOfCodeViolationLevel: ViolationLevel.noted,
maintainabilityIndexViolationLevel: ViolationLevel.none)),
ViolationLevel.warning);

expect(
UtilitySelector.functionViolationLevel(buildFunctionReportStub(
cyclomaticComplexityViolationLevel: ViolationLevel.warning,
linesOfCodeViolationLevel: ViolationLevel.alarm,
maintainabilityIndexViolationLevel: ViolationLevel.none)),
ViolationLevel.alarm);

expect(
UtilitySelector.functionViolationLevel(buildFunctionReportStub(
cyclomaticComplexityViolationLevel: ViolationLevel.none,
linesOfCodeViolationLevel: ViolationLevel.none,
maintainabilityIndexViolationLevel: ViolationLevel.noted)),
ViolationLevel.noted);
});
test('isIssueLevel', () {
const violationsMapping = {
ViolationLevel.none: isFalse,
ViolationLevel.noted: isFalse,
ViolationLevel.warning: isTrue,
ViolationLevel.alarm: isTrue,
};

assert(violationsMapping.keys.length == ViolationLevel.values.length);

violationsMapping.forEach((key, value) {
expect(UtilitySelector.isIssueLevel(key), value);
});
});
});
}
2 changes: 1 addition & 1 deletion test/scope_ast_visitor_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import 'package:path/path.dart' as p;
import 'package:test/test.dart';

void main() {
group('analyze file with ', () {
group('analyze file with', () {
test('abstract class', () {
final visitor = ScopeAstVisitor();
parseFile(
Expand Down
18 changes: 18 additions & 0 deletions test/stubs_builders.dart
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import 'package:dart_code_metrics/src/models/function_report.dart';
import 'package:dart_code_metrics/src/models/violation_level.dart';

FunctionReport buildFunctionReportStub(
{int cyclomaticComplexity = 0,
ViolationLevel cyclomaticComplexityViolationLevel = ViolationLevel.none,
int linesOfCode = 0,
ViolationLevel linesOfCodeViolationLevel = ViolationLevel.none,
double maintainabilityIndex = 0,
ViolationLevel maintainabilityIndexViolationLevel =
ViolationLevel.none}) =>
FunctionReport(
cyclomaticComplexity: cyclomaticComplexity,
cyclomaticComplexityViolationLevel: cyclomaticComplexityViolationLevel,
linesOfCode: linesOfCode,
linesOfCodeViolationLevel: linesOfCodeViolationLevel,
maintainabilityIndex: maintainabilityIndex,
maintainabilityIndexViolationLevel: maintainabilityIndexViolationLevel);