Fix #102 Add parameter to 'experimental-identifier-usage' rules to flag some identifiers as non-experimental

Author: racodond

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

@@ -19,15 +19,22 @@
  */
 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.css.IdentifierTree;
 import org.sonar.plugins.css.api.tree.css.ValueTree;
 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-identifier-usage",
   name = "Experimental identifiers should not be used",
@@ -37,14 +44,43 @@
 @ActivatedByDefault
 public class ExperimentalIdentifierCheck extends DoubleDispatchVisitorCheck {
 
+  private static final String DEFAULT_IDENTIFIERS_TO_EXCLUDE = "";
+
+  @RuleProperty(
+    key = "identifiersToExclude",
+    description = "A regular expression to exclude identifiers from being considered as experimental. Example: \"gradient|flex.*\". See " + CheckUtils.LINK_TO_JAVA_REGEX_PATTERN_DOC + " for detailed regular expression syntax.",
+    defaultValue = DEFAULT_IDENTIFIERS_TO_EXCLUDE)
+  private String identifiersToExclude = DEFAULT_IDENTIFIERS_TO_EXCLUDE;
+
   @Override
   public void visitValue(ValueTree tree) {
     tree.valueElementsOfType(IdentifierTree.class)
       .stream()
-      .filter(IdentifierTree::isVendorPrefixed)
+      .filter(i -> i.isVendorPrefixed() && !i.name().matches(identifiersToExclude))
       .forEach(i -> addPreciseIssue(i, "Remove this usage of the experimental \"" + i.text() + "\" identifier."));
 
     super.visitValue(tree);
   }
 
+  @Override
+  public void validateParameters() {
+    try {
+      Pattern.compile(identifiersToExclude);
+    } catch (PatternSyntaxException exception) {
+      throw new IllegalStateException(paramsErrorMessage(), exception);
+    }
+  }
+
+  @VisibleForTesting
+  void setIdentifiersToExclude(String identifiersToExclude) {
+    this.identifiersToExclude = identifiersToExclude;
+  }
+
+  private String paramsErrorMessage() {
+    return CheckUtils.paramsErrorMessage(
+      this.getClass(),
+      CheckList.CSS_REPOSITORY_KEY,
+      "identifiersToExclude parameter \"" + identifiersToExclude + "\" is not a valid regular expression.");
+  }
+
 }

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

@@ -81,5 +81,4 @@ private File getTestFile(String fileName) {
     return CheckTestUtils.getCommonTestFile("experimental-atrule-usage/" + fileName);
   }
 
-
 }

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

@@ -23,11 +23,39 @@
 import org.sonar.css.checks.CheckTestUtils;
 import org.sonar.css.checks.verifier.CssCheckVerifier;
 
+import java.io.File;
+
+import static org.fest.assertions.Assertions.assertThat;
+
 public class ExperimentalIdentifierCheckTest {
 
   @Test
   public void test() {
-    CssCheckVerifier.verifyCssFile(new ExperimentalIdentifierCheck(), CheckTestUtils.getCommonTestFile("experimentalIdentifierUsage.css"));
+    CssCheckVerifier.verifyCssFile(new ExperimentalIdentifierCheck(), getTestFile("experimentalIdentifierUsage.css"));
+  }
+
+  @Test
+  public void test_exclude_identifiers() {
+    ExperimentalIdentifierCheck check = new ExperimentalIdentifierCheck();
+    check.setIdentifiersToExclude("flex|defin.*");
+    CssCheckVerifier.verifyCssFile(check, getTestFile("experimentalIdentifierUsageExcludeIdentifiers.css"));
   }
 
+  @Test
+  public void should_throw_an_illegal_state_exception_as_the_identifiersToExclude_parameter_is_not_valid() {
+    try {
+      ExperimentalIdentifierCheck check = new ExperimentalIdentifierCheck();
+      check.setIdentifiersToExclude("(");
+      CssCheckVerifier.issuesOnCssFile(check, getTestFile("experimentalIdentifierUsage.css")).noMore();
+    } catch (IllegalStateException e) {
+      assertThat(e.getMessage()).isEqualTo("Check css:experimental-identifier-usage (Experimental identifiers should not be used): "
+        + "identifiersToExclude parameter \"(\" is not a valid regular expression.");
+    }
+  }
+
+  private File getTestFile(String fileName) {
+    return CheckTestUtils.getCommonTestFile("experimental-identifier-usage/" + fileName);
+  }
+
+
 }

