Change to use Pathos

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.
  */
+

[Andrei Mouravski, 2013/06/25 18:37:41]

You don't need this newline.

[janicejl, 2013/06/25 19:47:49]

Done.

 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 '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;
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/mirrors.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/mirrors/mirrors_util.dart';
 import '../../../sdk/lib/_internal/compiler/implementation/source_file_provider.dart';
 
 var logger = new Logger("Docgen");
 
 /// Counter used to provide unique IDs for each distinct item.  
 int _nextID = 0;
 
 int get nextID => _nextID++;
 
 const String usage = "Usage: dart docgen.dart [OPTIONS] [fooDir/barFile]";
 
-List<Path> listLibraries(List<String> args) {
-  if (args.length != 1) {
-    throw new UnsupportedError(usage);
-  }
-  var libraries = new List<Path>();
-  var type = FileSystemEntity.typeSync(args[0]);
-  
-  if (type == FileSystemEntityType.NOT_FOUND) { 
-    throw new UnsupportedError("File does not exist. $usage");
-  } else if (type == FileSystemEntityType.LINK) {
-    libraries.addAll(listLibrariesFromDir(new Link(args[0]).targetSync()));
-  } else if (type == FileSystemEntityType.FILE) {
-    libraries.add(new Path(args[0]));
-    logger.info("Added to libraries: ${libraries.last.toString()}");
-  } else if (type == FileSystemEntityType.DIRECTORY) {
-    libraries.addAll(listLibrariesFromDir(args[0]));
-  }
-  return libraries;
-}
-
-List<Path> listLibrariesFromDir(String path) {
-  var libraries = new List<Path>();
-  new Directory(path).listSync(recursive: true, 
-      followLinks: true).forEach((file) {
-        if (new Path(file.path).extension == "dart") {
-          if (!file.path.contains("/packages/")) {
-            libraries.add(new Path(file.path));
-            logger.info("Added to libraries: ${libraries.last.toString()}");
-          }
-        }
-      });
-  return libraries;
-}
-
 /**
  * This class documents a list of libraries.
  */
 class Docgen {
 
   /// Libraries to be documented.
   List<LibraryMirror> _libraries;
-  
+
   /// Current library being documented to be used for comment links.
   LibraryMirror _currentLibrary;
   
   /// 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
   markdown.Resolver linkResolver;
   
+  /// Package Directory of 
+  String packageDir;
+  
   bool outputToYaml;
   bool outputToJson;
   bool includePrivate;
   /// State for whether or not the SDK libraries should also be outputted.
   bool includeSdk;
 
   /**
    * Docgen constructor initializes the link resolver for markdown parsing.
    * Also initializes the command line arguments. 
    */
@@ skipping 10 matching lines @@
         throw new UnsupportedError("Cannot have contradictory output flags.");
       }
       outputToYaml = argResults["output-format"] == "yaml" ? true : false;
     }
     outputToJson = !outputToYaml;
     includePrivate = argResults["include-private"];
     includeSdk = argResults["include-sdk"];
     
     this.linkResolver = (name) => 
         fixReference(name, _currentLibrary, _currentClass, _currentMember);
+    
+    analyze(argResults.rest);
+  }
+  
+  List<String> listLibraries(List<String> args) {
+    if (args.length != 1) {
+      throw new UnsupportedError(usage);
+    }
+    var libraries = new List<String>();
+    var type = FileSystemEntity.typeSync(args[0]);
+    
+    if (type == FileSystemEntityType.NOT_FOUND) { 
+      throw new UnsupportedError("File does not exist. $usage");
+    } else if (type == FileSystemEntityType.LINK) {
+      var files = listDir(resolveLink(args[0]), recursive: true);
+      libraries.addAll(files.where((f) => 
+          f.endsWith(".dart") && !f.contains("/packages")));
+      packageDir = files.firstWhere((f) => 
+          f.endsWith("/pubspec.yaml"), orElse: () => "");
+      packageDir = packageDir == "" ? 
+          "" : path.dirname(packageDir) + "/packages"; 
+    } else if (type == FileSystemEntityType.FILE) {
+      libraries.add(path.absolute(args[0]));
+      packageDir = "";
+    } else if (type == FileSystemEntityType.DIRECTORY) {
+      var files = listDir(args[0], recursive: true);
+      libraries.addAll(files.where((f) => 
+          f.endsWith(".dart") && !f.contains("/packages")));
+      packageDir = files.firstWhere((f) => 
+          f.endsWith("/pubspec.yaml"), orElse: () => "");
+      packageDir = packageDir == "" ? 
+          "" : path.dirname(packageDir) + "/packages"; 
+    }
+    logger.info("Package Directory: $packageDir");
+    libraries.forEach((lib) => logger.info("Added to libraries: $lib"));
+    return libraries;
   }
   
   /**
    * Analyzes set of libraries by getting a mirror system and triggers the 
    * documentation of the libraries. 
    */
