This is an automated email from the ASF dual-hosted git repository.
michaelo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-doxia.git
The following commit(s) were added to refs/heads/master by this push:
new 728b860d [DOXIA-705] Remove remaining deprecated/duplicated code
728b860d is described below
commit 728b860dfac0ba55012ee4e8264407b6e85d481c
Author: Michael Osipov <[email protected]>
AuthorDate: Fri Jun 16 21:28:07 2023 +0200
[DOXIA-705] Remove remaining deprecated/duplicated code
---
.../org/apache/maven/doxia/index/IndexingSink.java | 4 +-
.../org/apache/maven/doxia/macro/toc/TocMacro.java | 6 +--
.../doxia/sink/impl/SinkEventAttributeSet.java | 9 -----
.../org/apache/maven/doxia/util/DoxiaUtils.java | 24 +----------
.../org/apache/maven/doxia/util/HtmlTools.java | 31 ---------------
.../apache/maven/doxia/util/DoxiaUtilsTest.java | 2 -
.../org/apache/maven/doxia/util/HtmlToolsTest.java | 44 ---------------------
.../apache/maven/doxia/module/apt/AptUtils.java | 46 ----------------------
.../maven/doxia/module/apt/AptUtilsTest.java | 9 -----
9 files changed, 7 insertions(+), 168 deletions(-)
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
index 05fbf777..18eb2b7d 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java
@@ -24,7 +24,7 @@ import java.util.Stack;
import java.util.concurrent.atomic.AtomicInteger;
import org.apache.maven.doxia.sink.impl.SinkAdapter;
-import org.apache.maven.doxia.util.HtmlTools;
+import org.apache.maven.doxia.util.DoxiaUtils;
/**
* A sink implementation for index.
@@ -292,7 +292,7 @@ public class IndexingSink extends SinkAdapter {
title = title.replaceAll("[\\r\\n]+", "");
entry.setTitle(title);
- entry.setId(getUniqueId(HtmlTools.encodeId(title)));
+ entry.setId(getUniqueId(DoxiaUtils.encodeId(title)));
break;
// Dunno how to handle these yet
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
index 03f58295..61c9e18c 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java
@@ -31,7 +31,7 @@ import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
-import org.apache.maven.doxia.util.HtmlTools;
+import org.apache.maven.doxia.util.DoxiaUtils;
/**
* Macro to display a <code>Table Of Content</code> in a given
<code>Sink</code>.
@@ -136,7 +136,7 @@ public class TocMacro extends AbstractMacro {
private void writeSubSectionN(Sink sink, IndexEntry sectionIndex, int n) {
if (fromDepth <= n) {
sink.listItem();
- sink.link("#" + HtmlTools.encodeId(sectionIndex.getId()));
+ sink.link("#" + DoxiaUtils.encodeId(sectionIndex.getId()));
sink.text(sectionIndex.getTitle());
sink.link_();
}
@@ -150,7 +150,7 @@ public class TocMacro extends AbstractMacro {
for (IndexEntry subsectionIndex :
sectionIndex.getChildEntries()) {
if (n == toDepth - 1) {
sink.listItem();
- sink.link("#" +
HtmlTools.encodeId(subsectionIndex.getId()));
+ sink.link("#" +
DoxiaUtils.encodeId(subsectionIndex.getId()));
sink.text(subsectionIndex.getTitle());
sink.link_();
sink.listItem_();
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
index 0bc910cd..ef578925 100644
---
a/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
+++
b/doxia-core/src/main/java/org/apache/maven/doxia/sink/impl/SinkEventAttributeSet.java
@@ -49,14 +49,6 @@ public class SinkEventAttributeSet implements
SinkEventAttributes, Cloneable {
*/
public static final SinkEventAttributes LINETHROUGH;
- /**
- * An unmodifiable attribute set containing only a boxed attribute.
- *
- * @deprecated use {@link #SOURCE} for source code
- */
- @Deprecated
- public static final SinkEventAttributes BOXED;
-
/**
* An unmodifiable attribute set containing only a source attribute.
*/
@@ -101,7 +93,6 @@ public class SinkEventAttributeSet implements
SinkEventAttributes, Cloneable {
UNDERLINE = new SinkEventAttributeSet(DECORATION,
"underline").unmodifiable();
OVERLINE = new SinkEventAttributeSet(DECORATION,
"overline").unmodifiable();
LINETHROUGH = new SinkEventAttributeSet(DECORATION,
"line-through").unmodifiable();
- BOXED = new SinkEventAttributeSet(DECORATION, "boxed").unmodifiable();
SOURCE = new SinkEventAttributeSet(DECORATION,
"source").unmodifiable();
BOLD = new SinkEventAttributeSet(STYLE, "bold").unmodifiable();
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
b/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
index fdcefde6..eed85776 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java
@@ -110,22 +110,6 @@ public class DoxiaUtils {
return (!isExternalLink(link) && !isInternalLink(link));
}
- /**
- * Construct a valid Doxia id.
- *
- * <p>
- * This method is equivalent to {@link #encodeId(java.lang.String,
boolean) encodeId(id, false)}.
- * </p>
- *
- * @param id The id to be encoded.
- * May be null in which case null is returned.
- * @return The trimmed and encoded id, or null if id is null.
- * @see #encodeId(java.lang.String, boolean)
- */
- public static String encodeId(final String id) {
- return encodeId(id, false);
- }
-
/**
* Construct a valid Doxia id.
*
@@ -167,16 +151,12 @@ public class DoxiaUtils {
*
* @param text The text to be encoded.
* May be null, empty or blank in which case null is returned.
- * @param chop true if non-encodable characters should be ignored.
- * If false, any non-encodable characters will be replaced as specified
above.
* @return The trimmed and encoded id, or null if id is null.
* If id is not null, the return value is guaranteed to be a valid Doxia
id.
* @see #isValidId(java.lang.String)
* @since 1.1.1
- * @deprecated Don't chop characters which might produce collisions in a
document
*/
- @Deprecated
- public static String encodeId(final String text, final boolean chop) {
+ public static String encodeId(final String text) {
if (text == null) {
return null;
}
@@ -201,7 +181,7 @@ public class DoxiaUtils {
buffer.append('_');
} else if (isAsciiLetter(c) || isAsciiDigit(c) || (c == '-') || (c
== '_') || (c == '.')) {
buffer.append(c);
- } else if (!chop) {
+ } else {
byte[] bytes =
String.valueOf(c).getBytes(StandardCharsets.UTF_8);
diff --git
a/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
b/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
index 4dfcb640..1ea40a35 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java
@@ -415,37 +415,6 @@ public class HtmlTools {
return encoded.toString();
}
- /**
- * Construct a valid id.
- *
- * <p>
- * <b>Note</b>: this method is identical to
- * {@link DoxiaUtils#encodeId(String)},
- * the rules to encode an id are laid out there.
- * </p>
- *
- * @param id The id to be encoded.
- * @return The trimmed and encoded id, or null if id is null, empty or
blank.
- * @see DoxiaUtils#encodeId(java.lang.String)
- * @deprecated use {@link DoxiaUtils#encodeId(String)}
- */
- @Deprecated
- public static String encodeId(String id) {
- return DoxiaUtils.encodeId(id);
- }
-
- /**
- * Determines if the specified text is a valid id according to the rules
- * laid out in {@link #encodeId(String)}.
- *
- * @param text The text to be tested.
- * @return <code>true</code> if the text is a valid id, otherwise
<code>false</code>.
- * @see DoxiaUtils#isValidId(String)
- */
- public static boolean isId(String text) {
- return DoxiaUtils.isValidId(text);
- }
-
private HtmlTools() {
// utility class
}
diff --git
a/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
b/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
index 586d435d..27ea2f3e 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java
@@ -138,9 +138,7 @@ public class DoxiaUtilsTest {
assertEquals("myAnchor", DoxiaUtils.encodeId("myAnchor"));
assertEquals("my.26Anchor", DoxiaUtils.encodeId("my&Anchor"));
assertEquals("H.C3.A5kon", DoxiaUtils.encodeId("H\u00E5kon"));
- assertEquals("Hkon", DoxiaUtils.encodeId("H\u00E5kon", true));
assertEquals("Theu.C3.9Fl", DoxiaUtils.encodeId("Theu\u00DFl"));
- assertEquals("Theul", DoxiaUtils.encodeId("Theu\u00DFl", true));
}
/**
diff --git
a/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
b/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
index 230632f4..73358dbc 100644
--- a/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java
@@ -24,10 +24,8 @@ import org.codehaus.plexus.testing.PlexusTest;
import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* Test case for <code>HtmlTools</code>.
@@ -91,26 +89,6 @@ public class HtmlToolsTest {
"<>&\"\u00E5\u0159\uD835\uDFED",
HtmlTools.unescapeHTML("<>&"åř𝟭"));
}
- /**
- * Verify the expected results.
- */
- @Test
- public void testEncodeId() {
- assertNull(HtmlTools.encodeId(null));
- assertNull(HtmlTools.encodeId(""));
- assertNull(HtmlTools.encodeId(" "));
- assertEquals("_", HtmlTools.encodeId(" _ "));
- assertEquals("a1", HtmlTools.encodeId("1"));
- assertEquals("a1anchor", HtmlTools.encodeId("1anchor"));
- assertEquals("_anchor", HtmlTools.encodeId("_anchor"));
- assertEquals("a_b-c123", HtmlTools.encodeId("a b-c123 "));
- assertEquals("anchor", HtmlTools.encodeId(" anchor"));
- assertEquals("myAnchor", HtmlTools.encodeId("myAnchor"));
- assertEquals("H.C3.A5kon", HtmlTools.encodeId("H\u00E5kon"));
- assertEquals("Theu.C3.9Fl", HtmlTools.encodeId("Theu\u00DFl"));
- assertEquals("a.E2.82.AC", HtmlTools.encodeId("\u20AC"));
- }
-
/**
* Verify the expected results.
*
@@ -132,28 +110,6 @@ public class HtmlToolsTest {
assertEquals(HtmlTools.encodeURL(url), URLEncoder.encode(url,
"UTF-8"));
}
- /**
- * Verify the expected results.
- */
- @Test
- public void testIsId() {
- assertFalse(HtmlTools.isId(null));
- assertFalse(HtmlTools.isId(""));
- assertFalse(HtmlTools.isId(" "));
- assertFalse(HtmlTools.isId(" _ "));
- assertFalse(HtmlTools.isId("1"));
- assertFalse(HtmlTools.isId("1anchor"));
- assertFalse(HtmlTools.isId("a b-c123 "));
- assertFalse(HtmlTools.isId(" anchor"));
- assertFalse(HtmlTools.isId("a:"));
- assertFalse(HtmlTools.isId("Theu\u00DFl"));
- assertTrue(HtmlTools.isId("_anchor"));
- assertTrue(HtmlTools.isId("myAnchor"));
- assertTrue(HtmlTools.isId("a_"));
- assertTrue(HtmlTools.isId("a-"));
- assertTrue(HtmlTools.isId("a."));
- }
-
/**
* Verify the expected results.
*/
diff --git
a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
index fcf76826..69c107f9 100644
---
a/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
+++
b/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java
@@ -73,52 +73,6 @@ public class AptUtils {
return (link.startsWith("/") || link.startsWith("./") ||
link.startsWith("../"));
}
- /**
- * Construct a valid anchor. This is a simplified version of
- * {@link org.apache.maven.doxia.util.DoxiaUtils#encodeId(String)}
- * to ensure the anchor is a valid Doxia id.
- * The procedure is identical to the one in
- * {@link org.apache.maven.doxia.util.HtmlTools#encodeId(String)}:
- *
- * <ol>
- * <li> Trim the id</li>
- * <li> If the first character is not a letter, prepend the letter
'a'</li>
- * <li> Any space is replaced with an underscore '_'</li>
- * <li> Remove any non alphanumeric characters except ':', '_', '.',
'-'.</li>
- * </ol>
- *
- * @param id The id to be encoded.
- * @return The trimmed and encoded id, or null if id is null.
- * @deprecated use {@link DoxiaUtils#encodeId(String)}
- */
- @Deprecated
- public static String encodeAnchor(String id) {
- if (id == null) {
- return null;
- }
-
- id = id.trim();
-
- int length = id.length();
- StringBuilder buffer = new StringBuilder(length);
-
- for (int i = 0; i < length; ++i) {
- char c = id.charAt(i);
-
- if ((i == 0) && (!Character.isLetter(c))) {
- buffer.append('a');
- }
-
- if (c == ' ') {
- buffer.append('_');
- } else if ((Character.isLetterOrDigit(c)) || (c == '-') || (c ==
'_') || (c == ':') || (c == '.')) {
- buffer.append(c);
- }
- }
-
- return buffer.toString();
- }
-
private AptUtils() {
// utility class
}
diff --git
a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
index 606e1b48..8474b592 100644
---
a/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
+++
b/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java
@@ -117,13 +117,4 @@ public class AptUtilsTest {
link = "..\\index.html";
assertFalse(AptUtils.isLocalLink(link), "Should NOT be a local link: "
+ link);
}
-
- /**
- * Test of encodeAnchor method, of class AptUtils.
- */
- @Test
- public void testEncodeAnchor() {
- assertNull(AptUtils.encodeAnchor(null));
- assertEquals("a123_:_.-aBc", AptUtils.encodeAnchor(" 12!3 :_.&-a)Bc
"));
- }
}
