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

Author: racodond

css-checks/src/main/java/org/sonar/css/checks/less/ExperimentalNotLessFunctionCheck.java

@@ -19,14 +19,21 @@
  */
 package org.sonar.css.checks.less;
 
+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-not-less-function-usage",
   name = "Experimental functions should not be used",
@@ -36,14 +43,45 @@
 @ActivatedByDefault
 public class ExperimentalNotLessFunctionCheck extends DoubleDispatchVisitorCheck {
 
+  private static final String DEFAULT_FUNCTIONS_TO_EXCLUDE = "";
+
+  @RuleProperty(
+    key = "functionsToExclude",
+    description = "A regular expression to exclude CSS 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().isLess() && (tree.isVendorPrefixed() || tree.standardFunction().isExperimental())) {
+    if (!tree.standardFunction().isLess()
+      && !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.LESS_REPOSITORY_KEY,
+      "functionsToExclude parameter \"" + functionsToExclude + "\" is not a valid regular expression.");
+  }
+
 }

css-checks/src/test/java/org/sonar/css/checks/less/ExperimentalNotLessFunctionCheckTest.java

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

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

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

its/ruling/projects/custom/less/experimentalFunctionUsageExcludeFunctions.less

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

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

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

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

@@ -50,6 +50,11 @@
 14,
 18,
 ],
+'project:custom/less/experimentalFunctionUsageExcludeFunctions.less':[
+2,
+3,
+4,
+],
 'project:custom/less/obsoleteFunctions.less':[
 2,
 3,

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

@@ -262,6 +262,11 @@
 19,
 19,
 ],
+'project:custom/less/experimentalFunctionUsageExcludeFunctions.less':[
+2,
+2,
+2,
+],
 'project:custom/less/obsoleteFunctions.less':[
 3,
 ],

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

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

its/ruling/tests/src/test/expected/less-prefer-single-line-comments.json

@@ -2123,6 +2123,10 @@
 14,
 18,
 ],
+'project:custom/less/experimentalFunctionUsageExcludeFunctions.less':[
+3,
+4,
+],
 'project:custom/less/lessEscapingFunction.less':[
 3,
 4,