Binary assets and more unit tests for Asset.

pkg/barback/lib/src/asset.dart

 // Copyright (c) 2013, 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.
 
 library barback.asset;
 
 import 'dart:async';
 import 'dart:io';
+import 'dart:utf';
 
 import 'asset_id.dart';
 
 /// A blob of content.
 ///
 /// Assets may come from the file system, or as the output of a [Transformer].
 /// They are identified by [AssetId].
 abstract class Asset {
   /// The ID for this asset.
   final AssetId id;
 
   Asset(this.id);
 
-  factory Asset.fromFile(AssetId id, File file) {
-    return new _FileAsset(id, file);
+  factory Asset.fromBytes(AssetId id, List<int> bytes) =>
+      new _BinaryAsset(id, bytes);
+
+  factory Asset.fromFile(AssetId id, File file) =>
+      new _FileAsset(id, file);
+
+  factory Asset.fromString(AssetId id, String content) =>
+      new _StringAsset(id, content);
+
+  factory Asset.fromPath(AssetId id, String path) =>
+      new _FileAsset(id, new File(path));
+
+  /// Returns the contents of the asset as a string.
+  ///
+  /// If the asset was created from a [String] the original string is always
+  /// returned and [encoding] is ignored. Otherwise, the binary data of the
+  /// asset is decoded using [encoding], which defaults to [Encoding.UTF_8].
+  Future<String> readAsString({Encoding encoding});
+
+  /// Streams the binary contents of the asset.
+  ///
+  /// If the asset was created from a [String], this returns its UTF-8 encoding.
+  Stream<List<int>> read();
+}
+
+/// An asset whose data is stored in a list of bytes.
+class _BinaryAsset extends Asset {
+  final List<int> _contents;
+
+  _BinaryAsset(AssetId id, this._contents)
+      : super(id);
+
+  Future<String> readAsString({Encoding encoding}) {
+    if (encoding == null) encoding = Encoding.UTF_8;
+
+    // TODO(rnystrom): When #6284 is fixed, just use that. Until then, only
+    // UTF-8 is supported. :(
+    if (encoding != Encoding.UTF_8) {
+      throw new UnsupportedError(
+          "${encoding.name} is not a supported encoding.");
+    }
+
+    return new Future.value(decodeUtf8(_contents));
   }
 
-  factory Asset.fromString(AssetId id, String content) {
-    return new _StringAsset(id, content);
+  Stream<List<int>> read() => new Future<List<int>>.value(_contents).asStream();
+
+  String toString() {
+    var buffer = new StringBuffer();
+    buffer.write("Bytes [");
+
+    writeByte(int i) {
+      var byte = _contents[i];
+      var digits = "0123456789abcdef";
+      buffer.write(digits[(byte ~/ 16) % 16]);
+      buffer.write(digits[byte % 16]);

[nweiz, 2013/07/08 22:50:46]

Add an intToHex function in utils.

[Bob Nystrom, 2013/07/08 23:26:04]

Done.

+    }
+
+    // Don't show the whole list if it's long.
+    if (_contents.length > 10) {

[nweiz, 2013/07/08 22:50:46]

It's weird that an 11-byte buffer is abbreviated to something longer than it
would have been un-abbreviated. This abbreviation scheme only starts to save
space with _contents.length > 12.

[Bob Nystrom, 2013/07/08 23:26:04]

I suppose so, but I think this is tolerable balance between user-friendly output
and simple code. toString() is already the longest method in the class. :)

[nweiz, 2013/07/09 02:00:01]

All you have to do is change "> 10" to "> 11".

[Bob Nystrom, 2013/07/09 16:26:03]

Done.

+      for (var i = 0; i < 5; i++) {
+        writeByte(i);
+        buffer.write(" ");
+      }
+
+      buffer.write("...");
+
+      for (var i = _contents.length - 5; i < _contents.length; i++) {
+        buffer.write(" ");
+        writeByte(i);
+      }
+    } else {
+      for (var i = 0; i < _contents.length; i++) {
+        if (i > 0) buffer.write(" ");
+        writeByte(i);
+      }
+    }
+
+    buffer.write("]");
+    return buffer.toString();
   }
-
-  factory Asset.fromPath(AssetId id, String path) {
-    return new _FileAsset(id, new File(path));
-  }
-
-  // TODO(rnystrom): This prevents users from defining their own
-  // implementations of Asset. Use serialization package instead.
-  factory Asset.deserialize(data) {
-    // TODO(rnystrom): Handle errors.
-    var id = new AssetId.parse(data[1]);
-    switch (data[0]) {
-      case "file": return new _FileAsset(id, new File(data[2])); break;
-      case "string": return new _StringAsset(id, data[2]); break;
-    }
-  }
-
-  /// Returns the contents of the asset as a string.
-  // TODO(rnystrom): Figure out how binary assets should be handled.
-  Future<String> readAsString();
-
-  /// Streams the contents of the asset.
-  Stream<List<int>> read();
-
-  /// Serializes this [Asset] to an object that can be sent across isolates
-  /// and passed to [deserialize].
-  Object serialize();
 }
 
 /// An asset backed by a file on the local file system.
 class _FileAsset extends Asset {
   final File _file;
   _FileAsset(AssetId id, this._file)
       : super(id);
 
-  Future<String> readAsString() => _file.readAsString();
+  Future<String> readAsString({Encoding encoding}) {
+    if (encoding == null) encoding = Encoding.UTF_8;
+    return _file.readAsString(encoding: encoding);
+  }
+
   Stream<List<int>> read() => _file.openRead();
 
   String toString() => 'File "${_file.path}"';
-
-  Object serialize() => ["file", id.serialize(), _file.path];
 }
 
 /// An asset whose data is stored in a string.
-// TODO(rnystrom): Have something similar for in-memory binary assets.
 class _StringAsset extends Asset {
   final String _contents;
 
   _StringAsset(AssetId id, this._contents)
       : super(id);
 
-  Future<String> readAsString() => new Future.value(_contents);
+  Future<String> readAsString({Encoding encoding}) =>
+      new Future.value(_contents);
 
-  // TODO(rnystrom): Implement this and handle encoding.
-  Stream<List<int>> read() => throw new UnimplementedError();
+  Stream<List<int>> read() =>
+      new Future<List<int>>.value(encodeUtf8(_contents)).asStream();
 
   String toString() {
     // Don't show the whole string if it's long.
     var contents = _contents;
     if (contents.length > 40) {
       contents = contents.substring(0, 20) + " ... " +
                  contents.substring(contents.length - 20);
     }
 
     contents = _escape(contents);
     return 'String "$contents"';
   }
 
-  Object serialize() => ["string", id.serialize(), _contents];
-
   String _escape(String string) {
     return string
         .replaceAll("\"", r'\"')
         .replaceAll("\n", r"\n")
         .replaceAll("\r", r"\r")
         .replaceAll("\t", r"\t");
   }
 }