[path_provider] Use platform interface (flutter#2557)

* Add dart file

* Rename file

* add interface, rename files, add methods to class

* Add to method channel, not done

* Add dart file

* Rename file

* Adds method channel test

* Remove prints

* Fix imports and version

* Format and commentas

* Space

* Rename apis to path and provide only the string from the platform

* Add test and remove null

* Format

* Add export

* Add imports

* Completed apis

* Fix and works

* Improve tests

* Remove asyncs

* Add imports

* Completed apis

* Fix and works

* Update version

* Finish test

* Make results per test

* Fix

* Add dependency

* Fix typo nad enum

* Change interface version

* Address comments

* Remove mock call

* Typo and import

* Remove file

Author: franciscojma86

packages/path_provider/path_provider/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.6.3
+
+* Use `path_provider_platform_interface` in core plugin.
+
 ## 1.6.2
 
 * Move package contents into `path_provider` for platform federation.

packages/path_provider/path_provider/example/macos/Runner.xcworkspace/contents.xcworkspacedata

@@ -5,21 +5,12 @@
 import 'dart:async';
 import 'dart:io' show Directory;
 
-import 'package:flutter/services.dart';
-import 'package:meta/meta.dart';
-import 'package:platform/platform.dart';
+import 'package:path_provider_platform_interface/path_provider_platform_interface.dart';
 
-const MethodChannel _channel =
-    MethodChannel('plugins.flutter.io/path_provider');
+export 'package:path_provider_platform_interface/path_provider_platform_interface.dart'
+    show StorageDirectory;
 
-Platform _platform = const LocalPlatform();
-
-/// This API is only exposed for the unit tests. It should not be used by
-/// any code outside of the plugin itself.
-@visibleForTesting
-void setMockPathProviderPlatform(Platform platform) {
-  _platform = platform;
-}
+PathProviderPlatform get _platform => PathProviderPlatform.instance;
 
 /// Path to the temporary directory on the device that is not backed up and is
 /// suitable for storing caches of downloaded files.
@@ -33,8 +24,7 @@ void setMockPathProviderPlatform(Platform platform) {
 ///
 /// On Android, this uses the `getCacheDir` API on the context.
 Future<Directory> getTemporaryDirectory() async {
-  final String path =
-      await _channel.invokeMethod<String>('getTemporaryDirectory');
+  final String path = await _platform.getTemporaryPath();
   if (path == null) {
     return null;
   }
@@ -52,8 +42,7 @@ Future<Directory> getTemporaryDirectory() async {
 ///
 /// On Android, this function uses the `getFilesDir` API on the context.
 Future<Directory> getApplicationSupportDirectory() async {
-  final String path =
-      await _channel.invokeMethod<String>('getApplicationSupportDirectory');
+  final String path = await _platform.getApplicationSupportPath();
   if (path == null) {
     return null;
   }
@@ -67,11 +56,7 @@ Future<Directory> getApplicationSupportDirectory() async {
 /// On Android, this function throws an [UnsupportedError] as no equivalent
 /// path exists.
 Future<Directory> getLibraryDirectory() async {
-  if (_platform.isAndroid) {
-    throw UnsupportedError('Functionality not available on Android');
-  }
-  final String path =
-      await _channel.invokeMethod<String>('getLibraryDirectory');
+  final String path = await _platform.getLibraryPath();
   if (path == null) {
     return null;
   }
@@ -88,8 +73,7 @@ Future<Directory> getLibraryDirectory() async {
 /// using [getExternalStorageDirectory] instead if data is intended to be visible
 /// to the user.
 Future<Directory> getApplicationDocumentsDirectory() async {
-  final String path =
-      await _channel.invokeMethod<String>('getApplicationDocumentsDirectory');
+  final String path = await _platform.getApplicationDocumentsPath();
   if (path == null) {
     return null;
   }
@@ -105,11 +89,7 @@ Future<Directory> getApplicationDocumentsDirectory() async {
 ///
 /// On Android this uses the `getExternalFilesDir(null)`.
 Future<Directory> getExternalStorageDirectory() async {
-  if (_platform.isIOS) {
-    throw UnsupportedError('Functionality not available on iOS');
-  }
-  final String path =
-      await _channel.invokeMethod<String>('getStorageDirectory');
+  final String path = await _platform.getExternalStoragePath();
   if (path == null) {
     return null;
   }
@@ -130,65 +110,11 @@ Future<Directory> getExternalStorageDirectory() async {
 /// On Android this returns Context.getExternalCacheDirs() or
 /// Context.getExternalCacheDir() on API levels below 19.
 Future<List<Directory>> getExternalCacheDirectories() async {
-  if (_platform.isIOS) {
-    throw UnsupportedError('Functionality not available on iOS');
-  }
-  final List<String> paths =
-      await _channel.invokeListMethod<String>('getExternalCacheDirectories');
+  final List<String> paths = await _platform.getExternalCachePaths();
 
   return paths.map((String path) => Directory(path)).toList();
 }
 
-/// Corresponds to constants defined in Androids `android.os.Environment` class.
-///
-/// https://developer.android.com/reference/android/os/Environment.html#fields_1
-enum StorageDirectory {
-  /// Contains audio files that should be treated as music.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_MUSIC.
-  music,
-
-  /// Contains audio files that should be treated as podcasts.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_PODCASTS.
-  podcasts,
-
-  /// Contains audio files that should be treated as ringtones.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_RINGTONES.
-  ringtones,
-
-  /// Contains audio files that should be treated as alarm sounds.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_ALARMS.
-  alarms,
-
-  /// Contains audio files that should be treated as notification sounds.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_NOTIFICATIONS.
-  notifications,
-
-  /// Contains images. See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_PICTURES.
-  pictures,
-
-  /// Contains movies. See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_MOVIES.
-  movies,
-
-  /// Contains files of any type that have been downloaded by the user.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_DOWNLOADS.
-  downloads,
-
-  /// Used to hold both pictures and videos when the device filesystem is
-  /// treated like a camera's.
-  ///
-  /// See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_DCIM.
-  dcim,
-
-  /// Holds user-created documents. See https://developer.android.com/reference/android/os/Environment.html#DIRECTORY_DOCUMENTS.
-  documents,
-}
-
 /// Paths to directories where application specific data can be stored.
 /// These paths typically reside on external storage like separate partitions
 /// or SD cards. Phones may have multiple storage directories available.
@@ -206,13 +132,8 @@ Future<List<Directory>> getExternalStorageDirectories({
   /// how this type translates to Android storage directories.
   StorageDirectory type,
 }) async {
-  if (_platform.isIOS) {
-    throw UnsupportedError('Functionality not available on iOS');
-  }
-  final List<String> paths = await _channel.invokeListMethod<String>(
-    'getExternalStorageDirectories',
-    <String, dynamic>{'type': type?.index},
-  );
+  final List<String> paths =
+      await _platform.getExternalStoragePaths(type: type);
 
   return paths.map((String path) => Directory(path)).toList();
 }
@@ -223,14 +144,7 @@ Future<List<Directory>> getExternalStorageDirectories({
 /// On Android and on iOS, this function throws an [UnsupportedError] as no equivalent
 /// path exists.
 Future<Directory> getDownloadsDirectory() async {
-  if (_platform.isAndroid) {
-    throw UnsupportedError('Functionality not available on Android');
-  }
-  if (_platform.isIOS) {
-    throw UnsupportedError('Functionality not available on iOS');
-  }
-  final String path =
-      await _channel.invokeMethod<String>('getDownloadsDirectory');
+  final String path = await _platform.getDownloadsPath();
   if (path == null) {
     return null;
   }

packages/path_provider/path_provider/lib/path_provider.dart

@@ -2,7 +2,7 @@ name: path_provider
 description: Flutter plugin for getting commonly used locations on the Android &
   iOS file systems, such as the temp and app data directories.
 homepage: https://github.com/flutter/plugins/tree/master/packages/path_provider/path_provider
-version: 1.6.2
+version: 1.6.3
 
 flutter:
   plugin:
@@ -16,8 +16,7 @@ flutter:
 dependencies:
   flutter:
     sdk: flutter
-  platform: ^2.0.0
-  meta: ^1.0.5
+  path_provider_platform_interface: ^1.0.1
 
 dev_dependencies:
   e2e: ^0.2.1
@@ -28,6 +27,8 @@ dev_dependencies:
   test: any
   uuid: "^1.0.0"
   pedantic: ^1.8.0
+  mockito: ^4.1.1
+  plugin_platform_interface: ^1.0.0
 
 environment:
   sdk: ">=2.0.0-dev.28.0 <3.0.0"