Add a template for sitemap generation

lib/src/generator.dart

@@ -6,6 +6,8 @@ library dartdoc.generator;
 
 import 'dart:io';
 
+import 'package:mustache4dart/mustache4dart.dart';
+
 import 'css.dart';
 import 'html_gen.dart';
 import 'html_utils.dart';
@@ -14,12 +16,16 @@ import 'model.dart';
 
 /// Generates the HTML files
 class HtmlGenerator {
+
+  // The sitemap template file
+  final String siteMapTemplate = '/templates/sitemap.xml';
 
   Directory out;
   Package package;
   HtmlHelper html = new HtmlHelper();
   CSS css = new CSS();
   HtmlGeneratorHelper helper;
+  List<String> htmlFiles =[];
 
   HtmlGenerator(this.package, this.out) {
     helper = new HtmlGeneratorHelper(package);
@@ -31,14 +37,17 @@ class HtmlGenerator {
     // copy the css resource into 'out'
     File f = joinFile(new Directory(out.path), [css.getCssName()]);
     f.writeAsStringSync(css.getCssContent());
+    generateSiteMap();
   }
 
   void generatePackage() {
     var packageName = package.name;
     var packageDesc = package.description;
     var packageVersion = package.version;
     if (packageName.isNotEmpty) {
-      File f = joinFile(new Directory(out.path), ['${packageName}_package.html']);
+      var fileName = '${packageName}_package.html';
+      File f = joinFile(new Directory(out.path), [fileName]);
+      htmlFiles.add(fileName);
       print('generating ${f.path}');
 
       html.start(title: 'Package ${packageName}', cssRef: css.getCssName());
@@ -75,8 +84,10 @@ class HtmlGenerator {
   }
 
   void generateLibrary(Library library) {
-    File f = joinFile(new Directory(out.path), [_getFileNameFor(library)]);
+    var fileName = _getFileNameFor(library);
+    File f = joinFile(new Directory(out.path), [fileName]);
     print('generating ${f.path}');
+    htmlFiles.add(fileName);
     html = new HtmlHelper();
     html.start(title: 'Library ${library.name}', cssRef: css.getCssName());
 
@@ -418,7 +429,17 @@ class HtmlGenerator {
     }
   }
 
-
+  void generateSiteMap() {
+    print('generating sitemap.xml');
+    File f = joinFile(new Directory(out.path), ['sitemap.xml']);
+    var script = new File(Platform.script.toFilePath());
+    File tmplFile = new File('${script.parent.parent.path}$siteMapTemplate');  
+    var tmpl = tmplFile.readAsStringSync();
+    // TODO: adjust urls
+    List names = htmlFiles.map((f) => {'name': '$f'}).toList();
+    var content = render(tmpl, {'links' : names}); 
+    f.writeAsStringSync(content);
+  }
 }
 
 String _getFileNameFor(Library library) {

pubspec.yaml

@@ -8,7 +8,9 @@ dependencies:
   args: any
   bootstrap: any
   logging: any
+  mustache4dart: '>= 1.0.0 < 2.0.0'
   path: any
+  unittest: any
   yaml: any
 executables:
   dartdoc: null

templates/sitemap.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> 
+{{#links}}
+  <url>
+    <loc>{{name}}</loc>
+  </url>
+{{/links}}
+</urlset>

test/all.dart

@@ -0,0 +1,7 @@
+library dartdoc.all_tests;
+
+import 'template_test.dart' as template_tests;
+
+main() {
+  template_tests.tests();
+}

test/template_test.dart

@@ -0,0 +1,49 @@
+library dartdoc.template_test;
+
+import 'dart:io';
+
+import 'package:mustache4dart/mustache4dart.dart';
+import 'package:unittest/unittest.dart';
+
+
+tests() {
+  group('template', () {
+    var script = new File(Platform.script.toFilePath());
+    File tmplFile = new File('${script.parent.parent.path}/templates/sitemap.xml');
+
+    test('sitemap template exists', () {
+      tmplFile.exists().then((t) => expect(t, true));
+    });
+
+    var siteMapTmpl = tmplFile.readAsStringSync();
+    var sitemap = compile(siteMapTmpl);
+
+    test('render', () {
+      expect(sitemap({'links' : [{'name': 'somefile.html'}]}), 
+            '''
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> 
+  <url>
+    <loc>somefile.html</loc>
+  </url>
+</urlset>
+''');
+      });
+
+      test('substitute multiple links', () {
+        expect(sitemap({'links' : [{'name': 'somefile.html'}, {'name': 'asecondfile.html'}]}),
+            '''
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"> 
+  <url>
+    <loc>somefile.html</loc>
+  </url>
+  <url>
+    <loc>asecondfile.html</loc>
+  </url>
+</urlset>
+''');
+      });
+
+    });
+}

tool/travis.sh

@@ -26,10 +26,8 @@ pub get
 # Verify that the libraries are error free.
 dartanalyzer --fatal-warnings \
   bin/dartdoc.dart \
-  lib/dartdoc.dart
-# TODO:
-#  test/all.dart
+  lib/dartdoc.dart \
+  test/all.dart
 
 # Run the tests.
-# TODO:
-#dart test/all.dart
+dart test/all.dart