Add file_selector getDirectoriesPaths

Author: eugerossetto

packages/file_selector/file_selector/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.9.2+2
+
+* Adds `getDirectoriesPaths` method.
+
 ## 0.9.2+1
 
 * Changes XTypeGroup initialization from final to const.

packages/file_selector/file_selector/lib/file_selector.dart

@@ -123,3 +123,22 @@ Future<String?> getDirectoryPath({
   return FileSelectorPlatform.instance.getDirectoryPath(
       initialDirectory: initialDirectory, confirmButtonText: confirmButtonText);
 }
+
+/// Opens a directory selection dialog and returns a list of the paths chosen by the user.
+/// This always returns `null` on the web.
+///
+/// [initialDirectory] is the full path to the directory that will be displayed
+/// when the dialog is opened. When not provided, the platform will pick an
+/// initial location.
+///
+/// [confirmButtonText] is the text in the confirmation button of the dialog.
+/// When not provided, the default OS label is used (for example, "Open").
+///
+/// Returns `null` if the user cancels the operation.
+Future<List<String?>?> getDirectoriesPaths({
+  String? initialDirectory,
+  String? confirmButtonText,
+}) async {
+  return FileSelectorPlatform.instance.getDirectoriesPaths(
+      initialDirectory: initialDirectory, confirmButtonText: confirmButtonText);
+}

packages/file_selector/file_selector/pubspec.yaml

@@ -3,7 +3,9 @@ description: Flutter plugin for opening and saving files, or selecting
   directories, using native file selection UI.
 repository: https://github.com/flutter/plugins/tree/main/packages/file_selector/file_selector
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22
-version: 0.9.2+1
+version: 0.9.2+2
+# TODO(eugerossetto): remove this once file_selector_platform_interface version is updated to 2.3.0
+publish_to: 'none'
 
 environment:
   sdk: ">=2.12.0 <3.0.0"
@@ -23,13 +25,20 @@ flutter:
       windows:
         default_package: file_selector_windows
 
+# TODO(eugerossetto): This should be reverted once file_selector_platform_interface 2.3.0 is published.
 dependencies:
-  file_selector_ios: ^0.5.0
-  file_selector_linux: ^0.9.0
-  file_selector_macos: ^0.9.0
-  file_selector_platform_interface: ^2.2.0
-  file_selector_web: ^0.9.0
-  file_selector_windows: ^0.9.0
+  file_selector_ios:
+    path: ../file_selector_ios
+  file_selector_linux: 
+    path: ../file_selector_linux
+  file_selector_macos: 
+    path: ../file_selector_macos
+  file_selector_platform_interface: 
+    path: ../file_selector_platform_interface
+  file_selector_web: 
+    path: ../file_selector_web
+  file_selector_windows:
+    path: ../file_selector_windows
   flutter:
     sdk: flutter
 

packages/file_selector/file_selector/test/file_selector_test.dart

@@ -258,6 +258,55 @@ void main() {
       expect(directoryPath, expectedDirectoryPath);
     });
   });
+
+  group('getDirectoriesPaths', () {
+    const List<String> expectedDirectoryPaths = <String>[
+      '/example/path',
+      '/example/2/path'
+    ];
+
+    test('works', () async {
+      fakePlatformImplementation
+        ..setExpectations(
+            initialDirectory: initialDirectory,
+            confirmButtonText: confirmButtonText)
+        ..setPathsResponse(expectedDirectoryPaths);
+
+      final List<String?>? directoryPaths = await getDirectoriesPaths(
+        initialDirectory: initialDirectory,
+        confirmButtonText: confirmButtonText,
+      );
+
+      expect(directoryPaths, expectedDirectoryPaths);
+    });
+
+    test('works with no arguments', () async {
+      fakePlatformImplementation.setPathsResponse(expectedDirectoryPaths);
+
+      final List<String?>? directoryPaths = await getDirectoriesPaths();
+      expect(directoryPaths, expectedDirectoryPaths);
+    });
+
+    test('sets the initial directory', () async {
+      fakePlatformImplementation
+        ..setExpectations(initialDirectory: initialDirectory)
+        ..setPathsResponse(expectedDirectoryPaths);
+
+      final List<String?>? directoryPaths =
+          await getDirectoriesPaths(initialDirectory: initialDirectory);
+      expect(directoryPaths, expectedDirectoryPaths);
+    });
+
+    test('sets the button confirmation label', () async {
+      fakePlatformImplementation
+        ..setExpectations(confirmButtonText: confirmButtonText)
+        ..setPathsResponse(expectedDirectoryPaths);
+
+      final List<String?>? directoryPaths =
+          await getDirectoriesPaths(confirmButtonText: confirmButtonText);
+      expect(directoryPaths, expectedDirectoryPaths);
+    });
+  });
 }
 
 class FakeFileSelector extends Fake
@@ -271,6 +320,7 @@ class FakeFileSelector extends Fake
   // Return values.
   List<XFile>? files;
   String? path;
+  List<String>? paths;
 
   void setExpectations({
     List<XTypeGroup> acceptedTypeGroups = const <XTypeGroup>[],
@@ -294,6 +344,11 @@ class FakeFileSelector extends Fake
     this.path = path;
   }
 
+  // ignore: use_setters_to_change_properties
+  void setPathsResponse(List<String> paths) {
+    this.paths = paths;
+  }
+
   @override
   Future<XFile?> openFile({
     List<XTypeGroup>? acceptedTypeGroups,
@@ -341,4 +396,14 @@ class FakeFileSelector extends Fake
     expect(confirmButtonText, this.confirmButtonText);
     return path;
   }
+
+  @override
+  Future<List<String>?> getDirectoriesPaths({
+    String? initialDirectory,
+    String? confirmButtonText,
+  }) async {
+    expect(initialDirectory, this.initialDirectory);
+    expect(confirmButtonText, this.confirmButtonText);
+    return paths;
+  }
 }