Support documenting unversioned packages (#1697)

* Fix bug where --version didn't do anything

* Review comments

* Rebuild test package docs for retype deprecation in dev.55

* dartdoc_test as full integration test now

* Eliminate unused initializer and update pubspec

* allow unversioned

* Add test

* Add gitignore to test_package_minimum

* dartfmt

* Remove extra copy of contextFromArgvTemp introduced in merge resolution

Author: jcollins-g

lib/dartdoc.dart

@@ -66,8 +66,7 @@ class Dartdoc extends PackageBuilder {
   /// An asynchronous factory method that builds Dartdoc's file writers
   /// and returns a Dartdoc object with them.
   static withDefaultGenerators(DartdocGeneratorOptionContext config) async {
-    List<Generator> generators =
-        await initGenerators(config);
+    List<Generator> generators = await initGenerators(config);
     return new Dartdoc._(config, generators);
   }
 

lib/src/model.dart

@@ -4396,7 +4396,7 @@ class PackageGraph extends Canonicalization
     return _inheritThrough;
   }
 
-  String get version => packageMeta.version;
+  String get version => packageMeta.version ?? '0.0.0-unknown';
 
   /// Looks up some [Library] that is reexporting this [Element]; not
   /// necessarily the canonical [Library].

test/compare_output_test.dart

@@ -49,7 +49,8 @@ void main() {
       var result = Process.runSync(Platform.resolvedExecutable, args,
           workingDirectory: _testPackagePath);
       PackageMeta dartdocMeta = new PackageMeta.fromFilename(dartdocBin);
-      expect(result.stdout, equals('dartdoc version: ${dartdocMeta.version}\n'));
+      expect(
+          result.stdout, equals('dartdoc version: ${dartdocMeta.version}\n'));
     });
 
     test("Validate html output of test_package", () async {

test/dartdoc_test.dart

@@ -28,13 +28,24 @@ void main() {
       delete(tempDir);
     });
 
-    Future<DartdocGeneratorOptionContext> generatorContextFromArgvTemp(List<String> argv) async {
+    Future<DartdocGeneratorOptionContext> generatorContextFromArgvTemp(
+        List<String> argv) async {
       return await generatorContextFromArgv(argv..addAll(outputParam));
     }
 
+    test('package without version produces valid semver in docs', () async {
+      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageMinimumDir.path]));
+      DartdocResults results = await dartdoc.generateDocs();
+      PackageGraph p = results.packageGraph;
+      assert(p.version == '0.0.0-unknown');
+    });
+
     test('basic interlinking test', () async {
-      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(await generatorContextFromArgvTemp(
-          ['--input', testPackageDir.path, '--link-to-remote']));
+      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageDir.path, '--link-to-remote']));
       DartdocResults results = await dartdoc.generateDocs();
       PackageGraph p = results.packageGraph;
       Package tuple = p.publicPackages.firstWhere((p) => p.name == 'tuple');
@@ -60,7 +71,6 @@ void main() {
           contains(stringLink));
     });
 
-
     test('generate docs for ${pathLib.basename(testPackageDir.path)} works',
         () async {
       Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
@@ -79,7 +89,8 @@ void main() {
     test('generate docs for ${pathLib.basename(testPackageBadDir.path)} fails',
         () async {
       Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
-          await generatorContextFromArgvTemp(['--input', testPackageBadDir.path]));
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageBadDir.path]));
 
       try {
         await dartdoc.generateDocs();
@@ -91,7 +102,8 @@ void main() {
 
     test('generate docs for a package that does not have a readme', () async {
       Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
-          await generatorContextFromArgvTemp(['--input', testPackageWithNoReadme.path]));
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageWithNoReadme.path]));
 
       DartdocResults results = await dartdoc.generateDocs();
       expect(results.packageGraph, isNotNull);
@@ -104,8 +116,9 @@ void main() {
     });
 
     test('generate docs including a single library', () async {
-      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(await generatorContextFromArgvTemp(
-          ['--input', testPackageDir.path, '--include', 'fake']));
+      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageDir.path, '--include', 'fake']));
 
       DartdocResults results = await dartdoc.generateDocs();
       expect(results.packageGraph, isNotNull);
