feat: introduce file metrics (#502)

* refactor: rename buildRecordStub to buildReportStub

* feat: introduce file metric

* feat: introduce file metrics report

* feat: report file metrics in console, code climate and json reporters

* chore: update changelog

Author: dkrutskikh

.gitignore

@@ -29,3 +29,4 @@ doc/api/
 .DS_Store
 
 .vscode/launch.json
+test/fake_test.dart

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-* refactor: make violations field of summary lint report record as integer
+* feat: introduce file metrics
 
 ## 4.6.0
 

lib/src/analyzers/lint_analyzer/lint_analysis_config.dart

@@ -14,6 +14,7 @@ class LintAnalysisConfig {
   final Iterable<Glob> rulesExcludes;
   final Iterable<Pattern> antiPatterns;
   final Iterable<Metric> classesMetrics;
+  final Iterable<Metric> fileMetrics;
   final Iterable<Metric> methodsMetrics;
   final Iterable<Glob> metricsExcludes;
   final Map<String, Object> metricsConfig;
@@ -25,6 +26,7 @@ class LintAnalysisConfig {
     this.rulesExcludes,
     this.antiPatterns,
     this.classesMetrics,
+    this.fileMetrics,
     this.methodsMetrics,
     this.metricsExcludes,
     this.metricsConfig,

lib/src/analyzers/lint_analyzer/lint_analyzer.dart

@@ -208,6 +208,12 @@ class LintAnalyzer {
         return LintFileReport(
           path: filePath,
           relativePath: relativePath,
+          file: Report(
+            location:
+                nodeLocation(node: internalResult.unit, source: internalResult),
+            metrics: const [],
+            declaration: internalResult.unit,
+          ),
           classes: Map.unmodifiable(classMetrics
               .map<String, Report>((key, value) => MapEntry(key.name, value))),
           functions: Map.unmodifiable(functionMetrics.map<String, Report>(
@@ -221,6 +227,12 @@ class LintAnalyzer {
       return LintFileReport(
         path: filePath,
         relativePath: relativePath,
+        file: Report(
+          location:
+              nodeLocation(node: internalResult.unit, source: internalResult),
+          metrics: const [],
+          declaration: internalResult.unit,
+        ),
         classes: const {},
         functions: const {},
         issues: issues,

lib/src/analyzers/lint_analyzer/metrics/models/file_metric.dart

@@ -0,0 +1,43 @@
+import 'package:analyzer/dart/ast/ast.dart';
+
+import '../../models/internal_resolved_unit_result.dart';
+import '../../models/scoped_class_declaration.dart';
+import '../../models/scoped_function_declaration.dart';
+import 'metric.dart';
+import 'metric_documentation.dart';
+import 'metric_value.dart';
+import 'metric_value_level.dart';
+
+/// An interface for metrics that compute a value for a file aka compilation unit node.
+abstract class FileMetric<T extends num> extends Metric<T> {
+  /// Initialize a newly created [FileMetric].
+  const FileMetric({
+    required String id,
+    required MetricDocumentation documentation,
+    required T? threshold,
+    required MetricValueLevel Function(T, T?) levelComputer,
+  }) : super(
+          id: id,
+          documentation: documentation,
+          threshold: threshold,
+          levelComputer: levelComputer,
+        );
+
+  @override
+  bool supports(
+    AstNode node,
+    Iterable<ScopedClassDeclaration> classDeclarations,
+    Iterable<ScopedFunctionDeclaration> functionDeclarations,
+    InternalResolvedUnitResult source,
+    Iterable<MetricValue> otherMetricsValues,
+  ) =>
+      node is CompilationUnit;
+
+  @override
+  String? nodeType(
+    AstNode node,
+    Iterable<ScopedClassDeclaration> classDeclarations,
+    Iterable<ScopedFunctionDeclaration> functionDeclarations,
+  ) =>
+      null;
+}

lib/src/analyzers/lint_analyzer/models/entity_type.dart

@@ -5,11 +5,14 @@ class EntityType {
   /// The entity representing a class, mixin or extension.
   static const classEntity = EntityType._('class');
 
+  /// The entity representing a whole file.
+  static const fileEntity = EntityType._('file');
+
   /// The entity representing a class method or constructor, function, getter or setter.
   static const methodEntity = EntityType._('method');
 
   /// A list containing all of the enum values that are defined.
-  static const values = [classEntity, methodEntity];
+  static const values = [classEntity, fileEntity, methodEntity];
 
   final String _value;
 

lib/src/analyzers/lint_analyzer/models/lint_file_report.dart

@@ -15,6 +15,9 @@ class LintFileReport implements FileReport {
   @override
   final String relativePath;
 
+  /// The metrics report about the target file.
+  final Report file;
+
   /// The all classes reports in the target file.
   final Map<String, Report> classes;
 
@@ -30,6 +33,7 @@ class LintFileReport implements FileReport {
   const LintFileReport({
     required this.path,
     required this.relativePath,
+    required this.file,
     required this.classes,
     required this.functions,
     required this.issues,

lib/src/analyzers/lint_analyzer/reporters/reporters_list/code_climate/lint_code_climate_reporter.dart

@@ -56,7 +56,7 @@ class LintCodeClimateReporter
           record.relativePath,
         ),
         ..._reportsToCodeClimate(
-          [...record.functions.values, ...record.classes.values],
+          [record.file, ...record.classes.values, ...record.functions.values],
           record.relativePath,
         ),
       ];

lib/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter.dart

@@ -33,8 +33,9 @@ class LintConsoleReporter
 
     for (final file in records) {
       final lines = [
+        ..._reportMetrics('', file.file),
         ..._reportIssues([...file.issues, ...file.antiPatternCases]),
-        ..._reportMetrics({...file.classes, ...file.functions}),
+        ..._reportEntityMetrics({...file.classes, ...file.functions}),
       ];
 
       if (lines.isNotEmpty) {
@@ -50,29 +51,28 @@ class LintConsoleReporter
             a.location.start.offset.compareTo(b.location.start.offset)))
       .map(_helper.getIssueMessage);
 
-  Iterable<String> _reportMetrics(Map<String, Report> reports) =>
+  Iterable<String> _reportEntityMetrics(Map<String, Report> reports) =>
       (reports.entries.toList()
             ..sort((a, b) => a.value.location.start.offset
                 .compareTo(b.value.location.start.offset)))
-          .expand((entry) {
-        final source = entry.key;
-        final report = entry.value;
+          .expand((entry) => _reportMetrics(entry.key, entry.value));
 
-        final reportLevel = report.metricsLevel;
-        if (reportAll || isReportLevel(reportLevel)) {
-          final violations = [
-            for (final metric in report.metrics)
-              if (reportAll || _isNeedToReport(metric))
-                _helper.getMetricReport(metric),
-          ];
+  Iterable<String> _reportMetrics(String source, Report report) {
+    final reportLevel = report.metricsLevel;
+    if (reportAll || isReportLevel(reportLevel)) {
+      final violations = [
+        for (final metric in report.metrics)
+          if (reportAll || _isNeedToReport(metric))
+            _helper.getMetricReport(metric),
+      ];
 
-          return [
-            _helper.getMetricMessage(reportLevel, source, violations),
-          ];
-        }
+      return [
+        _helper.getMetricMessage(reportLevel, source, violations),
+      ];
+    }
 
-        return [];
-      });
+    return [];
+  }
 
   bool _isNeedToReport(MetricValue metric) =>
       metric.level > MetricValueLevel.none;

lib/src/analyzers/lint_analyzer/reporters/reporters_list/console/lint_console_reporter_helper.dart

@@ -40,13 +40,13 @@ class LintConsoleReporterHelper {
   ) {
     final color = _colorPens[violationLevel];
     if (color != null) {
-      final normalizedLabel = _normalize(
+      final normalizedLabel = color(_normalize(
         violationLevel != MetricValueLevel.none
             ? violationLevel.toString().capitalize()
             : '',
-      );
+      ));
 
-      return '${color(normalizedLabel)}$source - ${violations.join(', ')}';
+      return '$normalizedLabel${source.isNotEmpty ? '$source - ' : ''}${violations.join(', ')}';
     }
 
     throw StateError('Unexpected violation level.');