Skip to content

Commit

Permalink
Change getDirectoriesPaths to getDirectoryPaths and rebase.
Browse files Browse the repository at this point in the history
  • Loading branch information
eugerossetto committed Oct 31, 2022
1 parent 25c1bbb commit 0683c05
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 25 deletions.
2 changes: 1 addition & 1 deletion packages/file_selector/file_selector/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 0.9.2+2

* Adds `getDirectoriesPaths` method.
* Adds `getDirectoryPaths` method.

## 0.9.2+1

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
import 'package:file_selector/file_selector.dart';
import 'package:flutter/material.dart';

/// Screen that allows the user to select one or more directories using `getDirectoriesPaths`,
/// Screen that allows the user to select one or more directories using `getDirectoryPaths`,
/// then displays the selected directories in a dialog.
class GetMultipleDirectoriesPage extends StatelessWidget {
/// Default Constructor
const GetMultipleDirectoriesPage({Key? key}) : super(key: key);

Future<void> _getDirectoryPaths(BuildContext context) async {
const String confirmButtonText = 'Choose';
final List<String?>? directoryPaths = await getDirectoriesPaths(
final List<String?>? directoryPaths = await getDirectoryPaths(
confirmButtonText: confirmButtonText,
);
if (directoryPaths == null) {
Expand Down
4 changes: 2 additions & 2 deletions packages/file_selector/file_selector/lib/file_selector.dart
Original file line number Diff line number Diff line change
Expand Up @@ -135,10 +135,10 @@ Future<String?> getDirectoryPath({
/// When not provided, the default OS label is used (for example, "Open").
///
/// Returns `null` if the user cancels the operation.
Future<List<String?>?> getDirectoriesPaths({
Future<List<String?>?> getDirectoryPaths({
String? initialDirectory,
String? confirmButtonText,
}) async {
return FileSelectorPlatform.instance.getDirectoriesPaths(
return FileSelectorPlatform.instance.getDirectoryPaths(
initialDirectory: initialDirectory, confirmButtonText: confirmButtonText);
}
2 changes: 2 additions & 0 deletions packages/file_selector/file_selector/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Flutter plugin for opening and saving files, or selecting
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+2
# TODO(eugerossetto): This should be reverted once file_selector_platform_interface 2.3.0 is published.
publish_to: 'none'

environment:
sdk: ">=2.12.0 <3.0.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ void main() {
});
});

group('getDirectoriesPaths', () {
group('getDirectoryPaths', () {
const List<String> expectedDirectoryPaths = <String>[
'/example/path',
'/example/2/path'
Expand All @@ -272,7 +272,7 @@ void main() {
confirmButtonText: confirmButtonText)
..setPathsResponse(expectedDirectoryPaths);

final List<String?>? directoryPaths = await getDirectoriesPaths(
final List<String?>? directoryPaths = await getDirectoryPaths(
initialDirectory: initialDirectory,
confirmButtonText: confirmButtonText,
);
Expand All @@ -283,7 +283,7 @@ void main() {
test('works with no arguments', () async {
fakePlatformImplementation.setPathsResponse(expectedDirectoryPaths);

final List<String?>? directoryPaths = await getDirectoriesPaths();
final List<String?>? directoryPaths = await getDirectoryPaths();
expect(directoryPaths, expectedDirectoryPaths);
});

Expand All @@ -293,7 +293,7 @@ void main() {
..setPathsResponse(expectedDirectoryPaths);

final List<String?>? directoryPaths =
await getDirectoriesPaths(initialDirectory: initialDirectory);
await getDirectoryPaths(initialDirectory: initialDirectory);
expect(directoryPaths, expectedDirectoryPaths);
});

Expand All @@ -303,7 +303,7 @@ void main() {
..setPathsResponse(expectedDirectoryPaths);

final List<String?>? directoryPaths =
await getDirectoriesPaths(confirmButtonText: confirmButtonText);
await getDirectoryPaths(confirmButtonText: confirmButtonText);
expect(directoryPaths, expectedDirectoryPaths);
});
});
Expand Down Expand Up @@ -398,7 +398,7 @@ class FakeFileSelector extends Fake
}

@override
Future<List<String>?> getDirectoriesPaths({
Future<List<String>?> getDirectoryPaths({
String? initialDirectory,
String? confirmButtonText,
}) async {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
## 2.3.0
## 2.4.0

* Replaces `macUTIs` with `uniformTypeIdentifiers`. `macUTIs` is available as an alias, but will be deprecated in a future release.
* Adds `getDirectoryPaths` method to the interface.

## 2.2.0+1
## 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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,10 @@ class MethodChannelFileSelector extends FileSelectorPlatform {

/// Gets a list of directories paths from a dialog
@override
Future<List<String>?> getDirectoriesPaths(
Future<List<String>?> getDirectoryPaths(
{String? initialDirectory, String? confirmButtonText}) async {
return _channel.invokeListMethod<String>(
'getDirectoriesPaths',
'getDirectoryPaths',
<String, dynamic>{
'initialDirectory': initialDirectory,
'confirmButtonText': confirmButtonText,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ abstract class FileSelectorPlatform extends PlatformInterface {

/// Open file dialog for loading directories and return multiple directories paths
/// Returns `null` if user cancels the operation.
Future<List<String>?> getDirectoriesPaths({
Future<List<String>?> getDirectoryPaths({
String? initialDirectory,
String? confirmButtonText,
}) {
throw UnimplementedError('getDirectoriesPaths() has not been implemented.');
throw UnimplementedError('getDirectoryPaths() has not been implemented.');
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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
version: 2.4.0

environment:
sdk: ">=2.12.0 <3.0.0"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -247,15 +247,15 @@ void main() {
);
});
});
group('#getDirectoriesPaths', () {
group('#getDirectoryPaths', () {
test('passes initialDirectory correctly', () async {
await plugin.getDirectoriesPaths(
await plugin.getDirectoryPaths(
initialDirectory: '/example/directory');

expect(
log,
<Matcher>[
isMethodCall('getDirectoriesPaths', arguments: <String, dynamic>{
isMethodCall('getDirectoryPaths', arguments: <String, dynamic>{
'initialDirectory': '/example/directory',
'confirmButtonText': null,
'multiple': true
Expand All @@ -264,12 +264,12 @@ void main() {
);
});
test('passes confirmButtonText correctly', () async {
await plugin.getDirectoriesPaths(confirmButtonText: 'Open File');
await plugin.getDirectoryPaths(confirmButtonText: 'Open File');

expect(
log,
<Matcher>[
isMethodCall('getDirectoriesPaths', arguments: <String, dynamic>{
isMethodCall('getDirectoryPaths', arguments: <String, dynamic>{
'initialDirectory': null,
'confirmButtonText': 'Open File',
'multiple': true
Expand Down

0 comments on commit 0683c05

Please sign in to comment.