Complete extraction of sorted methods used by templates (#2443)

* Complete extraction of sorted methods used by templates

* rebuild generated files

Author: jcollins-g

lib/src/generator/templates.renderers.dart

@@ -130,6 +130,9 @@ class _Renderer_Package extends RendererBase<Package> {
         'documentedCategories': Property(
           getValue: (Object c) => (c as Package).documentedCategories,
         ),
+        'documentedCategoriesSorted': Property(
+          getValue: (Object c) => (c as Package).documentedCategoriesSorted,
+        ),
         'documentedWhere': Property(
           getValue: (Object c) => (c as Package).documentedWhere,
         ),
@@ -327,6 +330,9 @@ class _Renderer_LibraryContainer extends RendererBase<LibraryContainer> {
         'publicLibraries': Property(
           getValue: (Object c) => (c as LibraryContainer).publicLibraries,
         ),
+        'publicLibrariesSorted': Property(
+          getValue: (Object c) => (c as LibraryContainer).publicLibrariesSorted,
+        ),
         'sortKey': Property(
           getValue: (Object c) => (c as LibraryContainer).sortKey,
           getProperties: _Renderer_String.propertyMap,

lib/src/model/class.dart

@@ -23,13 +23,13 @@ class Class extends Container
     implements EnclosedElement {
   // TODO(srawlins): To make final, remove public getter, setter, rename to be
   // public, and add `final` modifier.
-  List<DefinedElementType> _mixins;
+  List<DefinedElementType> _mixedInTypes;
 
-  List<DefinedElementType> get mixins => _mixins;
+  List<DefinedElementType> get mixedInTypes => _mixedInTypes;
 
   @Deprecated('Field intended to be final; setter will be removed as early as '
       'Dartdoc 1.0.0')
-  set mixins(List<DefinedElementType> value) => _mixins = value;
+  set mixedInTypes(List<DefinedElementType> value) => _mixedInTypes = value;
 
   // TODO(srawlins): To make final, remove public getter, setter, rename to be
   // public, and add `final` modifier.
@@ -44,7 +44,7 @@ class Class extends Container
   final List<DefinedElementType> _interfaces;
 
   Class(ClassElement element, Library library, PackageGraph packageGraph)
-      : _mixins = element.mixins
+      : _mixedInTypes = element.mixins
             .map<DefinedElementType>(
                 (f) => ElementType.from(f, library, packageGraph))
             .where((mixin) => mixin != null)
@@ -109,10 +109,16 @@ class Class extends Container
   Iterable<Constructor> get constructors => element.constructors
       .map((e) => ModelElement.from(e, library, packageGraph) as Constructor);
 
+  bool get hasPublicConstructors => publicConstructors.isNotEmpty;
+
   @visibleForTesting
   Iterable<Constructor> get publicConstructors =>
       model_utils.filterNonPublic(constructors);
 
+  List<Constructor> _publicConstructorsSorted;
+  Iterable<Constructor> get publicConstructorsSorted =>
+      _publicConstructorsSorted ??= publicConstructors.toList()..sort(byName);
+
   /// Returns the library that encloses this element.
   @override
   ModelElement get enclosingElement => library;
@@ -131,24 +137,15 @@ class Class extends Container
     return kind;
   }
 
-  @override
-  bool get hasPublicConstructors => publicConstructorsSorted.isNotEmpty;
-
-  List<Constructor> _publicConstructorsSorted;
-
-  @override
-  List<Constructor> get publicConstructorsSorted =>
-      _publicConstructorsSorted ??= publicConstructors.toList()..sort(byName);
-
   bool get hasPublicImplementors => publicImplementors.isNotEmpty;
 
   bool get hasPublicInterfaces => publicInterfaces.isNotEmpty;
 
-  bool get hasPublicMixins => publicMixins.isNotEmpty;
+  bool get hasPublicMixedInTypes => publicMixedInTypes.isNotEmpty;
 
   @override
   bool get hasModifiers =>
-      hasPublicMixins ||
+      hasPublicMixedInTypes ||
       hasAnnotations ||
       hasPublicInterfaces ||
       hasPublicSuperChainReversed ||
@@ -199,6 +196,10 @@ class Class extends Container
     return result;
   }
 
+  List<Class> _publicImplementorsSorted;
+  Iterable<Class> get publicImplementorsSorted =>
+      _publicImplementorsSorted ??= publicImplementors.toList()..sort(byName);
+
   /*lazy final*/ List<Method> _inheritedMethods;
 
   Iterable<Method> get inheritedMethods {
@@ -291,8 +292,8 @@ class Class extends Container
   @override
   String get kind => 'class';
 
-  Iterable<DefinedElementType> get publicMixins =>
-      model_utils.filterNonPublic(mixins);
+  Iterable<DefinedElementType> get publicMixedInTypes =>
+      model_utils.filterNonPublic(mixedInTypes);
 
   @override
   DefinedElementType get modelType => super.modelType;
@@ -310,7 +311,7 @@ class Class extends Container
       _inheritanceChain.add(this);
 
       /// Caching should make this recursion a little less painful.
-      for (var c in mixins.reversed.map((e) => (e.element as Class))) {
+      for (var c in mixedInTypes.reversed.map((e) => (e.element as Class))) {
         _inheritanceChain.addAll(c.inheritanceChain);
       }
 

lib/src/model/container.dart

@@ -54,13 +54,6 @@ abstract class Container extends ModelElement with TypeParameters {
       .where((m) => !m.isStatic && !m.isOperator)
       .toList(growable: false);
 
-  /// Whether any constructors are public.
-  ///
-  /// This is only used in mustache templates.
-  bool get hasPublicConstructors => false;
-
-  Iterable<Constructor> get publicConstructorsSorted => [];
-
   /// Whether all instance fields are inherited.
   ///
   /// This is only used in mustache templates.

lib/src/model/extension.dart

@@ -56,8 +56,7 @@ class Extension extends Container
   List<Method> get declaredMethods {
     _methods ??= _extension.methods.map((e) {
       return ModelElement.from(e, library, packageGraph) as Method;
-    }).toList(growable: false)
-      ..sort(byName);
+    }).toList(growable: false);
     return _methods;
   }
 
@@ -78,8 +77,7 @@ class Extension extends Container
       }
       return ModelElement.fromPropertyInducingElement(f, library, packageGraph,
           getter: getter, setter: setter) as Field;
-    }).toList(growable: false)
-      ..sort(byName);
+    }).toList(growable: false);
     return _declaredFields;
   }
 