…s/common/experimentalIdentifierUsage.css …er-usage/experimentalIdentifierUsage.csscss-checks/src/test/resources/checks/common/experimentalIdentifierUsage.css renamed to css-checks/src/test/resources/checks/common/experimental-identifier-usage/experimentalIdentifierUsage.css css-checks/src/test/resources/checks/common/experimentalIdentifierUsage.css renamed to css-checks/src/test/resources/checks/common/experimental-identifier-usage/experimentalIdentifierUsage.css

@@ -0,0 +1,5 @@
+.mybox {
+  display: -moz-abc; /* Noncompliant ![sc=12;ec=20;el=+0]! !{Remove this usage of the experimental "-moz-abc" identifier.}! */
+  display: -ms-definite;
+  display: -moz-flex;
+}

css-checks/src/test/resources/checks/common/experimental-identifier-usage/experimentalIdentifierUsageExcludeIdentifiers.css

@@ -34,12 +34,14 @@ public class IdentifierTreeImpl extends LiteralTreeImpl implements IdentifierTre
   private static final Pattern LESS_INTERPOLATED_VARIABLE = Pattern.compile("@\\{[\\w-_]+\\}");
   private static final Pattern SCSS_INTERPOLATED_VARIABLE = Pattern.compile("#\\{.+\\}");
   private final Vendor vendor;
+  private final String name;
   private Scope scope;
   private Symbol symbol = null;
 
   public IdentifierTreeImpl(SyntaxToken ident) {
     super(ident);
     this.vendor = setVendorPrefix();
+    this.name = setName();
   }
 
   @Override
@@ -82,6 +84,11 @@ public Vendor vendor() {
     return vendor;
   }
 
+  @Override
+  public String name() {
+    return name;
+  }
+
   private Vendor setVendorPrefix() {
     for (Vendor v : Vendor.values()) {
       if (text().toLowerCase(Locale.ENGLISH).startsWith(v.getPrefix())) {
@@ -91,6 +98,15 @@ private Vendor setVendorPrefix() {
     return null;
   }
 
+  private String setName() {
+    for (Vendor v : Vendor.values()) {
+      if (text().toLowerCase(Locale.ENGLISH).startsWith(v.getPrefix())) {
+        return text().substring(v.getPrefix().length());
+      }
+    }
+    return text();
+  }
+
   @Override
   public Scope scope() {
     return scope;

css-frontend/src/main/java/org/sonar/css/tree/impl/css/IdentifierTreeImpl.java

@@ -32,6 +32,8 @@ public interface IdentifierTree extends LiteralTree {
   @Nullable
   Vendor vendor();
 
+  String name();
+
   boolean isInterpolated();
 
   boolean isLessInterpolated();

css-frontend/src/main/java/org/sonar/plugins/css/api/tree/css/IdentifierTree.java

@@ -46,11 +46,13 @@ public void ident() {
     assertThat(tree.isVendorPrefixed()).isTrue();
     assertThat(tree.vendor()).isEqualTo(Vendor.MOZILLA);
     assertThat(tree.isLessInterpolated()).isFalse();
+    assertThat(tree.name()).isEqualTo("box-sizing");
 
     tree = checkParsed("_dunno-what");
     assertThat(tree.isVendorPrefixed()).isFalse();
     assertThat(tree.vendor()).isNull();
     assertThat(tree.isLessInterpolated()).isFalse();
+    assertThat(tree.name()).isEqualTo("_dunno-what");
 
     checkParsed("*");
   }

css-frontend/src/test/java/org/sonar/css/parser/css/IdentifierTreeTest.java

@@ -0,0 +1,5 @@
+.mybox {
+  display: -moz-abc; /* Noncompliant ![sc=12;ec=20;el=+0]! !{Remove this usage of the experimental "-moz-abc" identifier.}! */
+  display: -ms-definite;
+  display: -moz-flex;
+}