Support more Android styling tags
This commit is contained in:
Kaloian Doganov
parent
bc4bd7daf0
commit
5e7a9c9be3
4 changed files with 84 additions and 15 deletions
|
|
@ -1,3 +1,7 @@
|
|||
# next version
|
||||
|
||||
- Improvement: Support more Android styling tags (#278)
|
||||
|
||||
# 1.0.5 (2019-02-24)
|
||||
|
||||
- Bugfix: Incorrect language detection when reading localization files (#251)
|
||||
|
|
|
|||
|
|
@ -80,7 +80,7 @@ Twine currently supports the following output formats:
|
|||
* [Android String Resources][androidstrings] (format: android)
|
||||
* HTML tags will be escaped by replacing `<` with `<`
|
||||
* Tags inside `<![CDATA[` won't be escaped.
|
||||
* Supports [basic styling][androidstyling] with `<b>`, `<i>`, `<u>` and `<a>` links.
|
||||
* Supports [basic styling][androidstyling] according to [Android documentation](https://developer.android.com/guide/topics/resources/string-resource.html#StylingWithHTML). All of the documented tags are supported, in addition to `<a>` links.
|
||||
* These tags will *not* be escaped if the string doesn't contain placeholders. You can reference them directly in your layouts or by using [`getText()`](https://developer.android.com/reference/android/content/res/Resources.html#getText(int)) to read them programatically.
|
||||
* These tags *will* be escaped if the string contains placeholders. You can use [`getString()`](https://developer.android.com/reference/android/content/res/Resources.html#getString(int,%20java.lang.Object...)) combined with [`fromHtml`](https://developer.android.com/reference/android/text/Html.html#fromHtml(java.lang.String)) as shown in the [documentation][androidstyling] to display them.
|
||||
* See [\#212](https://github.com/scelis/twine/issues/212) for details.
|
||||
|
|
|
|||
|
|
@ -113,22 +113,26 @@ module Twine
|
|||
|
||||
# http://developer.android.com/guide/topics/resources/string-resource.html#FormattingAndStyling
|
||||
def escape_value(value)
|
||||
inside_cdata = /<\!\[CDATA\[((?!\]\]>).)*$/ # opening CDATA tag ('<![CDATA[') not followed by a closing tag (']]>')
|
||||
inside_opening_anchor_tag = /<a\s?((?!>).)*$/ # anchor tag start ('<a ') not followed by a '>'
|
||||
inside_cdata = /<\!\[CDATA\[((?!\]\]>).)*$/ # opening CDATA tag ('<![CDATA[') not followed by a closing tag (']]>')
|
||||
inside_opening_tag = /<(a|font|span|p)\s?((?!>).)*$/ # tag start ('<a ', '<font ', '<span ' or '<p ') not followed by a '>'
|
||||
|
||||
# escape double and single quotes and & signs
|
||||
value = gsub_unless(value, '"', '\\"') { |substring| substring =~ inside_cdata || substring =~ inside_opening_anchor_tag }
|
||||
value = gsub_unless(value, '"', '\\"') { |substring| substring =~ inside_cdata || substring =~ inside_opening_tag }
|
||||
value = gsub_unless(value, "'", "\\'") { |substring| substring =~ inside_cdata }
|
||||
value = gsub_unless(value, /&/, '&') { |substring| substring =~ inside_cdata || substring =~ inside_opening_anchor_tag }
|
||||
value = gsub_unless(value, /&/, '&') { |substring| substring =~ inside_cdata || substring =~ inside_opening_tag }
|
||||
|
||||
# if `value` contains a placeholder, escape all angle brackets
|
||||
# if not, escape opening angle brackes unless it's a supported styling tag
|
||||
# https://github.com/scelis/twine/issues/212
|
||||
# https://stackoverflow.com/questions/3235131/#18199543
|
||||
if number_of_twine_placeholders(value) > 0
|
||||
angle_bracket = /<(?!(\/?(\!\[CDATA)))/ # matches all `<` but <![CDATA
|
||||
else
|
||||
angle_bracket = /<(?!(\/?(b|u|i|a|\!\[CDATA)))/ # matches all `<` but <b>, <u>, <i>, <a> and <![CDATA
|
||||
# matches all `<` but <![CDATA
|
||||
angle_bracket = /<(?!(\/?(\!\[CDATA)))/
|
||||
else
|
||||
# matches all '<' but <b>, <em>, <i>, <cite>, <dfn>, <big>, <small>, <font>, <tt>, <s>,
|
||||
# <strike>, <del>, <u>, <super>, <sub>, <ul>, <li>, <br>, <div>, <span>, <p>, <a>
|
||||
# and <![CDATA
|
||||
angle_bracket = /<(?!(\/?(b|em|i|cite|dfn|big|small|font|tt|s|strike|del|u|super|sub|ul|li|br|div|span|p|a|\!\[CDATA)))/
|
||||
end
|
||||
value = gsub_unless(value, angle_bracket, '<') { |substring| substring =~ inside_cdata }
|
||||
|
||||
|
|
|
|||
|
|
@ -47,26 +47,87 @@ class TestAndroidFormatter < FormatterTest
|
|||
'a "good" way' => 'a \"good\" way',
|
||||
|
||||
'<b>bold</b>' => '<b>bold</b>',
|
||||
'<em>bold</em>' => '<em>bold</em>',
|
||||
|
||||
'<i>italic</i>' => '<i>italic</i>',
|
||||
'<cite>italic</cite>' => '<cite>italic</cite>',
|
||||
'<dfn>italic</dfn>' => '<dfn>italic</dfn>',
|
||||
|
||||
'<big>larger</big>' => '<big>larger</big>',
|
||||
'<small>smaller</small>' => '<small>smaller</small>',
|
||||
|
||||
'<font color="#45C1D0">F</font>' => '<font color="#45C1D0">F</font>',
|
||||
|
||||
'<tt>monospaced</tt>' => '<tt>monospaced</tt>',
|
||||
|
||||
'<s>strike</s>' => '<s>strike</s>',
|
||||
'<strike>strike</strike>' => '<strike>strike</strike>',
|
||||
'<del>strike</del>' => '<del>strike</del>',
|
||||
|
||||
'<u>underline</u>' => '<u>underline</u>',
|
||||
|
||||
'<super>superscript</super>'=> '<super>superscript</super>',
|
||||
|
||||
'<sub>subscript</sub>' => '<sub>subscript</sub>',
|
||||
|
||||
'<ul>bullet point</ul>' => '<ul>bullet point</ul>',
|
||||
'<li>bullet point</li>' => '<li>bullet point</li>',
|
||||
|
||||
'<br>line break' => '<br>line break',
|
||||
|
||||
'<div>division</div>' => '<div>division</div>',
|
||||
|
||||
'<span style="color:#45C1D0">inline</span>' => '<span style="color:#45C1D0">inline</span>',
|
||||
|
||||
'<p>para</p>' => '<p>para</p>',
|
||||
'<p dir="ltr">para</p>' => '<p dir="ltr">para</p>',
|
||||
|
||||
'<b>%@</b>' => '<b>%s</b>',
|
||||
'<em>%@</em>' => '<em>%s</em>',
|
||||
|
||||
'<i>%@</i>' => '<i>%s</i>',
|
||||
'<cite>%@</cite>' => '<cite>%s</cite>',
|
||||
'<dfn>%@</dfn>' => '<dfn>%s</dfn>',
|
||||
|
||||
'<big>%@</big>' => '<big>%s</big>',
|
||||
'<small>%@</small>' => '<small>%s</small>',
|
||||
|
||||
'<font color="#45C1D0>%@</font>' => '<font color="#45C1D0>%s</font>',
|
||||
|
||||
'<tt>%@</tt>' => '<tt>%s</tt>',
|
||||
|
||||
'<s>%@</s>' => '<s>%s</s>',
|
||||
'<strike>%@</strike>' => '<strike>%s</strike>',
|
||||
'<del>%@</del>' => '<del>%s</del>',
|
||||
|
||||
'<u>%@</u>' => '<u>%s</u>',
|
||||
|
||||
'<span>inline</span>' => '<span>inline</span>',
|
||||
'<p>paragraph</p>' => '<p>paragraph</p>',
|
||||
'<super>%@</super>' => '<super>%s</super>',
|
||||
|
||||
'<sub>%@</sub>' => '<sub>%s</sub>',
|
||||
|
||||
'<ul>%@</ul>' => '<ul>%s</ul>',
|
||||
'<li>%@</li>' => '<li>%s</li>',
|
||||
|
||||
'<br>%@' => '<br>%s',
|
||||
|
||||
'<div>%@</div>' => '<div>%s</div>',
|
||||
|
||||
'<span style="color:#45C1D0">%@</span>' => '<span style="color:#45C1D0">%s</span>',
|
||||
|
||||
'<p>%@</p>' => '<p>%s</p>',
|
||||
'<p dir="ltr">%@</p>' => '<p dir="ltr">%s</p>',
|
||||
|
||||
'<a href="target">link</a>' => '<a href="target">link</a>',
|
||||
'<a href="target">"link"</a>' => '<a href="target">\"link\"</a>',
|
||||
'<a href="target"></a>"out"' => '<a href="target"></a>\"out\"',
|
||||
'<a href="http://url.com?param=1¶m2=3¶m3=%20">link</a>' => '<a href="http://url.com?param=1¶m2=3¶m3=%20">link</a>',
|
||||
|
||||
'<p>escaped</p><![CDATA[]]>' => '<p>escaped</p><![CDATA[]]>',
|
||||
'<![CDATA[]]><p>escaped</p>' => '<![CDATA[]]><p>escaped</p>',
|
||||
'<![CDATA[<p>unescaped</p>]]>' => '<![CDATA[<p>unescaped</p>]]>',
|
||||
'<![CDATA[<p>unescaped with %@</p>]]>' => '<![CDATA[<p>unescaped with %s</p>]]>',
|
||||
'<![CDATA[]]><![CDATA[<p>unescaped</p>]]>' => '<![CDATA[]]><![CDATA[<p>unescaped</p>]]>',
|
||||
'<q>escaped</q><![CDATA[]]>' => '<q>escaped</q><![CDATA[]]>',
|
||||
'<![CDATA[]]><q>escaped</q>' => '<![CDATA[]]><q>escaped</q>',
|
||||
'<![CDATA[<q>unescaped</q>]]>' => '<![CDATA[<q>unescaped</q>]]>',
|
||||
'<![CDATA[<q>unescaped with %@</q>]]>' => '<![CDATA[<q>unescaped with %s</q>]]>',
|
||||
'<![CDATA[]]><![CDATA[<q>unescaped</q>]]>' => '<![CDATA[]]><![CDATA[<q>unescaped</q>]]>',
|
||||
|
||||
'<![CDATA[&]]>' => '<![CDATA[&]]>',
|
||||
'<![CDATA[\']]>' => '<![CDATA[\']]>',
|
||||
|
|
|
|||
Reference in a new issue