alphabetize names, like methods or properties

Author: sethladd

lib/src/model.dart

@@ -16,6 +16,8 @@ import 'model_utils.dart';
 import 'package_meta.dart';
 import '../markdown_processor.dart';
 
+int byName(a, b) => a.name.toUpperCase().compareTo(b.name.toUpperCase());
+
 final Map<Class, List<Class>> _implementors = new Map();
 
 void _addToImplementors(Class c) {
@@ -536,7 +538,7 @@ class Library extends ModelElement {
     elements..removeWhere(isPrivate);
     _variables = elements
         .map((e) => new TopLevelVariable(e, this))
-        .toList(growable: false);
+        .toList(growable: false)..sort(byName);
 
     return _variables;
   }
@@ -545,13 +547,15 @@ class Library extends ModelElement {
 
   /// All variables ("properties") except constants.
   List<TopLevelVariable> get properties {
-    return _getVariables().where((v) => !v.isConst).toList(growable: false);
+    return _getVariables().where((v) => !v.isConst).toList(growable: false)
+      ..sort(byName);
   }
 
   bool get hasConstants => _getVariables().any((v) => v.isConst);
 
   List<TopLevelVariable> get constants {
-    return _getVariables().where((v) => v.isConst).toList(growable: false);
+    return _getVariables().where((v) => v.isConst).toList(growable: false)
+      ..sort(byName);
   }
 
   bool get hasEnums => enums.isNotEmpty;
@@ -565,7 +569,7 @@ class Library extends ModelElement {
     _enums = enumClasses
         .where(isPublic)
         .map((e) => new Enum(e, this))
-        .toList(growable: false);
+        .toList(growable: false)..sort((a, b) => a.name.compareTo(b.name));
     return _enums;
   }
 
@@ -587,7 +591,9 @@ class Library extends ModelElement {
     elements.addAll(_exportedNamespace
         .where((element) => element is FunctionTypeAliasElement));
     elements..removeWhere(isPrivate);
-    _typeDefs = elements.map((e) => new Typedef(e, this)).toList();
+    _typeDefs = elements
+        .map((e) => new Typedef(e, this))
+        .toList(growable: false)..sort(byName);
     return _typeDefs;
   }
 
@@ -607,7 +613,7 @@ class Library extends ModelElement {
     elements..removeWhere(isPrivate);
     _functions = elements.map((e) {
       return new ModelFunction(e, this);
-    }).toList(growable: false);
+    }).toList(growable: false)..sort(byName);
     return _functions;
   }
 
@@ -631,7 +637,7 @@ class Library extends ModelElement {
     _classes = types
         .where(isPublic)
         .map((e) => new Class(e, this))
-        .toList(growable: true);
+        .toList(growable: false)..sort(byName);
 
     return _classes;
   }
@@ -654,7 +660,7 @@ class Library extends ModelElement {
 
   List<Class> get exceptions {
     return _allClasses.where((c) => c.isErrorOrException).toList(
-        growable: false);
+        growable: false)..sort(byName);
   }
 
   @override
