Docgen returning a future

pkg/docgen/lib/docgen.dart

 // Copyright (c) 2013, 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.
 
 /**
  * **docgen** is a tool for creating machine readable representations of Dart 
  * code metadata, including: classes, members, comments and annotations.
  * 
  * docgen is run on a `.dart` file or a directory containing `.dart` files. 
  * 
  *      $ dart docgen.dart [OPTIONS] [FILE/DIR]
  *
  * This creates files called `docs/<library_name>.yaml` in your current 
  * working directory.
  */
 library docgen;
 
 import 'dart:io';
 import 'dart:json';
 import 'dart:async';
 
-import 'package:args/args.dart';
 import 'package:logging/logging.dart';
 import 'package:markdown/markdown.dart' as markdown;
 import 'package:pathos/path.dart' as path;
 
 import 'dart2yaml.dart';
 import 'src/io.dart';
 import '../../../sdk/lib/_internal/compiler/compiler.dart' as api;
 import '../../../sdk/lib/_internal/compiler/implementation/filenames.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/dart2js_mirror.dart'
     as dart2js;
@@ skipping 11 matching lines @@
 
 /// Current class being documented to be used for comment links.
 ClassMirror _currentClass;
 
 /// Current member being documented to be used for comment links.
 MemberMirror _currentMember;
 
 /// Resolves reference links in doc comments. 
 markdown.Resolver linkResolver;
 
-/// Package directory of directory being analyzed. 
-String packageDir;
-
-bool outputToYaml;
-bool outputToJson;
-bool includePrivate;
-/// State for whether imported SDK libraries should also be outputted.
-bool includeSdk;
-/// State for whether all SDK libraries should be outputted. 
-bool parseSdk;
-
 /**
  * Docgen constructor initializes the link resolver for markdown parsing.
  * Also initializes the command line arguments. 
+ * 
+ * [packageRoot] is the packages directory of the directory being analyzed. 
+ * If [includeSdk] is 'true', then any SDK libraries explicitly imported will 
+ * also be documented. 
+ * If [parseSdk] is 'true', then all Dart SDK libraries will be documented. 
+ * This option is useful when only the SDK libraries are needed. 
  */
