Merge pull request #1093 from keertip/embedder

add support for _embedder.yaml file

Author: keertip

lib/dartdoc.dart

@@ -10,6 +10,7 @@ import 'dart:io';
 
 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';
@@ -128,7 +129,7 @@ class DartDoc {
   List<LibraryElement> _parseLibraries(List<String> files) {
     Set<LibraryElement> libraries = new Set();
     DartSdk sdk = new DirectoryBasedDartSdk(new JavaFile(sdkDir.path));
-    List<UriResolver> resolvers = [new DartUriResolver(sdk)];
+    List<UriResolver> resolvers = [];
 
     fileSystem.Resource cwd =
         PhysicalResourceProvider.INSTANCE.getResource(rootDir.path);
@@ -141,6 +142,20 @@ class DartDoc {
       resolvers.add(new SdkExtUriResolver(packageMap));
       resolvers.add(new PackageMapUriResolver(
           PhysicalResourceProvider.INSTANCE, packageMap));
+
+      EmbedderUriResolver embedderUriResolver = new EmbedderUriResolver(
+          new EmbedderYamlLocator(packageMap).embedderYamls);
+      if (embedderUriResolver.length == 0) {
+        // The embedder uri resolver has no mappings. Use the default Dart SDK
+        // uri resolver.
+        resolvers.add(new DartUriResolver(sdk));
+      } else {
+        // The embedder uri resolver has mappings, use it instead of the default
+        // Dart SDK uri resolver.
+        resolvers.add(embedderUriResolver);
+      }
+    } else {
+      resolvers.add(new DartUriResolver(sdk));
     }
     resolvers.add(new FileUriResolver());
 

pubspec.lock

@@ -2,9 +2,11 @@
 # See http://pub.dartlang.org/doc/glossary.html#lockfile
 packages:
   analyzer:
-    description: analyzer
+    description:
+      name: analyzer
+      url: "https://pub.dartlang.org"
     source: hosted
-    version: "0.27.1+2"
+    version: "0.27.2"
   ansicolor:
     description: ansicolor
     source: hosted

pubspec.yaml

@@ -7,7 +7,7 @@ homepage: https://github.com/dart-lang/dartdoc
 environment:
   sdk: '>=1.14.0 <2.0.0'
 dependencies:
-  analyzer: '>=0.27.0 <0.28.0'
+  analyzer: '>=0.27.2 <0.28.0'
   args: ^0.13.0
   cli_util: ^0.0.1
   collection: ^1.2.0

test/dartdoc_test.dart

@@ -99,5 +99,22 @@ void main() {
       expect(p.libraries, hasLength(7));
       expect(p.libraries.map((lib) => lib.name).contains('fake'), isFalse);
     });
+
+    test('generate docs for package with embedder yaml', () async {
+      PackageMeta meta = new PackageMeta.fromDir(testPackageWithEmbedderYaml);
+      DartDoc dartdoc = new DartDoc(
+          testPackageWithEmbedderYaml, [], getSdkDir(), [], tempDir, meta, []);
+
+      DartDocResults results = await dartdoc.generateDocs();
+      expect(results.package, isNotNull);
+
+      Package p = results.package;
+      expect(p.name, 'test_package_embedder_yaml');
+      expect(p.hasDocumentationFile, isFalse);
+      expect(p.libraries, hasLength(3));
+      expect(p.libraries.map((lib) => lib.name).contains('dart:core'), isTrue);
+      expect(p.libraries.map((lib) => lib.name).contains('dart:async'), isTrue);
+      expect(p.libraries.map((lib) => lib.name).contains('grizzly'), isTrue);
+    });
   });
 }

test/src/utils.dart

@@ -17,14 +17,16 @@ import 'package:dartdoc/src/model.dart';
 import 'package:dartdoc/src/package_meta.dart';
 import 'package:path/path.dart' as p;
 
-final Directory testPackageDir = new Directory('test_package');
-final Directory testPackageBadDir = new Directory('test_package_bad');
-final Directory testPackageWithNoReadme = new Directory('test_package_small');
-
-DartSdk sdkDir;
 AnalyzerHelper analyzerHelper;