lib/src/model/library.dart

@@ -200,8 +200,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
     _extensions ??= _exportedAndLocalElements
         .whereType<ExtensionElement>()
         .map((e) => ModelElement.from(e, this, packageGraph) as Extension)
-        .toList(growable: false)
-          ..sort(byName);
+        .toList(growable: false);
     return _extensions;
   }
 
@@ -358,8 +357,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
         .whereType<ClassElement>()
         .where((element) => element.isEnum)
         .map((e) => ModelElement.from(e, this, packageGraph) as Enum)
-        .toList(growable: false)
-          ..sort(byName);
+        .toList(growable: false);
     return _enums;
   }
 
@@ -371,8 +369,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
         .whereType<ClassElement>()
         .where((ClassElement c) => c.isMixin)
         .map((e) => ModelElement.from(e, this, packageGraph) as Mixin)
-        .toList(growable: false)
-          ..sort(byName);
+        .toList(growable: false);
     return _mixins;
   }
 
@@ -398,8 +395,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
     _functions ??=
         _exportedAndLocalElements.whereType<FunctionElement>().map((e) {
       return ModelElement.from(e, this, packageGraph) as ModelFunction;
-    }).toList(growable: false)
-          ..sort(byName);
+    }).toList(growable: false);
     return _functions;
   }
 
@@ -480,8 +476,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
     _typedefs ??= _exportedAndLocalElements
         .whereType<FunctionTypeAliasElement>()
         .map((e) => ModelElement.from(e, this, packageGraph) as Typedef)
-        .toList(growable: false)
-          ..sort(byName);
+        .toList(growable: false);
     return _typedefs;
   }
 
@@ -494,8 +489,7 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
         .whereType<ClassElement>()
         .where((e) => !e.isMixin && !e.isEnum)
         .map((e) => ModelElement.from(e, this, packageGraph) as Class)
-        .toList(growable: false)
-          ..sort(byName);
+        .toList(growable: false);
     return _classes;
   }
 
@@ -528,7 +522,6 @@ class Library extends ModelElement with Categorization, TopLevelContainer {
             getter: getter, setter: setter);
         _variables.add(me);
       }
-      _variables.sort(byName);
     }
     return _variables;
   }

lib/src/model/library_container.dart

@@ -19,6 +19,10 @@ abstract class LibraryContainer
   Iterable<Library> get publicLibraries =>
       model_utils.filterNonPublic(libraries);
 
+  List<Library> _publicLibrariesSorted;
+  Iterable<Library> get publicLibrariesSorted =>
+      _publicLibrariesSorted ??= publicLibraries.toList()..sort(byName);
+
   bool get hasPublicLibraries => publicLibraries.isNotEmpty;
 
   /// The name of the container or object that this LibraryContainer is a part

lib/src/model/package.dart

@@ -82,7 +82,6 @@ class Package extends LibraryContainer
   /// Holds all libraries added to this package.  May include non-documented
   /// libraries, but is not guaranteed to include a complete list of
   /// non-documented libraries unless they are all referenced by documented ones.
-  /// Not sorted.
   final Set<Library> allLibraries = {};
 
   bool get hasHomepage =>
@@ -338,6 +337,15 @@ class Package extends LibraryContainer
   Iterable<Category> get documentedCategories =>
       categories.where((c) => c.isDocumented);
 