-void docgen(ArgResults argResults) {  
-  _setCommandLineArguments(argResults);
+Future<bool> docgen(List<String> files, {String packageRoot, 
+    bool outputToYaml: true, bool includePrivate: false, bool includeSdk: false,
+    bool parseSdk: false}) {  
+  var docgenResult = new Completer<bool>();
+  
+  if (packageRoot == null && !parseSdk) {
+    if (FileSystemEntity.typeSync(files.first) 
+        == FileSystemEntityType.DIRECTORY) {
+      packageRoot = _findPackageRoot(files.first);
+    }
+  }
+  logger.info('Package Root: ${packageRoot}');
   
   linkResolver = (name) => 
       fixReference(name, _currentLibrary, _currentClass, _currentMember);
   
-  getMirrorSystem(argResults.rest).then((MirrorSystem mirrorSystem) {
-    if (mirrorSystem.libraries.values.isEmpty) {
-      throw new StateError('No Library Mirrors.');
-    }
-    _documentLibraries(mirrorSystem.libraries.values);
-  });
-}
-
-void _setCommandLineArguments(ArgResults argResults) {
-  outputToYaml = argResults['yaml'] || argResults['output-format'] == 'yaml';
-  outputToJson = argResults['json'] || argResults['output-format'] == 'json';
-  if (outputToYaml && outputToJson) {
-    throw new ArgumentError('Cannot have contradictory output flags.');
-  }
-  outputToYaml = outputToYaml || !outputToJson;
-  includePrivate = argResults['include-private'];
-  parseSdk = argResults['parse-sdk'];
-  includeSdk = parseSdk || argResults['include-sdk'];
-  packageDir = argResults['package-root'];
-  if (packageDir != null) logger.info('Package Root: ${packageDir}');
+  getMirrorSystem(files, packageRoot, parseSdk: parseSdk)
+    .then((MirrorSystem mirrorSystem) {
+      if (mirrorSystem.libraries.isEmpty) {
+        throw new StateError('No library mirrors were created.');
+      }
+      _documentLibraries(mirrorSystem.libraries.values, 
+          includeSdk: includeSdk, includePrivate: includePrivate, 
+          outputToYaml: outputToYaml);
+    }).then((e) => docgenResult.complete(true))
+    .catchError((e) => docgenResult.complete(false));
+  
+  return docgenResult.future;
 }
 
 List<String> _listLibraries(List<String> args) {
   // TODO(janicejl): At the moment, only have support to have either one file,
   // or one directory. This is because there can only be one package directory
   // since only one docgen is created per run. 
   if (args.length != 1) throw new UnsupportedError(USAGE);
   var libraries = new List<String>();
   var type = FileSystemEntity.typeSync(args[0]);
   
   if (type == FileSystemEntityType.FILE) {
     libraries.add(path.absolute(args[0]));
     logger.info('Added to libraries: ${libraries.last}');
   } else {
     libraries.addAll(_listDartFromDir(args[0]));
   } 
   return libraries;
 }
 
 List<String> _listDartFromDir(String args) {
   var files = listDir(args, recursive: true);
-  if (packageDir == null) {
-    packageDir = files.firstWhere((f) => 
-        f.endsWith('/pubspec.yaml'), orElse: () => '');
-    if (packageDir != '') packageDir = path.dirname(packageDir) + '/packages';
-    logger.info('Package Directory: $packageDir');
-  }
   // To avoid anaylzing package files twice, only files with paths not 
   // containing '/packages' will be added. The only exception is if the file to
   // analyze already has a '/package' in its path. 
   return files.where((f) => f.endsWith('.dart') && 
       (!f.contains('/packages') || args.contains('/packages'))).toList()
       ..forEach((lib) => logger.info('Added to libraries: $lib'));
 }
 
+String _findPackageRoot(String directory) {
+  var files = listDir(directory, recursive: true);
+  // Return '' means that there was no pubspec.yaml and therefor no packageRoot. 
+  String packageRoot = files.firstWhere((f) => 
+      f.endsWith('/pubspec.yaml'), orElse: () => '');

[janicejl, 2013/07/03 19:36:07]

If the pubspec.yaml is in the current directory, I think it returns the path to
pubspec.yaml. 

The if statement then removes the pubspec.yaml and appends it with /packages. 

If there is no packageRoot, I am right now under the assumption that a package
is not needed. 

+  if (packageRoot != '') {
+    packageRoot = path.dirname(packageRoot) + '/packages';
+  }
+  return packageRoot;
+}
+
 List<String> _listSdk() {
   var sdk = new List<String>();
   LIBRARIES.forEach((String name, LibraryInfo info) {
     if (info.documented) { 
       sdk.add('dart:$name');
       logger.info('Add to SDK: ${sdk.last}');
     }
   });
   return sdk;
 }
 
 /**
  * Analyzes set of libraries by getting a mirror system and triggers the 
  * documentation of the libraries. 
  */
-Future<MirrorSystem> getMirrorSystem(List<String> args) {
+Future<MirrorSystem> getMirrorSystem(List<String> args, String packageRoot, 
+    {bool parseSdk:false}) {
   var libraries = !parseSdk ? _listLibraries(args) : _listSdk();
   if (libraries.isEmpty) throw new StateError('No Libraries.');
   // DART_SDK should be set to the root of the SDK library. 
   var sdkRoot = Platform.environment['DART_SDK'];
   if (sdkRoot != null) {
     logger.info('Using DART_SDK to find SDK at $sdkRoot');
   } else {
     // If DART_SDK is not defined in the environment, 
     // assuming the dart executable is from the Dart SDK folder inside bin. 
     sdkRoot = path.dirname(path.dirname(new Options().executable));
     logger.info('SDK Root: ${sdkRoot}');
   }
   
-  return _getMirrorSystemHelper(libraries, sdkRoot, packageRoot: packageDir);
+  return _analyzeLibraries(libraries, sdkRoot, packageRoot: packageRoot);
 }
 
 // TODO(janicejl): Should make docgen fail gracefully, or output a friendly
 // error message letting them know why it is failing to create a mirror system.
 // If there is conflicting library names, should modify it with a hash at the 
 // end of it's library name. 
 /**
  * Analyzes set of libraries and provides a mirror system which can be used 
  * for static inspection of the source code.
  */
-Future<MirrorSystem> _getMirrorSystemHelper(List<String> libraries,
+Future<MirrorSystem> _analyzeLibraries(List<String> libraries,
       String libraryRoot, {String packageRoot}) {
   SourceFileProvider provider = new SourceFileProvider();
   api.DiagnosticHandler diagnosticHandler =
         new FormattingDiagnosticHandler(provider).diagnosticHandler;
   Uri libraryUri = currentDirectory.resolve(appendSlash('$libraryRoot'));
   Uri packageUri = null;
   if (packageRoot != null) {
     packageUri = currentDirectory.resolve(appendSlash('$packageRoot'));
   }
   List<Uri> librariesUri = <Uri>[];
   libraries.forEach((library) {
     librariesUri.add(currentDirectory.resolve(library));
   });
   return dart2js.analyze(librariesUri, libraryUri, packageUri,
       provider.readStringFromUri, diagnosticHandler,
       ['--preserve-comments', '--categories=Client,Server'])
       ..catchError((error) {
         logger.severe('Error: Failed to create mirror system. ');
         // TODO(janicejl): Use the stack trace package when bug is resolved. 
         // Currently, a string is thrown when it fails to create a mirror 
         // system, and it is not possible to use the stack trace. BUG(#11622)
         // To avoid printing the stack trace. 
         exit(1);
       });
 }
 
 /**
  * Creates documentation for filtered libraries.
  */
-void _documentLibraries(List<LibraryMirror> libraries) {
+void _documentLibraries(List<LibraryMirror> libraries, 
+    {bool includeSdk:false, bool includePrivate:false, bool 
+     outputToYaml:true}) {
   libraries.forEach((lib) {
     // Files belonging to the SDK have a uri that begins with 'dart:'.
     if (includeSdk || !lib.uri.toString().startsWith('dart:')) {
-      var library = generateLibrary(lib);
-      _outputLibrary(library);
+      var library = generateLibrary(lib, includePrivate: includePrivate);
+      _writeLibraryToFile(library, outputToYaml);
     }
   });
   // Outputs a text file with a list of files available after creating all 
   // the libraries. This will help the viewer know what files are available 
   // to read in. 
   _writeToFile(listDir("docs").join('\n'), 'library_list.txt');
 }
 
-Library generateLibrary(dart2js.Dart2JsLibraryMirror library) {
+Library generateLibrary(dart2js.Dart2JsLibraryMirror library, 
+  {bool includePrivate:false}) {
   _currentLibrary = library;
   var result = new Library(library.qualifiedName, _getComment(library),
-      _getVariables(library.variables), _getMethods(library.functions),
-      _getClasses(library.classes));
+      _getVariables(library.variables, includePrivate), 
+      _getMethods(library.functions, includePrivate),
+      _getClasses(library.classes, includePrivate));
   logger.fine('Generated library for ${result.name}');
   return result;
 }
 
-void _outputLibrary(Library result) {
-  if (outputToJson) {
+void _writeLibraryToFile(Library result, bool outputToYaml) {
+  if (outputToYaml) {
+    _writeToFile(getYamlString(result.toMap()), '${result.name}.yaml');
+  } else {
     _writeToFile(stringify(result.toMap()), '${result.name}.json');
   } 
-  if (outputToYaml) {
-    _writeToFile(getYamlString(result.toMap()), '${result.name}.yaml');
-  }
+  
 }
 
 /**
  * Returns a list of meta annotations assocated with a mirror. 
  */
 List<String> _getAnnotations(DeclarationMirror mirror) {
   var annotations = mirror.metadata.where((e) => 
       e is dart2js.Dart2JsConstructedConstantMirror);
   return annotations.map((e) => e.type.qualifiedName).toList();
 }
@@ skipping 28 matching lines @@
 // TODO(tmandel): Create proper links for [_] style markdown based
 // on scope once layout of viewer is finished.
 markdown.Node fixReference(String name, LibraryMirror currentLibrary, 
     ClassMirror currentClass, MemberMirror currentMember) {
   return new markdown.Element.text('code', name);
 }
 
 /**
  * Returns a map of [Variable] objects constructed from inputted mirrors.
  */
-Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap) {
+Map<String, Variable> _getVariables(Map<String, VariableMirror> mirrorMap, 
+    bool includePrivate) {
   var data = {};
+  // TODO(janicejl): When map to map feature is created, replace the below with 
+  // a filter. Issue(#9590).
   mirrorMap.forEach((String mirrorName, VariableMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
       data[mirrorName] = new Variable(mirrorName, mirror.qualifiedName, 
           mirror.isFinal, mirror.isStatic, mirror.type.qualifiedName, 
           _getComment(mirror), _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * Returns a map of [Method] objects constructed from inputted mirrors.
  */
-Map<String, Method> _getMethods(Map<String, MethodMirror> mirrorMap) {
+Map<String, Method> _getMethods(Map<String, MethodMirror> mirrorMap, 
+    bool includePrivate) {
   var data = {};
   mirrorMap.forEach((String mirrorName, MethodMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentMember = mirror;
       data[mirrorName] = new Method(mirrorName, mirror.qualifiedName, 
           mirror.isSetter, mirror.isGetter, mirror.isConstructor, 
           mirror.isOperator, mirror.isStatic, mirror.returnType.qualifiedName, 
           _getComment(mirror), _getParameters(mirror.parameters), 
           _getAnnotations(mirror));
     }
   });
   return data;
 } 
 
 /**
  * Returns a map of [Class] objects constructed from inputted mirrors.
  */
-Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap) {
+Map<String, Class> _getClasses(Map<String, ClassMirror> mirrorMap,
+    bool includePrivate) {
   var data = {};
   mirrorMap.forEach((String mirrorName, ClassMirror mirror) {
     if (includePrivate || !mirror.isPrivate) {
       _currentClass = mirror;
       var superclass = (mirror.superclass != null) ? 
           mirror.superclass.qualifiedName : '';
       var interfaces = 
           mirror.superinterfaces.map((interface) => interface.qualifiedName);
       data[mirrorName] = new Class(mirrorName, mirror.qualifiedName, 
           superclass, mirror.isAbstract, mirror.isTypedef, 
           _getComment(mirror), interfaces.toList(),
-          _getVariables(mirror.variables), _getMethods(mirror.methods), 
+          _getVariables(mirror.variables, includePrivate),
+          _getMethods(mirror.methods, includePrivate), 
           _getAnnotations(mirror));
     }
   });
   return data;
 }
 
 /**
  * Returns a map of [Parameter] objects constructed from inputted mirrors.
  */
 Map<String, Parameter> _getParameters(List<ParameterMirror> mirrorList) {
@@ skipping 220 matching lines @@
     parameterMap['qualifiedname'] = qualifiedName;
     parameterMap['optional'] = isOptional.toString();
     parameterMap['named'] = isNamed.toString();
     parameterMap['default'] = hasDefaultValue.toString();
     parameterMap['type'] = type;
     parameterMap['value'] = defaultValue;
     parameterMap['annotations'] = new List.from(annotations);
     return parameterMap;
   } 
 }