Fix #102 Add parameter to 'experimental-function-usage' rules to flag some functions as non-experimental

Author: racodond

css-checks/src/main/java/org/sonar/css/checks/css/ExperimentalCssFunctionCheck.java

@@ -19,14 +19,21 @@
  */
 package org.sonar.css.checks.css;
 
+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.FunctionTree;
 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-function-usage",
   name = "Experimental functions should not be used",
@@ -36,14 +43,46 @@
 @ActivatedByDefault
 public class ExperimentalCssFunctionCheck extends DoubleDispatchVisitorCheck {
 
+  private static final String DEFAULT_FUNCTIONS_TO_EXCLUDE = "";
+
+  @RuleProperty(
+    key = "functionsToExclude",
+    description = "A regular expression to exclude functions from being considered as experimental. Example: \"conic-gradient|count.*\". See " + CheckUtils.LINK_TO_JAVA_REGEX_PATTERN_DOC + " for detailed regular expression syntax.",
+    defaultValue = DEFAULT_FUNCTIONS_TO_EXCLUDE)
+  private String functionsToExclude = DEFAULT_FUNCTIONS_TO_EXCLUDE;
+
   @Override
   public void visitFunction(FunctionTree tree) {
-    if (tree.standardFunction().isCss() && (tree.isVendorPrefixed() || tree.standardFunction().isExperimental())) {
+    if (tree.standardFunction().isCss()
+      && !tree.standardFunction().getName().matches(functionsToExclude)
+      && (tree.isVendorPrefixed() || tree.standardFunction().isExperimental())) {
       addPreciseIssue(
         tree.function(),
         "Remove this usage of the experimental \"" + tree.standardFunction().getName() + "\" function.");
     }
     super.visitFunction(tree);
   }
 
+
+  @Override
+  public void validateParameters() {
+    try {
+      Pattern.compile(functionsToExclude);
+    } catch (PatternSyntaxException exception) {
+      throw new IllegalStateException(paramsErrorMessage(), exception);
+    }
+  }
+
+  @VisibleForTesting
+  void setFunctionsToExclude(String functionsToExclude) {
+    this.functionsToExclude = functionsToExclude;
+  }
+
+  private String paramsErrorMessage() {
+    return CheckUtils.paramsErrorMessage(
+      this.getClass(),
+      CheckList.CSS_REPOSITORY_KEY,
+      "functionsToExclude parameter \"" + functionsToExclude + "\" is not a valid regular expression.");
+  }
+
 }

css-checks/src/test/java/org/sonar/css/checks/css/ExperimentalCssFunctionCheckTest.java

@@ -21,13 +21,35 @@
 
 import org.junit.Test;
 import org.sonar.css.checks.CheckTestUtils;
+import org.sonar.css.checks.common.ExperimentalPseudoCheck;
 import org.sonar.css.checks.verifier.CssCheckVerifier;
 
+import static org.fest.assertions.Assertions.assertThat;
+
 public class ExperimentalCssFunctionCheckTest {
 
   @Test
   public void test() {
     CssCheckVerifier.verifyCssFile(new ExperimentalCssFunctionCheck(), CheckTestUtils.getCssTestFile("experimentalFunctionUsage.css"));
   }
 
+  @Test
+  public void test_exclude_functions() {
+    ExperimentalCssFunctionCheck check = new ExperimentalCssFunctionCheck();
+    check.setFunctionsToExclude("conic-gradient|count.*");
+    CssCheckVerifier.verifyCssFile(check, CheckTestUtils.getCssTestFile("experimentalFunctionUsageExcludeFunctions.css"));
+  }
+
+  @Test
+  public void should_throw_an_illegal_state_exception_as_the_functionsToExclude_parameter_is_not_valid() {
+    try {
+      ExperimentalCssFunctionCheck check = new ExperimentalCssFunctionCheck();
+      check.setFunctionsToExclude("(");
+      CssCheckVerifier.issuesOnCssFile(check, CheckTestUtils.getCssTestFile("experimentalFunctionUsage.css")).noMore();
+    } catch (IllegalStateException e) {
+      assertThat(e.getMessage()).isEqualTo("Check css:experimental-function-usage (Experimental functions should not be used): "
+        + "functionsToExclude parameter \"(\" is not a valid regular expression.");
+    }
+  }
+
 }

css-checks/src/test/resources/checks/css/experimentalFunctionUsage.css

@@ -18,4 +18,3 @@
 @document url-prefix("http://www.w3.org/Style/CSS/") { /* Noncompliant */
   #summary { background: yellow; color: black}
 }
-

css-checks/src/test/resources/checks/css/experimentalFunctionUsageExcludeFunctions.css

@@ -0,0 +1,5 @@
+.mybox {
+  background: conic-gradient(#f06, rgba(0,0,0,.5));
+  width: counter(1);
+  abc: supports(); /* Noncompliant */
+}

its/ruling/projects/custom/css/experimentalFunctionUsage.css

@@ -18,4 +18,3 @@
 @document url-prefix("http://www.w3.org/Style/CSS/") { /* Noncompliant */
   #summary { background: yellow; color: black}
 }
-

its/ruling/projects/custom/css/experimentalFunctionUsageExcludeFunctions.css

@@ -0,0 +1,5 @@
+.mybox {
+  background: conic-gradient(#f06, rgba(0,0,0,.5));
+  width: counter(1);
+  abc: supports(); /* Noncompliant */
+}

its/ruling/tests/src/test/expected/css-alphabetize-declarations.json

@@ -143,6 +143,9 @@
 'project:custom/css/experimentalFunctionUsage.css':[
 1,
 ],
+'project:custom/css/experimentalFunctionUsageExcludeFunctions.css':[
+1,
+],
 'project:custom/css/unknownFunctions.css':[
 1,
 ],

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

@@ -72,6 +72,11 @@
 14,
 18,
 ],
+'project:custom/css/experimentalFunctionUsageExcludeFunctions.css':[
+2,
+3,
+4,
+],
 'project:custom/css/obsoleteFunctions.css':[
 7,
 8,

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

@@ -383,6 +383,11 @@
 19,
 19,
 ],
+'project:custom/css/experimentalFunctionUsageExcludeFunctions.css':[
+2,
+2,
+2,
+],
 'project:custom/css/obsoleteFunctions.css':[
 8,
 ],

its/ruling/tests/src/test/expected/css-known-properties.json

@@ -96,4 +96,7 @@
 'project:custom/css/experimentalFunctionUsage.css':[
 7,
 ],
+'project:custom/css/experimentalFunctionUsageExcludeFunctions.css':[
+4,
+],
 }