Fix #102 Add parameter to 'experimental-pseudo-usage' rules to flag some pseudo elements as non-experimental

Author: racodond

css-checks/src/main/java/org/sonar/css/checks/common/ExperimentalPseudoCheck.java

@@ -19,16 +19,23 @@
  */
 package org.sonar.css.checks.common;
 
+import com.google.common.annotations.VisibleForTesting;
 import org.sonar.check.Priority;
 import org.sonar.check.Rule;
+import org.sonar.check.RuleProperty;
+import org.sonar.css.checks.CheckList;
+import org.sonar.css.checks.CheckUtils;
 import org.sonar.css.checks.Tags;
+import org.sonar.plugins.css.api.tree.Tree;
 import org.sonar.plugins.css.api.tree.css.PseudoFunctionTree;
 import org.sonar.plugins.css.api.tree.css.PseudoIdentifierTree;
-import org.sonar.plugins.css.api.tree.Tree;
 import org.sonar.plugins.css.api.visitors.DoubleDispatchVisitorCheck;
 import org.sonar.squidbridge.annotations.ActivatedByDefault;
 import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
 
+import java.util.regex.Pattern;
+import java.util.regex.PatternSyntaxException;
+
 @Rule(
   key = "experimental-pseudo-usage",
   name = "Experimental pseudo-elements and pseudo-classes should not be used",
@@ -38,17 +45,27 @@
 @ActivatedByDefault
 public class ExperimentalPseudoCheck extends DoubleDispatchVisitorCheck {
 
+  private static final String DEFAULT_PSEUDOS_TO_EXCLUDE = "";
+
+  @RuleProperty(
+    key = "pseudosToExclude",
+    description = "A regular expression to exclude pseudo-elements and pseudo-classes from being considered as experimental. Example: \"any-link|user.*\". See " + CheckUtils.LINK_TO_JAVA_REGEX_PATTERN_DOC + " for detailed regular expression syntax.",
+    defaultValue = DEFAULT_PSEUDOS_TO_EXCLUDE)
+  private String pseudosToExclude = DEFAULT_PSEUDOS_TO_EXCLUDE;
+
   @Override
   public void visitPseudoFunction(PseudoFunctionTree tree) {
-    if (tree.isVendorPrefixed() || tree.standardFunction().isExperimental()) {
+    if (!tree.standardFunction().getName().matches(pseudosToExclude)
+      && (tree.isVendorPrefixed() || tree.standardFunction().isExperimental())) {
       createIssue(tree.function(), tree.standardFunction().getName());
     }
     super.visitPseudoFunction(tree);
   }
 
   @Override
   public void visitPseudoIdentifier(PseudoIdentifierTree tree) {
-    if (tree.isVendorPrefixed() || tree.standardPseudoIdentifier().isExperimental()) {
+    if (!tree.standardPseudoIdentifier().getName().matches(pseudosToExclude)
+      && (tree.isVendorPrefixed() || tree.standardPseudoIdentifier().isExperimental())) {
       createIssue(tree.identifier(), tree.standardPseudoIdentifier().getName());
     }
     super.visitPseudoIdentifier(tree);
@@ -58,4 +75,25 @@ private void createIssue(Tree location, String pseudo) {
     addPreciseIssue(location, "Remove this usage of the experimental \"" + pseudo + "\" pseudo.");
   }
 
+  @Override
+  public void validateParameters() {
+    try {
+      Pattern.compile(pseudosToExclude);
+    } catch (PatternSyntaxException exception) {
+      throw new IllegalStateException(paramsErrorMessage(), exception);
+    }
+  }
+
+  @VisibleForTesting
+  void setPseudosToExclude(String pseudosToExclude) {
+    this.pseudosToExclude = pseudosToExclude;
+  }
+
+  private String paramsErrorMessage() {
+    return CheckUtils.paramsErrorMessage(
+      this.getClass(),
+      CheckList.CSS_REPOSITORY_KEY,
+      "pseudosToExclude parameter \"" + pseudosToExclude + "\" is not a valid regular expression.");
+  }
+
 }

css-checks/src/test/java/org/sonar/css/checks/common/ExperimentalPseudoCheckTest.java

@@ -25,23 +25,56 @@
 
 import java.io.File;
 
-public class ExperimentalPseudoCheckTest {
+import static org.fest.assertions.Assertions.assertThat;
 
-  private ExperimentalPseudoCheck check = new ExperimentalPseudoCheck();
+public class ExperimentalPseudoCheckTest {
 
   @Test
   public void test_css() {
-    CssCheckVerifier.verifyCssFile(check, getTestFile("experimentalPseudoUsage.css"));
+    CssCheckVerifier.verifyCssFile(new ExperimentalPseudoCheck(), getTestFile("experimentalPseudoUsage.css"));
+  }
+
+  @Test
+  public void test_css_exclude_pseudos() {
+    ExperimentalPseudoCheck check = new ExperimentalPseudoCheck();
+    check.setPseudosToExclude("any-link|cont.*");
+    CssCheckVerifier.verifyCssFile(check, getTestFile("experimentalPseudoUsageExcludePseudos.css"));
   }
 
   @Test
   public void test_less() {
-    CssCheckVerifier.verifyLessFile(check, getTestFile("experimentalPseudoUsage.less"));
+    CssCheckVerifier.verifyLessFile(new ExperimentalPseudoCheck(), getTestFile("experimentalPseudoUsage.less"));
+  }
+
+  @Test
+  public void test_less_exclude_pseudos() {
+    ExperimentalPseudoCheck check = new ExperimentalPseudoCheck();
+    check.setPseudosToExclude("any-link|cont.*");
+    CssCheckVerifier.verifyLessFile(check, getTestFile("experimentalPseudoUsageExcludePseudos.less"));
   }
 
   @Test
   public void test_scss() {
-    CssCheckVerifier.verifyScssFile(check, getTestFile("experimentalPseudoUsage.scss"));
+    CssCheckVerifier.verifyScssFile(new ExperimentalPseudoCheck(), getTestFile("experimentalPseudoUsage.scss"));
+  }
+
+  @Test
+  public void test_scss_exclude_pseudos() {
+    ExperimentalPseudoCheck check = new ExperimentalPseudoCheck();
+    check.setPseudosToExclude("any-link|cont.*");
+    CssCheckVerifier.verifyScssFile(check, getTestFile("experimentalPseudoUsageExcludePseudos.scss"));
+  }
+
+  @Test
+  public void should_throw_an_illegal_state_exception_as_the_pseudosToExclude_parameter_is_not_valid() {
+    try {
+      ExperimentalPseudoCheck check = new ExperimentalPseudoCheck();
+      check.setPseudosToExclude("(");
+      CssCheckVerifier.issuesOnCssFile(check, getTestFile("experimentalPseudoUsage.css")).noMore();
+    } catch (IllegalStateException e) {
+      assertThat(e.getMessage()).isEqualTo("Check css:experimental-pseudo-usage (Experimental pseudo-elements and pseudo-classes should not be used): "
+        + "pseudosToExclude parameter \"(\" is not a valid regular expression.");
+    }
   }
 
   private File getTestFile(String fileName) {

css-checks/src/test/resources/checks/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.css

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

css-checks/src/test/resources/checks/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.less

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

css-checks/src/test/resources/checks/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.scss

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

its/ruling/projects/custom/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.css

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

its/ruling/projects/custom/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.less

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

its/ruling/projects/custom/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.scss

@@ -0,0 +1,27 @@
+#id:-moz-abc { /* Noncompliant ![sc=5;ec=13;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+p:-moz-abc(ltr) { /* Noncompliant ![sc=3;ec=11;el=+0]! !{Remove this usage of the experimental "abc" pseudo.}! */
+  color: red;
+}
+
+:host { /* Noncompliant ![sc=2;ec=6;el=+0]! !{Remove this usage of the experimental "host" pseudo.}! */
+  color: red;
+}
+
+:content {
+  color: red;
+}
+
+:any-link() {
+  color: red;
+}
+
+p:empty {
+  color: red;
+}
+
+p:not(.mybox) {
+  color: red;
+}

its/ruling/tests/src/test/expected/css-experimental-pseudo-usage.json

@@ -6,6 +6,12 @@
 13,
 17,
 ],
+'project:custom/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.css':[
+1,
+5,
+9,
+13,
+],
 'project:custom/common/unknown-pseudo/unknownPseudo.css':[
 7,
 17,

its/ruling/tests/src/test/expected/css-ids.json

@@ -9,6 +9,9 @@
 1,
 5,
 ],
+'project:custom/common/experimental-pseudo-usage/experimentalPseudoUsageExcludePseudos.css':[
+1,
+],
 'project:custom/common/id-selector-naming-convention/selectorNamingConvention.css':[
 1,
 7,