some ascii char dont need to be escaped, fix inspection for them and reduce deprecated warning to weak notification #693

Author: Haehnchen

src/fr/adrienbrault/idea/symfony2plugin/intentions/yaml/YamlQuotedEscapedInspection.java

@@ -28,18 +28,21 @@ public void visitElement(PsiElement element) {
                 if(element.getNode().getElementType() == YAMLTokenTypes.SCALAR_DSTRING) {
                     // "Foo\Foo" -> "Foo\\Foo"
                     String text = StringUtils.strip(element.getText(), "\"");
-                    if(text.matches(".*[^\\\\]\\\\[^\\\\].*")) {
-                        holder.registerProblem(element, "Not escaping a backslash in a double-quoted string is deprecated", ProblemHighlightType.LIKE_DEPRECATED);
+
+                    // dont check to long strings
+                    // ascii chars that need to be escape; some @see Symfony\Component\Yaml\Unescaper
+                    if(text.length() < 255 && text.matches(".*[^\\\\]\\\\[^\\\\0abtnvfre \"/N_LPxuU].*")) {
+                        holder.registerProblem(element, "Not escaping a backslash in a double-quoted string is deprecated", ProblemHighlightType.WEAK_WARNING);
                     }
                 } else if (element.getNode().getElementType() == YAMLTokenTypes.TEXT) {
                     // @foo -> "@foo"
                     String text = element.getText();
                     if(text.length() > 1) {
                         String startChar = text.substring(0, 1);
                         if(startChar.equals("@") || startChar.equals("`") || startChar.equals("|") || startChar.equals(">")) {
-                            holder.registerProblem(element, String.format("Deprecated usage of '%s' at the beginning of unquoted string", startChar), ProblemHighlightType.LIKE_DEPRECATED);
+                            holder.registerProblem(element, String.format("Deprecated usage of '%s' at the beginning of unquoted string", startChar), ProblemHighlightType.WEAK_WARNING);
                         } else if(startChar.equals("%")) {
-                            holder.registerProblem(element, "Not quoting a scalar starting with the '%' indicator character is deprecated since Symfony 3.1", ProblemHighlightType.LIKE_DEPRECATED);
+                            holder.registerProblem(element, "Not quoting a scalar starting with the '%' indicator character is deprecated since Symfony 3.1", ProblemHighlightType.WEAK_WARNING);
                         }
                     }
                 }

tests/fr/adrienbrault/idea/symfony2plugin/tests/intentions/yaml/YamlQuotedEscapedInspectionTest.java

@@ -1,6 +1,7 @@
 package fr.adrienbrault.idea.symfony2plugin.tests.intentions.yaml;
 
 import fr.adrienbrault.idea.symfony2plugin.tests.SymfonyLightCodeInsightFixtureTestCase;
+import org.apache.commons.lang.StringUtils;
 
 /**
  * @author Daniel Espendiller <daniel@espendiller.net>
@@ -30,6 +31,22 @@ public void testDeprecatedNonEscapedInDoubleQuotedStrings() {
         );
     }
 
+    public void testDeprecatedNonEscapedWhitelistCharInDoubleQuotedStrings() {
+        for (String s : new String[]{"\\n", "\\r", "\\t", "\\_", " "}) {
+            assertLocalInspectionContainsNotContains("foo.yml",
+                "class: \"Foo<caret>" + s +"Bar\"",
+                "Not escaping a backslash in a double-quoted string is deprecated"
+            );
+        }
+    }
+
+    public void testDeprecatedNonEscapedBlacklistConditionInDoubleQuotedStrings() {
+        assertLocalInspectionContainsNotContains("foo.yml",
+            "class: \"Foo<caret>\\Bar" + StringUtils.repeat("a", 255) + "\"",
+            "Not escaping a backslash in a double-quoted string is deprecated"
+        );
+    }
+
     public void testDeprecatedUsageOfAtCharAtTheBeginningOfUnquotedStrings() {
         assertLocalInspectionContains("foo.yml",
             "class: @f<caret>oo",