Flatten change

Author: jcollins-g

bin/dartdoc.dart

@@ -261,6 +261,7 @@ main(List<String> arguments) async {
       reexportMinConfidence:
           double.parse(args['ambiguous-reexport-scorer-min-confidence']),
       verboseWarnings: args['verbose-warnings'],
+      excludePackages: args['exclude-packages'],
       dropTextFrom: dropTextFrom);
 
   DartDoc dartdoc = new DartDoc(inputDir, excludeLibraries, sdkDir, generators,
@@ -325,6 +326,8 @@ ArgParser _createArgsParser() {
           '(optional text next to the package name and version).');
   parser.addOption('exclude',
       allowMultiple: true, splitCommas: true, help: 'Library names to ignore.');
+  parser.addOption('exclude-packages',
+      allowMultiple: true, splitCommas: true, help: 'Package names to ignore.');
   parser.addOption('include',
       allowMultiple: true,
       splitCommas: true,

lib/dartdoc.dart

@@ -120,6 +120,18 @@ class DartDoc {
 
   Stream<String> get onCheckProgress => _onCheckProgress.stream;
 
+  bool isExcluded(String name) => excludes.any((pattern) => name == pattern);
+
+  Iterable<LibraryElement> filterExcludesFrom(Iterable<LibraryElement> libraries) sync* {
+    for (LibraryElement l in libraries) {
+      if (isExcluded(l.source.uri.toString()) ||
+          config.excludePackages.contains(Library.getPackageMeta(l)?.name)) {
+        continue;
+      }
+      yield l;
+    }
+  }
+
   /// Generate DartDoc documentation.
   ///
   /// [DartDocResults] is returned if dartdoc succeeds. [DartDocFailure] is
@@ -129,52 +141,63 @@ class DartDoc {
   Future<DartDocResults> generateDocs() async {
     _stopwatch = new Stopwatch()..start();
 
-    List<String> files = packageMeta.isSdk
-        ? const []
-        : findFilesToDocumentInPackage(rootDir.path).toList();
-
-    // TODO(jcollins-g): seems like most of this belongs in the Package constructor
-    List<LibraryElement> libraries = _parseLibraries(files, includeExternals);
-
-    if (includes != null && includes.isNotEmpty) {
-      Iterable knownLibraryNames = libraries.map((l) => l.name);
-      Set notFound =
-          new Set.from(includes).difference(new Set.from(knownLibraryNames));
-      if (notFound.isNotEmpty) {
-        throw 'Did not find: [${notFound.join(', ')}] in '
-            'known libraries: [${knownLibraryNames.join(', ')}]';
-      }
-      libraries.removeWhere((lib) => !includes.contains(lib.name));
-    } else {
-      // remove excluded libraries
-      excludes.forEach((pattern) {
-        libraries.removeWhere((lib) {
-          return lib.name.startsWith(pattern) || lib.name == pattern;
-        });
-      });
-    }
-
     PackageWarningOptions warningOptions = new PackageWarningOptions();
     // TODO(jcollins-g): explode this into detailed command line options.
     if (config != null && config.showWarnings) {
       for (PackageWarning kind in PackageWarning.values) {
         warningOptions.warn(kind);
       }
     }
+
     Package package;
-    if (config != null && config.autoIncludeDependencies) {
-      package = Package.withAutoIncludedDependencies(
-          libraries, packageMeta, warningOptions);
-      libraries = package.libraries.map((l) => l.element).toList();
-      // remove excluded libraries again, in case they are picked up through
-      // dependencies.
-      excludes.forEach((pattern) {
-        libraries.removeWhere((lib) {
-          return lib.name.startsWith(pattern) || lib.name == pattern;
-        });
-      });
+    // TODO(jcollins-g): seems like most of this belongs in the Package constructor
+    Set<String> rootDirsPrev = new Set();
+    Set<String> rootDirs = new Set()..add(rootDir.path);
+    Set<LibraryElement> libraries = new Set();
+    Set<String> files = new Set();
+    Set<String> filesPrev = new Set();
+    while (!rootDirsPrev.containsAll(rootDirs)) {
+      for (String rootDirPath in rootDirs.difference(rootDirsPrev)) {
+        files.addAll(packageMeta.isSdk
+            ? new Set()
+            : findFilesToDocumentInPackage(rootDirPath));
+      }
+
+      libraries.addAll(_parseLibraries(files.difference(filesPrev), includeExternals, rootDirsPrev.isEmpty));
+
+      if (includes != null && includes.isNotEmpty) {
+        Iterable knownLibraryNames = libraries.map((l) => l.name);
+        Set notFound =
+        new Set.from(includes).difference(new Set.from(knownLibraryNames));
+        if (notFound.isNotEmpty) {
+          throw 'Did not find: [${notFound.join(', ')}] in '
+              'known libraries: [${knownLibraryNames.join(', ')}]';
+        }
+        libraries.removeWhere((lib) => !includes.contains(lib.name));
+      } else {
+        libraries = filterExcludesFrom(libraries).toSet();
+      }
+      /*
+      if (config != null && config.autoIncludeDependencies) {
+        package = Package.withAutoIncludedDependencies(
+            libraries, packageMeta, warningOptions);
+        // remove excluded libraries again, in case they are picked up through
+        // dependencies.
+        libraries = filterExcludesFrom(package.publicLibraries.map((l) => l.element as LibraryElement)).toSet();
+      }
+      rootDirsPrev = rootDirs.toSet();
+      for (Library lib in package.publicLibraries) {
+        if (libraries.contains(lib.element)) {
+          PackageMeta meta = lib.packageMeta;
+          if (meta != null) rootDirs.add(meta.dir.path);
+        }
+      }
+      filesPrev = files.toSet();
+      */
+      rootDirsPrev = rootDirs.toSet();
+      filesPrev = files.toSet();
     }
-    package = new Package(libraries, packageMeta, warningOptions);
+    package = new Package(libraries, packageMeta, warningOptions, context);
 
     // Go through docs of every model element in package to prebuild the macros index
     // TODO(jcollins-g): move index building into a cached-on-demand generation
@@ -201,10 +224,10 @@ class DartDoc {
 
     double seconds = _stopwatch.elapsedMilliseconds / 1000.0;
     logInfo(
-        "Documented ${package.libraries.length} librar${package.libraries.length == 1 ? 'y' : 'ies'} "
+        "Documented ${package.publicLibraries.length} librar${package.publicLibraries.length == 1 ? 'y' : 'ies'} "
         "in ${seconds.toStringAsFixed(1)} seconds");
 
-    if (package.libraries.isEmpty) {
+    if (package.publicLibraries.isEmpty) {
       throw new DartDocFailure(
           "dartdoc could not find any libraries to document. Run `pub get` and try again.");
     }
@@ -412,6 +435,7 @@ class DartDoc {
   }
 
   Map<String, Set<ModelElement>> _hrefs;
+  AnalysisContext context;
 
   /// Don't call this method more than once, and only after you've
   /// generated all docs for the Package.
@@ -428,7 +452,7 @@ class DartDoc {
   }
 
   List<LibraryElement> _parseLibraries(
-      List<String> files, List<String> includeExternals) {
+      Iterable<String> files, List<String> includeExternals, [bool parseEmbedders = true]) {
     Set<LibraryElement> libraries = new Set();
     DartSdk sdk = new FolderBasedDartSdk(PhysicalResourceProvider.INSTANCE,
         PhysicalResourceProvider.INSTANCE.getFolder(sdkDir.path));
@@ -470,13 +494,18 @@ class DartDoc {
 
     AnalysisEngine.instance.processRequiredPlugins();
 
-    AnalysisContext context = AnalysisEngine.instance.createAnalysisContext()
+    context = AnalysisEngine.instance.createAnalysisContext()
       ..analysisOptions = options
       ..sourceFactory = sourceFactory;
 
     if (packageMeta.isSdk) {
       libraries
           .addAll(new Set()..addAll(getSdkLibrariesToDocument(sdk, context)));
+    } else if (embedderSdk == null || embedderSdk.urlMappings.isEmpty) {
+      // TODO(jcollins-g): make this work for embedders?
+      // Make sure that Interceptor gets found so that the Package can collect
+      // it later and cloak that class completely.
+      libraries.addAll(getSdkLibrariesToDocument(sdk, context).where((l) => l.name == '_interceptors'));
     }
 
     List<Source> sources = [];
@@ -512,7 +541,7 @@ class DartDoc {
 
     files.forEach(processLibrary);
 
-    if ((embedderSdk != null) && (embedderSdk.urlMappings.length > 0)) {
+    if (parseEmbedders && (embedderSdk != null) && (embedderSdk.urlMappings.length > 0)) {
       embedderSdk.urlMappings.keys.forEach((String dartUri) {
         Source source = embedderSdk.mapDartUri(dartUri);
         processLibrary(source.fullName);
@@ -531,42 +560,38 @@ class DartDoc {
       String libraryName = Library.getLibraryName(library);
       var fullPath = source.fullName;
 
+      if (libraryName.contains('analyzer'))  {
+        1+1;
+      }
       if (includeExternals.any((string) => fullPath.endsWith(string))) {
         if (libraries.map(Library.getLibraryName).contains(libraryName)) {
           continue;
         }
         libraries.add(library);
-      } else if (config != null &&
-          config.autoIncludeDependencies &&
-          libraryName != '') {
-        File searchFile = new File(fullPath);
-        searchFile =
-            new File(path.join(searchFile.parent.path, 'pubspec.yaml'));
-        bool foundLibSrc = false;
-        while (!foundLibSrc && searchFile.parent != null) {
-          if (searchFile.existsSync()) break;
-          List<String> pathParts = path.split(searchFile.parent.path);
-          // This is a pretty intensely hardcoded convention, but there seems to
-          // to be no other way to identify what might be a "top level" library
-          // here.  If lib/src is in the path between the file and the pubspec,
-          // assume that this is supposed to be private.
-          if (pathParts.length < 2) break;
-          pathParts = pathParts.sublist(pathParts.length - 2, pathParts.length);
-          foundLibSrc =
-              path.join(pathParts[0], pathParts[1]) == path.join('lib', 'src');
-          searchFile = new File(
-              path.join(searchFile.parent.parent.path, 'pubspec.yaml'));
-        }
-        if (foundLibSrc) continue;
-        libraries.add(library);
       }
     }
 
+    libraries = filterExcludesFrom(libraries).toSet();
     List<AnalysisErrorInfo> errorInfos = [];
 
+    // TODO(jcollins-g): figure out why sources can't contain includeExternals
+    // or embedded SDK components without having spurious(?) analysis errors.
+    // That seems wrong.
     for (Source source in sources) {
       context.computeErrors(source);
-      errorInfos.add(context.getErrors(source));
+      AnalysisErrorInfo info = context.getErrors(source);
+      errorInfos.add(info);
+      List<_Error> errors = [info].expand((AnalysisErrorInfo info) {
+          return info.errors.map((error) =>
+              new _Error(error, info.lineInfo, packageMeta.dir.path));
+        })
+        .where((_Error error) => error.isError)
+        .toList()
+          ..sort();
+      if (errors.isNotEmpty) {
+        logWarning('analysis errors from source: ${source.uri.toString()} (${source.toString()}');
+        errors.forEach(logWarning);
+      }
     }
 
     List<_Error> errors = errorInfos
@@ -584,7 +609,6 @@ class DartDoc {
     _stopwatch.reset();
 
     if (errors.isNotEmpty) {
-      errors.forEach(logWarning);
       int len = errors.length;
       throw new DartDocFailure(
           "encountered ${len} analysis error${len == 1 ? '' : 's'}");

lib/src/config.dart

@@ -18,6 +18,7 @@ class Config {
   final double reexportMinConfidence;
   final bool verboseWarnings;
   final List<String> dropTextFrom;
+  final List<String> excludePackages;
   Config._(
       this.inputDir,
       this.showWarnings,
@@ -29,7 +30,8 @@ class Config {
       this.categoryOrder,
       this.reexportMinConfidence,
       this.verboseWarnings,
-      this.dropTextFrom);
+      this.dropTextFrom,
+      this.excludePackages);
 }
 
 Config _config;
@@ -46,7 +48,8 @@ void setConfig(
     List<String> categoryOrder,
     double reexportMinConfidence: 0.1,
     bool verboseWarnings: true,
-    List<String> dropTextFrom}) {
+    List<String> dropTextFrom,
+    List<String> excludePackages}) {
   _config = new Config._(
       inputDir,
       showWarnings,
@@ -58,5 +61,6 @@ void setConfig(
       categoryOrder ?? const <String>[],
       reexportMinConfidence,
       verboseWarnings,
-      dropTextFrom ?? const <String>[]);
+      dropTextFrom ?? const <String>[],
+      excludePackages ?? const <String> []);
 }

lib/src/element_type.dart

@@ -10,12 +10,16 @@ import 'package:analyzer/dart/element/type.dart';
 
 import 'model.dart';
 
-class ElementType {
+class ElementType extends Privacy {
   final DartType _type;
   final ModelElement element;
   String _linkedName;
 
-  ElementType(this._type, this.element);
+  ElementType(this._type, this.element) {
+    assert(element != null);
+  }
+
+  DartType get type => _type;
 
   bool get isDynamic => _type.isDynamic;
 
@@ -25,6 +29,15 @@ class ElementType {
 
   bool get isParameterType => (_type is TypeParameterType);
 
+  /// This type is a public type if the underlying, canonical element is public.
+  /// This avoids discarding the resolved type information as canonicalization
+  /// would ordinarily do.
+  @override
+  bool get isPublic {
+    Class canonicalClass = element.package.findCanonicalModelElementFor(element.element) ?? element;
+    return canonicalClass.isPublic;
+  }
+
   String get linkedName {
     if (_linkedName == null) {
       StringBuffer buf = new StringBuffer();
@@ -56,7 +69,10 @@ class ElementType {
     return _linkedName;
   }
 
-  String get name => _type.name;
+  String get name {
+    if (_type.name == null) return _type.element.name;
+    return _type.name;
+  }
 
   ModelElement get returnElement {
     Element e;
@@ -129,6 +145,11 @@ class ElementType {
     // can happen if element is dynamic
     if (f.element.library != null) {
       lib = new ModelElement.from(f.element.library, element.library);
+    } else {
+      // TODO(jcollins-g): Assigning libraries to dynamics doesn't make sense,
+      // really, but is needed for .package.
+      assert(f.element.kind == ElementKind.DYNAMIC);
+      lib = element.library;
     }
     return new ElementType(f, new ModelElement.from(f.element, lib));
   }