added Command Line Arguments, support for directories, hiding private data, not parsing the SDK, rem

pkg/docgen/bin/docgen_main.dart

Index: pkg/docgen/bin/docgen_main.dart
diff --git a/pkg/docgen/bin/docgen_main.dart b/pkg/docgen/bin/docgen_main.dart
new file mode 100644
index 0000000000000000000000000000000000000000..49de1246af284f9ab19e40c96f67f1182aa4a876
--- /dev/null
+++ b/pkg/docgen/bin/docgen_main.dart
@@ -0,0 +1,55 @@
+import 'dart:io';
+import 'package:docgen/docgen.dart';
+import 'package:args/args.dart';
+import 'package:compiler_unsupported/implementation/mirrors/dart2js_mirror.dart';
+import '../lib/src/dart2js_mirrors.dart' as dart2js;
+import 'package:compiler_unsupported/implementation/mirrors/mirrors.dart';
+import 'package:compiler_unsupported/implementation/mirrors/mirrors_util.dart';
+
+/**
+ * Entry function to create YAML documentation from Dart files.

[Andrei Mouravski, 2013/06/18 02:42:36]

"Analyzes Dart files and generates a representation of included libraries,
classes, and members."

[janicejl, 2013/06/18 18:42:46]

Done.

+ */
+void main() {

[Andrei Mouravski, 2013/06/18 02:42:36]

Why did you make this file? The entry point should definitely be at
bin/docgen.dart

[janicejl, 2013/06/18 18:42:46]

I moved everything to the Lib folder so that I can start unit testing. I moved
only main into this file since there cannot be a main in the Lib folder. 

[Andrei Mouravski, 2013/06/18 19:31:00]

main should stay in bin/docgen.dart so that people can just call it as an
executable.

+  Options opts = new Options();

[Andrei Mouravski, 2013/06/18 02:42:36]

This whole section is very inconsistent. I have to run or else I'd demo what I
mean.

Basically, you're using opts, results, parser, docgen in really weird ways. I
don't think you need all the objects you're creating.

Try to reduce the amount of code by separating out concrete chunks and inlining
code that's used once.

[Andrei Mouravski, 2013/06/18 10:17:45]

I think the Docgen constructor should take all of the options as optional
arguments, and then a new Docgen is created from the ArgResults object.

Also, the function that returns an argparser should either be a library function
in this file or in a bin/src file.

Something like:

void main() {
  var results = argParser().parse(new Options().arguments);
  var docgen = new DocGen(sdk: results.sdk, ...)

  ...
}

[janicejl, 2013/06/18 18:42:46]

Done.

+  Docgen docgen = new Docgen();
+  
+  var parser = createArgParser(docgen);
+  var results = parser.parse(opts.arguments);
+  
+  if (results.rest.length != 1) {

[Andrei Mouravski, 2013/06/18 10:17:45]

This should really be:
if (results.rest.length != 1) throw new UnsupportedException('Blah blah usage.
Does not support multiple arguments.');

Then you don't need an else block.

[janicejl, 2013/06/18 18:42:46]

Done.

+      print ("Usage: dart docgen.dart [OPTIONS] [FILE/DIR]");

[Andrei Mouravski, 2013/06/18 10:17:45]

Don't use print. Create a logger and use that instead.

[janicejl, 2013/06/18 18:42:46]

Done.

+  } else {
+    var directory = new Path(opts.arguments.last).directoryPath; 

[Andrei Mouravski, 2013/06/18 10:17:45]

Use pathos instead, please.

[Andrei Mouravski, 2013/06/18 10:17:45]

This should probably use results.rest, yo.

[janicejl, 2013/06/18 18:42:46]

Done.

+    var libraries = [];
+    Path sdkDirectory = new Path("../../../../../dart/dart-sdk");

[Andrei Mouravski, 2013/06/18 10:17:45]

Make these vars.

[Andrei Mouravski, 2013/06/18 10:17:45]

Ugh. The pain. I'm not sure this will work in every instance.

[janicejl, 2013/06/18 18:42:46]

Will it be better to get the user to pass in the location to their SDK library
as part of the command line arguments?

[Andrei Mouravski, 2013/06/18 22:54:01]

No. Just use what pub does in pub/lib/src/sdk.dart

+    Path packageDir = directory.append("packages");

[Andrei Mouravski, 2013/06/18 10:17:45]

What if the packages directory isn't there?

+
+    if (FileSystemEntity.isFileSync(opts.arguments.last)) {

[Andrei Mouravski, 2013/06/18 10:17:45]

This all feels rather clumsy. I think Pub might have this done a different way.

I would do:

var libraries = _listLibraries(results.rest);


List<String> _listLibraries(List<String> args) {
  var type = FileSystemEntity.typeSync(args[0]);

  if (type == FileSystemEntityType.LINK) throw new Unsupported('...');
  else if (type == ... .NOT_FOUND) throw new ArgumentException...
  else if (type == ... .FILE) return [args[0]];
  
  // logic for dirs here.

  return list;

}

[janicejl, 2013/06/18 18:42:46]

Done.

+      libraries = [new Path(opts.arguments.last)];
+    } else {
+      libraries = new List<Path>();
+      new Directory.fromPath(directory).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));            
+              }
+            }
+          });
+    }
+    
+    var workingMirrors = dart2js.analyze(libraries, sdkDirectory, 
+        packageRoot: packageDir, 
+        options: ['--preserve-comments', '--categories=Client,Server']);

[Andrei Mouravski, 2013/06/18 10:17:45]

We may want to just hardcode these into the dart2js_mirrors method.

+    
+    workingMirrors.then( (MirrorSystem mirrorSystem) {

[Andrei Mouravski, 2013/06/18 10:17:45]

No space between ( (.

[janicejl, 2013/06/18 18:42:46]

Done.

+      var mirrors = mirrorSystem.libraries.values;
+      if (mirrors.isEmpty) {

[Andrei Mouravski, 2013/06/18 10:17:45]

Don't just print, throw an error! They screwed up!

[janicejl, 2013/06/18 18:42:46]

Done.

+        print("no LibraryMirrors");

[Andrei Mouravski, 2013/06/18 10:17:45]

Don't print. Log.

[janicejl, 2013/06/18 18:42:46]

Done.

+      } else {
+        docgen.libraries = mirrors;

[Andrei Mouravski, 2013/06/18 10:17:45]

Instead of holding onto the mirrors object, just set docgen.libraries to
mirrorSystem.libraries.values earlier on.

[janicejl, 2013/06/18 18:42:46]

Done.

+        docgen.documentLibraries();

[Andrei Mouravski, 2013/06/18 10:17:45]

This is the only operative bit of code here. I think main() should be as short
as freakin' possible, so use functions.

[janicejl, 2013/06/18 18:42:46]

Done.

+      }
+    });
+  }
+}