@@ -669,14 +675,17 @@ class Class extends ModelElement {
   List<Method> _allMethods;
   List<Operator> _operators;
   List<Operator> _inheritedOperators;
+  List<Operator> _allOperators;
   List<Method> _inheritedMethods;
   List<Method> _staticMethods;
   List<Method> _instanceMethods;
+  List<Method> _allInstanceMethods;
   List<Field> _fields;
   List<Field> _staticFields;
   List<Field> _constants;
   List<Field> _instanceFields;
   List<Field> _inheritedProperties;
+  List<Field> _allInstanceProperties;
 
   ClassElement get _cls => (element as ClassElement);
 
@@ -783,7 +792,7 @@ class Class extends ModelElement {
     _fields = _cls.fields
         .where(isPublic)
         .map((e) => new Field(e, library))
-        .toList(growable: false);
+        .toList(growable: false)..sort(byName);
 
     return _fields;
   }
@@ -793,35 +802,37 @@ class Class extends ModelElement {
     _staticFields = _allFields
         .where((f) => f.isStatic)
         .where((f) => !f.isConst)
-        .toList(growable: false);
+        .toList(growable: false)..sort(byName);
     return _staticFields;
   }
 
+  bool get hasInstanceProperties => instanceProperties.isNotEmpty;
+
   List<Field> get instanceProperties {
     if (_instanceFields != null) return _instanceFields;
-    _instanceFields =
-        _allFields.where((f) => !f.isStatic).toList(growable: false);
+    _instanceFields = _allFields
+        .where((f) => !f.isStatic)
+        .toList(growable: false)..sort(byName);
     return _instanceFields;
   }
 
   List<Field> get constants {
     if (_constants != null) return _constants;
-    _constants = _allFields.where((f) => f.isConst).toList(growable: false);
+    _constants = _allFields.where((f) => f.isConst).toList(growable: false)
+      ..sort((a, b) => a.name.compareTo(b.name));
     return _constants;
   }
 
   bool get hasConstants => constants.isNotEmpty;
 
   bool get hasStaticProperties => staticProperties.isNotEmpty;
 
-  bool get hasInstanceProperties => instanceProperties.isNotEmpty;
-
   List<Constructor> get constructors {
     if (_constructors != null) return _constructors;
 
     _constructors = _cls.constructors.where(isPublic).map((e) {
       return new Constructor(e, library);
-    }).toList(growable: true);
+    }).toList(growable: true)..sort(byName);
 
     return _constructors;
   }
@@ -837,26 +848,37 @@ class Class extends ModelElement {
       } else {
         return new Operator(e, library);
       }
-    }).toList(growable: false);
+    }).toList(growable: false)..sort(byName);
 
     return _allMethods;
   }
 
   List<Operator> get operators {
     if (_operators != null) return _operators;
 
-    _operators = _methods.where((m) => m.isOperator).toList(growable: false);
+    _operators = _methods.where((m) => m.isOperator).toList(growable: false)
+      ..sort(byName);
 
     return _operators;
   }
 
   bool get hasOperators =>
       operators.isNotEmpty || inheritedOperators.isNotEmpty;
 
+  List<Operator> get allOperators {
+    if (_allOperators != null) return _allOperators;
+    _allOperators = []
+      ..addAll(operators)
+      ..addAll(inheritedOperators)
+      ..sort(byName);
+    return _allOperators;
+  }
+
   List<Method> get staticMethods {
     if (_staticMethods != null) return _staticMethods;
 
-    _staticMethods = _methods.where((m) => m.isStatic).toList(growable: false);
+    _staticMethods = _methods.where((m) => m.isStatic).toList(growable: false)
+      ..sort(byName);
 
     return _staticMethods;
   }
@@ -868,7 +890,7 @@ class Class extends ModelElement {
 
     _instanceMethods = _methods
         .where((m) => !m.isStatic && !m.isOperator)
-        .toList(growable: false);
+        .toList(growable: false)..sort(byName);
 
     return _instanceMethods;
   }
@@ -911,9 +933,20 @@ class Class extends ModelElement {
       }
     }
 
+    _inheritedMethods..sort(byName);
+
     return _inheritedMethods;
   }
 
+  List<Method> get allInstanceMethods {
+    if (_allInstanceMethods != null) return _allInstanceMethods;
+    _allInstanceMethods = []
+      ..addAll(instanceMethods)
+      ..addAll(inheritedMethods)
+      ..sort(byName);
+    return _allInstanceMethods;
+  }
+
   List<Method> get inheritedOperators {
     if (_inheritedOperators != null) return _inheritedOperators;
     InheritanceManager manager = new InheritanceManager(element.library);
@@ -959,6 +992,8 @@ class Class extends ModelElement {
       _inheritedOperators.add(new Operator.inherited(value, lib));
     }
 
+    _inheritedOperators..sort(byName);
+
     return _inheritedOperators;
   }
 
@@ -999,6 +1034,9 @@ class Class extends ModelElement {
         _inheritedProperties.add(new Field.inherited(e, lib));
       }
     }
