[path_provider_platform_interface] Rename back to StorageDirectory (#2564)

franciscojma86 · web-flow · commit 9af7525307da · 2020-02-28T10:34:11.000-08:00
* Rename StorageDirectory

* Update version

* Update version to non-breaking

* Use 1.0.1
diff --git a/packages/path_provider/path_provider_platform_interface/CHANGELOG.md b/packages/path_provider/path_provider_platform_interface/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.0.1
+
+* Rename enum to StorageDirectory for backwards compatibility.
+
 ## 1.0.0
 
 * Initial release.
diff --git a/packages/path_provider/path_provider_platform_interface/lib/path_provider_platform_interface.dart b/packages/path_provider/path_provider_platform_interface/lib/path_provider_platform_interface.dart
@@ -85,9 +85,9 @@ abstract class PathProviderPlatform extends PlatformInterface {
   /// These paths typically reside on external storage like separate partitions
   /// or SD cards. Phones may have multiple storage directories available.
   Future<List<String>> getExternalStoragePaths({
-    /// Optional parameter. See [AndroidStorageDirectory] for more informations on
+    /// Optional parameter. See [StorageDirectory] for more informations on
     /// how this type translates to Android storage directories.
-    AndroidStorageDirectory type,
+    StorageDirectory type,
   }) {
     throw UnimplementedError(
         'getExternalStoragePaths() has not been implemented.');
diff --git a/packages/path_provider/path_provider_platform_interface/lib/src/enums.dart b/packages/path_provider/path_provider_platform_interface/lib/src/enums.dart
@@ -1,7 +1,7 @@
 /// Corresponds to constants defined in Androids `android.os.Environment` class.
 ///
 /// https://developer.android.com/reference/android/os/Environment.html#fields_1
-enum AndroidStorageDirectory {
+enum StorageDirectory {
   /// Contains audio files that should be treated as music.
   ///
   /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_MUSIC.
diff --git a/packages/path_provider/path_provider_platform_interface/lib/src/method_channel_path_provider.dart b/packages/path_provider/path_provider_platform_interface/lib/src/method_channel_path_provider.dart
@@ -66,7 +66,7 @@ class MethodChannelPathProvider extends PathProviderPlatform {
   }
 
   Future<List<String>> getExternalStoragePaths({
-    AndroidStorageDirectory type,
+    StorageDirectory type,
   }) async {
     if (!_platform.isAndroid) {
       throw UnsupportedError('Functionality only available on Android');
diff --git a/packages/path_provider/path_provider_platform_interface/pubspec.yaml b/packages/path_provider/path_provider_platform_interface/pubspec.yaml
@@ -3,7 +3,7 @@ description: A common platform interface for the path_provider plugin.
 homepage: https://github.com/flutter/plugins/tree/master/packages/path_provider/path_provider_platform_interface
 # 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: 1.0.0
+version: 1.0.1
 
 dependencies:
   flutter:
diff --git a/packages/path_provider/path_provider_platform_interface/test/method_channel_path_provider_test.dart b/packages/path_provider/path_provider_platform_interface/test/method_channel_path_provider_test.dart
@@ -147,8 +147,8 @@ void main() {
       }
     });
 
-    for (AndroidStorageDirectory type
-        in AndroidStorageDirectory.values + <AndroidStorageDirectory>[null]) {
+    for (StorageDirectory type
+        in StorageDirectory.values + <StorageDirectory>[null]) {
       test('getExternalStoragePaths (type: $type) android succeeds', () async {
         final List<String> result =
             await methodChannelPathProvider.getExternalStoragePaths(type: type);

Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ class MethodChannelPathProvider extends PathProviderPlatform {`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`Future<List<String>> getExternalStoragePaths({`
`69`		`- AndroidStorageDirectory type,`
	`69`	`+ StorageDirectory type,`
`70`	`70`	`}) async {`
`71`	`71`	`if (!_platform.isAndroid) {`
`72`	`72`	`throw UnsupportedError('Functionality only available on Android');`