From cea586640617ec5770f479573383ac8fd12104b3 Mon Sep 17 00:00:00 2001 From: Alejandro Pinola Date: Mon, 17 Oct 2022 11:35:11 -0300 Subject: [PATCH] apply feedback --- .../CHANGELOG.md | 7 +- .../method_channel_file_selector.dart | 13 +-- .../file_selector_interface.dart | 15 ++- .../pubspec.yaml | 2 +- ...file_selector_platform_interface_test.dart | 10 ++ .../method_channel_file_selector_test.dart | 104 +++++++++--------- 6 files changed, 78 insertions(+), 73 deletions(-) diff --git a/packages/file_selector/file_selector_platform_interface/CHANGELOG.md b/packages/file_selector/file_selector_platform_interface/CHANGELOG.md index 5343f9ff3aa4..e0b08f086977 100644 --- a/packages/file_selector/file_selector_platform_interface/CHANGELOG.md +++ b/packages/file_selector/file_selector_platform_interface/CHANGELOG.md @@ -1,6 +1,9 @@ -## 2.3.0+1 +## 2.4.0 + +* Adds `getDirectoryPaths` method to the interface. + +## 2.3.0 -* Adds `getDirectoriesPaths` method to the interface. * Replaces `macUTIs` with `uniformTypeIdentifiers`. `macUTIs` is available as an alias, but will be deprecated in a future release. ## 2.2.0 diff --git a/packages/file_selector/file_selector_platform_interface/lib/src/method_channel/method_channel_file_selector.dart b/packages/file_selector/file_selector_platform_interface/lib/src/method_channel/method_channel_file_selector.dart index 95f12e610871..98184cab8768 100644 --- a/packages/file_selector/file_selector_platform_interface/lib/src/method_channel/method_channel_file_selector.dart +++ b/packages/file_selector/file_selector_platform_interface/lib/src/method_channel/method_channel_file_selector.dart @@ -16,7 +16,6 @@ class MethodChannelFileSelector extends FileSelectorPlatform { @visibleForTesting MethodChannel get channel => _channel; - /// Load a file from user's computer and return it as an XFile @override Future openFile({ List? acceptedTypeGroups, @@ -37,7 +36,6 @@ class MethodChannelFileSelector extends FileSelectorPlatform { return path == null ? null : XFile(path.first); } - /// Load multiple files from user's computer and return it as an XFile @override Future> openFiles({ List? acceptedTypeGroups, @@ -58,7 +56,6 @@ class MethodChannelFileSelector extends FileSelectorPlatform { return pathList?.map((String path) => XFile(path)).toList() ?? []; } - /// Gets the path from a save dialog @override Future getSavePath({ List? acceptedTypeGroups, @@ -79,7 +76,6 @@ class MethodChannelFileSelector extends FileSelectorPlatform { ); } - /// Gets a directory path from a dialog @override Future getDirectoryPath({ String? initialDirectory, @@ -94,17 +90,16 @@ class MethodChannelFileSelector extends FileSelectorPlatform { ); } - /// Gets a list of directories paths from a dialog @override - Future?> getDirectoriesPaths( + Future> getDirectoryPaths( {String? initialDirectory, String? confirmButtonText}) async { - return _channel.invokeListMethod( - 'getDirectoriesPaths', + final List? pathList = await _channel.invokeListMethod( + 'getDirectoryPaths', { 'initialDirectory': initialDirectory, 'confirmButtonText': confirmButtonText, - 'multiple': true, }, ); + return pathList ?? []; } } diff --git a/packages/file_selector/file_selector_platform_interface/lib/src/platform_interface/file_selector_interface.dart b/packages/file_selector/file_selector_platform_interface/lib/src/platform_interface/file_selector_interface.dart index 55bac70026b6..ad4fe617e44e 100644 --- a/packages/file_selector/file_selector_platform_interface/lib/src/platform_interface/file_selector_interface.dart +++ b/packages/file_selector/file_selector_platform_interface/lib/src/platform_interface/file_selector_interface.dart @@ -36,7 +36,7 @@ abstract class FileSelectorPlatform extends PlatformInterface { _instance = instance; } - /// Open file dialog for loading files and return a file path + /// Opens a file dialog for loading files and returns a file path. /// Returns `null` if user cancels the operation. Future openFile({ List? acceptedTypeGroups, @@ -46,7 +46,7 @@ abstract class FileSelectorPlatform extends PlatformInterface { throw UnimplementedError('openFile() has not been implemented.'); } - /// Open file dialog for loading files and return a list of file paths + /// Opens a file dialog for loading files and returns a list of file paths. Future> openFiles({ List? acceptedTypeGroups, String? initialDirectory, @@ -55,7 +55,7 @@ abstract class FileSelectorPlatform extends PlatformInterface { throw UnimplementedError('openFiles() has not been implemented.'); } - /// Open file dialog for saving files and return a file path at which to save + /// Opens a file dialog for saving files and returns a file path at which to save. /// Returns `null` if user cancels the operation. Future getSavePath({ List? acceptedTypeGroups, @@ -66,7 +66,7 @@ abstract class FileSelectorPlatform extends PlatformInterface { throw UnimplementedError('getSavePath() has not been implemented.'); } - /// Open file dialog for loading directories and return a directory path + /// Opens a file dialog for loading directories and returns a directory path. /// Returns `null` if user cancels the operation. Future getDirectoryPath({ String? initialDirectory, @@ -75,12 +75,11 @@ abstract class FileSelectorPlatform extends PlatformInterface { throw UnimplementedError('getDirectoryPath() has not been implemented.'); } - /// Open file dialog for loading directories and return multiple directories paths - /// Returns `null` if user cancels the operation. - Future?> getDirectoriesPaths({ + /// Opens a file dialog for loading directories and returns multiple directory paths. + Future> getDirectoryPaths({ String? initialDirectory, String? confirmButtonText, }) { - throw UnimplementedError('getDirectoriesPaths() has not been implemented.'); + throw UnimplementedError('getDirectoryPaths() has not been implemented.'); } } diff --git a/packages/file_selector/file_selector_platform_interface/pubspec.yaml b/packages/file_selector/file_selector_platform_interface/pubspec.yaml index 21efa98f87f8..4ab63acbf7e6 100644 --- a/packages/file_selector/file_selector_platform_interface/pubspec.yaml +++ b/packages/file_selector/file_selector_platform_interface/pubspec.yaml @@ -4,7 +4,7 @@ repository: https://github.com/flutter/plugins/tree/main/packages/file_selector/ issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+file_selector%22 # NOTE: We strongly prefer non-breaking changes, even at the expense of a # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes -version: 2.3.0+1 +version: 2.4.0 environment: sdk: ">=2.12.0 <3.0.0" diff --git a/packages/file_selector/file_selector_platform_interface/test/file_selector_platform_interface_test.dart b/packages/file_selector/file_selector_platform_interface/test/file_selector_platform_interface_test.dart index 91e78b452961..6e3552fa736c 100644 --- a/packages/file_selector/file_selector_platform_interface/test/file_selector_platform_interface_test.dart +++ b/packages/file_selector/file_selector_platform_interface/test/file_selector_platform_interface_test.dart @@ -19,6 +19,16 @@ void main() { FileSelectorPlatform.instance = ExtendsFileSelectorPlatform(); }); }); + + group('#GetDirectoryPaths', () { + test('Should throw unimplemented exception', () async { + final FileSelectorPlatform sut = ExtendsFileSelectorPlatform(); + + await expectLater(() async { + return sut.getDirectoryPaths(); + }, throwsA(isA())); + }); + }); } class ExtendsFileSelectorPlatform extends FileSelectorPlatform {} diff --git a/packages/file_selector/file_selector_platform_interface/test/method_channel_file_selector_test.dart b/packages/file_selector/file_selector_platform_interface/test/method_channel_file_selector_test.dart index 98033b1817b7..892f98ef2d5d 100644 --- a/packages/file_selector/file_selector_platform_interface/test/method_channel_file_selector_test.dart +++ b/packages/file_selector/file_selector_platform_interface/test/method_channel_file_selector_test.dart @@ -219,64 +219,62 @@ void main() { ], ); }); - group('#getDirectoryPath', () { - test('passes initialDirectory correctly', () async { - await plugin.getDirectoryPath(initialDirectory: '/example/directory'); + }); + group('#getDirectoryPath', () { + test('passes initialDirectory correctly', () async { + await plugin.getDirectoryPath(initialDirectory: '/example/directory'); - expect( - log, - [ - isMethodCall('getDirectoryPath', arguments: { - 'initialDirectory': '/example/directory', - 'confirmButtonText': null, - }), - ], - ); - }); - test('passes confirmButtonText correctly', () async { - await plugin.getDirectoryPath(confirmButtonText: 'Open File'); + expect( + log, + [ + isMethodCall('getDirectoryPath', arguments: { + 'initialDirectory': '/example/directory', + 'confirmButtonText': null, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.getDirectoryPath(confirmButtonText: 'Select Folder'); - expect( - log, - [ - isMethodCall('getDirectoryPath', arguments: { - 'initialDirectory': null, - 'confirmButtonText': 'Open File', - }), - ], - ); - }); + expect( + log, + [ + isMethodCall('getDirectoryPath', arguments: { + 'initialDirectory': null, + 'confirmButtonText': 'Select Folder', + }), + ], + ); }); - group('#getDirectoriesPaths', () { - test('passes initialDirectory correctly', () async { - await plugin.getDirectoriesPaths( - initialDirectory: '/example/directory'); + }); + group('#getDirectoryPaths', () { + test('passes initialDirectory correctly', () async { + await plugin.getDirectoryPaths(initialDirectory: '/example/directory'); - expect( - log, - [ - isMethodCall('getDirectoriesPaths', arguments: { - 'initialDirectory': '/example/directory', - 'confirmButtonText': null, - 'multiple': true - }), - ], - ); - }); - test('passes confirmButtonText correctly', () async { - await plugin.getDirectoriesPaths(confirmButtonText: 'Open File'); + expect( + log, + [ + isMethodCall('getDirectoryPaths', arguments: { + 'initialDirectory': '/example/directory', + 'confirmButtonText': null, + }), + ], + ); + }); + test('passes confirmButtonText correctly', () async { + await plugin.getDirectoryPaths( + confirmButtonText: 'Select one or more Folders'); - expect( - log, - [ - isMethodCall('getDirectoriesPaths', arguments: { - 'initialDirectory': null, - 'confirmButtonText': 'Open File', - 'multiple': true - }), - ], - ); - }); + expect( + log, + [ + isMethodCall('getDirectoryPaths', arguments: { + 'initialDirectory': null, + 'confirmButtonText': 'Select one or more Folders', + }), + ], + ); }); }); });