Determine file type based on documentation location

Author: jdkoren

lib/src/model/category.dart

@@ -9,7 +9,6 @@ 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
@@ -121,7 +120,9 @@ class Category extends Nameable
   @override
   String get fullyQualifiedName => name;
 
-  String get filePath => _fileNameRenderer.renderFileName('topics/$name-topic');
+  String get fileType => package.fileType;
+
+  String get filePath => 'topics/$name-topic.$fileType';
 
   @override
   String get href => isCanonical ? '${package.baseHref}$filePath' : null;
@@ -202,7 +203,4 @@ class Category extends Nameable
 
   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 => fileNameRenderer.renderFileName('$name-class');
+  String get fileName => '$name-class.$fileType';
 
   @override
   String get filePath => '${library.dirName}/$fileName';

lib/src/model/field.dart

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

lib/src/model/library.dart

@@ -375,7 +375,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
   }
 
   @override
-  String get fileName => fileNameRenderer.renderFileName('$dirName-library');
+  String get fileName => '$dirName-library.$fileType';
 
   @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 => fileNameRenderer.renderFileName('$name-mixin');
+  String get fileName => '$name-mixin.$fileType';
 
   @override
   String get kind => 'mixin';

lib/src/model/model_element.dart

@@ -25,7 +25,6 @@ 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';
@@ -788,7 +787,9 @@ abstract class ModelElement extends Canonicalization
     return '';
   }
 
-  String get fileName => fileNameRenderer.renderFileName(name);
+  String get fileName => '$name.$fileType';
+
+  String get fileType => package.fileType;
 
   String get filePath;
 
@@ -917,9 +918,6 @@ abstract class ModelElement extends Canonicalization
     return _linkedName;
   }
 
-  FileNameRenderer get fileNameRenderer =>
-      packageGraph.rendererFactory.fileNameRenderer;
-
   ModelElementRenderer get _modelElementRenderer =>
       packageGraph.rendererFactory.modelElementRenderer;
 

lib/src/model/operator.dart

@@ -44,7 +44,7 @@ class Operator extends Method {
     if (friendlyNames.containsKey(actualName)) {
       actualName = "operator_${friendlyNames[actualName]}";
     }
-    return fileNameRenderer.renderFileName(actualName);
+    return '$actualName.$fileType';
   }
 
   @override

lib/src/model/package.dart

@@ -181,8 +181,19 @@ class Package extends LibraryContainer
   @override
   String get enclosingName => packageGraph.defaultPackageName;
 
-  String get filePath =>
-      packageGraph.rendererFactory.fileNameRenderer.renderFileName('index');
+  String get filePath => 'index.$fileType';
+
+  String get fileType {
+    // TODO(jdkoren): Provide a way to determine file type of a remote package's
+    // docs. Perhaps make this configurable through dartdoc options.
+    // In theory, a remote package could be documented in any supported format.
+    // In practice, devs depend on Dart, Flutter, and/or packages fetched
+    // from pub.dev, and we know that all of those use html docs.
+    if (package.documentedWhere == DocumentLocation.remote) {
+      return 'html';
+    }
+    return packageGraph.rendererFactory.fileTypeRenderer.fileType;
+  }
 
   @override
   String get fullyQualifiedName => 'package:$name';

lib/src/model/top_level_variable.dart

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

lib/src/render/filename_renderer.dart renamed to lib/src/render/file_type_renderer.dart

@@ -2,11 +2,11 @@
 // 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);
+abstract class FileTypeRenderer {
+  String get fileType;
 }
 
-class HtmlFileNameRenderer extends FileNameRenderer {
+class HtmlFileTypeRenderer extends FileTypeRenderer {
   @override
-  String renderFileName(String name) => '$name.html';
+  String get fileType => 'html';
 }