From de6b1153594383f1210f98f0f76dd18a85eef6d1 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Thu, 15 Jan 2015 12:40:30 -0800 Subject: [PATCH 1/4] allow running each test set as its own file --- test/all.dart | 14 +++++++------- test/css_test.dart | 2 +- test/dartdoc_test.dart | 2 +- test/io_utils_test.dart | 2 +- test/model_test.dart | 2 +- test/package_utils_test.dart | 2 +- test/template_test.dart | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/test/all.dart b/test/all.dart index 88ddfc9034..d561e7d624 100644 --- a/test/all.dart +++ b/test/all.dart @@ -12,11 +12,11 @@ import 'package_utils_test.dart' as package_util_tests; import 'template_test.dart' as template_tests; -main() { - css_tests.tests(); - dartdoc_tests.tests(); - io_utils_tests.tests(); - model_tests.tests(); - package_util_tests.tests(); - template_tests.tests(); +void main() { + css_tests.main(); + dartdoc_tests.main(); + io_utils_tests.main(); + model_tests.main(); + package_util_tests.main(); + template_tests.main(); } diff --git a/test/css_test.dart b/test/css_test.dart index de6cab5698..70a4c790a9 100644 --- a/test/css_test.dart +++ b/test/css_test.dart @@ -9,7 +9,7 @@ import 'package:unittest/unittest.dart'; import '../lib/src/css.dart'; -tests() { +void main() { group('check bootstrap', () { CSS css = new CSS(); diff --git a/test/dartdoc_test.dart b/test/dartdoc_test.dart index 867102a8fb..6bd0b59a71 100644 --- a/test/dartdoc_test.dart +++ b/test/dartdoc_test.dart @@ -12,7 +12,7 @@ import '../lib/dartdoc.dart'; import '../lib/src/package_utils.dart'; -tests() { +void main() { group('dartdoc test', () { test('version info', () { diff --git a/test/io_utils_test.dart b/test/io_utils_test.dart index 80f40b39ae..d253201b22 100644 --- a/test/io_utils_test.dart +++ b/test/io_utils_test.dart @@ -10,7 +10,7 @@ import 'package:unittest/unittest.dart'; import '../lib/src/io_utils.dart'; -tests() { +void main() { group('io utils', () { test('find files to document', () { diff --git a/test/model_test.dart b/test/model_test.dart index 8c02072d7b..6043b66047 100644 --- a/test/model_test.dart +++ b/test/model_test.dart @@ -48,7 +48,7 @@ abstract class C {} '''; -tests() { +void main() { AnalyzerHelper helper = new AnalyzerHelper(); Source source = helper.addSource(SOURCE1); diff --git a/test/package_utils_test.dart b/test/package_utils_test.dart index 96f78a57b9..c6ff9fa2b4 100644 --- a/test/package_utils_test.dart +++ b/test/package_utils_test.dart @@ -10,7 +10,7 @@ import 'package:unittest/unittest.dart'; import '../lib/src/package_utils.dart'; -tests() { +void main() { group('package utils test', () { test('get package name', () { diff --git a/test/template_test.dart b/test/template_test.dart index b03974fc1f..ded8dece21 100644 --- a/test/template_test.dart +++ b/test/template_test.dart @@ -9,7 +9,7 @@ import 'dart:io'; import 'package:mustache4dart/mustache4dart.dart'; import 'package:unittest/unittest.dart'; -tests() { +void main() { group('template', () { var script = new File(Platform.script.toFilePath()); File tmplFile = new File( From 86d17ee3e9bc6d2e6fd9dba46073bc23445a94a5 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Thu, 15 Jan 2015 12:42:34 -0800 Subject: [PATCH 2/4] use package: urls for lib access --- test/css_test.dart | 2 +- test/dartdoc_test.dart | 4 ++-- test/io_utils_test.dart | 2 +- test/model_test.dart | 4 ++-- test/package_utils_test.dart | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/test/css_test.dart b/test/css_test.dart index 70a4c790a9..529e41aba2 100644 --- a/test/css_test.dart +++ b/test/css_test.dart @@ -7,7 +7,7 @@ library dartdoc.css_test; import 'package:http/http.dart' as http; import 'package:unittest/unittest.dart'; -import '../lib/src/css.dart'; +import 'package:dartdoc/src/css.dart'; void main() { group('check bootstrap', () { diff --git a/test/dartdoc_test.dart b/test/dartdoc_test.dart index 6bd0b59a71..408525b632 100644 --- a/test/dartdoc_test.dart +++ b/test/dartdoc_test.dart @@ -8,8 +8,8 @@ import 'dart:io'; import 'package:unittest/unittest.dart'; -import '../lib/dartdoc.dart'; -import '../lib/src/package_utils.dart'; +import 'package:dartdoc/dartdoc.dart'; +import 'package:dartdoc/src/package_utils.dart'; void main() { diff --git a/test/io_utils_test.dart b/test/io_utils_test.dart index d253201b22..78ff501e36 100644 --- a/test/io_utils_test.dart +++ b/test/io_utils_test.dart @@ -8,7 +8,7 @@ import 'dart:io'; import 'package:unittest/unittest.dart'; -import '../lib/src/io_utils.dart'; +import 'package:dartdoc/src/io_utils.dart'; void main() { group('io utils', () { diff --git a/test/model_test.dart b/test/model_test.dart index 6043b66047..4f9d163a88 100644 --- a/test/model_test.dart +++ b/test/model_test.dart @@ -17,8 +17,8 @@ import 'package:analyzer/src/generated/sdk.dart'; import 'package:analyzer/src/generated/sdk_io.dart'; import 'package:analyzer/src/generated/source_io.dart'; -import '../lib/src/model.dart'; -import '../lib/src/model_utils.dart'; +import 'package:dartdoc/src/model.dart'; +import 'package:dartdoc/src/model_utils.dart'; const SOURCE1 = r''' library ex; diff --git a/test/package_utils_test.dart b/test/package_utils_test.dart index c6ff9fa2b4..95b519742b 100644 --- a/test/package_utils_test.dart +++ b/test/package_utils_test.dart @@ -8,7 +8,7 @@ import 'dart:io'; import 'package:unittest/unittest.dart'; -import '../lib/src/package_utils.dart'; +import 'package:dartdoc/src/package_utils.dart'; void main() { group('package utils test', () { From 8572e0135b377100775d783da8a117a98f684ec9 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Thu, 15 Jan 2015 12:44:20 -0800 Subject: [PATCH 3/4] remove unused fields --- lib/dartdoc.dart | 3 --- lib/src/model_utils.dart | 3 --- 2 files changed, 6 deletions(-) diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 32fac5ef98..5e67cf7a73 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -6,7 +6,6 @@ library dartdoc; import 'dart:io'; -import 'package:analyzer/src/generated/ast.dart'; import 'package:analyzer/src/generated/element.dart'; import 'package:analyzer/src/generated/engine.dart'; import 'package:analyzer/src/generated/java_io.dart'; @@ -84,7 +83,6 @@ class DartDoc { List _parseLibraries(List files) { DartSdk sdk = new DirectoryBasedDartSdk(new JavaFile(_sdkDir.path)); - ContentCache contentCache = new ContentCache(); List resolvers = [new DartUriResolver(sdk), new FileUriResolver()]; JavaFile packagesDir = @@ -104,7 +102,6 @@ class DartDoc { Source source = new FileBasedSource.con1(new JavaFile(filePath)); if (context.computeKindOf(source) == SourceKind.LIBRARY) { LibraryElement library = context.computeLibraryElement(source); - CompilationUnit unit = context.resolveCompilationUnit(source, library); libraries.add(library); libraries.addAll(library.exportedLibraries); } diff --git a/lib/src/model_utils.dart b/lib/src/model_utils.dart index 29c322e81f..32bb4d902a 100644 --- a/lib/src/model_utils.dart +++ b/lib/src/model_utils.dart @@ -4,7 +4,6 @@ library dartdoc.model_utils; -import 'package:analyzer/src/generated/ast.dart'; import 'package:analyzer/src/generated/constant.dart'; import 'package:analyzer/src/generated/element.dart'; import 'package:analyzer/src/generated/engine.dart'; @@ -45,7 +44,6 @@ List getSdkLibrariesToDocument(DartSdk sdk, sdkApiLibs.forEach((SdkLibrary sdkLib) { Source source = sdk.mapDartUri(sdkLib.shortName); LibraryElement library = context.computeLibraryElement(source); - CompilationUnit unit = context.resolveCompilationUnit(source, library); libraries.add(library); libraries.addAll(library.exportedLibraries); }); @@ -53,7 +51,6 @@ List getSdkLibrariesToDocument(DartSdk sdk, } List getAllSupertypes(ClassElement c) { - InterfaceType t = c.type; return c.allSupertypes; // TODO: From bac66bb2bdbecd7132f4bb3b214785f6bb145ac2 Mon Sep 17 00:00:00 2001 From: Kevin Moore Date: Thu, 15 Jan 2015 12:44:45 -0800 Subject: [PATCH 4/4] formatting --- bin/dartdoc.dart | 21 +++++-------- lib/dartdoc.dart | 30 +++++++++--------- lib/generator.dart | 1 - lib/src/css.dart | 2 -- lib/src/html_generator.dart | 24 ++++++++------- lib/src/html_printer.dart | 3 +- lib/src/io_utils.dart | 4 +-- lib/src/model.dart | 59 ++++++++++++++++++------------------ lib/src/model_utils.dart | 10 +++--- test/all.dart | 1 - test/css_test.dart | 1 - test/dartdoc_test.dart | 3 -- test/io_utils_test.dart | 2 -- test/model_test.dart | 33 ++++++-------------- test/package_utils_test.dart | 1 - test/template_test.dart | 4 +-- tool/grind.dart | 13 ++++---- 17 files changed, 92 insertions(+), 120 deletions(-) diff --git a/bin/dartdoc.dart b/bin/dartdoc.dart index 4c53f7792c..9b7ea1baee 100644 --- a/bin/dartdoc.dart +++ b/bin/dartdoc.dart @@ -26,15 +26,14 @@ void main(List arguments) { Directory sdkDir = grinder.getSdkDir(arguments); if (sdkDir == null) { - print( - "Warning: unable to locate the Dart SDK. Please use the --dart-sdk " - "command line option or set the DART_SDK environment variable."); + print("Warning: unable to locate the Dart SDK. Please use the --dart-sdk " + "command line option or set the DART_SDK environment variable."); exit(1); } bool sdkDocs = false; - if (results['sdk-docs']) { - sdkDocs = true; + if (results['sdk-docs']) { + sdkDocs = true; } List excludeLibraries = @@ -43,10 +42,9 @@ void main(List arguments) { var currentDir = Directory.current; var generators = initGenerators(url); new DartDoc(currentDir, excludeLibraries, sdkDir, generators, sdkDocs) - ..generateDocs(); + ..generateDocs(); } - /// Print help if we are passed the help option or invalid arguments. void _printUsageAndExit(ArgParser parser) { print(parser.usage); @@ -59,17 +57,14 @@ ArgParser _createArgsParser() { var parser = new ArgParser(); parser.addOption('exclude', help: 'a comma-separated list of library names to ignore'); - parser.addOption('dart-sdk', - help: 'the location of the Dart SDK'); + parser.addOption('dart-sdk', help: 'the location of the Dart SDK'); parser.addOption('url', help: 'the url where the docs will be hosted (used to generate the sitemap)'); parser.addFlag('help', abbr: 'h', negatable: false, help: 'show command help'); parser.addFlag('version', help: 'Display the version for $NAME', negatable: false); - parser.addFlag( - 'sdk-docs', - help: 'generate docs for the dart sdk.' - 'Use "--dart-sdk" option to specify path to sdk'); + parser.addFlag('sdk-docs', help: 'generate docs for the dart sdk.' + 'Use "--dart-sdk" option to specify path to sdk'); return parser; } diff --git a/lib/dartdoc.dart b/lib/dartdoc.dart index 5e67cf7a73..8dd818fe57 100644 --- a/lib/dartdoc.dart +++ b/lib/dartdoc.dart @@ -26,7 +26,6 @@ const String NAME = 'dartdoc'; // Update when puspec version changes const String VERSION = '0.0.1'; - /// Initialize and setup the generators List initGenerators(String url) { List generators = []; @@ -45,11 +44,8 @@ class DartDoc { Set libraries = new Set(); List _generators; - DartDoc(this._rootDir, - this._excludes, - this._sdkDir, - this._generators, - [this._sdkDocs = false]); + DartDoc(this._rootDir, this._excludes, this._sdkDir, this._generators, + [this._sdkDocs = false]); /// Generate the documentation void generateDocs() { @@ -60,10 +56,10 @@ class DartDoc { List libs = []; libs.addAll(_parseLibraries(files)); // remove excluded libraries - _excludes.forEach((pattern) - => libs.removeWhere((l) => l.name.startsWith(pattern))); - libs.removeWhere((LibraryElement library) - => _excludes.contains(library.name)); + _excludes.forEach( + (pattern) => libs.removeWhere((l) => l.name.startsWith(pattern))); + libs.removeWhere( + (LibraryElement library) => _excludes.contains(library.name)); libs.sort(elementCompare); libraries.addAll(libs); @@ -78,24 +74,28 @@ class DartDoc { double seconds = stopwatch.elapsedMilliseconds / 1000.0; print(''); - print("Documented ${libraries.length} " "librar${libraries.length == 1 ? 'y' : 'ies'} in " "${seconds.toStringAsFixed(1)} seconds."); + print( + "Documented ${libraries.length} " "librar${libraries.length == 1 ? 'y' : 'ies'} in " "${seconds.toStringAsFixed(1)} seconds."); } List _parseLibraries(List files) { DartSdk sdk = new DirectoryBasedDartSdk(new JavaFile(_sdkDir.path)); - List resolvers = [new DartUriResolver(sdk), - new FileUriResolver()]; + List resolvers = [ + new DartUriResolver(sdk), + new FileUriResolver() + ]; JavaFile packagesDir = new JavaFile.relative(new JavaFile(_rootDir.path), 'packages'); if (packagesDir.exists()) { resolvers.add(new PackageUriResolver([packagesDir])); } - SourceFactory sourceFactory = new SourceFactory(/*contentCache,*/ resolvers); + SourceFactory sourceFactory = + new SourceFactory(/*contentCache,*/ resolvers); AnalysisContext context = AnalysisEngine.instance.createAnalysisContext(); context.sourceFactory = sourceFactory; if (_sdkDocs) { - libraries.addAll(getSdkLibrariesToDocument(sdk, context)); + libraries.addAll(getSdkLibrariesToDocument(sdk, context)); } files.forEach((String filePath) { print('parsing ${filePath}...'); diff --git a/lib/generator.dart b/lib/generator.dart index 36639ae42a..271fff916f 100644 --- a/lib/generator.dart +++ b/lib/generator.dart @@ -12,7 +12,6 @@ import 'src/model.dart'; /// for a given package. Generators can generate documentation in different /// formats - html, json etc abstract class Generator { - Package package; Directory out; diff --git a/lib/src/css.dart b/lib/src/css.dart index 10874e86ad..2c1958a245 100644 --- a/lib/src/css.dart +++ b/lib/src/css.dart @@ -5,7 +5,6 @@ library dartdoc.css; class CSS { - final String cssHeader = 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css'; @@ -13,5 +12,4 @@ class CSS { 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css'; String getCssName() => 'bootstrap.css'; - } diff --git a/lib/src/html_generator.dart b/lib/src/html_generator.dart index c385460e6e..2cac8b7779 100644 --- a/lib/src/html_generator.dart +++ b/lib/src/html_generator.dart @@ -25,8 +25,10 @@ body { margin: 8px; }'''; - static final String bootstrapCss = 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css'; - static final String bootstrapTheme ='https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css'; + static final String bootstrapCss = + 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap.min.css'; + static final String bootstrapTheme = + 'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.1/css/bootstrap-theme.min.css'; HtmlPrinter html = new HtmlPrinter(); CSS css = new CSS(); @@ -34,9 +36,7 @@ body { List htmlFiles = []; String url; - HtmlGenerator(this.url) { - - } + HtmlGenerator(this.url) {} void generate(Package package, Directory out) { this.package = package; @@ -51,15 +51,17 @@ body { void generatePackage() { var data = { - 'css' : bootstrapCss, - 'theme' : bootstrapTheme, + 'css': bootstrapCss, + 'theme': bootstrapTheme, 'packageName': package.name, 'packageDesc': package.description, 'packageVersion': package.version, 'libraries': package.libraries.map((lib) { - return {'name': lib.name, - 'filename': _getFileNameFor(lib), - 'descr': getDocOneLiner(lib)}; + return { + 'name': lib.name, + 'filename': _getFileNameFor(lib), + 'descr': getDocOneLiner(lib) + }; }) }; var fileName = 'index.html'; @@ -352,7 +354,7 @@ body { if (doc == null || doc == '') return null; var endOfFirstSentence = doc.indexOf('.'); if (endOfFirstSentence >= 0) { - return doc.substring(0, endOfFirstSentence+1); + return doc.substring(0, endOfFirstSentence + 1); } else { return doc; } diff --git a/lib/src/html_printer.dart b/lib/src/html_printer.dart index 201b4822b2..65ffcd9eca 100644 --- a/lib/src/html_printer.dart +++ b/lib/src/html_printer.dart @@ -30,7 +30,8 @@ class HtmlPrinter { endTag(); } - void start({String title, String cssRef, String theme, String jsScript, String inlineStyle}) { + void start({String title, String cssRef, String theme, String jsScript, + String inlineStyle}) { startTag('html', newLine: false); writeln(); startTag('head'); diff --git a/lib/src/io_utils.dart b/lib/src/io_utils.dart index 90d950f79b..d4550ef497 100644 --- a/lib/src/io_utils.dart +++ b/lib/src/io_utils.dart @@ -49,8 +49,8 @@ List _doList(String dir, Set listedDirectories, bool recurse, contents.add(entity.path); if (entity is Directory) { if (recurse) { - children.addAll( - _doList(entity.path, listedDirectories, recurse, listDir)); + children + .addAll(_doList(entity.path, listedDirectories, recurse, listDir)); } } } diff --git a/lib/src/model.dart b/lib/src/model.dart index 86b4b5284f..e6296e367f 100644 --- a/lib/src/model.dart +++ b/lib/src/model.dart @@ -121,8 +121,8 @@ abstract class ModelElement { String createLinkedSummary(Helper generator) { if (isExecutable) { ExecutableElement ex = (element as ExecutableElement); - String retType = generator.createLinkedReturnTypeName( - new ElementType(ex.type, library)); + String retType = generator + .createLinkedReturnTypeName(new ElementType(ex.type, library)); return '${generator.createLinkedName(this)}' '(${generator.printParams(ex.parameters.map((f) => @@ -133,8 +133,9 @@ abstract class ModelElement { PropertyInducingElement pe = (element as PropertyInducingElement); StringBuffer buf = new StringBuffer(); buf.write('${generator.createLinkedName(this)}'); - String type = generator.createLinkedName(pe.type == null ? null : - new ModelElement.from(pe.type.element, library)); + String type = generator.createLinkedName(pe.type == null + ? null + : new ModelElement.from(pe.type.element, library)); if (!type.isEmpty) { buf.write(': $type'); } @@ -152,8 +153,8 @@ abstract class ModelElement { buf.write('static '); } - buf.write(generator.createLinkedReturnTypeName( - new ElementType(e.type, library))); + buf.write(generator + .createLinkedReturnTypeName(new ElementType(e.type, library))); buf.write( ' ${e.name}(${generator.printParams(e.parameters.map((f) => new Parameter(f, library)).toList())})'); return buf.toString(); @@ -171,8 +172,9 @@ abstract class ModelElement { buf.write('const '); } - buf.write(generator.createLinkedName(e.type == null ? null : - new ModelElement.from(e.type.element, library))); + buf.write(generator.createLinkedName(e.type == null + ? null + : new ModelElement.from(e.type.element, library))); buf.write(' ${e.name}'); // write out any constant value @@ -202,18 +204,15 @@ class Package { String get name => _isSdk ? 'Dart API Reference' : getPackageName(_rootDirPath); - String get version => - _isSdk ? _sdkVersion : getPackageVersion(_rootDirPath); + String get version => _isSdk ? _sdkVersion : getPackageVersion(_rootDirPath); String get description => _isSdk ? 'Dart API Libraries' : getPackageDescription(_rootDirPath); List get libraries => _libraries; - Package(Iterable libraryElements, - this._rootDirPath, - [this._sdkVersion, - this._isSdk = false]) { + Package(Iterable libraryElements, this._rootDirPath, + [this._sdkVersion, this._isSdk = false]) { libraryElements.forEach((element) { _libraries.add(new Library(element)); }); @@ -221,7 +220,7 @@ class Package { bool isDocumented(ModelElement e) { if (e is Library) { - return _libraries.any((library) => library.element == e.element); + return _libraries.any((library) => library.element == e.element); } return _libraries.contains(e.library); } @@ -373,8 +372,8 @@ class ModelFunction extends ModelElement { String get typeName => 'Functions'; String createLinkedSummary(Helper generator) { - String retType = generator.createLinkedReturnTypeName( - new ElementType(_func.type, library)); + String retType = generator + .createLinkedReturnTypeName(new ElementType(_func.type, library)); return '${generator.createLinkedName(this)}' '(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)))})' @@ -386,8 +385,8 @@ class ModelFunction extends ModelElement { if (_func.isStatic) { buf.write('static '); } - buf.write(generator.createLinkedReturnTypeName( - new ElementType(_func.type, library))); + buf.write(generator + .createLinkedReturnTypeName(new ElementType(_func.type, library))); buf.write( ' ${_func.name}(${generator.printParams(_func.parameters.map((f) => new Parameter(f, library)).toList())})'); return buf.toString(); @@ -419,8 +418,8 @@ class Typedef extends ModelElement { } buf.write( '(${generator.printParams(_typedef.parameters.map((f) => new Parameter(f, library)).toList())}): '); - buf.write(generator.createLinkedReturnTypeName( - new ElementType(_typedef.type, library))); + buf.write(generator + .createLinkedReturnTypeName(new ElementType(_typedef.type, library))); return buf.toString(); } @@ -522,8 +521,8 @@ class Accessor extends ModelElement { buf.write(generator.createLinkedName(this)); buf.write(': '); buf.write(generator.createLinkedReturnTypeName(new ElementType( - _accessor.type, new ModelElement.from( - _accessor.type.element, library)))); + _accessor.type, + new ModelElement.from(_accessor.type.element, library)))); } else { buf.write('${generator.createLinkedName(this)}(' '${generator.printParams(_accessor.parameters.map((f) => @@ -576,15 +575,15 @@ class Parameter extends ModelElement { class TypeParameter extends ModelElement { TypeParameter(TypeParameterElement element, Library library) - : super(element, library); + : super(element, library); - TypeParameterElement get _typeParameter => element as TypeParameterElement; + TypeParameterElement get _typeParameter => element as TypeParameterElement; - ElementType get type => new ElementType(_typeParameter.type, library); + ElementType get type => new ElementType(_typeParameter.type, library); - String toString() => element.name; + String toString() => element.name; - String get typeName => 'Type Parameters'; + String get typeName => 'Type Parameters'; } class ElementType { @@ -615,8 +614,8 @@ class ElementType { } List get typeArguments => (_type as ParameterizedType).typeArguments - .map((f) => new ElementType(f, library)) - .toList(); + .map((f) => new ElementType(f, library)) + .toList(); } abstract class Helper { diff --git a/lib/src/model_utils.dart b/lib/src/model_utils.dart index 32bb4d902a..10cdb0fa1c 100644 --- a/lib/src/model_utils.dart +++ b/lib/src/model_utils.dart @@ -34,12 +34,12 @@ int elementCompare(Element a, Element b) => a.name.compareTo(b.name); bool isPrivate(Element e) => e.name.startsWith('_'); -List getSdkLibrariesToDocument(DartSdk sdk, - AnalysisContext context) { +List getSdkLibrariesToDocument( + DartSdk sdk, AnalysisContext context) { List libraries = []; - var sdkApiLibs = - sdk.sdkLibraries.where((SdkLibrary sdkLib) - => !sdkLib.isInternal && sdkLib.isDocumented).toList(); + var sdkApiLibs = sdk.sdkLibraries + .where((SdkLibrary sdkLib) => !sdkLib.isInternal && sdkLib.isDocumented) + .toList(); sdkApiLibs.sort((lib1, lib2) => lib1.shortName.compareTo(lib2.shortName)); sdkApiLibs.forEach((SdkLibrary sdkLib) { Source source = sdk.mapDartUri(sdkLib.shortName); diff --git a/test/all.dart b/test/all.dart index d561e7d624..c736a841eb 100644 --- a/test/all.dart +++ b/test/all.dart @@ -11,7 +11,6 @@ import 'model_test.dart' as model_tests; import 'package_utils_test.dart' as package_util_tests; import 'template_test.dart' as template_tests; - void main() { css_tests.main(); dartdoc_tests.main(); diff --git a/test/css_test.dart b/test/css_test.dart index 529e41aba2..75e4f308f0 100644 --- a/test/css_test.dart +++ b/test/css_test.dart @@ -26,6 +26,5 @@ void main() { expect(response.statusCode, 200); }); }); - }); } diff --git a/test/dartdoc_test.dart b/test/dartdoc_test.dart index 408525b632..4f45349748 100644 --- a/test/dartdoc_test.dart +++ b/test/dartdoc_test.dart @@ -11,14 +11,11 @@ import 'package:unittest/unittest.dart'; import 'package:dartdoc/dartdoc.dart'; import 'package:dartdoc/src/package_utils.dart'; - void main() { group('dartdoc test', () { - test('version info', () { String version = getPackageVersion(Directory.current.path); expect(version, VERSION); }); }); - } diff --git a/test/io_utils_test.dart b/test/io_utils_test.dart index 78ff501e36..714fd71548 100644 --- a/test/io_utils_test.dart +++ b/test/io_utils_test.dart @@ -12,11 +12,9 @@ import 'package:dartdoc/src/io_utils.dart'; void main() { group('io utils', () { - test('find files to document', () { var files = findFilesToDocumentInPackage(Directory.current.path); expect(files.length, 2); }); - }); } diff --git a/test/model_test.dart b/test/model_test.dart index 4f9d163a88..49cc3d6fde 100644 --- a/test/model_test.dart +++ b/test/model_test.dart @@ -47,9 +47,7 @@ class B extends A { abstract class C {} '''; - void main() { - AnalyzerHelper helper = new AnalyzerHelper(); Source source = helper.addSource(SOURCE1); LibraryElement e = helper.resolve(source); @@ -85,23 +83,20 @@ void main() { }); }); - group('Library', () { - test('name', () { expect(l.name, 'ex'); }); - Library sdkLib = new Library(getSdkLibrariesToDocument(helper.sdk, helper.context)[0]); + Library sdkLib = + new Library(getSdkLibrariesToDocument(helper.sdk, helper.context)[0]); test('sdk library name', () { expect(sdkLib.name, 'dart:async'); }); - }); group('Class', () { - var classes = l.getTypes(); Class A = classes[0]; var B = classes[1]; @@ -161,7 +156,6 @@ void main() { }); group('Function', () { - ModelFunction f1 = l.getFunctions()[0]; test('local element', () { @@ -182,7 +176,6 @@ void main() { }); group('Method', () { - var c = l.getTypes()[1]; var m = c.getMethods()[0]; @@ -196,7 +189,6 @@ void main() { }); group('Accessor', () { - var c = l.getTypes()[0]; var a = c.getAccessors()[0]; @@ -210,7 +202,6 @@ void main() { }); group('Field', () { - var c = l.getTypes()[0]; var f1 = c.getStaticFields()[0]; var f2 = c.getInstanceFields()[1]; @@ -233,7 +224,6 @@ void main() { }); group('Variable', () { - var v = l.getVariables()[0]; test('is final', () { @@ -254,7 +244,6 @@ void main() { }); group('Parameter', () { - test('has correct type name', () { var t = new Parameter(null, null); expect(t.typeName, equals('Parameters')); @@ -262,7 +251,6 @@ void main() { }); group('TypeParameter', () { - test('has correct type name', () { var t = new TypeParameter(null, null); expect(t.typeName, equals('Type Parameters')); @@ -270,7 +258,6 @@ void main() { }); group('Constructor', () { - var c = l.getTypes()[0].getCtors()[0]; test('has correct type name', () { @@ -279,7 +266,6 @@ void main() { }); group('Typedef', () { - test('has correct type name', () { var t = new Typedef(null, null); expect(t.typeName, equals('Typedefs')); @@ -289,9 +275,7 @@ void main() { var t = new Typedef(null, null); expect(t.getDocumentation(), null); }); - }); - } class AnalyzerHelper { @@ -305,7 +289,10 @@ class AnalyzerHelper { void _initAnalyzer() { Directory sdkDir = grinder.getSdkDir(['']); sdk = new DirectoryBasedDartSdk(new JavaFile(sdkDir.path)); - List resolvers = [new DartUriResolver(sdk), new FileUriResolver()]; + List resolvers = [ + new DartUriResolver(sdk), + new FileUriResolver() + ]; SourceFactory sourceFactory = new SourceFactory(resolvers); context = AnalysisEngine.instance.createAnalysisContext(); @@ -313,7 +300,6 @@ class AnalyzerHelper { } Source addSource(String contents) { - Source source = _cacheSource("/test.dart", contents); ChangeSet changeSet = new ChangeSet(); changeSet.addedSource(source); @@ -322,11 +308,12 @@ class AnalyzerHelper { } Source _cacheSource(String filePath, String contents) { - Source source = new FileBasedSource.con1(FileUtilities2.createFile(filePath)); + Source source = + new FileBasedSource.con1(FileUtilities2.createFile(filePath)); context.setContents(source, contents); return source; } - LibraryElement resolve(Source librarySource) => context.computeLibraryElement(librarySource); - + LibraryElement resolve(Source librarySource) => + context.computeLibraryElement(librarySource); } diff --git a/test/package_utils_test.dart b/test/package_utils_test.dart index 95b519742b..d6baa5b95e 100644 --- a/test/package_utils_test.dart +++ b/test/package_utils_test.dart @@ -12,7 +12,6 @@ import 'package:dartdoc/src/package_utils.dart'; void main() { group('package utils test', () { - test('get package name', () { String name = getPackageName(Directory.current.path); expect(name, 'dartdoc'); diff --git a/test/template_test.dart b/test/template_test.dart index ded8dece21..61e4a12b8e 100644 --- a/test/template_test.dart +++ b/test/template_test.dart @@ -12,8 +12,8 @@ import 'package:unittest/unittest.dart'; void main() { group('template', () { var script = new File(Platform.script.toFilePath()); - File tmplFile = new File( - '${script.parent.parent.path}/templates/sitemap.xml'); + File tmplFile = + new File('${script.parent.parent.path}/templates/sitemap.xml'); test('sitemap template exists', () { tmplFile.exists().then((t) => expect(t, true)); diff --git a/tool/grind.dart b/tool/grind.dart index 2294eb07bb..ab0499673d 100644 --- a/tool/grind.dart +++ b/tool/grind.dart @@ -22,14 +22,13 @@ void testDartdoc(GrinderContext context) { if (DOC_DIR.existsSync()) DOC_DIR.deleteSync(recursive: true); try { - context.log('running dartdoc'); - runDartScript(context, 'bin/dartdoc.dart'); - - File indexHtml = joinFile(DOC_DIR, ['index.html']); - if(!indexHtml.existsSync()) context.fail('docs not generated'); - File docFile = joinFile(DOC_DIR, ['dartdoc.html']); - if(!docFile.existsSync()) context.fail('docs not generated'); + context.log('running dartdoc'); + runDartScript(context, 'bin/dartdoc.dart'); + File indexHtml = joinFile(DOC_DIR, ['index.html']); + if (!indexHtml.existsSync()) context.fail('docs not generated'); + File docFile = joinFile(DOC_DIR, ['dartdoc.html']); + if (!docFile.existsSync()) context.fail('docs not generated'); } catch (e) { rethrow; }