Mustachio: fix getter override order, and bounds bug (dart-lang#2523)

Mustachio: fix getter override order, and bounds bug

Fix indentation in category.html (dart-lang#2521)

WIP: flip to mustachio

Author: srawlins

lib/src/generator/dartdoc_generator_backend.dart

@@ -2,6 +2,7 @@
 // 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.
 
+import 'package:analyzer/file_system/file_system.dart';
 import 'package:dartdoc/dartdoc.dart';
 import 'package:dartdoc/options.dart';
 import 'package:dartdoc/src/generator/generator_frontend.dart';
@@ -11,6 +12,7 @@ import 'package:dartdoc/src/generator/templates.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:dartdoc/src/model/package.dart';
 import 'package:dartdoc/src/model/package_graph.dart';
+import 'package:dartdoc/src/mustachio/renderer_base.dart';
 import 'package:dartdoc/src/warnings.dart';
 import 'package:mustache/mustache.dart';
 import 'package:path/path.dart' as path show Context;
@@ -90,7 +92,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
         sidebarForLibrary = SidebarGenerator(templates.sidebarLibraryTemplate);
 
   /// Helper method to bind template data and emit the content to the writer.
-  void render(FileWriter writer, String filename, Template template,
+  void render0(FileWriter writer, String filename, Template template,
       TemplateData data) {
     var content = template.renderString(data);
     if (!options.useBaseHref) {
@@ -100,6 +102,17 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
         element: data.self is Warnable ? data.self : null);
   }
 
+  /// Helper method to bind template data and emit the content to the writer.
+  void render<T extends TemplateData>(FileWriter writer, String filename,
+      RenderFunction<T> renderTemplate, T data) {
+    var content = renderTemplate(data, FILE);
+    if (!options.useBaseHref) {
+      content = content.replaceAll(HTMLBASE_PLACEHOLDER, data.htmlBase);
+    }
+    writer.write(filename, content,
+        element: data.self is Warnable ? data.self : null);
+  }
+
   @override
   void generateCategoryJson(
       FileWriter writer, List<Categorization> categories) {
@@ -128,7 +141,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
   @override
   void generatePackage(FileWriter writer, PackageGraph graph, Package package) {
     TemplateData data = PackageTemplateData(options, graph, package);
-    render(writer, package.filePath, templates.indexTemplate, data);
+    render0(writer, package.filePath, templates.indexTemplate, data);
   }
 
   @override
@@ -143,15 +156,15 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
       FileWriter writer, PackageGraph packageGraph, Library lib) {
     TemplateData data = LibraryTemplateData(
         options, packageGraph, lib, sidebarForLibrary.getRenderFor);
-    render(writer, lib.filePath, templates.libraryTemplate, data);
+    render0(writer, lib.filePath, templates.libraryTemplate, data);
   }
 
   @override
   void generateClass(
       FileWriter writer, PackageGraph packageGraph, Library lib, Class clazz) {
     TemplateData data = ClassTemplateData(options, packageGraph, lib, clazz,
         sidebarForLibrary.getRenderFor, sidebarForContainer.getRenderFor);
-    render(writer, clazz.filePath, templates.classTemplate, data);
+    render0(writer, clazz.filePath, templates.classTemplate, data);
   }
 
   @override
@@ -164,15 +177,15 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
         extension,
         sidebarForLibrary.getRenderFor,
         sidebarForContainer.getRenderFor);
-    render(writer, extension.filePath, templates.extensionTemplate, data);
+    render0(writer, extension.filePath, templates.extensionTemplate, data);
   }
 
   @override
   void generateMixin(
       FileWriter writer, PackageGraph packageGraph, Library lib, Mixin mixin) {
     TemplateData data = MixinTemplateData(options, packageGraph, lib, mixin,
         sidebarForLibrary.getRenderFor, sidebarForContainer.getRenderFor);
-    render(writer, mixin.filePath, templates.mixinTemplate, data);
+    render0(writer, mixin.filePath, templates.mixinTemplate, data);
   }
 
   @override
@@ -181,7 +194,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = ConstructorTemplateData(options, packageGraph, lib,
         clazz, constructor, sidebarForContainer.getRenderFor);
 
-    render(writer, constructor.filePath, templates.constructorTemplate, data);
+    render0(writer, constructor.filePath, templates.constructorTemplate, data);
   }
 
   @override
