use origin libraries if public

Use pkg/resource to load assets

Closes #1089

Author: sethladd

.gitignore

@@ -10,6 +10,7 @@ packages
 .packages
 .settings/
 .DS_Store
+.atom
 *.iml
 
 pub.dartlang.org/

lib/src/html/resource_loader.dart

@@ -12,12 +12,8 @@ library dartdoc.resource_loader;
 
 import 'dart:async' show Future;
 import 'dart:convert' show UTF8;
-import 'dart:io' show Platform, File, Directory;
-import 'dart:typed_data' show Uint8List;
 
-import 'package:http/http.dart' as http;
-import 'package:path/path.dart' as p;
-import 'package:pub_cache/pub_cache.dart';
+import 'package:resource/resource.dart';
 
 /// Loads a `package:` resource as a String.
 Future<String> loadAsString(String path) async {
@@ -32,135 +28,7 @@ Future<List<int>> loadAsBytes(String path) async {
     throw new ArgumentError('path must begin with package:');
   }
 
-  // TODO: Remove once https://github.com/dart-lang/pub/issues/22 is fixed.
-  try {
-    return await _doLoad(path);
-  } catch (_) {
-    return new Resource(path).readAsBytes();
-  }
-}
-
-/// Determine how to do the load. HTTP? Snapshotted? From source?
-Future<Uint8List> _doLoad(final String path) {
-  var scriptUri = Platform.script;
-  if (scriptUri.toString().startsWith('http')) {
-    return _doLoadOverHttp(path);
-  } else if (scriptUri.toString().endsWith('.snapshot')) {
-    return _doLoadWhenSnapshot(path);
-  } else {
-    return _doLoadFromFileFromPackagesDir(path);
-  }
-}
-
-Future<Uint8List> _doLoadWhenSnapshot(final String resourcePath) {
-  var scriptFilePath = Platform.script.toFilePath();
-  // Check if we're running as a pub globally installed package
-  // Jump back out to where our source is
-  var cacheDirPath = PubCache.getSystemCacheLocation().path;
-  if (scriptFilePath.startsWith(cacheDirPath)) {
-    // find packages installed with pub
-    var appName = _appNameWhenGloballyInstalled();
-    var installedApplication = new PubCache()
-        .getGlobalApplications()
-        .firstWhere((app) => app.name == appName);
-    if (installedApplication == null) {
-      throw new StateError(
-          'Could not find globally installed app $appName. Are you running as a snapshot from the global_packages directory?');
-    }
-    var resourcePackageName = _packageNameForResource(resourcePath);
-    var resourcePackageRef = installedApplication
-        .getPackageRefs()
-        .firstWhere((ref) => ref.name == resourcePackageName);
-    if (resourcePackageRef == null) {
-      throw new StateError(
-          'Could not find package dependency for $resourcePackageName');
-    }
-    var resourcePackage = resourcePackageRef.resolve();
-    var resourcePackageDir = resourcePackage.location;
-    var fullPath = resourcePackageDir.path;
-    return _doLoadOverFileFromLocation(resourcePath, p.join(fullPath, "lib"));
-  } else {
-    // maybe we're a snapshot next to a packages/ dir?
-    return _doLoadFromFileFromPackagesDir(resourcePath);
-  }
-}
-
-Future<Uint8List> _doLoadOverHttp(final String resourcePath) {
-  var scriptUri = Platform.script;
-  var convertedResourcePath = _convertPackageSchemeToPackagesDir(resourcePath);
-  // strip file name from script uri, append path to resource
-  var segmentsToResource = scriptUri.pathSegments
-      .sublist(0, scriptUri.pathSegments.length - 1)
-        ..addAll(p.split(convertedResourcePath));
-  var fullPath = scriptUri.replace(pathSegments: segmentsToResource);
-
-  return http.readBytes(fullPath);
-}
-
-Future<Uint8List> _doLoadOverFileFromLocation(
-    final String resourcePath, final String baseDir) {
-  var convertedPath = _convertPackageSchemeToPackagesDir(resourcePath);
-  // remove 'packages' and package name
-  var pathInsideLib = p.split(convertedPath).sublist(2);
-  // put the baseDir in front
-  pathInsideLib.insert(0, baseDir);
-  // put it all back together
-  var fullPath = p.joinAll(pathInsideLib);
-  return _readFile(resourcePath, fullPath);
-}
-
-/// First, try a packages/ dir next to the entry point (Platform.script).
-/// If that doesn't exist, try a packages/ dir inside of the current
-/// working directory.
-Future<Uint8List> _doLoadFromFileFromPackagesDir(final String resourcePath) {
-  var convertedPath = _convertPackageSchemeToPackagesDir(resourcePath);
-  var scriptFile = new File(Platform.script.toFilePath());
-  String baseDir = p.dirname(scriptFile.path);
-
-  if (!new Directory(p.join(baseDir, 'packages')).existsSync()) {
-    // try CWD
-    baseDir = Directory.current.path;
-  }
-
-  var fullPath = p.join(baseDir, convertedPath);
-  return _readFile(resourcePath, fullPath);
-}
-
-Future<Uint8List> _readFile(
-    final String resourcePath, final String fullPath) async {
-  var file = new File(fullPath);
-  if (!file.existsSync()) {
-    throw new ArgumentError('$resourcePath does not exist, tried $fullPath');
-  }
-  var bytes = await file.readAsBytes();
-  return new Uint8List.fromList(bytes);
-}
-
-String _convertPackageSchemeToPackagesDir(String resourcePath) {
-  var withoutScheme = _removePackageScheme(resourcePath);
-  return p.join('packages', withoutScheme);
-}
-
-String _removePackageScheme(final String resourcePath) {
-  return resourcePath.substring('package:'.length, resourcePath.length);
-}
-
-/// Tries to determine the app name, which is the same as the directory
-/// name when globally installed.
-///
-/// Only call this if your app is globally installed.
-String _appNameWhenGloballyInstalled() {
-  var parts = p.split(Platform.script.toFilePath());
-  var marker = parts.indexOf('global_packages');
-  if (marker < 0) {
-    throw new StateError(
-        '${Platform.script.toFilePath()} does not include global_packages');
-  }
-  return parts[marker + 1];
-}
+  var uri = Uri.parse(path);
 