+  Iterable<Category> get documentedCategoriesSorted {
+    // Category display order is configurable; leave the category order
+    // as defined if the order is specified.
+    if (config.categoryOrder.isEmpty) {
+      return documentedCategories;
+    }
+    return documentedCategories.toList()..sort(byName);
+  }
+
   bool get hasDocumentedCategories => documentedCategories.isNotEmpty;
 
   DartdocOptionContext _config;

lib/src/model/package_graph.dart

@@ -10,7 +10,6 @@ import 'package:analyzer/file_system/file_system.dart';
 import 'package:analyzer/src/generated/sdk.dart';
 import 'package:analyzer/src/generated/source.dart';
 import 'package:analyzer/src/generated/source_io.dart';
-import 'package:collection/collection.dart';
 import 'package:dartdoc/src/dartdoc_options.dart';
 import 'package:dartdoc/src/logging.dart';
 import 'package:dartdoc/src/model/model.dart';
@@ -80,7 +79,6 @@ class PackageGraph {
     // After the allModelElements traversal to be sure that all packages
     // are picked up.
     for (var package in documentedPackages) {
-      package.libraries.sort((a, b) => compareNatural(a.name, b.name));
       for (var library in package.libraries) {
         _addToImplementors(library.allClasses);
         _extensions.addAll(library.extensions);
@@ -89,9 +87,6 @@ class PackageGraph {
         package.warn(PackageWarning.noDocumentableLibrariesInPackage);
       }
     }
-    for (var l in _implementors.values) {
-      l.sort();
-    }
     allImplementorsAdded = true;
     allExtensionsAdded = true;
 
@@ -614,7 +609,7 @@ class PackageGraph {
     }
 
     void addImplementor(Class class_) {
-      for (var type in class_.mixins) {
+      for (var type in class_.mixedInTypes) {
         checkAndAddClass(type.element, class_);
       }
       if (class_.supertype != null) {

lib/src/model/top_level_container.dart

@@ -49,24 +49,59 @@ abstract class TopLevelContainer implements Nameable {
 
   Iterable<Class> get publicClasses => model_utils.filterNonPublic(classes);
 
+  List<Class> _publicClassesSorted;
+  Iterable<Class> get publicClassesSorted =>
+      _publicClassesSorted ??= publicClasses.toList()..sort(byName);
+
   Iterable<Extension> get publicExtensions =>
       model_utils.filterNonPublic(extensions);
 
+  List<Extension> _publicExtensionsSorted;
+  Iterable<Extension> get publicExtensionsSorted =>
+      _publicExtensionsSorted ??= publicExtensions.toList()..sort(byName);
+
   Iterable<TopLevelVariable> get publicConstants =>
       model_utils.filterNonPublic(constants);
 
+  Iterable<TopLevelVariable> get publicConstantsSorted =>
+      publicConstants.toList()..sort(byName);
+
   Iterable<Enum> get publicEnums => model_utils.filterNonPublic(enums);
 
+  List<Enum> _publicEnumsSorted;
+  Iterable<Enum> get publicEnumsSorted =>
+      _publicEnumsSorted ??= publicEnums.toList()..sort(byName);
+
   Iterable<Class> get publicExceptions =>
       model_utils.filterNonPublic(exceptions);
 
+  List<Class> _publicExceptionsSorted;
+  Iterable<Class> get publicExceptionsSorted =>
+      _publicExceptionsSorted ??= publicExceptions.toList()..sort(byName);
+
   Iterable<ModelFunctionTyped> get publicFunctions =>
       model_utils.filterNonPublic(functions);
 
+  List<ModelFunctionTyped> _publicFunctionsSorted;
+  Iterable<ModelFunctionTyped> get publicFunctionsSorted =>
+      _publicFunctionsSorted ??= publicFunctions.toList()..sort(byName);
+
   Iterable<Mixin> get publicMixins => model_utils.filterNonPublic(mixins);
 
+  List<Mixin> _publicMixinsSorted;
+  Iterable<Mixin> get publicMixinsSorted =>
+      _publicMixinsSorted ??= publicMixins.toList()..sort(byName);
+
   Iterable<TopLevelVariable> get publicProperties =>
       model_utils.filterNonPublic(properties);
 
+  List<TopLevelVariable> _publicPropertiesSorted;
+  Iterable<TopLevelVariable> get publicPropertiesSorted =>
+      _publicPropertiesSorted ??= publicProperties.toList()..sort(byName);
+
   Iterable<Typedef> get publicTypedefs => model_utils.filterNonPublic(typedefs);
+
+  List<Typedef> _publicTypedefsSorted;
+  Iterable<Typedef> get publicTypedefsSorted =>
+      _publicTypedefsSorted ??= publicTypedefs.toList()..sort(byName);
 }

lib/templates/html/_feature_set.html

@@ -2,4 +2,4 @@
   {{#displayedLanguageFeatures}}
     {{{featureLabel}}}
   {{/displayedLanguageFeatures}}
-{{/hasFeatureSet}}
+{{/hasFeatureSet}}