fix: improve context root included files calculation (#862)

* fix: improve context root included files calculation

* test: add more test cases

* chore: add content to files

* test: update tests

Author: incendial

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Unreleased
 
 * chore: restrict `analyzer` version to `>=2.4.0 <4.2.0`.
+* fix: improve context root included files calculation.
 
 ## 4.15.2
 

analysis_options.yaml

@@ -6,6 +6,7 @@ analyzer:
     - test/resources/unused_files_analyzer/**
     - test/resources/unused_l10n_analyzer/**
     - test/resources/unused_code_analyzer/generated/**
+    - test/resources/file_path_folder/**
     - test/**/examples/**
   language:
     strict-inference: true

lib/src/utils/analyzer_utils.dart

@@ -32,11 +32,12 @@ Set<String> getFilePaths(
   String rootFolder,
   Iterable<Glob> excludes,
 ) {
+  final rootPath = context.contextRoot.root.path;
+
   final contextFolders = folders.where((path) {
-    final newPath = normalize(join(rootFolder, path));
-    final rootPath = context.contextRoot.root.path;
+    final folderPath = normalize(join(rootFolder, path));
 
-    return newPath == rootPath || rootPath.startsWith('$newPath/');
+    return folderPath == rootPath || folderPath.startsWith('$rootPath/');
   }).toList();
 
   return extractDartFilesFromFolders(contextFolders, rootFolder, excludes);

test/resources/file_paths_folder/first_file.dart

@@ -0,0 +1,2 @@
+// ignore: no-empty-block
+void main() {}

test/resources/file_paths_folder/inner_folder/first_inner_file.dart

@@ -0,0 +1,2 @@
+// ignore: no-empty-block
+void main() {}

test/resources/file_paths_folder/second_file.dart

@@ -0,0 +1,2 @@
+// ignore: no-empty-block
+void main() {}

test/src/utils/analyzer_utils_test.dart

@@ -0,0 +1,77 @@
+import 'package:analyzer/dart/analysis/analysis_context.dart';
+import 'package:analyzer/dart/analysis/context_root.dart';
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:dart_code_metrics/src/utils/analyzer_utils.dart';
+import 'package:glob/glob.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:test/test.dart';
+
+class AnalysisContextMock extends Mock implements AnalysisContext {}
+
+class ContextRootMock extends Mock implements ContextRoot {}
+
+class FolderMock extends Mock implements Folder {}
+
+void main() {
+  group('getFilePaths', () {
+    const folderPath = 'file_paths_folder';
+    const rootFolder = 'test/resources';
+
+    final folder = FolderMock();
+    final contextRoot = ContextRootMock();
+    final context = AnalysisContextMock();
+
+    setUp(() {
+      when(() => folder.path).thenReturn('test/resources');
+      when(() => contextRoot.root).thenReturn(folder);
+      when(() => context.contextRoot).thenReturn(contextRoot);
+    });
+
+    test(
+      'should return paths to the files',
+      () {
+        const excludes = <Glob>[];
+
+        final filePaths =
+            getFilePaths([folderPath], context, rootFolder, excludes).toList()
+              ..sort();
+
+        expect(filePaths, hasLength(3));
+
+        const startPath = '$rootFolder/$folderPath';
+
+        final firstPath = filePaths.first;
+        expect(firstPath, '$startPath/first_file.dart');
+
+        final secondPath = filePaths.elementAt(1);
+        expect(secondPath, '$startPath/inner_folder/first_inner_file.dart');
+
+        final thirdPath = filePaths.last;
+        expect(thirdPath, '$startPath/second_file.dart');
+      },
+      testOn: 'posix',
+    );
+
+    test(
+      'should return paths to the files without excluded',
+      () {
+        final excludes = [Glob('**/second_file.dart')];
+
+        final filePaths =
+            getFilePaths([folderPath], context, rootFolder, excludes).toList()
+              ..sort();
+
+        expect(filePaths, hasLength(2));
+
+        const startPath = '$rootFolder/$folderPath';
+
+        final firstPath = filePaths.first;
+        expect(firstPath, '$startPath/first_file.dart');
+
+        final secondPath = filePaths.last;
+        expect(secondPath, '$startPath/inner_folder/first_inner_file.dart');
+      },
+      testOn: 'posix',
+    );
+  });
+}