General cleanup of package:file (#81)

* Fix/update analysis options
* Fix some linter errors
* Run dartfmt
* Fix some Dart 2 strong-mode type checks
* Remove usage of "part" and "part of" in the forwarding, memory, and local backends.
* Fix AppVeyor and Travis scripts to work only for Dart 2
* Comment out test that's causing problems with newer SDKs

Author: tvolkert

.gitignore

@@ -1,6 +1,7 @@
 ### Dart template
 # Don’t commit the following directories created by pub.
 .buildlog
+.dart_tool/
 .pub/
 build/
 packages

.travis.yml

@@ -1,7 +1,6 @@
 language: dart
 
 dart:
-  - stable
   - dev
 
 dart_task:

CHANGELOG.md

@@ -1,7 +1,11 @@
-#### 4.0.0 
+#### 4.0.1
 
-* Change method signature for `RecordingRandomAccessFile._close` to return a 
-  `Future<void>` instead of `Future<RandomAccessFile>`. This follows a change in 
+* General library cleanup
+
+#### 4.0.0
+
+* Change method signature for `RecordingRandomAccessFile._close` to return a
+  `Future<void>` instead of `Future<RandomAccessFile>`. This follows a change in
   dart:io, Dart SDK `2.0.0-dev.40`.
 
 #### 3.0.0

analysis_options.yaml

@@ -1,7 +1,8 @@
 analyzer:
-  strong-mode: true
+  strong-mode:
+    implicit-dynamic: false
   language:
-    enableStrictCallChecks: true
+    enablePreviewDart2: true
     enableSuperMixins: true
   errors:
     # treat missing required parameters as a warning (not a hint)
@@ -63,7 +64,7 @@ linter:
     - type_annotate_public_apis
     - type_init_formals
     # TODO - unawaited_futures (https://github.com/dart-lang/linter/issues/419)
-    - unnecessary_brace_in_string_interp
+    - unnecessary_brace_in_string_interps
     - unnecessary_getters_setters
 
     # === pub rules ===

appveyor.yml

@@ -1,13 +1,14 @@
 install:
-  - choco install dart-sdk
+  - ps: wget https://storage.googleapis.com/dart-archive/channels/dev/release/latest/sdk/dartsdk-windows-x64-release.zip -OutFile dart-sdk.zip
+  - cmd: echo "Unzipping dart-sdk..."
+  - cmd: 7z x dart-sdk.zip -o"C:\tools" -y > nul
   - ps: refreshenv
-  - refreshenv
-  - set DART_DIR=c:\tools\dart-sdk\bin
-  - set PUB_EXECUTABLE=pub.bat
+  - set PATH=%PATH%;C:\tools\dart-sdk\bin
+  - set PATH=%PATH%;%APPDATA%\Pub\Cache\bin
   - ps: pwd
   - pub get
 
 build: off
 
 test_script:
-  - pub run test
+  - pub run test -j1

lib/src/backends/chroot/chroot_directory.dart

@@ -5,7 +5,7 @@
 part of file.src.backends.chroot;
 
 class _ChrootDirectory extends _ChrootFileSystemEntity<Directory, io.Directory>
-    with ForwardingDirectory, common.DirectoryAddOnsMixin {
+    with ForwardingDirectory<Directory>, common.DirectoryAddOnsMixin {
   _ChrootDirectory(ChrootFileSystem fs, String path) : super(fs, path);
 
   factory _ChrootDirectory.wrapped(

lib/src/backends/chroot/chroot_file.dart

@@ -257,7 +257,7 @@ class _ChrootFile extends _ChrootFileSystemEntity<File, io.File>
   @override
   IOSink openWrite({
     FileMode mode: FileMode.WRITE,
-    Encoding encoding: UTF8,
+    Encoding encoding: utf8,
   }) =>
       getDelegate(followLinks: true).openWrite(mode: mode, encoding: encoding);
 
@@ -270,19 +270,19 @@ class _ChrootFile extends _ChrootFileSystemEntity<File, io.File>
       getDelegate(followLinks: true).readAsBytesSync();
 
   @override
-  Future<String> readAsString({Encoding encoding: UTF8}) =>
+  Future<String> readAsString({Encoding encoding: utf8}) =>
       getDelegate(followLinks: true).readAsString(encoding: encoding);
 
   @override
-  String readAsStringSync({Encoding encoding: UTF8}) =>
+  String readAsStringSync({Encoding encoding: utf8}) =>
       getDelegate(followLinks: true).readAsStringSync(encoding: encoding);
 
   @override
-  Future<List<String>> readAsLines({Encoding encoding: UTF8}) =>
+  Future<List<String>> readAsLines({Encoding encoding: utf8}) =>
       getDelegate(followLinks: true).readAsLines(encoding: encoding);
 
   @override
-  List<String> readAsLinesSync({Encoding encoding: UTF8}) =>
+  List<String> readAsLinesSync({Encoding encoding: utf8}) =>
       getDelegate(followLinks: true).readAsLinesSync(encoding: encoding);
 
   @override
@@ -310,7 +310,7 @@ class _ChrootFile extends _ChrootFileSystemEntity<File, io.File>
   Future<File> writeAsString(
     String contents, {
     FileMode mode: FileMode.WRITE,
-    Encoding encoding: UTF8,
+    Encoding encoding: utf8,
     bool flush: false,
   }) async =>
       wrap(await getDelegate(followLinks: true).writeAsString(
@@ -324,7 +324,7 @@ class _ChrootFile extends _ChrootFileSystemEntity<File, io.File>
   void writeAsStringSync(
     String contents, {
     FileMode mode: FileMode.WRITE,
-    Encoding encoding: UTF8,
+    Encoding encoding: utf8,
     bool flush: false,
   }) =>
       getDelegate(followLinks: true).writeAsStringSync(

lib/src/backends/local.dart

@@ -2,18 +2,4 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-library file.src.backends.local;
-
-import 'dart:async';
-
-import 'package:file/src/common.dart' as common;
-import 'package:file/src/forwarding.dart';
-import 'package:file/src/io.dart' as io;
-import 'package:file/file.dart';
-import 'package:path/path.dart' as p;
-
-part 'local/local_directory.dart';
-part 'local/local_file.dart';
-part 'local/local_file_system.dart';
-part 'local/local_file_system_entity.dart';
-part 'local/local_link.dart';
+export 'local/local_file_system.dart' show LocalFileSystem;

lib/src/backends/local/local_directory.dart

@@ -2,12 +2,19 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-part of file.src.backends.local;
+import 'package:file/src/common.dart' as common;
+import 'package:file/src/forwarding.dart';
+import 'package:file/src/io.dart' as io;
+import 'package:file/file.dart';
 
-class _LocalDirectory
-    extends _LocalFileSystemEntity<_LocalDirectory, io.Directory>
-    with ForwardingDirectory, common.DirectoryAddOnsMixin {
-  _LocalDirectory(FileSystem fs, io.Directory delegate) : super(fs, delegate);
+import 'local_file_system_entity.dart';
+
+/// [Directory] implementation that forwards all calls to `dart:io`.
+class LocalDirectory extends LocalFileSystemEntity<LocalDirectory, io.Directory>
+    with ForwardingDirectory<LocalDirectory>, common.DirectoryAddOnsMixin {
+  /// Instantiates a new [LocalDirectory] tied to the specified file system
+  /// and delegating to the specified [delegate].
+  LocalDirectory(FileSystem fs, io.Directory delegate) : super(fs, delegate);
 
   @override
   String toString() => "LocalDirectory: '$path'";

lib/src/backends/local/local_file.dart

@@ -2,11 +2,18 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-part of file.src.backends.local;
+import 'package:file/src/forwarding.dart';
+import 'package:file/src/io.dart' as io;
+import 'package:file/file.dart';
 
-class _LocalFile extends _LocalFileSystemEntity<File, io.File>
+import 'local_file_system_entity.dart';
+
+/// [File] implementation that forwards all calls to `dart:io`.
+class LocalFile extends LocalFileSystemEntity<File, io.File>
     with ForwardingFile {
-  _LocalFile(FileSystem fs, io.File delegate) : super(fs, delegate);
+  /// Instantiates a new [LocalFile] tied to the specified file system
+  /// and delegating to the specified [delegate].
+  LocalFile(FileSystem fs, io.File delegate) : super(fs, delegate);
 
   @override
   String toString() => "LocalFile: '$path'";

lib/src/backends/local/local_file_system.dart

@@ -2,7 +2,15 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-part of file.src.backends.local;
+import 'dart:async';
+
+import 'package:file/src/io.dart' as io;
+import 'package:file/file.dart';
+import 'package:path/path.dart' as p;
+
+import 'local_directory.dart';
+import 'local_file.dart';
+import 'local_link.dart';
 
 /// A wrapper implementation around `dart:io`'s implementation.
 ///
@@ -14,13 +22,13 @@ class LocalFileSystem extends FileSystem {
 
   @override
   Directory directory(dynamic path) =>
-      new _LocalDirectory(this, new io.Directory(getPath(path)));
+      new LocalDirectory(this, new io.Directory(getPath(path)));
 
   @override
-  File file(dynamic path) => new _LocalFile(this, new io.File(getPath(path)));
+  File file(dynamic path) => new LocalFile(this, new io.File(getPath(path)));
 
   @override
-  Link link(dynamic path) => new _LocalLink(this, new io.Link(getPath(path)));
+  Link link(dynamic path) => new LocalLink(this, new io.Link(getPath(path)));
 
   @override
   p.Context get path => new p.Context();
@@ -30,7 +38,7 @@ class LocalFileSystem extends FileSystem {
   /// platform-dependent, and may be set by an environment variable.
   @override
   Directory get systemTempDirectory =>
-      new _LocalDirectory(this, io.Directory.systemTemp);
+      new LocalDirectory(this, io.Directory.systemTemp);
 
   @override
   Directory get currentDirectory => directory(io.Directory.current.path);

lib/src/backends/local/local_file_system_entity.dart

@@ -2,17 +2,26 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-part of file.src.backends.local;
+import 'package:file/src/forwarding.dart';
+import 'package:file/src/io.dart' as io;
+import 'package:file/file.dart';
 
-abstract class _LocalFileSystemEntity<T extends FileSystemEntity,
+import 'local_directory.dart';
+import 'local_file.dart';
+import 'local_link.dart';
+
+/// [FileSystemEntity] implementation that forwards all calls to `dart:io`.
+abstract class LocalFileSystemEntity<T extends FileSystemEntity,
     D extends io.FileSystemEntity> extends ForwardingFileSystemEntity<T, D> {
   @override
   final FileSystem fileSystem;
 
   @override
   final D delegate;
 
-  _LocalFileSystemEntity(this.fileSystem, this.delegate);
+  /// Instantiates a new [LocalFileSystemEntity] tied to the specified file
+  /// system and delegating to the specified [delegate].
+  LocalFileSystemEntity(this.fileSystem, this.delegate);
 
   @override
   String get dirname => fileSystem.path.dirname(path);
@@ -22,11 +31,11 @@ abstract class _LocalFileSystemEntity<T extends FileSystemEntity,
 
   @override
   Directory wrapDirectory(io.Directory delegate) =>
-      new _LocalDirectory(fileSystem, delegate);
+      new LocalDirectory(fileSystem, delegate);
 
   @override
-  File wrapFile(io.File delegate) => new _LocalFile(fileSystem, delegate);
+  File wrapFile(io.File delegate) => new LocalFile(fileSystem, delegate);
 
   @override
-  Link wrapLink(io.Link delegate) => new _LocalLink(fileSystem, delegate);
+  Link wrapLink(io.Link delegate) => new LocalLink(fileSystem, delegate);
 }

lib/src/backends/local/local_link.dart

@@ -2,11 +2,18 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-part of file.src.backends.local;
+import 'package:file/src/forwarding.dart';
+import 'package:file/src/io.dart' as io;
+import 'package:file/file.dart';
 
-class _LocalLink extends _LocalFileSystemEntity<Link, io.Link>
+import 'local_file_system_entity.dart';
+
+/// [Link] implementation that forwards all calls to `dart:io`.
+class LocalLink extends LocalFileSystemEntity<Link, io.Link>
     with ForwardingLink {
-  _LocalLink(FileSystem fs, io.Link delegate) : super(fs, delegate);
+  /// Instantiates a new [LocalLink] tied to the specified file system
+  /// and delegating to the specified [delegate].
+  LocalLink(FileSystem fs, io.Link delegate) : super(fs, delegate);
 
   @override
   String toString() => "LocalLink: '$path'";

lib/src/backends/memory.dart

@@ -2,22 +2,4 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-library file.src.backends.memory;
-
-import 'dart:async';
-import 'dart:convert';
-import 'dart:math' show min;
-
-import 'package:file/file.dart';
-import 'package:file/src/common.dart' as common;
-import 'package:file/src/io.dart' as io;
-import 'package:path/path.dart' as p;
-
-part 'memory/memory_directory.dart';
-part 'memory/memory_file.dart';
-part 'memory/memory_file_stat.dart';
-part 'memory/memory_file_system.dart';
-part 'memory/memory_file_system_entity.dart';
-part 'memory/memory_link.dart';
-part 'memory/node.dart';
-part 'memory/utils.dart';
+export 'memory/memory_file_system.dart' show MemoryFileSystem;

lib/src/backends/memory/common.dart

@@ -0,0 +1,18 @@
+// Copyright (c) 2018, the Dart project authors.  Please see the AUTHORS file
+// for details. All rights reserved. Use of this source code is governed by a
+// BSD-style license that can be found in the LICENSE file.
+
+import 'package:file/src/common.dart' as common;
+
+/// The file separator.
+const String separator = '/';
+
+/// Generates a path to use in error messages.
+typedef dynamic PathGenerator();
+
+/// Throws a `FileSystemException` if [object] is null.
+void checkExists(Object object, PathGenerator path) {
+  if (object == null) {
+    throw common.noSuchFileOrDirectory(path());
+  }
+}