fix a regression with generating package docs

Author: devoncarew

CONTRIBUTING.md

@@ -18,7 +18,6 @@ yet in the issue tracker, start by opening an issue. Thanks!
 
 [![Build Status](https://travis-ci.org/dart-lang/dartdoc.svg)](https://travis-ci.org/dart-lang/dartdoc)
 [![Build status](https://ci.appveyor.com/api/projects/status/s6sh69et2ga00dlu?svg=true)](https://ci.appveyor.com/project/devoncarew/dartdoc)
-[![Coverage Status](https://img.shields.io/coveralls/dart-lang/dartdoc.svg)](https://coveralls.io/r/dart-lang/dartdoc)
 
 ## Making Changes
 

bin/dartdoc.dart

@@ -106,11 +106,20 @@ main(List<String> arguments) async {
       : new PackageMeta.fromDir(inputDir);
 
   if (!packageMeta.isValid) {
-    print('Unable to generate documentation.');
-    packageMeta.getInvalidReasons().map((r) => '* $r').forEach(print);
+    stderr.writeln(
+        'Unable to generate documentation: ${packageMeta.getInvalidReasons().first}.');
     exit(1);
   }
 
+  if (!packageMeta.isSdk && packageMeta.needsPubGet) {
+    try {
+      packageMeta.runPubGet();
+    } catch (e) {
+      stderr.writeln('$e');
+      exit(1);
+    }
+  }
+
   print("Generating documentation for '${packageMeta}' into "
       "${outputDir.absolute.path}${Platform.pathSeparator}");
   print('');

lib/dartdoc.dart

@@ -12,9 +12,7 @@ import 'package:analyzer/dart/element/element.dart';
 import 'package:analyzer/file_system/file_system.dart' as fileSystem;
 import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/source/embedder.dart';
-import 'package:analyzer/source/package_map_provider.dart';
 import 'package:analyzer/source/package_map_resolver.dart';
-import 'package:analyzer/source/pub_package_map_provider.dart';
 import 'package:analyzer/source/sdk_ext.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/error.dart';
@@ -23,7 +21,8 @@ import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/sdk_io.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/source_io.dart';
-import 'package:path/path.dart' as p;
+import 'package:package_config/discovery.dart' as package_config;
+import 'package:path/path.dart' as path;
 
 import 'src/config.dart';
 import 'src/generator.dart';
@@ -42,7 +41,7 @@ const String name = 'dartdoc';
 // Update when pubspec version changes.
 const String version = '0.9.7+1';
 
-final String defaultOutDir = p.join('doc', 'api');
+final String defaultOutDir = path.join('doc', 'api');
 
 /// Initialize and setup the generators.
 Future<List<Generator>> initGenerators(String url, List<String> headerFilePaths,
@@ -156,21 +155,17 @@ class DartDoc {
     DartSdk sdk = new DirectoryBasedDartSdk(new JavaFile(sdkDir.path));
     List<UriResolver> resolvers = [];
 
-    fileSystem.Resource cwd =
+    fileSystem.Folder cwd =
         PhysicalResourceProvider.INSTANCE.getResource(rootDir.path);
-    PubPackageMapProvider pubPackageMapProvider =
-        new PubPackageMapProvider(PhysicalResourceProvider.INSTANCE, sdk);
-    PackageMapInfo packageMapInfo =
-        pubPackageMapProvider.computePackageMap(cwd);
-    Map<String, List<fileSystem.Folder>> packageMap = packageMapInfo.packageMap;
+    Map<String, List<fileSystem.Folder>> packageMap = _calculatePackageMap(cwd);
     EmbedderUriResolver embedderUriResolver;
     if (packageMap != null) {
       resolvers.add(new SdkExtUriResolver(packageMap));
       resolvers.add(new PackageMapUriResolver(
           PhysicalResourceProvider.INSTANCE, packageMap));
 
-      embedderUriResolver = new EmbedderUriResolver(
-          new EmbedderYamlLocator(packageMap).embedderYamls);
+      var embedderYamls = new EmbedderYamlLocator(packageMap).embedderYamls;
+      embedderUriResolver = new EmbedderUriResolver(embedderYamls);
       if (embedderUriResolver.length == 0) {
         // The embedder uri resolver has no mappings. Use the default Dart SDK
         // uri resolver.
@@ -183,7 +178,8 @@ class DartDoc {
     } else {
       resolvers.add(new DartUriResolver(sdk));
     }
-    resolvers.add(new FileUriResolver());
+    resolvers.add(
+        new fileSystem.ResourceUriResolver(PhysicalResourceProvider.INSTANCE));
 
     SourceFactory sourceFactory = new SourceFactory(resolvers);
 
@@ -262,7 +258,7 @@ class DartDoc {
               new _Error(error, info.lineInfo, packageMeta.dir.path));
         })
         .where((_Error error) => error.isError)
-        .toList() as List<_Error>..sort();
+        .toList()..sort();
 
     double seconds = _stopwatch.elapsedMilliseconds / 1000.0;
     print("Parsed ${libraries.length} "
@@ -280,6 +276,23 @@ class DartDoc {
   }
 }
 
+Map<String, List<fileSystem.Folder>> _calculatePackageMap(
+    fileSystem.Folder dir) {
+  Map<String, List<fileSystem.Folder>> map = new Map();
+  var info = package_config.findPackagesFromFile(dir.toUri());
+
+  for (String name in info.packages) {
+    Uri uri = info.asMap()[name];
+    fileSystem.Resource resource =
+        PhysicalResourceProvider.INSTANCE.getResource(uri.toFilePath());
+    if (resource is fileSystem.Folder) {
+      map[name] = [resource];
+    }
+  }
+
+  return map;
+}
+
 /// This class is returned if dartdoc fails in an expected way (for instance, if
 /// there is an analysis error in the library).
 class DartDocFailure {

lib/src/package_meta.dart

@@ -19,6 +19,9 @@ abstract class PackageMeta {
       new _SdkMeta(sdkDir, sdkReadmePath: sdkReadmePath);
 
   bool get isSdk;
+  bool get needsPubGet => false;
+
+  void runPubGet();
 
   String get name;
   String get version;
@@ -84,6 +87,23 @@ class _FilePackageMeta extends PackageMeta {
   @override
   bool get isSdk => false;
 
+  @override
+  bool get needsPubGet =>
+      !(new File(path.join(dir.path, '.packages')).existsSync());
+
+  @override
+  void runPubGet() {
+    ProcessResult result =
+        Process.runSync('pub', ['get'], workingDirectory: dir.path);
+
+    if (result.exitCode != 0) {
+      StringBuffer buf = new StringBuffer();
+      buf.writeln('${result.stdout}');
+      buf.writeln('${result.stderr}');
+      throw buf.toString().trim();
+    }
+  }
+
   @override
   String get name => _pubspec['name'];
   @override
@@ -126,9 +146,9 @@ class _FilePackageMeta extends PackageMeta {
   List<String> getInvalidReasons() {
     List<String> reasons = <String>[];
     if (_pubspec == null || _pubspec.isEmpty) {
-      reasons.add('No pubspec.yaml found');
+      reasons.add('no pubspec.yaml found');
     } else if (!_pubspec.containsKey('name')) {
-      reasons.add('No name found in pubspec.yaml');
+      reasons.add('no name found in pubspec.yaml');
     }
     return reasons;
   }
@@ -157,6 +177,11 @@ class _SdkMeta extends PackageMeta {
   @override
   bool get isSdk => true;
 
+  @override
+  void runPubGet() {
+    throw 'unsupported operation';
+  }
+
   @override
   String get name => 'Dart SDK';
   @override

pubspec.lock

@@ -6,7 +6,7 @@ packages:
       name: analyzer
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.27.4-alpha.18"
+    version: "0.28.1"
   ansicolor:
     description:
       name: ansicolor
@@ -133,6 +133,12 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.12.0+2"
+  meta:
+    description:
+      name: meta
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.2"
   mime:
     description:
       name: mime
@@ -157,6 +163,12 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.1.5"
+  package_resolver:
+    description:
+      name: package_resolver
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.2"
   path:
     description:
       name: path
@@ -199,6 +211,12 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "0.6.5+2"
+  shelf_packages_handler:
+    description:
+      name: shelf_packages_handler
+      url: "https://pub.dartlang.org"
+    source: hosted
+    version: "1.0.0"
   shelf_static:
     description:
       name: shelf_static
@@ -216,7 +234,7 @@ packages:
       name: source_map_stack_trace
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "1.0.4"
+    version: "1.1.3"
   source_maps:
     description:
       name: source_maps
@@ -258,7 +276,7 @@ packages:
       name: test
       url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.12.15+1"
+    version: "0.12.15+6"
   typed_data:
     description:
       name: typed_data
@@ -307,4 +325,5 @@ packages:
       url: "https://pub.dartlang.org"
     source: hosted
     version: "2.1.10"
-sdk: ">=1.16.0 <1.20.0"
+sdks:
+  dart: ">=1.16.0 <2.0.0"

pubspec.yaml

@@ -7,14 +7,15 @@ homepage: https://github.com/dart-lang/dartdoc
 environment:
   sdk: '>=1.14.0 <2.0.0'
 dependencies:
-  analyzer: 0.27.4-alpha.18
+  analyzer: ^0.28.1
   args: ^0.13.0
   cli_util: ^0.0.1
   collection: ^1.2.0
   html: ^0.12.1
   logging: '>=0.9.0 <0.12.0'
   markdown: ^0.10.1
   mustache4dart: ^1.0.9
+  package_config: ^0.1.5
   path: ^1.3.0
   quiver: '>=0.18.0 <0.23.0'
   resource: ^1.1.0

test/package_meta_test.dart

@@ -27,7 +27,7 @@ void main() {
     test('is not valid', () {
       expect(p.isValid, isFalse);
       expect(p.getInvalidReasons(), isNotEmpty);
-      expect(p.getInvalidReasons(), contains('No pubspec.yaml found'));
+      expect(p.getInvalidReasons(), contains('no pubspec.yaml found'));
     });
   });
 

test/src/utils.dart

@@ -7,6 +7,8 @@ library test_utils;
 import 'dart:io';
 
 import 'package:analyzer/dart/element/element.dart';
+import 'package:analyzer/file_system/file_system.dart';
+import 'package:analyzer/file_system/physical_file_system.dart';
 import 'package:analyzer/src/generated/engine.dart';
 import 'package:analyzer/src/generated/java_io.dart';
 import 'package:analyzer/src/generated/sdk.dart';
@@ -69,7 +71,7 @@ class AnalyzerHelper {
   AnalyzerHelper() {
     List<UriResolver> resolvers = [
       new DartUriResolver(sdkDir),
-      new FileUriResolver()
+      new ResourceUriResolver(PhysicalResourceProvider.INSTANCE)
     ];
 
     SourceFactory sourceFactory = new SourceFactory(resolvers);

testing/test_package/pubspec.lock

@@ -1,3 +1,5 @@
 # Generated by pub
 # See http://pub.dartlang.org/doc/glossary.html#lockfile
 packages: {}
+sdks:
+  dart: any

testing/test_package_docs/fake/ExtraSpecialList/expand.html

@@ -158,6 +158,15 @@ <h5><a href="fake/ExtraSpecialList-class.html">ExtraSpecialList</a></h5>
 by <code>f</code> for each element of this, in iteration order.</p>
 <p>The returned <code>Iterable</code> is lazy, and calls <code>f</code> for each element
 of this every time it's iterated.</p>
+<p>Example:</p>
+<pre class="prettyprint language-dart"><code>var pairs = [[1, 2], [3, 4]];
+var flattened = pairs.expand((pair) =&gt; pair).toList();
+print(flattened); // =&gt; [1, 2, 3, 4];
+
+var input = [1, 2, 3];
+var duplicated = input.expand((i) =&gt; [i, i]).toList();
+print(duplicated); // =&gt; [1, 1, 2, 2, 3, 3]
+</code></pre>
     </section>