@@ -190,7 +203,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = EnumTemplateData(options, packageGraph, lib, eNum,
         sidebarForLibrary.getRenderFor, sidebarForContainer.getRenderFor);
 
-    render(writer, eNum.filePath, templates.enumTemplate, data);
+    render0(writer, eNum.filePath, templates.enumTemplate, data);
   }
 
   @override
@@ -199,7 +212,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = FunctionTemplateData(
         options, packageGraph, lib, function, sidebarForLibrary.getRenderFor);
 
-    render(writer, function.filePath, templates.functionTemplate, data);
+    render0(writer, function.filePath, templates.functionTemplate, data);
   }
 
   @override
@@ -208,7 +221,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = MethodTemplateData(options, packageGraph, lib, clazz,
         method, sidebarForContainer.getRenderFor);
 
-    render(writer, method.filePath, templates.methodTemplate, data);
+    render0(writer, method.filePath, templates.methodTemplate, data);
   }
 
   @override
@@ -222,7 +235,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = PropertyTemplateData(options, packageGraph, lib, clazz,
         property, sidebarForContainer.getRenderFor);
 
-    render(writer, property.filePath, templates.propertyTemplate, data);
+    render0(writer, property.filePath, templates.propertyTemplate, data);
   }
 
   @override
@@ -231,7 +244,8 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = TopLevelPropertyTemplateData(
         options, packageGraph, lib, property, sidebarForLibrary.getRenderFor);
 
-    render(writer, property.filePath, templates.topLevelPropertyTemplate, data);
+    render0(
+        writer, property.filePath, templates.topLevelPropertyTemplate, data);
   }
 
   @override
@@ -245,7 +259,7 @@ abstract class DartdocGeneratorBackend implements GeneratorBackend {
     TemplateData data = TypedefTemplateData(
         options, packageGraph, lib, typeDef, sidebarForLibrary.getRenderFor);
 
-    render(writer, typeDef.filePath, templates.typeDefTemplate, data);
+    render0(writer, typeDef.filePath, templates.typeDefTemplate, data);
   }
 
   @override

lib/src/generator/html_generator.dart

@@ -36,7 +36,7 @@ class HtmlGeneratorBackend extends DartdocGeneratorBackend {
     super.generatePackage(writer, graph, package);
     // We have to construct the data again. This only happens once per package.
     TemplateData data = PackageTemplateData(options, graph, package);
-    render(writer, '__404error.html', templates.errorTemplate, data);
+    render0(writer, '__404error.html', templates.errorTemplate, data);
   }
 
   @override

lib/src/generator/markdown_generator.dart

@@ -32,6 +32,6 @@ class MarkdownGeneratorBackend extends DartdocGeneratorBackend {
     super.generatePackage(writer, graph, package);
     // We have to construct the data again. This only happens once per package.
     TemplateData data = PackageTemplateData(options, graph, package);
-    render(writer, '__404error.md', templates.errorTemplate, data);
+    render0(writer, '__404error.md', templates.errorTemplate, data);
   }
 }

lib/src/generator/templates.dart

@@ -4,7 +4,19 @@
 
 // TODO(srawlins): Add Renderer annotations for more types as the mustachio
 // implementation matures.
-@Renderer(#renderIndex, Context<PackageTemplateData>(), visibleTypes: {Package})
+@Renderer(#renderCategory, Context<CategoryTemplateData>())
+@Renderer(#renderClass, Context<ClassTemplateData>())
+@Renderer(#renderConstructor, Context<ConstructorTemplateData>())
+@Renderer(#renderEnum, Context<EnumTemplateData>())
+@Renderer(#renderExtension, Context<ExtensionTemplateData>())
+@Renderer(#renderFunction, Context<FunctionTemplateData>())
+@Renderer(#renderIndex, Context<PackageTemplateData>())
+@Renderer(#renderLibrary, Context<LibraryTemplateData>())
+@Renderer(#renderMethod, Context<MethodTemplateData>())
+@Renderer(#renderMixin, Context<MixinTemplateData>())
+@Renderer(#renderProperty, Context<PropertyTemplateData>())
+@Renderer(#renderTopLevelProperty, Context<TopLevelPropertyTemplateData>())
+@Renderer(#renderTypedef, Context<TypedefTemplateData>())
 library dartdoc.templates;
 
 import 'package:analyzer/file_system/file_system.dart';