+
+    _inheritedProperties..sort(byName);
+
     return _inheritedProperties;
   }
 
@@ -1008,6 +1046,18 @@ class Class extends ModelElement {
   bool get hasProperties =>
       inheritedProperties.isNotEmpty || instanceProperties.isNotEmpty;
 
+  List<Field> get allInstanceProperties {
+    if (_allInstanceProperties != null) return _allInstanceProperties;
+
+    // TODO best way to make this a fixed length list?
+    _allInstanceProperties = []
+      ..addAll(instanceProperties)
+      ..addAll(inheritedProperties)
+      ..sort(byName);
+
+    return _allInstanceProperties;
+  }
+
   bool get isErrorOrException {
     bool _doCheck(InterfaceType type) {
       return (type.element.library.isDartCore &&
@@ -1049,7 +1099,7 @@ class Enum extends Class {
         .where(isPublic)
         .where((f) => f.isConst)
         .map((field) => new EnumField(index++, field, library))
-        .toList(growable: false);
+        .toList(growable: false)..sort(byName);
 
     return _constants;
   }

lib/templates/_sidebar_for_class.html

@@ -22,12 +22,9 @@
 
     {{#class.hasInstanceProperties}}
     <li class="section-title"><a href="{{class.href}}#instance-properties">Properties</a></li>
-    {{#class.instanceProperties}}
+    {{#class.allInstanceProperties}}
     <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.instanceProperties}}
-    {{#class.inheritedProperties}}
-    <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.inheritedProperties}}
+    {{/class.allInstanceProperties}}
     {{/class.hasInstanceProperties}}
 
     {{#class.hasConstructors}}
@@ -39,21 +36,15 @@
 
     {{#class.hasOperators}}
     <li class="section-title"><a href="{{class.href}}#operators">Operators</a></li>
-    {{#class.operators}}
-    <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.operators}}
-    {{#class.inheritedOperators}}
+    {{#class.allOperators}}
     <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.inheritedOperators}}
+    {{/class.allOperators}}
     {{/class.hasOperators}}
 
     {{#class.hasMethods}}
     <li class="section-title"><a href="{{class.href}}#methods">Methods</a></li>
-    {{#class.instanceMethods}}
-    <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.instanceMethods}}
-    {{#class.inheritedMethods}}
+    {{#class.allInstanceMethods}}
     <li><a href="{{href}}">{{name}}</a></li>
-    {{/class.inheritedMethods}}
+    {{/class.allInstanceMethods}}
     {{/class.hasMethods}}
   </ol>

lib/templates/class.html

@@ -107,13 +107,9 @@ <h2>Static Methods</h2>
         <h2>Properties</h2>
 
         <dl class="properties">
-            {{#class.instanceProperties}}
+            {{#class.allInstanceProperties}}
             {{>property}}
-            {{/class.instanceProperties}}
-
-            {{#class.inheritedProperties}}
-            {{>property}}
-            {{/class.inheritedProperties}}
+            {{/class.allInstanceProperties}}
         </dl>
     </section>
     {{/class.hasProperties}}
@@ -144,13 +140,9 @@ <h2>Constructors</h2>
       <section class="summary" id="operators">
           <h2>Operators</h2>
           <dl class="callables">
-              {{#class.operators}}
-              {{>callable}}
-              {{/class.operators}}
-
-              {{#class.inheritedOperators}}
+              {{#class.allOperators}}
               {{>callable}}
-              {{/class.inheritedOperators}}
+              {{/class.allOperators}}
           </dl>
       </section>
       {{/class.hasOperators}}
@@ -159,13 +151,9 @@ <h2>Operators</h2>
       <section class="summary" id="instance-methods">
           <h2>Methods</h2>
           <dl class="callables">
-              {{#class.instanceMethods}}
-              {{>callable}}
-              {{/class.instanceMethods}}
-
-              {{#class.inheritedMethods}}
+              {{#class.allInstanceMethods}}
               {{>callable}}
-              {{/class.inheritedMethods}}
+              {{/class.allInstanceMethods}}
           </dl>
       </section>
       {{/class.hasMethods}}