Add a path.formatUri method and release path 1.2.0.

Add a path.formatUri method and release path 1.2.0.

R=rnystrom@google.com

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

[Bob Nystrom, 2014-05-23 21:57:52]

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart
File pkg/path/lib/path.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:370: /// Returns a human-readable representation of
[uri].
"a human" -> "a terse, human".

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:372: /// If [uri] can be made relative to the current
working directory, that's
Document what types uri may be.

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:390: ///     path.formatUri('file:///root/path'); // ->
'file:///root/path'
Should this normalize too?

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:391: String formatUri(uri) => _context.formatUri(uri);
"format" still feels wrong to me. I expect it to take a format string or somehow
let the user configure the format. The intent of the method is not that the
result follows some specific format. If anything, it's the opposite: the result
will be less structured than the argument.

How about "shortenUri" or "prettyUri"?

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/src/context.dart
File pkg/path/lib/src/context.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/src/context.dar...
pkg/path/lib/src/context.dart:511: // fewest components. This avoids ugly things
like long "../" chains to get
How about replacing the first sentence with:

"Only return a relative path if it's actually shorter than the original one."

https://codereview.chromium.org/296233002/diff/1/pkg/path/test/posix_test.dart
File pkg/path/test/posix_test.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/test/posix_test.dar...
pkg/path/test/posix_test.dart:514:
expect(context.formatUri(Uri.parse('file:///root/path/a/b')), 'a/b');
The tests would be a bit cleaner if you passed a string argument for most tests
and than just had a single test for passing in a Uri object.

[nweiz, 2014-05-23 22:18:04]

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart
File pkg/path/lib/path.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:370: /// Returns a human-readable representation of
[uri].
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> "a human" -> "a terse, human".

Done.

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:372: /// If [uri] can be made relative to the current
working directory, that's
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> Document what types uri may be.

Done.

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:390: ///     path.formatUri('file:///root/path'); // ->
'file:///root/path'
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> Should this normalize too?

Good idea, done.

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:391: String formatUri(uri) => _context.formatUri(uri);
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> "format" still feels wrong to me. I expect it to take a format string or
somehow
> let the user configure the format. The intent of the method is not that the
> result follows some specific format. If anything, it's the opposite: the
result
> will be less structured than the argument.
> 
> How about "shortenUri" or "prettyUri"?

I feel like "format" can be interpreted in the same sense as e.g. "the Dart
formatter", but I don't mind "pretty" much either (although it's not a verb).
It's up to you.

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/src/context.dart
File pkg/path/lib/src/context.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/src/context.dar...
pkg/path/lib/src/context.dart:511: // fewest components. This avoids ugly things
like long "../" chains to get
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> How about replacing the first sentence with:
> 
> "Only return a relative path if it's actually shorter than the original one."

Done.

https://codereview.chromium.org/296233002/diff/1/pkg/path/test/posix_test.dart
File pkg/path/test/posix_test.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/test/posix_test.dar...
pkg/path/test/posix_test.dart:514:
expect(context.formatUri(Uri.parse('file:///root/path/a/b')), 'a/b');
On 2014/05/23 21:57:52, Bob Nystrom wrote:
> The tests would be a bit cleaner if you passed a string argument for most
tests
> and than just had a single test for passing in a Uri object.

Done.

[Bob Nystrom, 2014-05-23 22:24:37]

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart
File pkg/path/lib/path.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:391: String formatUri(uri) => _context.formatUri(uri);
On 2014/05/23 22:18:04, nweiz wrote:
> On 2014/05/23 21:57:52, Bob Nystrom wrote:
> > "format" still feels wrong to me. I expect it to take a format string or
> somehow
> > let the user configure the format. The intent of the method is not that the
> > result follows some specific format. If anything, it's the opposite: the
> result
> > will be less structured than the argument.
> > 
> > How about "shortenUri" or "prettyUri"?
> 
> I feel like "format" can be interpreted in the same sense as e.g. "the Dart
> formatter", but I don't mind "pretty" much either (although it's not a verb).
> It's up to you.

I like "pretty" a lot more than "format". It makes it clear that it produces
something for human aesthetics. It's a verb where I'm from!

[nweiz, 2014-05-23 22:36:55]

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart
File pkg/path/lib/path.dart (right):

https://codereview.chromium.org/296233002/diff/1/pkg/path/lib/path.dart#newco...
pkg/path/lib/path.dart:391: String formatUri(uri) => _context.formatUri(uri);
On 2014/05/23 22:24:38, Bob Nystrom wrote:
> On 2014/05/23 22:18:04, nweiz wrote:
> > On 2014/05/23 21:57:52, Bob Nystrom wrote:
> > > "format" still feels wrong to me. I expect it to take a format string or
> > somehow
> > > let the user configure the format. The intent of the method is not that
the
> > > result follows some specific format. If anything, it's the opposite: the
> > result
> > > will be less structured than the argument.
> > > 
> > > How about "shortenUri" or "prettyUri"?
> > 
> > I feel like "format" can be interpreted in the same sense as e.g. "the Dart
> > formatter", but I don't mind "pretty" much either (although it's not a
verb).
> > It's up to you.
> 
> I like "pretty" a lot more than "format". It makes it clear that it produces
> something for human aesthetics. It's a verb where I'm from!

Done.

[Bob Nystrom, 2014-05-23 22:55:12]

LGTM!

[nweiz, 2014-05-23 23:04:47]

Committed patchset #3 manually as r36597 (presubmit successful).