-String _packageNameForResource(final String resourcePath) {
-  var parts = p.split(_convertPackageSchemeToPackagesDir(resourcePath));
-  // first part is 'packages', second part is the package name
-  return parts[1];
+  return await ResourceLoader.defaultLoader.readAsBytes(uri);
 }

lib/src/model.dart

@@ -217,6 +217,9 @@ class Class extends ModelElement implements EnclosedElement {
   }
 
   /// Returns the library that encloses this element.
+  ///
+  /// If this class is exported by a library, this returns
+  /// the exporting library.
   ModelElement get enclosingElement => library;
 
   String get fileName => "${name}-class.html";
@@ -320,7 +323,7 @@ class Class extends ModelElement implements EnclosedElement {
           isPublic(value) &&
           !value.isOperator &&
           value.enclosingElement != null) {
-        if (!package.isDocumented(value.enclosingElement)) {
+        if (!package.isInLibraryAndExported(value.enclosingElement)) {
           Method m = new Method.inherited(value, this, library);
           _inheritedMethods.add(m);
           _genPageMethods.add(m);
@@ -375,7 +378,7 @@ class Class extends ModelElement implements EnclosedElement {
     }
 
     for (ExecutableElement value in vs.values) {
-      if (!package.isDocumented(value.enclosingElement)) {
+      if (!package.isInLibraryAndExported(value.enclosingElement)) {
         Operator o = new Operator.inherited(value, this, library);
         _inheritedOperators.add(o);
         _genPageOperators.add(o);
@@ -437,7 +440,7 @@ class Class extends ModelElement implements EnclosedElement {
         if (_inheritedProperties.any((f) => f.element == e)) {
           continue;
         }
-        if (!package.isDocumented(value.enclosingElement)) {
+        if (!package.isInLibraryAndExported(value.enclosingElement)) {
           Field f = new Field.inherited(e, this, library);
           _inheritedProperties.add(f);
           _genPageProperties.add(f);
@@ -681,6 +684,8 @@ class Dynamic extends ModelElement {
 ///
 /// Libraries are not enclosed.
 abstract class EnclosedElement {
+  /// Returns the enclosing element, or null
+  /// if this is a library.
   ModelElement get enclosingElement;
 }
 
@@ -986,7 +991,13 @@ class Library extends ModelElement {
         .where((element) => element is FunctionElement));
 
     _functions = elements.where(isPublic).map((e) {
-      return new ModelFunction(e, this);
+      // TODO: port this logic to all names that come from exported libraries
+      if (e.library == this._library ||
+          !package._libraryElements.contains(e.library)) {
+        return new ModelFunction(e, this);
+      } else {
+        return new ModelFunction(e, new Library(e.library, this.package));
+      }
     }).toList(growable: false)..sort(byName);
 
     return _functions;
@@ -1061,12 +1072,19 @@ class Library extends ModelElement {
       elements.addAll(cu.functionTypeAliases);
     }
 
-    elements.addAll(_exportedNamespace.definedNames.values
-        .where((element) => element is FunctionTypeAliasElement));
-    elements..removeWhere(isPrivate);
-    _typeDefs = elements
-        .map((e) => new Typedef(e, this))
-        .toList(growable: false)..sort(byName);
+    elements
+      ..addAll(_exportedNamespace.definedNames.values
+          .where((element) => element is FunctionTypeAliasElement))
+      ..removeWhere(isPrivate);
+    _typeDefs = elements.map((e) {
+      // TODO: port this logic to all names that come from exported libraries
+      if (e.library == this._library ||
+          !package._libraryElements.contains(e.library)) {
+        return new Typedef(e, this);
+      } else {
+        return new Typedef(e, new Library(e.library, this.package));
+      }
+    }).toList(growable: false)..sort(byName);
 
     return _typeDefs;
   }
@@ -1080,18 +1098,23 @@ class Library extends ModelElement {
       types.addAll(cu.types);
     }
     for (LibraryElement le in _library.exportedLibraries) {
-      types.addAll(le.definingCompilationUnit.types
-          .where((t) => _exportedNamespace.definedNames.values.contains(t.name))
-          .toList());
+      types.addAll(le.definingCompilationUnit.types.where(
+          (t) => _exportedNamespace.definedNames.values.contains(t.name)));
     }
 
+    // TODO: does this code duplicate the above loop through exportedLibraries?
     types.addAll(_exportedNamespace.definedNames.values
         .where((element) => element is ClassElement && !element.isEnum));
 
-    _classes = types
-        .where(isPublic)
-        .map((e) => new Class(e, this))
-        .toList(growable: false)..sort(byName);
+    _classes = types.where(isPublic).map((e) {
+      // TODO: port this logic to all names that come from exported libraries
+      if (e.library == this._library ||
+          !package._libraryElements.contains(e.library)) {
+        return new Class(e, this);
+      } else {
+        return new Class(e, new Library(e.library, this.package));
+      }
+    }).toList(growable: false)..sort(byName);
 
     return _classes;
   }
@@ -1105,13 +1128,15 @@ class Library extends ModelElement {
   bool hasInExportedNamespace(Element element) {
     Element found = _exportedNamespace.get(element.name);
     if (found == null) return false;
-    if (found == element) return true; // this checks more than just the name
 
     // Fix for #587, comparison between elements isn't reliable on windows.
     // for some reason. sigh.
 
-    return found.runtimeType == element.runtimeType &&
-        found.nameOffset == element.nameOffset;
+    bool isSame = (found == element) ||
+        found.runtimeType == element.runtimeType &&
+            found.nameOffset == element.nameOffset;
+
+    return isSame;
   }
 
   List<TopLevelVariable> _getVariables() {
@@ -1125,10 +1150,15 @@ class Library extends ModelElement {
     _exportedNamespace.definedNames.values.forEach((element) {
       if (element is PropertyAccessorElement) elements.add(element.variable);
     });
-    _variables = elements
-        .where(isPublic)
-        .map((e) => new TopLevelVariable(e, this))
-        .toList(growable: false)..sort(byName);
+    _variables = elements.where(isPublic).map((e) {
+      // TODO: port this logic to all names that come from exported libraries
+      if (e.library == this._library ||
+          !package._libraryElements.contains(e.library)) {
+        return new TopLevelVariable(e, this);
+      } else {
+        return new TopLevelVariable(e, new Library(e.library, this.package));
+      }
+    }).toList(growable: false)..sort(byName);
 
     return _variables;
   }
@@ -1539,15 +1569,17 @@ abstract class ModelElement implements Comparable, Nameable, Documentable {
     if (name.startsWith('_')) {
       return HTML_ESCAPE.convert(name);
     }
-    if (!(this is Method || this is Field) && !package.isDocumented(element)) {
+    if (!(this is Method || this is Field) &&
+        !package.isInLibraryAndExported(element)) {
       return HTML_ESCAPE.convert(name);
     }
 
+    // TODO: get the library that is exporting this class, not just containing it
     ModelElement c = (this is EnclosedElement)
         ? (this as EnclosedElement).enclosingElement
         : null;
     if (c != null) {
-      if (!package.isDocumented(c.element)) {
+      if (!package.isInLibraryAndExported(c.element)) {
         return HTML_ESCAPE.convert(name);
       }
       if (c.name.startsWith('_')) {
@@ -1651,12 +1683,14 @@ class Operator extends Method {
 }
 
 class Package implements Nameable, Documentable {
+  final List<LibraryElement> _libraryElements = [];
   final List<Library> _libraries = [];
   final PackageMeta packageMeta;
   final Map<String, Library> elementLibaryMap = {};
   String _docsAsHtml;
 
   Package(Iterable<LibraryElement> libraryElements, this.packageMeta) {
+    _libraryElements.addAll(libraryElements);
     libraryElements.forEach((element) {
       // add only if the element should be included in the public api
       if (isPublic(element)) {
@@ -1740,11 +1774,14 @@ class Package implements Nameable, Documentable {
     } else {
       el = element;
     }
+
     return _libraries.firstWhere((lib) => lib.hasInExportedNamespace(el),
         orElse: () => null);
   }
 
-  bool isDocumented(Element element) => findLibraryFor(element) != null;
+  /// Returns true if element is found in a library in this package.
+  bool isInLibraryAndExported(Element element) =>
+      findLibraryFor(element) != null;
 
   String toString() => isSdk ? 'SDK' : 'Package $name';