You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-dev@maven.apache.org by Dennis Lundberg <de...@apache.org> on 2009/05/19 20:58:28 UTC
Re: svn commit: r776294 - in /maven/doxia/doxia/trunk: doxia-core/src/main/java/org/apache/maven/doxia/parser/
doxia-core/src/main/java/org/apache/maven/doxia/util/ doxia-core/src/test/java/org/apache/maven/doxia/util/
doxia-modules/doxia-module-xdoc/src/m...
Hi Vincent
Can you please add back HtmlTools.unescapeHtml( String ), add a
@deprecated note for it and have it redirect to the new method?
This is a public method of a public helper class in Doxia core. I don't
know if it used outside of Doxia, but we shouldn't just rename it for a
point release.
vsiveton@apache.org wrote:
> Author: vsiveton
> Date: Tue May 19 12:36:02 2009
> New Revision: 776294
>
> URL: http://svn.apache.org/viewvc?rev=776294&view=rev
> Log:
> o refactor unescapeHtml to unescapeHTML for consistency reason
>
> Modified:
> maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
> maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
> maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
> maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
>
> Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java?rev=776294&r1=776293&r2=776294&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java (original)
> +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java Tue May 19 12:36:02 2009
> @@ -395,7 +395,7 @@
> // TODO: the MXParser doesn't actually handle correctly surrogate char, ie
> // if orignalText = "𝟯", text = "\ud7ef"
>
> - String unescaped = HtmlTools.unescapeHtml( text );
> + String unescaped = HtmlTools.unescapeHTML( text );
>
> // TODO: StringEscapeUtils.unescapeHtml returns unknown entities as is,
> // they should be handled as one character as well
>
> Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java?rev=776294&r1=776293&r2=776294&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java (original)
> +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java Tue May 19 12:36:02 2009
> @@ -207,7 +207,7 @@
> * @return a new unescaped <code>String</code>, <code>null</code> if null string input.
> * @since 1.1.1.
> */
> - public static String unescapeHtml( String text )
> + public static String unescapeHTML( String text )
> {
> if ( text == null )
> {
>
> Modified: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java?rev=776294&r1=776293&r2=776294&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java (original)
> +++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java Tue May 19 12:36:02 2009
> @@ -56,22 +56,22 @@
> */
> public void testUnescapeHTML()
> {
> - assertNull( HtmlTools.unescapeHtml( null ) );
> - assertEquals( "", HtmlTools.unescapeHtml( "" ) );
> - assertEquals( "<", HtmlTools.unescapeHtml( "<" ) );
> - assertEquals( ">", HtmlTools.unescapeHtml( ">" ) );
> - assertEquals( "&", HtmlTools.unescapeHtml( "&" ) );
> - assertEquals( "\"", HtmlTools.unescapeHtml( """ ) );
> - assertEquals( "&", HtmlTools.unescapeHtml( "&amp;" ) );
> - assertEquals( "<Français>", HtmlTools.unescapeHtml( "&lt;Fran&ccedil;ais&gt;" ) );
> - assertEquals( "\u0159", HtmlTools.unescapeHtml( "ř" ) );
> - assertEquals( "\uD808\uDF45", HtmlTools.unescapeHtml( "𒍅" ) );
> - assertEquals( "\uD835\uDFED", HtmlTools.unescapeHtml( "𝟭" ) );
> - assertEquals( "\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHtml( "𒍅𝟭" ) );
> + assertNull( HtmlTools.unescapeHTML( null ) );
> + assertEquals( "", HtmlTools.unescapeHTML( "" ) );
> + assertEquals( "<", HtmlTools.unescapeHTML( "<" ) );
> + assertEquals( ">", HtmlTools.unescapeHTML( ">" ) );
> + assertEquals( "&", HtmlTools.unescapeHTML( "&" ) );
> + assertEquals( "\"", HtmlTools.unescapeHTML( """ ) );
> + assertEquals( "&", HtmlTools.unescapeHTML( "&amp;" ) );
> + assertEquals( "<Français>", HtmlTools.unescapeHTML( "&lt;Fran&ccedil;ais&gt;" ) );
> + assertEquals( "\u0159", HtmlTools.unescapeHTML( "ř" ) );
> + assertEquals( "\uD808\uDF45", HtmlTools.unescapeHTML( "𒍅" ) );
> + assertEquals( "\uD835\uDFED", HtmlTools.unescapeHTML( "𝟭" ) );
> + assertEquals( "\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHTML( "𒍅𝟭" ) );
>
> try
> {
> - HtmlTools.unescapeHtml( "test 𝟭 test" );
> + HtmlTools.unescapeHTML( "test 𝟭 test" );
> assertTrue( false );
> }
> catch ( IllegalArgumentException e )
>
> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java?rev=776294&r1=776293&r2=776294&view=diff
> ==============================================================================
> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java (original)
> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java Tue May 19 12:36:02 2009
> @@ -185,7 +185,7 @@
>
> sink.sectionTitle( Sink.SECTION_LEVEL_1, attribs );
>
> - sink.text( HtmlTools.unescapeHtml( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
> + sink.text( HtmlTools.unescapeHTML( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>
> sink.sectionTitle1_();
> }
> @@ -204,7 +204,7 @@
>
> sink.sectionTitle( Sink.SECTION_LEVEL_2, attribs );
>
> - sink.text( HtmlTools.unescapeHtml( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
> + sink.text( HtmlTools.unescapeHTML( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>
> sink.sectionTitle2_();
> }
>
>
>
--
Dennis Lundberg
Re: svn commit: r776294 - in /maven/doxia/doxia/trunk: doxia-core/src/main/java/org/apache/maven/doxia/parser/
doxia-core/src/main/java/org/apache/maven/doxia/util/ doxia-core/src/test/java/org/apache/maven/doxia/util/
doxia-modules/doxia-module-xdoc/src/m...
Posted by Lukas Theussl <lt...@apache.org>.
Hi Dennis,
As Vincent said, this method was only added in 1.1.1.
OTOH, I have run clirr on the whole doxia codebase and after fixing a few issues,
we are completely compatible with 1.1 now.
Only in doxia-maven-plugin I had to exclude some classes because clirr doesn't
take into account the manipulations by the shade plugin, but absolutely nothing
has changed there between 1.1 and 1.1.1. If anybody knows a better way to handle
that, let me know.
Cheers,
-Lukas
Dennis Lundberg wrote:
> Hi Vincent
>
> Can you please add back HtmlTools.unescapeHtml( String ), add a
> @deprecated note for it and have it redirect to the new method?
>
> This is a public method of a public helper class in Doxia core. I don't
> know if it used outside of Doxia, but we shouldn't just rename it for a
> point release.
>
> vsiveton@apache.org wrote:
>> Author: vsiveton
>> Date: Tue May 19 12:36:02 2009
>> New Revision: 776294
>>
>> URL: http://svn.apache.org/viewvc?rev=776294&view=rev
>> Log:
>> o refactor unescapeHtml to unescapeHTML for consistency reason
>>
>> Modified:
>> maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
>> maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
>> maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
>> maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
>>
>> Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java
>> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java?rev=776294&r1=776293&r2=776294&view=diff
>> ==============================================================================
>> --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java (original)
>> +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java Tue May 19 12:36:02 2009
>> @@ -395,7 +395,7 @@
>> // TODO: the MXParser doesn't actually handle correctly surrogate char, ie
>> // if orignalText = "𝟯", text = "\ud7ef"
>>
>> - String unescaped = HtmlTools.unescapeHtml( text );
>> + String unescaped = HtmlTools.unescapeHTML( text );
>>
>> // TODO: StringEscapeUtils.unescapeHtml returns unknown entities as is,
>> // they should be handled as one character as well
>>
>> Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
>> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java?rev=776294&r1=776293&r2=776294&view=diff
>> ==============================================================================
>> --- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java (original)
>> +++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java Tue May 19 12:36:02 2009
>> @@ -207,7 +207,7 @@
>> * @return a new unescaped <code>String</code>, <code>null</code> if null string input.
>> * @since 1.1.1.
>> */
>> - public static String unescapeHtml( String text )
>> + public static String unescapeHTML( String text )
>> {
>> if ( text == null )
>> {
>>
>> Modified: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
>> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java?rev=776294&r1=776293&r2=776294&view=diff
>> ==============================================================================
>> --- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java (original)
>> +++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java Tue May 19 12:36:02 2009
>> @@ -56,22 +56,22 @@
>> */
>> public void testUnescapeHTML()
>> {
>> - assertNull( HtmlTools.unescapeHtml( null ) );
>> - assertEquals( "", HtmlTools.unescapeHtml( "" ) );
>> - assertEquals( "<", HtmlTools.unescapeHtml( "<" ) );
>> - assertEquals( ">", HtmlTools.unescapeHtml( ">" ) );
>> - assertEquals( "&", HtmlTools.unescapeHtml( "&" ) );
>> - assertEquals( "\"", HtmlTools.unescapeHtml( """ ) );
>> - assertEquals( "&", HtmlTools.unescapeHtml( "&amp;" ) );
>> - assertEquals( "<Français>", HtmlTools.unescapeHtml( "&lt;Fran&ccedil;ais&gt;" ) );
>> - assertEquals( "\u0159", HtmlTools.unescapeHtml( "ř" ) );
>> - assertEquals( "\uD808\uDF45", HtmlTools.unescapeHtml( "𒍅" ) );
>> - assertEquals( "\uD835\uDFED", HtmlTools.unescapeHtml( "𝟭" ) );
>> - assertEquals( "\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHtml( "𒍅𝟭" ) );
>> + assertNull( HtmlTools.unescapeHTML( null ) );
>> + assertEquals( "", HtmlTools.unescapeHTML( "" ) );
>> + assertEquals( "<", HtmlTools.unescapeHTML( "<" ) );
>> + assertEquals( ">", HtmlTools.unescapeHTML( ">" ) );
>> + assertEquals( "&", HtmlTools.unescapeHTML( "&" ) );
>> + assertEquals( "\"", HtmlTools.unescapeHTML( """ ) );
>> + assertEquals( "&", HtmlTools.unescapeHTML( "&amp;" ) );
>> + assertEquals( "<Français>", HtmlTools.unescapeHTML( "&lt;Fran&ccedil;ais&gt;" ) );
>> + assertEquals( "\u0159", HtmlTools.unescapeHTML( "ř" ) );
>> + assertEquals( "\uD808\uDF45", HtmlTools.unescapeHTML( "𒍅" ) );
>> + assertEquals( "\uD835\uDFED", HtmlTools.unescapeHTML( "𝟭" ) );
>> + assertEquals( "\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHTML( "𒍅𝟭" ) );
>>
>> try
>> {
>> - HtmlTools.unescapeHtml( "test 𝟭 test" );
>> + HtmlTools.unescapeHTML( "test 𝟭 test" );
>> assertTrue( false );
>> }
>> catch ( IllegalArgumentException e )
>>
>> Modified: maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java
>> URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java?rev=776294&r1=776293&r2=776294&view=diff
>> ==============================================================================
>> --- maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java (original)
>> +++ maven/doxia/doxia/trunk/doxia-modules/doxia-module-xdoc/src/main/java/org/apache/maven/doxia/module/xdoc/XdocParser.java Tue May 19 12:36:02 2009
>> @@ -185,7 +185,7 @@
>>
>> sink.sectionTitle( Sink.SECTION_LEVEL_1, attribs );
>>
>> - sink.text( HtmlTools.unescapeHtml( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>> + sink.text( HtmlTools.unescapeHTML( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>>
>> sink.sectionTitle1_();
>> }
>> @@ -204,7 +204,7 @@
>>
>> sink.sectionTitle( Sink.SECTION_LEVEL_2, attribs );
>>
>> - sink.text( HtmlTools.unescapeHtml( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>> + sink.text( HtmlTools.unescapeHTML( parser.getAttributeValue( null, Attribute.NAME.toString() ) ) );
>>
>> sink.sectionTitle2_();
>> }
>>
>>
>>
>
>