Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(210)

Unified Diff: pkg/barback/lib/src/transformer/aggregate_transformer.dart

Issue 262173009: Add aggregate transformer types to barback. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: code review Created 6 years, 7 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: pkg/barback/lib/src/transformer/aggregate_transformer.dart
diff --git a/pkg/barback/lib/src/transformer/aggregate_transformer.dart b/pkg/barback/lib/src/transformer/aggregate_transformer.dart
new file mode 100644
index 0000000000000000000000000000000000000000..959b3e75a105331b06982d154b0e83070e7b1da5
--- /dev/null
+++ b/pkg/barback/lib/src/transformer/aggregate_transformer.dart
@@ -0,0 +1,58 @@
+// Copyright (c) 2014, 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.transformer.aggregate_transformer;
+
+import '../asset/asset_id.dart';
+import 'aggregate_transform.dart';
+
+/// An alternate interface for transformers that want to perform aggregate
+/// transformations on multiple inputs without any individual one of them being
+/// considered "primary".
+///
+/// This is useful for transformers like image spriting, where all the images in
+/// a directory need to be combined into a single image. A normal [Transformer]
+/// can't do this gracefully since when it's running on a single image, it has
+/// no way of knowing what other images exist to request as secondary inputs.
+///
+/// Aggregate transformers work by classifying assets into different groups
+/// based on their ids in [classifyPrimary]. Then [apply] is run once for each
+/// group. For example, a spriting transformer might put each image asset into a
+/// group identified by its directory name. All images in a given directory will
+/// end up in the same group, and they'll all be passed to one [apply] call.
+///
+/// If possible, aggregate transformers should implement
+/// [DeclaringAggregateTransformer] as well to help barback optimize the package
+/// graph.
+abstract class AggregateTransformer {
+ /// Classifies an asset id by returning a key identifying which group the
+ /// asset should be placed in.
+ ///
+ /// All assets for which [classifyPrimary] returns the same key are passed
+ /// together to the same [apply] call.
+ ///
+ /// Any string can be used to classify an asset. If possible, though, this
+ /// should return a path-like string to aid in logging. If [classifyPrimary]
+ /// needs to do asynchronous work, it can also return a [Future] that
+ /// completes to the key.
+ ///
+ /// A return value of `null` indicates that the transformer is not interested
+ /// in an asset. Assets with a key of `null` will not be passed to any [apply]
+ /// call; this is equivalent to [Transformer.isPrimary] returning `false`.
+ String classifyPrimary(AssetId id);
+
+ /// Runs this transformer on a group of primary inputs specified by
+ /// [transform].
+ ///
+ /// If this does asynchronous work, it should return a [Future] that completes
+ /// once it's finished.
+ ///
+ /// This may complete before [AggregateTransform.primarInputs] is closed. For
+ /// example, it may know that each key will only have two inputs associated
+ /// with it, and so use `transform.primaryInputs.take(2)` to access only those
+ /// inputs.
+ apply(AggregateTransform transform);
+
+ String toString() => runtimeType.toString().replaceAll("Transformer", "");
+}
« no previous file with comments | « pkg/barback/lib/src/transformer/aggregate_transform.dart ('k') | pkg/barback/lib/src/transformer/base_transform.dart » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698