@@ -118,8 +131,9 @@ void main() {
     });
 
     test('generate docs excluding a single library', () async {
-      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(await generatorContextFromArgvTemp(
-          ['--input', testPackageDir.path, '--exclude', 'fake']));
+      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageDir.path, '--exclude', 'fake']));
 
       DartdocResults results = await dartdoc.generateDocs();
       expect(results.packageGraph, isNotNull);
@@ -135,8 +149,9 @@ void main() {
     test('generate docs for package with embedder yaml', () async {
       PackageMeta meta = new PackageMeta.fromDir(testPackageWithEmbedderYaml);
       if (meta.needsPubGet) meta.runPubGet();
-      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(await generatorContextFromArgvTemp(
-          ['--input', testPackageWithEmbedderYaml.path]));
+      Dartdoc dartdoc = await Dartdoc.withDefaultGenerators(
+          await generatorContextFromArgvTemp(
+              ['--input', testPackageWithEmbedderYaml.path]));
 
       DartdocResults results = await dartdoc.generateDocs();
       expect(results.packageGraph, isNotNull);

test/src/utils.dart

@@ -21,22 +21,23 @@ PackageGraph testPackageGraphSdk;
 
 final Directory testPackageBadDir = new Directory('testing/test_package_bad');
 final Directory testPackageDir = new Directory('testing/test_package');
+final Directory testPackageMinimumDir =
+    new Directory('testing/test_package_minimum');
 final Directory testPackageWithEmbedderYaml =
     new Directory('testing/test_package_embedder_yaml');
 final Directory testPackageWithNoReadme =
     new Directory('testing/test_package_small');
 
-
 /// Convenience factory to build a [DartdocGeneratorOptionContext] and associate
 /// it with a [DartdocOptionSet] based on the current working directory.
-Future<DartdocGeneratorOptionContext> generatorContextFromArgv(List<String> argv) async {
-  DartdocOptionSet optionSet = await DartdocOptionSet
-      .fromOptionGenerators('dartdoc', [createDartdocOptions, createGeneratorOptions]);
+Future<DartdocGeneratorOptionContext> generatorContextFromArgv(
+    List<String> argv) async {
+  DartdocOptionSet optionSet = await DartdocOptionSet.fromOptionGenerators(
+      'dartdoc', [createDartdocOptions, createGeneratorOptions]);
   optionSet.parseArguments(argv);
   return new DartdocGeneratorOptionContext(optionSet, Directory.current);
 }
 
-
 /// Convenience factory to build a [DartdocOptionContext] and associate it with a
 /// [DartdocOptionSet] based on the current working directory.
 Future<DartdocOptionContext> contextFromArgv(List<String> argv) async {

testing/test_package_minimum/.gitignore

@@ -0,0 +1,2 @@
+doc/api/
+pubspec.lock

testing/test_package_minimum/lib/main.dart

@@ -0,0 +1 @@
+library small;

testing/test_package_minimum/pubspec.yaml

@@ -0,0 +1 @@
+name: test_package_minimal

tool/grind.dart

@@ -732,9 +732,8 @@ testPreviewDart2() async {
   List<String> parameters = ['--preview-dart-2', '--enable-asserts'];
 
   // sdk#32901 is really bad on Windows.
-  for (File dartFile in testFiles
-      .where((f) =>
-          !f.path.endsWith('html_generator_test.dart') && !Platform.isWindows)) {
+  for (File dartFile in testFiles.where((f) =>
+      !f.path.endsWith('html_generator_test.dart') && !Platform.isWindows)) {
     // absolute path to work around dart-lang/sdk#32901
     await testFutures.addFuture(new SubprocessLauncher(
             'dart2-${pathLib.basename(dartFile.absolute.path)}')