Add FileSystem.systemTempDirectory (flutter-team-archive#55)

This provides API parity with dart:io's `Directory.systemTemp`
getter.

Author: tvolkert

lib/src/backends/chroot/chroot_file_system.dart

@@ -34,6 +34,7 @@ class ChrootFileSystem extends FileSystem {
   final FileSystem delegate;
   final String root;
 
+  String _systemTemp;
   String _cwd;
 
   /// Creates a new `ChrootFileSystem` backed by the specified [delegate] file
@@ -62,6 +63,15 @@ class ChrootFileSystem extends FileSystem {
   @override
   Link link(path) => new _ChrootLink(this, common.getPath(path));
 
+  /// Gets the system temp directory. This directory will be created on-demand
+  /// in the local root of the file system. Once created, its location is fixed
+  /// for the life of the process.
+  @override
+  Directory get systemTempDirectory {
+    _systemTemp ??= directory(_localRoot).createTempSync('.tmp_').path;
+    return directory(_systemTemp)..createSync();
+  }
+
   /// Gets the current working directory for this file system. Note that this
   /// does *not* proxy to the underlying file system's current directory in
   /// any way; the state of this file system's current directory is local to

lib/src/backends/local/local_file_system.dart

@@ -17,6 +17,13 @@ class LocalFileSystem extends FileSystem {
   @override
   Link link(path) => new _LocalLink(this, shim.newLink(path));
 
+  /// Gets the directory provided by the operating system for creating temporary
+  /// files and directories in. The location of the system temp directory is
+  /// platform-dependent, and may be set by an environment variable.
+  @override
+  Directory get systemTempDirectory =>
+      new _LocalDirectory(this, shim.systemTemp());
+
   @override
   Directory get currentDirectory => directory(shim.currentDirectory.path);
 

lib/src/backends/memory/memory_file_system.dart

@@ -44,6 +44,7 @@ typedef _Node _SegmentVisitor(
 /// as [#28078](https://github.com/dart-lang/sdk/issues/28078) is resolved.
 class MemoryFileSystem extends FileSystem {
   _RootNode _root;
+  String _systemTemp;
   String _cwd = _separator;
 
   MemoryFileSystem() {
@@ -59,6 +60,15 @@ class MemoryFileSystem extends FileSystem {
   @override
   Link link(path) => new _MemoryLink(this, common.getPath(path));
 
+  /// Gets the system temp directory. This directory will be created on-demand
+  /// in the root of the file system. Once created, its location is fixed for
+  /// the life of the process.
+  @override
+  Directory get systemTempDirectory {
+    _systemTemp ??= directory(_separator).createTempSync('.tmp_').path;
+    return directory(_systemTemp)..createSync();
+  }
+
   @override
   Directory get currentDirectory => directory(_cwd);
 

lib/src/interface/file_system.dart

@@ -24,6 +24,12 @@ abstract class FileSystem {
   /// [path] can be either a [`String`], a [`Uri`], or a [`FileSystemEntity`].
   Link link(path);
 
+  /// Gets the system temp directory.
+  ///
+  /// It is left to file system implementations to decide how to define the
+  /// "system temp directory".
+  Directory get systemTempDirectory;
+
   /// Creates a directory object pointing to the current working directory.
   Directory get currentDirectory;
 

lib/src/io/shim_dart_io.dart

@@ -7,6 +7,7 @@ import 'package:file/src/common.dart' as common;
 io.Directory newDirectory(path) => new io.Directory(common.getPath(path));
 io.File newFile(path) => new io.File(common.getPath(path));
 io.Link newLink(path) => new io.Link(common.getPath(path));
+io.Directory systemTemp() => io.Directory.systemTemp;
 io.Directory get currentDirectory => io.Directory.current;
 set currentDirectory(dynamic path) => io.Directory.current = path;
 Future<io.FileStat> stat(String path) => io.FileStat.stat(path);

lib/src/io/shim_internal.dart

@@ -8,6 +8,7 @@ dynamic _requiresIO() => throw new UnsupportedError(_requiresIOMsg);
 io.Directory newDirectory(_) => _requiresIO();
 io.File newFile(_) => _requiresIO();
 io.Link newLink(_) => _requiresIO();
+io.Directory systemTemp() => _requiresIO();
 io.Directory get currentDirectory => _requiresIO();
 set currentDirectory(dynamic _) => _requiresIO();
 Future<io.FileStat> stat(String _) => _requiresIO();

test/common_tests.dart

@@ -120,6 +120,14 @@ void runCommonTests(
         });
       });
 
+      group('systemTempDirectory', () {
+        test('existsAsDirectory', () {
+          var tmp = fs.systemTempDirectory;
+          expect(tmp, isDirectory);
+          expect(tmp.existsSync(), isTrue);
+        });
+      });
+
       group('currentDirectory', () {
         test('defaultsToRoot', () {
           expect(fs.currentDirectory.path, root);