Fixed parameters losing their original order

pkg/docgen/lib/dart2yaml.dart

 // Copyright (c) 2013, 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.
 
 /**
  * This library is used to convert data from a map to a YAML string.
  */
 library dart2yaml;
 
 /**
  * Gets a String representing the input Map in YAML format.
  */
 String getYamlString(Map documentData) {
   StringBuffer yaml = new StringBuffer();
   _addLevel(yaml, documentData, 0);
   return yaml.toString();
 }
 
 /**
  * This recursive function builds a YAML string from [documentData] and
  * adds it to [yaml].
  * The [level] input determines the indentation of the block being processed.
  * The [isList] input determines whether [documentData] is a member of an outer
  * lists of maps. A map must be preceeded with a '-' if it is to exist at the
  * same level of indentation in the YAML output as other members of the list.
  */
 void _addLevel(StringBuffer yaml, Map documentData, int level,
                {bool isList: false}) {
-  // Since the ordering of the keys could be non-deterministic, the keys
-  // are sorted to ensure consistency in the output.
+  // TODO(tmandel): The order of the keys could be nondeterministic, but it
+  // is insufficient to just sort the keys, as their order could be significant
+  // (i.e. parameters to a method). This should have a check that the map's key
+  // order is deterministic or something similar.

[Jennifer Messerly, 2013/08/16 21:43:32]

maybe check that documentData is LinkedHashMap or SplayTreeMap? Those two are
ordered consistently.

[Tate Mandel, 2013/08/16 21:53:41]

Are these the only two that are ordered consistently?

[Jennifer Messerly, 2013/08/16 22:05:49]

hmm, it's tricky. I guess it depends on who calls this function and what data
they supply, and if the order contract should be enforced here or at a higher
level in the code :)

Map by itself doesn't say anything about order. LinkedHashMap and SplayTreeMap
both guarantee an order, and plain HashMap does not, but with a custom type that
implements Map there's really no way to tell for sure.

[Tate Mandel, 2013/08/16 22:09:45]

I'd say it should be enforced elsewhere. We probably want to allow for the user
to decide how ordering should work. I updated the comment and reverted to the
initial version.

   var keys = documentData.keys.toList();
-  keys.sort();
   keys.forEach((key) {
     _calcSpaces(level, yaml);
     // Only the first entry of the map should be preceeded with a '-' since
     // the map is a member of an outer list and the map as a whole must be 
     // marked as a single member of that list. See example 2.4 at
     // http://www.yaml.org/spec/1.2/spec.html#id2759963
     if (isList && key == keys.first) {
       yaml.write("- ");
       level++;
     }
@@ skipping 31 matching lines @@
 
 /**
  * Based on the depth in the file, this function returns the correct spacing
  * for an element in the YAML output.
  */
 void _calcSpaces(int spaceLevel, StringBuffer yaml) {
   for (int i = 0; i < spaceLevel; i++) {
     yaml.write("  ");
   }
 }