Improve browser description formatting

Improve browser description formatting

I saw antdillon's branch to improve the formatting and really liked the idea (https://code.launchpad.net/~ya-bo-ng/juju-gui/linkify-charm-descriptions/+merge/192852).  However, I wanted to improve the testing and the XSS behavior.  Trying to accomplish the second of those involved quite a bit of changes from his original design, but there's still a regex in there or two.

To QA, look at the mediawiki summary tab.  Note that the change log and description now are better formmatted, and have links, and break only for long stuff.  mongodb's description shows the pre-line formatting off, and liferay's description shows why truncating at 300 characters was problematic--a url might be cut in half.  I thought of some approaches to try and make that work, but I thought that removing the 300 character limit looked better anyway.  cassandra's change log is another one to look at: the pre-line works well, I think, and there are a few links to look at in the "earlier changes" section when you expand the change log.

https://code.launchpad.net/~gary/juju-gui/linkify-charm-descriptions/+merge/194048

(do not edit description out of merge proposal)

[gary.poster, 2013-11-06 02:20:23]

Please take a look.

[huwshimi, 2013-11-06 05:26:30]

This looks like a really nice change, thanks Gary!

A minor issue is that occasionally in the changelog the "- REVNOXX" gets pushed
to a new line when there's clearly space for it on the previous line. Could this
be because there are trailing new lines in the commit message? Could we strip
the trailing new lines? This is obviously not a blocker, but the display does
seem a bit strange as it is now.

https://codereview.appspot.com/22200045/diff/1/app/config-debug.js
File app/config-debug.js (right):

https://codereview.appspot.com/22200045/diff/1/app/config-debug.js#newcode32
app/config-debug.js:32: charmworldURL: 'https://manage.jujucharms.com/',
Did you mean to commit this change?

https://codereview.appspot.com/22200045/diff/1/app/subapps/browser/templates/...
File app/subapps/browser/templates/browser_charm.handlebars (right):

https://codereview.appspot.com/22200045/diff/1/app/subapps/browser/templates/...
app/subapps/browser/templates/browser_charm.handlebars:149: <span
class="respect-whitespace">{{linkify message}}</span> -
I'm not sure that italics is the best way to distinguish these details from the
rest of the content, but I don't have a better suggestion at this point.

[gary.poster, 2013-11-06 13:36:09]

Please take a look.

[gary.poster, 2013-11-06 13:38:18]

On 2013/11/06 05:26:30, huwshimi wrote:
> This looks like a really nice change, thanks Gary!

Thanks, Huw, and thanks for the review.

> A minor issue is that occasionally in the changelog the "- REVNOXX" gets
pushed
> to a new line when there's clearly space for it on the previous line. Could
this
> be because there are trailing new lines in the commit message? Could we strip
> the trailing new lines? This is obviously not a blocker, but the display does
> seem a bit strange as it is now.

Good point.  I added this behavior with a test.

> https://codereview.appspot.com/22200045/diff/1/app/config-debug.js
> File app/config-debug.js (right):
> 
> https://codereview.appspot.com/22200045/diff/1/app/config-debug.js#newcode32
> app/config-debug.js:32: charmworldURL: 'https://manage.jujucharms.com/',
> Did you mean to commit this change?

Kind of. :-) We need to sneak it in soon, and this seemed like a reasonable time
to do so.  Sorry for not calling this out explicitly in reviewer comments.

>
https://codereview.appspot.com/22200045/diff/1/app/subapps/browser/templates/...
> File app/subapps/browser/templates/browser_charm.handlebars (right):
> 
>
https://codereview.appspot.com/22200045/diff/1/app/subapps/browser/templates/...
> app/subapps/browser/templates/browser_charm.handlebars:149: <span
> class="respect-whitespace">{{linkify message}}</span> -
> I'm not sure that italics is the best way to distinguish these details from
the
> rest of the content, but I don't have a better suggestion at this point.

Ack.  Since you don't have another suggestion, I'm leaving it, since I do think
it is an improvment.

[gary.poster, 2013-11-06 13:40:00]

https://codereview.appspot.com/22200045/diff/20001/app/config-debug.js
File app/config-debug.js (right):

https://codereview.appspot.com/22200045/diff/20001/app/config-debug.js#newcode32
app/config-debug.js:32: charmworldURL: 'https://manage.jujucharms.com/',
We can switch this now, so I'm doing it.

[rharding, 2013-11-06 13:49:22]

code looks good if a bit dense to weed through. Will QA.

https://codereview.appspot.com/22200045/diff/20001/app/config-debug.js
File app/config-debug.js (right):

https://codereview.appspot.com/22200045/diff/20001/app/config-debug.js#newcode32
app/config-debug.js:32: charmworldURL: 'https://manage.jujucharms.com/',
On 2013/11/06 13:40:01, gary.poster wrote:
> We can switch this now, so I'm doing it.

Thank you much!

[rharding, 2013-11-06 13:53:39]

LGTM, thanks for helping to get Ant's work from the sprint through!

[gary.poster, 2013-11-06 14:49:57]

*** Submitted:

Improve browser description formatting

I saw antdillon's branch to improve the formatting and really liked the idea
(https://code.launchpad.net/~ya-bo-ng/juju-gui/linkify-charm-descriptions/+mer...).
 However, I wanted to improve the testing and the XSS behavior.  Trying to
accomplish the second of those involved quite a bit of changes from his original
design, but there's still a regex in there or two.

To QA, look at the mediawiki summary tab.  Note that the change log and
description now are better formmatted, and have links, and break only for long
stuff.  mongodb's description shows the pre-line formatting off, and liferay's
description shows why truncating at 300 characters was problematic--a url might
be cut in half.  I thought of some approaches to try and make that work, but I
thought that removing the 300 character limit looked better anyway.  cassandra's
change log is another one to look at: the pre-line works well, I think, and
there are a few links to look at in the "earlier changes" section when you
expand the change log.

R=huwshimi, rharding
CC=
https://codereview.appspot.com/22200045

[gary.poster, 2013-11-06 17:43:58]

I responded to Rick's comment about density with a small refactoring and a lot
of comments.  Hopefully that helps our future selves.

Thank you both!