Play template package doesn’t disable HTML escaping for Crown Copyright entity

[Paul Waite]

Steps to reproduce

Examine the Crown Copyright section of the packaged Play template

Expected behaviour

The copyright HTML entity is wrapped in a call to Html(), to avoid it being HTML-escaped

<a href="http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/">@crownCopyrightMessage.getOrElse(Html("&copy; Crown copyright"))</a>

Actual behaviour

The copyright HTML entity is not wrapped in an Html() call, resulting in it being HTML-escaped, and thus appearing as © in the browser.

<a href="http://www.nationalarchives.gov.uk/information-management/re-using-public-sector-information/copyright-and-re-use/crown-copyright/">@crownCopyrightMessage.getOrElse("&copy; Crown copyright")</a>

Workaround

I’m currently working around the bug by duplicating the Crown copyright message content in my main template:

@crownCopyrightMessage = {
    © Crown copyright
}
...
@govuk_template(... Some(crownCopyrightMessage))(content)

This content isn’t HTML-escaped, so the copyright entity appears correctly when the resulting pages are viewed in a web browser.

[Paul Waite]

I think the following line in play_processor.rb:

crown_copyright_message: '@crownCopyrightMessage.getOrElse("© Crown copyright")',

Should be changed to:

crown_copyright_message: '@crownCopyrightMessage.getOrElse(Html("© Crown copyright"))',

And maybe there should be a new test of some sort in play_processor_spec.rb?