-  void analyze(List<Path> libraries) {
+  void analyze(List<String> args) {
+    var libraries = listLibraries(args);
+    if (libraries.isEmpty) throw new UnsupportedError("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");
-      sdkRoot = new Path(sdkRoot);
     } else {
       // If DART_SDK is not defined in the environment, 
       // assuming the dart executable is from the Dart SDK folder inside bin. 
-      sdkRoot = new Path(new Options().executable).directoryPath
-          .directoryPath;
-      logger.info("SDK Root: ${sdkRoot.toString()}");
+      sdkRoot = path.dirname(path.dirname(new Options().executable));
+      logger.info("SDK Root: ${sdkRoot}");
     }
     
-    Path packageDir = libraries.last.directoryPath.append("packages");
-    logger.info("Package Root: ${packageDir.toString()}");
-    getMirrorSystem(libraries, sdkRoot, 
-        packageRoot: packageDir).then((MirrorSystem mirrorSystem) {
+    getMirrorSystem(libraries, new Path(sdkRoot), 
+        packageRoot: new Path(packageDir)).then((MirrorSystem mirrorSystem) {
           if (mirrorSystem.libraries.values.isEmpty) {
             throw new UnsupportedError("No Library Mirrors.");
           } 
           this.libraries = mirrorSystem.libraries.values;
           documentLibraries();
         });
   }
   
   /**
    * Analyzes set of libraries and provides a mirror system which can be used 
    * for static inspection of the source code.
    */
-  Future<MirrorSystem> getMirrorSystem(List<Path> libraries,
+  Future<MirrorSystem> getMirrorSystem(List<String> libraries,
         Path libraryRoot, {Path 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.toString()));
+      librariesUri.add(currentDirectory.resolve(library));
     });
     return dart2js.analyze(librariesUri, libraryUri, packageUri,
         provider.readStringFromUri, diagnosticHandler,
         ['--preserve-comments', '--categories=Client,Server']);
   }
   
   /**
    * Creates documentation for filtered libraries.
    */
   void documentLibraries() {
     _libraries.forEach((library) {
       // Files belonging to the SDK have a uri that begins with "dart:".
       if (includeSdk || !library.uri.toString().startsWith("dart:")) {
         _currentLibrary = library;
         var result = new Library(library.qualifiedName, _getComment(library),
             _getVariables(library.variables), _getMethods(library.functions),
             _getClasses(library.classes), nextID);
         if (outputToJson) {
           _writeToFile(stringify(result.toMap()), "${result.name}.json");
         } 
         if (outputToYaml) {
           _writeToFile(getYamlString(result.toMap()), "${result.name}.yaml");
         }
      }
     });
    }
-  
+
   /// Saves list of libraries for Docgen object.
   void set libraries(value){
     _libraries = value;
   }
-   
+  
   /**
    * Returns any documentation comments associated with a mirror with
    * simple markdown converted to html.
    */
   String _getComment(DeclarationMirror mirror) {
     String commentText;
     mirror.metadata.forEach((metadata) {
       if (metadata is CommentInstanceMirror) {
         CommentInstanceMirror comment = metadata;
         if (comment.isDocComment) {
@@ skipping 297 matching lines @@
   if (!dir.existsSync()) {
     dir.createSync();
   }
   File file = new File('docs/$filename');
   if (!file.existsSync()) {
     file.createSync();
   }
   file.openSync();
   file.writeAsString(text);
 }