Migrate resourceProvider.pathContext

Author: fshcheglov

pubspec.yaml

@@ -23,6 +23,7 @@ dependencies:
   yaml: ^3.1.2
 
 dev_dependencies:
+  analyzer_testing: ^0.1.2
   async: ^2.11.0
   dart_style: ^3.0.0
   lints: ">=5.0.0 <7.0.0"

test/html_generator_test.dart

@@ -4,6 +4,7 @@
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';
 import 'package:dartdoc/src/dartdoc.dart' show DartdocFileWriter;
 import 'package:dartdoc/src/dartdoc_options.dart';
 import 'package:dartdoc/src/generator/generator.dart';
@@ -69,8 +70,8 @@ void main() {
           HtmlGeneratorBackend(options, templates, writer, resourceProvider));
     });
 
-    File getConvertedFile(String filePath) =>
-        resourceProvider.getFile(resourceProvider.convertPath(filePath));
+    File getConvertedFile(String filePath) => resourceProvider.getFile(
+        ResourceProviderExtension(resourceProvider).convertPath(filePath));
 
     tearDown(clearPackageMetaCache);
 
@@ -126,11 +127,14 @@ const Matcher doesExist = _DoesExist();
 
 class _DoesExist extends Matcher {
   const _DoesExist();
+
   @override
   bool matches(Object? item, Map<Object?, Object?> matchState) =>
       (item as Resource).exists;
+
   @override
   Description describe(Description description) => description.add('exists');
+
   @override
   Description describeMismatch(Object? item, Description mismatchDescription,
       Map<Object?, Object?> matchState, bool verbose) {

test/libraries_test.dart

@@ -3,6 +3,7 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:test/test.dart';
 import 'package:test_reflective_loader/test_reflective_loader.dart';
@@ -130,8 +131,10 @@ A doc comment.
       packageMetaProvider,
       packageConfigProvider,
     );
-    final daName = resourceProvider.convertPath('d/a');
-    final eaName = resourceProvider.convertPath('e/a');
+    final daName =
+        ResourceProviderExtension(resourceProvider).convertPath('d/a');
+    final eaName =
+        ResourceProviderExtension(resourceProvider).convertPath('e/a');
     final daLibrary = packageGraph.libraries.displayNamed(daName);
     final eaLibrary = packageGraph.libraries.displayNamed(eaName);
     final bLibrary = packageGraph.libraries.displayNamed('b');
@@ -257,7 +260,7 @@ class LibrariesInAdditionalPackageTest extends DartdocTestBase {
     return bootPackageFromFiles(
       [
         d.file('lib/lib1.dart', "import 'package:two/lib2.dart';"),
-        d.dir(resourceProvider.convertPath('vendor/two'), [
+        d.dir(ResourceProviderExtension(resourceProvider).convertPath('vendor/two'), [
           d.file('pubspec.yaml', '''
 name: two
 version: 0.0.1

test/mustachio/runtime_renderer_render_test.dart

@@ -7,6 +7,7 @@ library;
 
 import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';
 import 'package:dartdoc/src/mustachio/renderer_base.dart';
 import 'package:path/path.dart' as path show Context;
 import 'package:test/test.dart';
@@ -19,8 +20,9 @@ void main() {
 
   late path.Context pathContext;
 
-  File getFile(String path) => resourceProvider
-      .getFile(pathContext.canonicalize(resourceProvider.convertPath(path)));
+  File getFile(String path) =>
+      resourceProvider.getFile(pathContext.canonicalize(
+          ResourceProviderExtension(resourceProvider).convertPath(path)));
 
   setUp(() {
     resourceProvider = MemoryResourceProvider();

test/src/test_descriptor_utils.dart

@@ -5,6 +5,7 @@
 import 'dart:convert';
 
 import 'package:analyzer/file_system/memory_file_system.dart';
+import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';
 import 'package:test_descriptor/test_descriptor.dart' as d;
 import 'package:yaml/yaml.dart' as yaml;
 
@@ -109,28 +110,11 @@ Future<String> createPackage(
   }
 }
 
-extension DescriptorExtensions on d.Descriptor {
-  /// Creates this [d.Descriptor] in the [MemoryResourceProvider].
-  ///
-  /// For a [d.DirectoryDescriptor], the subtree will be created. For a
-  /// [d.FileDescriptor], the file contents will be written.
-  Future<String> createInMemory(MemoryResourceProvider resourceProvider,
-      [String? parent]) {
-    var self = this;
-    return switch (self) {
-      d.DirectoryDescriptor() => self.createInMemory(resourceProvider, parent),
-      d.FileDescriptor() => self.createInMemory(resourceProvider, parent!),
-      _ => throw StateError(
-          '$runtimeType is not a DirectoryDescriptor, nor a FileDescriptor!')
-    };
-  }
-}
-
 extension on d.DirectoryDescriptor {
   Future<String> createInMemory(MemoryResourceProvider resourceProvider,
       [String? parent]) async {
-    parent ??= resourceProvider.pathContext
-        .canonicalize(resourceProvider.convertPath('/temp'));
+    parent ??= resourceProvider.pathContext.canonicalize(
+        ResourceProviderExtension(resourceProvider).convertPath('/temp'));
     resourceProvider.newFolder(parent).create();
     var fullPath = resourceProvider.pathContext.join(parent, name);
     resourceProvider.newFolder(fullPath).create();
@@ -145,9 +129,26 @@ extension on d.FileDescriptor {
   Future<String> createInMemory(
       MemoryResourceProvider resourceProvider, String parent) async {
     var content = await readAsBytes().transform(utf8.decoder).join('');
-    var fullPath = resourceProvider
+    var fullPath = ResourceProviderExtension(resourceProvider)
         .convertPath(resourceProvider.pathContext.join(parent, name));
     resourceProvider.newFile(fullPath, content);
     return fullPath;
   }
 }
+
+extension DescriptorExtensions on d.Descriptor {
+  /// Creates this [d.Descriptor] in the [MemoryResourceProvider].
+  ///
+  /// For a [d.DirectoryDescriptor], the subtree will be created. For a
+  /// [d.FileDescriptor], the file contents will be written.
+  Future<String> createInMemory(MemoryResourceProvider resourceProvider,
+      [String? parent]) {
+    var self = this;
+    return switch (self) {
+      d.DirectoryDescriptor() => self.createInMemory(resourceProvider, parent),
+      d.FileDescriptor() => self.createInMemory(resourceProvider, parent!),
+      _ => throw StateError(
+          '$runtimeType is not a DirectoryDescriptor, nor a FileDescriptor!')
+    };
+  }
+}

test/src/utils.dart

@@ -9,6 +9,7 @@ import 'package:analyzer/file_system/memory_file_system.dart';
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/dart/sdk/sdk.dart';
 import 'package:analyzer/src/test_utilities/mock_sdk.dart';
+import 'package:analyzer_testing/utilities/extensions/resource_provider.dart';
 import 'package:dartdoc/src/dartdoc_options.dart';
 import 'package:dartdoc/src/failure.dart';
 import 'package:dartdoc/src/generator/generator.dart';
@@ -136,8 +137,8 @@ FakePackageConfigProvider getTestPackageConfigProvider(String sdkPath) {
 PackageMetaProvider get testPackageMetaProvider {
   var resourceProvider = MemoryResourceProvider();
   final sdkRoot = resourceProvider.getFolder(
-    resourceProvider.pathContext
-        .canonicalize(resourceProvider.convertPath('/sdk')),
+    resourceProvider.pathContext.canonicalize(
+        ResourceProviderExtension(resourceProvider).convertPath('/sdk')),
   );
   createMockSdk(
     resourceProvider: resourceProvider,
@@ -190,8 +191,8 @@ version: 0.0.1
 homepage: https://github.com/dart-lang
 ''';
   var pathContext = resourceProvider.pathContext;
-  var projectsFolder = resourceProvider.getFolder(
-      pathContext.canonicalize(resourceProvider.convertPath('/projects')));
+  var projectsFolder = resourceProvider.getFolder(pathContext.canonicalize(
+      ResourceProviderExtension(resourceProvider).convertPath('/projects')));
   var projectFolder = projectsFolder.getChildAssumingFolder(packageName)
     ..create();
   var projectRoot = projectFolder.path;