Extract file extensions to a new renderer

Author: jdkoren

lib/src/model/category.dart

@@ -9,6 +9,7 @@ import 'package:dartdoc/src/dartdoc_options.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:dartdoc/src/package_meta.dart';
 import 'package:dartdoc/src/render/category_renderer.dart';
+import 'package:dartdoc/src/render/filename_renderer.dart';
 import 'package:dartdoc/src/warnings.dart';
 
 /// A category is a subcategory of a package, containing libraries tagged
@@ -120,14 +121,14 @@ class Category extends Nameable
   @override
   String get fullyQualifiedName => name;
 
-  String get filePath => 'topics/${name}-topic.html';
+  String get filePath => _fileNameRenderer.renderFileName('topics/$name-topic');
 
   @override
   String get href => isCanonical ? '${package.baseHref}$filePath' : null;
 
-  String get categorization => _renderer.renderCategoryLabel(this);
+  String get categorization => _categoryRenderer.renderCategoryLabel(this);
 
-  String get linkedName => _renderer.renderLinkedName(this);
+  String get linkedName => _categoryRenderer.renderLinkedName(this);
 
   int _categoryIndex;
 
@@ -199,6 +200,9 @@ class Category extends Nameable
   @override
   Iterable<Typedef> get typedefs => _typedefs;
 
-  CategoryRenderer get _renderer =>
+  CategoryRenderer get _categoryRenderer =>
       packageGraph.rendererFactory.categoryRenderer;
+
+  FileNameRenderer get _fileNameRenderer =>
+      packageGraph.rendererFactory.fileNameRenderer;
 }

lib/src/model/class.dart

@@ -184,7 +184,7 @@ class Class extends Container
   ModelElement get enclosingElement => library;
 
   @override
-  String get fileName => "${name}-class.html";
+  String get fileName => fileNameRenderer.renderFileName('$name-class');
 
   @override
   String get filePath => '${library.dirName}/$fileName';

lib/src/model/field.dart

@@ -156,7 +156,8 @@ class Field extends ModelElement
   FieldElement get field => (element as FieldElement);
 
   @override
-  String get fileName => isConst ? '$name-constant.html' : '$name.html';
+  String get fileName =>
+      fileNameRenderer.renderFileName(isConst ? '$name-constant' : '$name');
 
   String _sourceCode;
 

lib/src/model/library.dart

@@ -375,7 +375,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
   }
 
   @override
-  String get fileName => '$dirName-library.html';
+  String get fileName => fileNameRenderer.renderFileName('$dirName-library');
 
   @override
   String get filePath => '${library.dirName}/$fileName';

lib/src/model/mixin.dart

@@ -64,7 +64,7 @@ class Mixin extends Class {
   bool get hasModifiers => super.hasModifiers || hasPublicSuperclassConstraints;
 
   @override
-  String get fileName => "${name}-mixin.html";
+  String get fileName => fileNameRenderer.renderFileName('$name-mixin');
 
   @override
   String get kind => 'mixin';

lib/src/model/model_element.dart

@@ -25,6 +25,7 @@ import 'package:dartdoc/src/element_type.dart';
 import 'package:dartdoc/src/logging.dart';
 import 'package:dartdoc/src/model/model.dart';
 import 'package:dartdoc/src/model_utils.dart' as utils;
+import 'package:dartdoc/src/render/filename_renderer.dart';
 import 'package:dartdoc/src/render/model_element_renderer.dart';
 import 'package:dartdoc/src/render/parameter_renderer.dart';
 import 'package:dartdoc/src/source_linker.dart';
@@ -787,7 +788,7 @@ abstract class ModelElement extends Canonicalization
     return '';
   }
 
-  String get fileName => "${name}.html";
+  String get fileName => fileNameRenderer.renderFileName(name);
 
   String get filePath;
 
@@ -916,6 +917,9 @@ abstract class ModelElement extends Canonicalization
     return _linkedName;
   }
 
+  FileNameRenderer get fileNameRenderer =>
+      packageGraph.rendererFactory.fileNameRenderer;
+
   ModelElementRenderer get _modelElementRenderer =>
       packageGraph.rendererFactory.modelElementRenderer;
 

lib/src/model/operator.dart

@@ -42,10 +42,9 @@ class Operator extends Method {
   String get fileName {
     var actualName = super.name;
     if (friendlyNames.containsKey(actualName)) {
-      return "operator_${friendlyNames[actualName]}.html";
-    } else {
-      return '$actualName.html';
+      actualName = "operator_${friendlyNames[actualName]}";
     }
+    return fileNameRenderer.renderFileName(actualName);
   }
 
   @override

lib/src/model/package.dart

@@ -181,7 +181,8 @@ class Package extends LibraryContainer
   @override
   String get enclosingName => packageGraph.defaultPackageName;
 
-  String get filePath => 'index.html';
+  String get filePath =>
+      packageGraph.rendererFactory.fileNameRenderer.renderFileName('index');
 
   @override
   String get fullyQualifiedName => 'package:$name';

lib/src/model/top_level_variable.dart

@@ -85,7 +85,8 @@ class TopLevelVariable extends ModelElement
   }
 
   @override
-  String get fileName => isConst ? '$name-constant.html' : '$name.html';
+  String get fileName =>
+      fileNameRenderer.renderFileName(isConst ? '$name-constant' : '$name');
 
   @override
   DefinedElementType get modelType => super.modelType;

lib/src/render/filename_renderer.dart

@@ -0,0 +1,12 @@
+// Copyright (c) 2020, the Dart project authors. Please see the AUTHORS file
+// 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.
+
+abstract class FileNameRenderer {
+  String renderFileName(String name);
+}
+
+class HtmlFileNameRenderer extends FileNameRenderer {
+  @override
+  String renderFileName(String name) => '$name.html';
+}

lib/src/render/renderer_factory.dart

@@ -7,13 +7,16 @@ import 'package:dartdoc/src/render/category_renderer.dart';
 import 'package:dartdoc/src/render/documentation_renderer.dart';
 import 'package:dartdoc/src/render/element_type_renderer.dart';
 import 'package:dartdoc/src/render/enum_field_renderer.dart';
+import 'package:dartdoc/src/render/filename_renderer.dart';
 import 'package:dartdoc/src/render/model_element_renderer.dart';
 import 'package:dartdoc/src/render/parameter_renderer.dart';
 import 'package:dartdoc/src/render/template_renderer.dart';
 import 'package:dartdoc/src/render/type_parameters_renderer.dart';
 import 'package:dartdoc/src/render/typedef_renderer.dart';
 
 abstract class RendererFactory {
+  FileNameRenderer get fileNameRenderer;
+
   TemplateRenderer get templateRenderer;
 
   CategoryRenderer get categoryRenderer;
@@ -42,6 +45,9 @@ abstract class RendererFactory {
 }
 
 class HtmlRenderFactory extends RendererFactory {
+  @override
+  FileNameRenderer get fileNameRenderer => HtmlFileNameRenderer();
+
   @override
   TemplateRenderer get templateRenderer => HtmlTemplateRenderer();
 

test/html/html_template_renderer_test.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:dartdoc/src/render/filename_renderer.dart';
 import 'package:dartdoc/src/render/template_renderer.dart';
 import 'package:test/test.dart';
 
@@ -23,4 +24,9 @@ void main() {
       expect(test, equals('<span class="deprecated">Banana</span> Fruit'));
     });
   });
+
+  test('HtmlFileNameRenderer adds html extension', () {
+    HtmlFileNameRenderer renderer = HtmlFileNameRenderer();
+    expect(renderer.renderFileName('MyFile'), equals('MyFile.html'));
+  });
 }