Use indentation for maps in lockfile.

Use indentation for maps in lockfile.

BUG=https://code.google.com/p/dart/issues/detail?id=5104
R=nweiz@google.com

Committed: https://code.google.com/p/dart/source/detail?r=23114

[Bob Nystrom, 2013-05-22 21:04:02]

With this, lockfiles look like:

# Generated by pub
# See http://pub.dartlang.org/doc/glossary.html#lockfile
analyzer_experimental:
  description: "analyzer_experimental"
  source: "hosted"
  version: "0.5.9"
args:
  description: "args"
  source: "hosted"
  version: "0.5.9"
browser:
  description: "browser"
  source: "hosted"
  version: "0.5.9"

[nweiz, 2013-05-23 18:44:57]

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
File sdk/lib/_internal/pub/lib/src/lock_file.dart (right):

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:115: _stringify(bool isMapValue,
StringBuffer buffer, String indent, data) {
Move this into utils as yamlToString or something like that. Also make the
public signature just "String yamlToString(data)".

It's also probably worth adding unit tests for this function.

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:130: buffer.write('$indent$key:');
This is unsafe in general. If the key contains meaningful characters, this will
break. You should check for that and use json.stringify if it does.

Also probably worth validating that key is in fact a string.

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:139: var string =
json.stringify(data);
Since we'll need the logic above anyway, we might as well check if data is a
string that can be printed unquoted here.

[Bob Nystrom, 2013-05-23 23:05:55]

Thanks!

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
File sdk/lib/_internal/pub/lib/src/lock_file.dart (right):

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:115: _stringify(bool isMapValue,
StringBuffer buffer, String indent, data) {
On 2013/05/23 18:44:57, nweiz wrote:
> Move this into utils as yamlToString or something like that. Also make the
> public signature just "String yamlToString(data)".
> 
> It's also probably worth adding unit tests for this function.

Done.

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:130: buffer.write('$indent$key:');
On 2013/05/23 18:44:57, nweiz wrote:
> This is unsafe in general. If the key contains meaningful characters, this
will
> break. You should check for that and use json.stringify if it does.
> 
> Also probably worth validating that key is in fact a string.

Done.

https://codereview.chromium.org/15777002/diff/1/sdk/lib/_internal/pub/lib/src...
sdk/lib/_internal/pub/lib/src/lock_file.dart:139: var string =
json.stringify(data);
On 2013/05/23 18:44:57, nweiz wrote:
> Since we'll need the logic above anyway, we might as well check if data is a
> string that can be printed unquoted here.

Done.

[nweiz, 2013-05-23 23:26:00]

A couple typos, but otherwise LGTM.

Excited to have nice-looking lockfiles.

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
File sdk/lib/_internal/pub/lib/src/utils.dart (right):

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:463: /// strings may be unnecessarily
quoted, but it much simpler.
"it" -> "it's"

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:464: final _unquotableYamlString = new
RegExp(r"^[a-zA-Z_\-][a-zA-Z_0-9\-]*$");
I don't think you need to escape trailing hyphens in regexps, although it
doesn't hurt either.

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:466: /// Converts [data], which is a
parsed YAML object to a pretty-printed string,
"object" -> "object,"

[Bob Nystrom, 2013-05-23 23:47:14]

Committed patchset #2 manually as r23114 (presubmit successful).

[Bob Nystrom, 2013-05-23 23:47:52]

I'm happy to get this in too.

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
File sdk/lib/_internal/pub/lib/src/utils.dart (right):

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:463: /// strings may be unnecessarily
quoted, but it much simpler.
On 2013/05/23 23:26:00, nweiz wrote:
> "it" -> "it's"

Done.

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:464: final _unquotableYamlString = new
RegExp(r"^[a-zA-Z_\-][a-zA-Z_0-9\-]*$");
On 2013/05/23 23:26:00, nweiz wrote:
> I don't think you need to escape trailing hyphens in regexps, although it
> doesn't hurt either.

Done.

https://codereview.chromium.org/15777002/diff/5001/sdk/lib/_internal/pub/lib/...
sdk/lib/_internal/pub/lib/src/utils.dart:466: /// Converts [data], which is a
parsed YAML object to a pretty-printed string,
On 2013/05/23 23:26:00, nweiz wrote:
> "object" -> "object,"

Done.