+DartSdk sdkDir;
 Package testPackage;
+final Directory testPackageBadDir = new Directory('test_package_bad');
+
+final Directory testPackageDir = new Directory('test_package');
 Package testPackageSmall;
+final Directory testPackageWithEmbedderYaml =
+    new Directory('test_package_embedder_yaml');
+final Directory testPackageWithNoReadme = new Directory('test_package_small');
 
 void delete(Directory dir) {
   if (dir.existsSync()) dir.deleteSync(recursive: true);

test_package_docs/fake/Color-class.html

@@ -185,7 +185,7 @@ <h2>Constants</h2>
           <span class="signature">&#8594; <a href="fake/Color-class.html">Color</a></span>
         </dt>
         <dd>
-          <p></p>
+          <p>Orange</p>
           <div>
             <span class="signature"><code>const Color(2)</code></span>
           </div>
@@ -195,7 +195,7 @@ <h2>Constants</h2>
           <span class="signature">&#8594; <a href="fake/Color-class.html">Color</a></span>
         </dt>
         <dd>
-          <p></p>
+          <p>Red</p>
           <div>
             <span class="signature"><code>const Color(1)</code></span>
           </div>

test_package_embedder_yaml/lib/_embedder.yaml

@@ -0,0 +1,4 @@
+embedder_libs:
+  "dart:bear": "grizzly.dart"
+  "dart:core": "core.dart"
+  "dart:async": "async.dart"

test_package_embedder_yaml/lib/async.dart

@@ -0,0 +1,9 @@
+// Copyright (c) 2016, 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 dart.async;
+
+abstract class Future<T> {}
+
+abstract class Stream<T> {}

test_package_embedder_yaml/lib/core.dart

@@ -0,0 +1,99 @@
+// Copyright (c) 2016, 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 dart.core;
+
+external bool identical(Object a, Object b);
+
+void print(Object object) {}
+
+class bool extends Object {}
+
+abstract class Comparable<T> {
+  int compareTo(T other);
+}
+
+class DateTime extends Object {}
+
+class double extends num {}
+
+class Function {}
+
+abstract class int extends num {
+  bool get isEven => false;
+  int operator -();
+  external static int parse(String source,
+      {int radix, int onError(String source)});
+}
+
+abstract class Iterable<E> {
+  bool get isEmpty;
+  Iterator<E> get iterator;
+}
+
+class Iterator<E> {
+  E get current;
+  bool moveNext();
+}
+
+abstract class List<E> implements Iterable<E> {
+  Iterator<E> get iterator => null;
+  E operator [](int index);
+  void operator []=(int index, E value);
+  void add(E value);
+  void clear();
+}
+
+abstract class Map<K, V> extends Object {
+  Iterable<K> get keys;
+  bool containsKey(Object key);
+}
+
+class Null extends Object {}
+
+abstract class num implements Comparable<num> {
+  num operator %(num other);
+  num operator *(num other);
+  num operator +(num other);
+  num operator -(num other);
+  num operator /(num other);
+  bool operator <(num other);
+  bool operator <=(num other);
+  bool operator >(num other);
+  bool operator >=(num other);
+  num abs();
+  int round();
+  int toInt();
+}
+
+class Object {
+  int get hashCode => 0;
+  bool operator ==(other) => identical(this, other);
+  String toString() => 'a string';
+}
+
+class StackTrace {}
+
+abstract class String implements Comparable<String> {
+  external factory String.fromCharCodes(Iterable<int> charCodes,
+      [int start = 0, int end]);
+  List<int> get codeUnits;
+  bool get isEmpty => false;
+  bool get isNotEmpty => false;
+  int get length => 0;
+  String toUpperCase();
+}
+
+class Symbol {}
+
+class Type {}
+
+class Uri {
+  static List<int> parseIPv6Address(String host, [int start = 0, int end]) {
+    int parseHex(int start, int end) {
+      return 0;
+    }
+    return null;
+  }
+}

test_package_embedder_yaml/lib/grizzly.dart

@@ -0,0 +1,7 @@
+// Copyright (c) 2016, 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 grizzly;
+
+class Bear {}