svn commit: r1745081 - in /maven/doxia/doxia/trunk/doxia-core/src: main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java

[rf...@apache.org]

Author: rfscholte
Date: Sun May 22 18:44:15 2016
New Revision: 1745081

URL: http://svn.apache.org/viewvc?rev=1745081&view=rev
Log:
[DOXIA-522] Make snippet macro less permissive of issues
exact match of snippetId

Added:
    maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java
Modified:
    maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java

Modified: maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java?rev=1745081&r1=1745080&r2=1745081&view=diff
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java (original)
+++ maven/doxia/doxia/trunk/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java Sun May 22 18:44:15 2016
@@ -25,7 +25,7 @@ import java.io.InputStreamReader;
 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 @@ public class SnippetReader
      * @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();
     }
 
     /**

Added: maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java
URL: http://svn.apache.org/viewvc/maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java?rev=1745081&view=auto
==============================================================================
--- maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java (added)
+++ maven/doxia/doxia/trunk/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetReaderTest.java Sun May 22 18:44:15 2016
@@ -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" ) );
+        
+    }
+}