XCOMMONS-2830: Introduce a utility component to check if a string con…

…tains Velocity code * Remove the interface as the component is internal.
xwiki · Oct 20, 2023 · 245cefc · 245cefc
1 parent a57e4a3
commit 245cefc
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 50 deletions.
diff --git a/...mons-velocity/src/main/java/org/xwiki/velocity/internal/util/DefaultVelocityDetector.java b/...mons-velocity/src/main/java/org/xwiki/velocity/internal/util/DefaultVelocityDetector.java
diff --git a/...iki-commons-velocity/src/main/java/org/xwiki/velocity/internal/util/VelocityDetector.java b/...iki-commons-velocity/src/main/java/org/xwiki/velocity/internal/util/VelocityDetector.java
@@ -19,22 +19,28 @@
  */
 package org.xwiki.velocity.internal.util;
 
-import org.xwiki.component.annotation.Role;
+import javax.inject.Singleton;
+
+import org.xwiki.component.annotation.Component;
 
 /**
- * Utility role to detect velocity scripts.
+ * Utility component to check if a string contains a velocity script.
  *
  * @version $Id$
  * @since 15.9RC1
  */
-@Role
-public interface VelocityDetector
+@Component(roles = VelocityDetector.class)
+@Singleton
+public class VelocityDetector
 {
     /**
      * Checks if a string contains a velocity script.
      *
      * @param input the string to check
      * @return true if the string contains a velocity script, false otherwise
      */
-    boolean containsVelocityScript(String input);
+    public boolean containsVelocityScript(String input)
+    {
+        return input.contains("#") || input.contains("$");
+    }
 }
diff --git a/xwiki-commons-core/xwiki-commons-velocity/src/main/resources/META-INF/components.txt b/xwiki-commons-core/xwiki-commons-velocity/src/main/resources/META-INF/components.txt
@@ -4,4 +4,4 @@ org.xwiki.velocity.internal.DefaultVelocityContextFactory
 org.xwiki.velocity.internal.DefaultVelocityManager
 org.xwiki.velocity.internal.InternalVelocityEngine
 org.xwiki.velocity.internal.ServicesVelocityContextInitializer
-org.xwiki.velocity.internal.util.DefaultVelocityDetector
+org.xwiki.velocity.internal.util.VelocityDetector
diff --git a/...nal/util/DefaultVelocityDetectorTest.java → ...y/internal/util/VelocityDetectorTest.java b/...nal/util/DefaultVelocityDetectorTest.java → ...y/internal/util/VelocityDetectorTest.java
@@ -27,15 +27,15 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 /**
- * Tests for {@link DefaultVelocityDetector}.
+ * Tests for {@link VelocityDetector}.
  *
  * @version $Id$
  */
 @ComponentTest
-class DefaultVelocityDetectorTest
+class VelocityDetectorTest
 {
     @InjectMockComponents
-    private DefaultVelocityDetector detector;
+    private VelocityDetector detector;
 
     @ParameterizedTest
     @CsvSource({