Allow the Git source to depend on a specific revision.

utils/pub/git_source.dart

 // Copyright (c) 2012, 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('git_source');
 
 #import('io.dart');
 #import('package.dart');
 #import('source.dart');
 #import('source_registry.dart');
@@ skipping 22 matching lines @@
    * `<package name>-<url hash>`. These are used to check out the repository
    * itself; each of the commit-specific directories are clones of a directory
    * in `cache/`.
    */
   Future<Package> installToSystemCache(PackageId id) {
     var revisionCachePath;
 
     return isGitInstalled.chain((installed) {
       if (!installed) {
         throw new Exception(
-            "Cannot install '${id.name}' from Git (${id.description}).\n"
+            "Cannot install '${id.name}' from Git (${_getUrl(id)}).\n"
             "Please ensure Git is correctly installed.");
       }
 
       return ensureDir(join(systemCacheRoot, 'cache'));
     }).chain((_) => _ensureRepoCache(id))
-      .chain((_) => _revisionCachePath(id, "HEAD"))
+      .chain((_) => _revisionCachePath(id))
       .chain((path) {
       revisionCachePath = path;
       return exists(revisionCachePath);
     }).chain((exists) {
       if (exists) return new Future.immediate(null);
       return _clone(_repoCachePath(id), revisionCachePath);
+    }).chain((_) {
+      var ref = _getRef(id);
+      if (ref == null) return new Future.immediate(null);
+      return _checkout(revisionCachePath, ref);
     }).chain((_) => Package.load(revisionCachePath, systemCache.sources));
   }
 
   /**
    * The package name of a Git repo is the name of the directory into which
    * it'll be cloned.
    */
   String packageName(description) =>
-      basename(description).replaceFirst(const RegExp("\.git\$"), "");
+    basename(_getUrl(description)).replaceFirst(const RegExp("\.git\$"), "");
 
   /**
    * Ensures [description] is a Git URL.
    */
   void validateDescription(description) {
-    if (description is! String) {
-      throw new FormatException("The description must be a git URL.");
+    // A single string is assumed to be a Git URL.
+    if (description is String) return;
+    if (description is! Map || !description.containsKey('url')) {
+      throw new FormatException("The description must be a Git URL or a map "
+          "with a 'url' key.");
+    }
+    description = new Map.from(description);
+    description.remove('url');
+    description.remove('ref');
+
+    if (!description.isEmpty()) {
+      var plural = description.length > 1;
+      var keys = Strings.join(description.keys, ', ');
+      throw new FormatException("Invalid key${plural ? 's' : ''}: $keys.");
     }
   }
 
   /**
    * Ensure that the canonical clone of the repository referred to by [id] (the
    * one in `<system cache>/git/cache`) exists and is up-to-date. Returns a
    * future that completes once this is finished and throws an exception if it
    * fails.
    */
   Future _ensureRepoCache(PackageId id) {
     var path = _repoCachePath(id);
     return exists(path).chain((exists) {
-      if (!exists) return _clone(id.description, path);
+      if (!exists) return _clone(_getUrl(id), path);
 
       return runProcess("git", ["pull", "--force"], workingDir: path,
           pipeStdout: true, pipeStderr: true).transform((result) {
         if (!result.success) throw 'Git failed.';
         return null;
       });
     });
   }
 
   /**
    * Returns a future that completes to the revision hash of the repository for
    * [id] at [ref], which can be any Git ref.
    */
   Future<String> _revisionAt(PackageId id, String ref) {
     return runProcess("git", ["rev-parse", ref],
         workingDir: _repoCachePath(id), pipeStderr: true).transform((result) {
       if (!result.success) throw 'Git failed.';
       return result.stdout[0];
     });
   }
 
   /**
    * Returns the path to the revision-specific cache of [id] at [ref], which can
    * be any Git ref.
    */
-  Future<String> _revisionCachePath(PackageId id, String ref) {
+  Future<String> _revisionCachePath(PackageId id) {
+    var ref = _getRef(id);
+    if (ref == null) ref = 'HEAD';
     return _revisionAt(id, ref).transform((rev) {
       var revisionCacheName = '${id.name}-$rev';
       return join(systemCacheRoot, revisionCacheName);
     });
   }
 
   /**
    * Clones the repo at the URI [from] to the path [to] on the local filesystem.
    */
   Future _clone(String from, String to) {
     return runProcess("git", ["clone", from, to], pipeStdout: true,
         pipeStderr: true).transform((result) {
       if (!result.success) throw 'Git failed.';
       return null;
     });
   }
 
   /**
+   * Checks out the reference [ref] in [repoPath].
+   */
+  Future _checkout(String repoPath, String ref) {

[Bob Nystrom, 2012/07/17 00:10:31]

"_checkOut". I know the command is all lowercase in git, but it seems like the
method should be camel-cased to me.

[nweiz, 2012/07/17 01:06:55]

Done.

+    return runProcess("git", ["checkout", ref], pipeStdout: true,
+        pipeStderr: true, workingDir: repoPath).transform((result) {
+      if (!result.success) throw 'Git failed.';

[Bob Nystrom, 2012/07/17 00:10:31]

Should handle this more gracefully, or at least have a TODO to do so.

[nweiz, 2012/07/17 01:06:55]

I'm not sure I agree. Since we're piping stderr, so any errors will be presented
by Git more clearly than we could do.

+      return null;
+    });
+  }
+
+  /**
    * Returns the path to the canonical clone of the repository referred to by
    * [id] (the one in `<system cache>/git/cache`).
    */
   String _repoCachePath(PackageId id) {
-    var repoCacheName = '${id.name}-${sha1(id.description)}';
+    var repoCacheName = '${id.name}-${sha1(_getUrl(id))}';
     return join(systemCacheRoot, 'cache', repoCacheName);
   }
+
+  /**
+   * Returns the repository URL for [id].
+   *
+   * [description] may be a description or a [PackageId].
+   */
+  String _getUrl(description) {
+    description = _getDescription(description);
+    if (description is String) return description;
+    return description['url'];
+  }
+
+  /**
+   * Returns the commit ref for [id], or null if none is given.
+   *
+   * [description] may be a description or a [PackageId].
+   */
+  String _getRef(description) {
+    description = _getDescription(description);
+    if (description is String) return null;
+    return description['ref'];
+  }
+
+  /**
+   * Returns [description] if it's a description, or [PackageId.description] if
+   * it's a [PackageId].
+   */
+  _getDescription(description) {
+    if (description is PackageId) return description.description;
+    return description;
+  }
 }