Merge pull request #1929 from Haehnchen/feature/1429-security-matcher

#1429 fix security matcher starting string replacement and support php attributes

Author: Haehnchen

src/main/java/fr/adrienbrault/idea/symfony2plugin/security/AnnotationExpressionGotoCompletionRegistrar.java

@@ -3,11 +3,15 @@
 import com.intellij.codeInsight.completion.CompletionResultSet;
 import com.intellij.patterns.PatternCondition;
 import com.intellij.patterns.PlatformPatterns;
+import com.intellij.patterns.PsiElementPattern;
 import com.intellij.psi.PsiElement;
 import com.intellij.util.ProcessingContext;
 import com.jetbrains.php.lang.documentation.phpdoc.lexer.PhpDocTokenTypes;
 import com.jetbrains.php.lang.documentation.phpdoc.parser.PhpDocElementTypes;
 import com.jetbrains.php.lang.documentation.phpdoc.psi.tags.PhpDocTag;
+import com.jetbrains.php.lang.lexer.PhpTokenTypes;
+import com.jetbrains.php.lang.psi.elements.ParameterList;
+import com.jetbrains.php.lang.psi.elements.PhpAttribute;
 import com.jetbrains.php.lang.psi.elements.StringLiteralExpression;
 import de.espend.idea.php.annotation.util.AnnotationUtil;
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionProvider;
@@ -16,6 +20,7 @@
 import fr.adrienbrault.idea.symfony2plugin.codeInsight.GotoCompletionRegistrarParameter;
 import fr.adrienbrault.idea.symfony2plugin.security.utils.VoterUtil;
 import fr.adrienbrault.idea.symfony2plugin.util.PhpElementsUtil;
