[DOXIA-522] Make snippet macro less permissive of issues
exact match of snippetId
git-svn-id: https://svn.apache.org/repos/asf/maven/doxia/doxia/trunk@1745081 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
index 22bf2d1..51a7456 100644
--- a/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
+++ b/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
@@ -25,7 +25,7 @@
import java.net.URL;
import java.util.ArrayList;
import java.util.List;
-import java.util.Locale;
+import java.util.regex.Pattern;
import org.codehaus.plexus.util.IOUtil;
@@ -199,12 +199,17 @@
* @param line the line.
* @return True, if the line is a start demarcator.
*/
- protected boolean isDemarcator( String snippetId, String what, String line )
+ protected static boolean isDemarcator( String snippetId, String what, String line )
{
- String upper = line.toUpperCase( Locale.ENGLISH );
- return upper.contains( what.toUpperCase( Locale.ENGLISH ) )
- && upper.contains( "SNIPPET" )
- && line.contains( snippetId );
+ // SNIPPET and what are case insensitive
+ // SNIPPET and what can switch order
+ String snippetRegExp = "(^|\\W)(?i:SNIPPET)($|\\W)";
+ String snippetIdRegExp = "(^|\\W)" + snippetId + "($|\\W)";
+ String whatRegExp = "(^|\\W)(?i:" + what + ")($|\\W)";
+
+ return Pattern.compile( snippetRegExp ).matcher( line ).find()
+ && Pattern.compile( whatRegExp ).matcher( line ).find()
+ && Pattern.compile( snippetIdRegExp ).matcher( line ).find();
}
/**
diff --git a/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java b/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java
new file mode 100644
index 0000000..0282ab4
--- /dev/null
+++ b/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java
@@ -0,0 +1,45 @@
+package org.apache.maven.doxia.macro.snippet;
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import org.junit.Test;
+
+public class SnippetReaderTest
+{
+ @Test
+ public void testIsDemarcator()
+ {
+ String snippetId = "first";
+ String what = "START";
+ assertTrue( SnippetReader.isDemarcator( snippetId, what, "SNIPPET START first" ) );
+ assertTrue( SnippetReader.isDemarcator( snippetId, what, "SNIPPET start first" ) );
+ assertTrue( SnippetReader.isDemarcator( snippetId, what, "snippet START first" ) );
+ assertTrue( SnippetReader.isDemarcator( snippetId, what, "snippet start first" ) );
+ assertTrue( SnippetReader.isDemarcator( snippetId, what, "<!-- START SNIPPET: first -->" ) );
+
+ assertFalse( SnippetReader.isDemarcator( snippetId, what, "SNIPPET START First" ) );
+ assertFalse( SnippetReader.isDemarcator( snippetId, what, "SNIPPET START FIRST" ) );
+ assertFalse( SnippetReader.isDemarcator( snippetId, what, "SNIPPET START first_id" ) );
+ assertFalse( SnippetReader.isDemarcator( snippetId, what, "SNIPPET START id_first" ) );
+
+ }
+}