+import org.apache.commons.lang.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.util.Collection;
@@ -29,22 +34,43 @@
  */
 public class AnnotationExpressionGotoCompletionRegistrar implements GotoCompletionRegistrar {
 
-    private static final String SECURITY_ANNOTATION = "Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Security";
+    private static final String SECURITY_ANNOTATION = "\\Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Security";
 
     @Override
     public void register(@NotNull GotoCompletionRegistrarParameter registrar) {
         // "@Security("is_granted('POST_SHOW', post) and has_role('ROLE_ADMIN')")"
         registrar.register(
-            PlatformPatterns.psiElement(PhpDocTokenTypes.DOC_STRING)
+            PlatformPatterns.or(getDocTagStringPattern(), getAttributeStringPattern()),
+            MyGotoCompletionProvider::new
+        );
+    }
+
+    @NotNull
+    private PsiElementPattern.Capture<PsiElement> getAttributeStringPattern() {
+        // #[Security("is_granted('POST_SHOW')")]
+        return PlatformPatterns.psiElement().withElementType(PlatformPatterns.elementType().or(
+                PhpTokenTypes.STRING_LITERAL_SINGLE_QUOTE,
+                PhpTokenTypes.STRING_LITERAL
+            ))
+            .withParent(PlatformPatterns.psiElement(StringLiteralExpression.class)
+                .withParent(PlatformPatterns.psiElement(ParameterList.class)
+                    .withParent(PlatformPatterns.psiElement(PhpAttribute.class)
+                        .with(PhpDocInstancePatternCondition.INSTANCE)
+                    )
+                )
+            );
+    }
+
+    @NotNull
+    private PsiElementPattern.Capture<PsiElement> getDocTagStringPattern() {
+        return PlatformPatterns.psiElement(PhpDocTokenTypes.DOC_STRING)
             .withParent(PlatformPatterns.psiElement(StringLiteralExpression.class)
                 .withParent(PlatformPatterns.psiElement(PhpDocElementTypes.phpDocAttributeList)
                     .withParent(PlatformPatterns.psiElement(PhpDocTag.class)
                         .with(PhpDocInstancePatternCondition.INSTANCE)
                     )
                 )
-            ),
-            MyGotoCompletionProvider::new
-        );
+            );
     }
 
     /**
@@ -64,12 +90,13 @@ public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arg
             // find caret position:
             // - "has_role('"
             // - "has_role('YAML_ROLE_"
-            if(!blockNamePrefix.matches("^.*(has_role|is_granted)\\s*\\(\\s*'[\\w-]*$")) {
+            if(!blockNamePrefix.matches("^.*(has_role|is_granted)\\s*\\(\\s*['|\"][\\w-]*$")) {
                 return;
             }
 
             // clear prefix caret string; for a clean completion independent from inside content
-            CompletionResultSet myResultSet = resultSet.withPrefixMatcher("");
+            String substring = blockNamePrefix.replaceAll("^(.*(has_role|is_granted)\\s*\\(\\s*['|\"])", "");
+            CompletionResultSet myResultSet = resultSet.withPrefixMatcher(substring);
 
             VoterUtil.LookupElementPairConsumer consumer = new VoterUtil.LookupElementPairConsumer();
             VoterUtil.visitAttribute(getProject(), consumer);
@@ -79,17 +106,27 @@ public void getLookupElements(@NotNull GotoCompletionProviderLookupArguments arg
         @NotNull
         @Override
         public Collection<PsiElement> getPsiTargets(PsiElement element) {
-            if(getElement().getNode().getElementType() != PhpDocTokenTypes.DOC_STRING) {
-                return Collections.emptyList();
+            String contents = null;
+            if(getElement().getNode().getElementType() == PhpDocTokenTypes.DOC_STRING) {
+                // @Security
+                PsiElement parent = getElement().getParent();
+                if(!(parent instanceof StringLiteralExpression)) {
+                    return Collections.emptyList();
+                }
+
+                contents = ((StringLiteralExpression) parent).getContents();
+           } else {
+                // @Security
+                PsiElement parent = getElement().getParent();
+                if (parent instanceof StringLiteralExpression) {
+                    contents = ((StringLiteralExpression) parent).getContents();
+                }
             }
 
-            PsiElement parent = getElement().getParent();
-            if(!(parent instanceof StringLiteralExpression)) {
+            if (StringUtils.isBlank(contents)) {
                 return Collections.emptyList();
             }
 
-            String contents = ((StringLiteralExpression) parent).getContents();
-
             Collection<String> roles = new HashSet<>();
             for (String regex : new String[]{"is_granted\\s*\\(\\s*['|\"]([^'\"]+)['|\"]\\s*[\\)|,]", "has_role\\s*\\(\\s*['|\"]([^'\"]+)['|\"]\\s*\\)"}) {
                 Matcher matcher = Pattern.compile(regex).matcher(contents);
@@ -118,16 +155,21 @@ public Collection<PsiElement> getPsiTargets(PsiElement element) {
      * Check if given PhpDocTag is instance of given Annotation class
      */
     private static class PhpDocInstancePatternCondition extends PatternCondition<PsiElement> {
-        private static PhpDocInstancePatternCondition INSTANCE = new PhpDocInstancePatternCondition();
+        private static final PhpDocInstancePatternCondition INSTANCE = new PhpDocInstancePatternCondition();
 
         PhpDocInstancePatternCondition() {
-            super("PhpDoc Annotation Instance");
+            super("PhpDoc/Attribute Instance");
         }
 
         @Override
         public boolean accepts(@NotNull PsiElement psiElement, ProcessingContext processingContext) {
-            return psiElement instanceof PhpDocTag
-                && PhpElementsUtil.isEqualClassName(AnnotationUtil.getAnnotationReference((PhpDocTag) psiElement), SECURITY_ANNOTATION);
+            if (psiElement instanceof PhpDocTag) {
+                return PhpElementsUtil.isEqualClassName(AnnotationUtil.getAnnotationReference((PhpDocTag) psiElement), SECURITY_ANNOTATION);
+            } else if (psiElement instanceof PhpAttribute) {
+                return SECURITY_ANNOTATION.equals(((PhpAttribute) psiElement).getFQN());
+            }
+
+            return false;
         }
     }
 }

src/test/java/fr/adrienbrault/idea/symfony2plugin/tests/security/AnnotationExpressionGotoCompletionRegistrarTest.java

@@ -74,6 +74,17 @@ public void testSecurityAnnotationProvidesCompletion() {
         );
     }
 
+    public void testSecurityAttributeProvidesCompletion() {
+        assertCompletionContains(
+            "test.php",
+            "<?php\n" +
+                "use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Security;\n" +
+                "#[Security('is_granted(\"YAML_ROLE<caret>_USER_FOOBAR\", post)')]\n" +
+                "function test() {};\n",
+            "YAML_ROLE_USER_FOOBAR"
+        );
+    }
+
     public void testSecurityAnnotationProvidesRoleNavigation() {
         assertNavigationMatch(
             "test.php",
@@ -123,4 +134,15 @@ public void testSecurityAnnotationProvidesRoleNavigation() {
             PlatformPatterns.psiElement()
         );
     }
+
+    public void testSecurityAttributeProvidesRoleNavigation() {
+        assertNavigationMatch(
+            "test.php",
+            "<?php\n" +
+                "use Sensio\\Bundle\\FrameworkExtraBundle\\Configuration\\Security;\n" +
+                "#[Security('is_granted(\"YAML_ROLE<caret>_USER_FOOBAR\", post)')]\n" +
+                "function test() {};\n",
+            PlatformPatterns.psiElement()
+        );
+    }
 }