org.sonar.css.checks.RuleDescriptionsGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of css-checks Show documentation
There is a newer version: 4.13
/*
 * SonarQube CSS / SCSS / Less Analyzer
 * Copyright (C) 2013-2017 David RACODON
 * mailto: [email protected]
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.css.checks;

import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang.StringEscapeUtils;
import org.sonar.css.checks.common.CaseCheck;
import org.sonar.css.checks.common.UnknownTypeSelectorCheck;
import org.sonar.css.model.StandardCssObject;
import org.sonar.css.model.StandardCssObjectFactory;
import org.sonar.css.model.Vendor;
import org.sonar.css.model.atrule.StandardAtRule;
import org.sonar.css.model.function.StandardFunction;
import org.sonar.css.model.function.StandardFunctionFactory;
import org.sonar.css.model.property.StandardProperty;
import org.sonar.css.model.property.StandardPropertyFactory;
import org.sonar.css.model.pseudo.StandardPseudoComponent;

import java.io.*;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

public class RuleDescriptionsGenerator {

  private static final String UTF_8 = "UTF-8";

  private static final Map CSS_OBJECT_LINKS = Maps.newLinkedHashMap();

  static {
    CSS_OBJECT_LINKS.put("#", "https://developer.mozilla.org/en-US/docs/Web/CSS/Value_definition_syntax#Hash_mark_()");
    CSS_OBJECT_LINKS.put("\\|\\|", "https://developer.mozilla.org/en-US/docs/Web/CSS/Value_definition_syntax#Double_bar");
    CSS_OBJECT_LINKS.put("(?", "http://dev.w3.org/csswg/css-values-3/#angle-value");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-shapes/#typedef-basic-shape");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-backgrounds-3/#border-style");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-backgrounds-3/#border-width");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-backgrounds-3/#box");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-color/#typedef-color");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-counter-styles-3/#typedef-counter-style");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-speech/#cue-after");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-speech/#cue-before");
    CSS_OBJECT_LINKS.put("", "https://www.w3.org/TR/CSS22/fonts.html#value-def-family-name");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/fxtf/filters/#typedef-filter-function");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-flexbox-1/#propdef-flex-direction");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-flexbox-1/#propdef-flex-wrap");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#frequency-value");
    CSS_OBJECT_LINKS.put("", "https://wiki.csswg.org/ideas/functional-notation");
    CSS_OBJECT_LINKS.put("", "https://www.w3.org/TR/CSS22/fonts.html#value-def-generic-family");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-ui/#typedef-id");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#identifier-value");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-images-3/#typedef-image");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#integer-value");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#length-value");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-linebox/#line-stacking-ruby");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-linebox/#line-stacking-shift");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-linebox/#line-stacking-strategy");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-lists-3/#propdef-list-style-position");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-lists-3/#propdef-list-style-image");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-lists-3/#propdef-list-style-type");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/CSS2/box.html#value-def-margin-width");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#number-value");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/CSS2/ui.html#propdef-outline-color");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/CSS2/ui.html#propdef-outline-style");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/CSS2/ui.html#propdef-outline-width");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/CSS2/box.html#value-def-padding-width");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-speech-1/#pause-after");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-speech-1/#pause-before");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#percentage-value");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#resolution-value");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#url-value");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-animations/#single-animation-name");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-animations/#single-animation-direction");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-animations/#single-animation-fill-mode");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-animations/#single-animation-iteration-count");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/css3-animations/#single-animation-play-state");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-shapes/#typedef-shape-box");
    CSS_OBJECT_LINKS.put("", "http://www.w3.org/TR/2012/WD-css3-transitions-20120403/#transition-timing-function");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#string-value");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-ui/#typedef-target-name");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css-values-3/#time-value");
    CSS_OBJECT_LINKS.put("", "https://drafts.csswg.org/css-transforms/#typedef-transform-function");
    CSS_OBJECT_LINKS.put("", "http://dev.w3.org/csswg/css2/visudet.html#propdef-width");
  }

  private final Map tags = ImmutableMap.builder()
    .put("[[allProperties]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardProperty.class, o -> true)))
    .put("[[allCssFunctions]]", generateHtmlCssFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(StandardFunction::isCss).sorted((o1, o2) -> o1.getName().compareTo(o2.getName())).collect(Collectors.toList())))
    .put("[[allLessFunctions]]", generateHtmlLessFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(StandardFunction::isLess).sorted((o1, o2) -> o1.getName().compareTo(o2.getName())).collect(Collectors.toList())))
    .put("[[allAtRules]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardAtRule.class, o -> true)))
    .put("[[allHtmlElements]]", generateHtmlTableFromListOfStrings(UnknownTypeSelectorCheck.KNOWN_HTML_TAGS.stream().sorted((o1, o2) -> o1.toLowerCase().compareTo(o2.toLowerCase())).collect(Collectors.toList())))
    .put("[[allSvgElements]]", generateHtmlTableFromListOfStrings(UnknownTypeSelectorCheck.KNOWN_SVG_TAGS.stream().sorted((o1, o2) -> o1.toLowerCase().compareTo(o2.toLowerCase())).collect(Collectors.toList())))
    .put("[[allPseudos]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardPseudoComponent.class, o -> true)))
    .put("[[experimentalProperties]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardProperty.class, StandardCssObject::isExperimental)))
    .put("[[experimentalCssFunctions]]", generateHtmlCssFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(f -> f.isCss() && f.isExperimental()).sorted((o1, o2) -> o1.getName().compareTo(o2.getName())).collect(Collectors.toList())))
    .put("[[experimentalNotLessFunctions]]", generateHtmlCssFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(f -> !f.isLess() && f.isExperimental()).sorted((o1, o2) -> o1.getName().compareTo(o2.getName()))
        .collect(Collectors.toList())))
    .put("[[experimentalAtRules]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardAtRule.class, StandardCssObject::isExperimental)))
    .put("[[experimentalPseudos]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardPseudoComponent.class, StandardCssObject::isExperimental)))
    .put("[[functionCaseExceptions]]", generateHtmlTableFromListOfStrings(CaseCheck.FUNCTION_CASE_EXCEPTIONS.stream().sorted((o1, o2) -> o1.toLowerCase().compareTo(o2.toLowerCase())).collect(Collectors.toList())))
    .put("[[obsoleteProperties]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardProperty.class, StandardCssObject::isObsolete)))
    .put("[[obsoleteCssFunctions]]", generateHtmlCssFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(f -> f.isCss() && f.isObsolete()).sorted((o1, o2) -> o1.getName().compareTo(o2.getName())).collect(Collectors.toList())))
    .put("[[obsoleteNotLessFunctions]]", generateHtmlCssFunctionTable(
      StandardFunctionFactory.getAll().stream().filter(f -> !f.isLess() && f.isObsolete()).sorted((o1, o2) -> o1.getName().compareTo(o2.getName())).collect(Collectors.toList())))
    .put("[[obsoleteAtRules]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardAtRule.class, StandardCssObject::isObsolete)))
    .put("[[obsoletePseudos]]", generateHtmlTable(StandardCssObjectFactory.getStandardCssObjects(StandardPseudoComponent.class, StandardCssObject::isObsolete)))
    .put("[[vendors]]", generateListOfVendors())
    .put("[[vendorPrefixedProperties]]", generateVendorPrefixedPropertiesHtmlTable())
    .put("[[propertyValidators]]", generateValidatorsHtmlTable())
    .put("[[shorthandProperties]]", generateShorthandPropertiesHtmlTable())
    .build();

  public void generateHtmlRuleDescription(String templatePath, String outputPath, String language) throws IOException {
    try (OutputStream fileOutputStream = new FileOutputStream(outputPath)) {
      Writer writer = new BufferedWriter(new OutputStreamWriter(fileOutputStream, UTF_8));
      writer.write(processTemplate(FileUtils.readFileToString(new File(templatePath), UTF_8), language));
      writer.flush();
      writer.close();
    } catch (IOException e) {
      throw new IllegalStateException("Could not generate the HTML description.", e);
    }
  }

  private String generateValidatorsHtmlTable() {
    StringBuilder description = new StringBuilder();

    StandardProperty property;
    for (StandardCssObject cssObject : StandardCssObjectFactory.getStandardCssObjects(StandardProperty.class, o -> !o.isObsolete())) {
      property = (StandardProperty) cssObject;
      description.append("  \n").append("    ");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      description.append("").append(property.getName()).append("");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      for (int i = 1; i < property.getLinks().size(); i++) {
        description.append("  #").append(i + 1).append("");
      }
      description.append("\n")
        .append("    ");
      if (property.getValidatorFormat().isEmpty()) {
        description.append("Not yet implemented");
      } else {
        description.append(replaceLinks(property.getValidatorFormat()));
      }
      description.append("\n")
        .append("");
      if (property.isExperimental()) {
        description.append("Experimental");
      } else {
        description.append("Supported");
      }
      description
        .append("\n")
        .append("  \n");
    }
    return description.toString();
  }

  private String generateVendorPrefixedPropertiesHtmlTable() {
    StringBuilder description = new StringBuilder();

    StandardProperty property;
    for (StandardCssObject cssObject : StandardCssObjectFactory.getStandardCssObjects(StandardProperty.class, StandardCssObject::hasVendors)) {
      property = (StandardProperty) cssObject;
      description.append("  \n").append("    ");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      description.append("").append(property.getName()).append("");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      for (int i = 1; i < property.getLinks().size(); i++) {
        description.append("  #").append(i + 1).append("");
      }
      description
        .append("\n")
        .append("\n");
      for (Vendor vendor : property.getVendors().stream().sorted((o1, o2) -> o1.getPrefix().compareTo(o2.getPrefix())).collect(Collectors.toList())) {
        description.append("").append(vendor.getPrefix()).append("").append("  ");
      }
      description
        .append("\n")
        .append("\n");
    }
    return description.toString();
  }

  private String generateShorthandPropertiesHtmlTable() {
    StringBuilder description = new StringBuilder();

    List shorthandProperties = StandardPropertyFactory.getAll()
      .stream()
      .filter(StandardProperty::isShorthand)
      .sorted((o1, o2) -> o1.getName().compareTo(o2.getName()))
      .collect(Collectors.toList());

    for (StandardProperty property : shorthandProperties) {
      description.append("  \n").append("    ");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      description.append("").append(property.getName()).append("");
      if (!property.getLinks().isEmpty()) {
        description.append("");
      }
      for (int i = 1; i < property.getLinks().size(); i++) {
        description.append("  #").append(i + 1).append("");
      }
      description
        .append("\n")
        .append("\n");
      for (String shorthandFor : property.getShorthandForPropertyNames().stream().sorted().collect(Collectors.toList())) {
        description.append("").append(shorthandFor).append("").append("
");
      }
      description
        .append("\n")
        .append("\n");
    }
    return description.toString();
  }

  private String generateListOfVendors() {
    StringBuilder html = new StringBuilder("\n");
    for (Vendor vendor : Vendor.values()) {
      html.append("")
        .append("")
        .append(vendor.getPrefix())
        .append(" ")
        .append(vendor.getDescription())
        .append("\n");
    }
    html.append("\n");
    return html.toString();
  }

  // TODO: refactor generateHtmlCssFunctionTable and generateHtmlLessFunctionTable
  private String generateHtmlCssFunctionTable(List standardFunctions) {
    StringBuilder html = new StringBuilder("\n");
    List> subLists = Lists.partition(standardFunctions, 3);
    for (List subList : subLists) {
      html.append("");
      for (StandardFunction standardCssFunction : subList) {
        List links = standardCssFunction.getLinks().stream().filter(f -> !f.contains("lesscss.org")).collect(Collectors.toList());
        html.append("\n");
      }
      html.append("");
    }
    html.append("");
        if (!links.isEmpty()) {
          html.append("");
        }
        html.append("").append(standardCssFunction.getName()).append("");
        if (!links.isEmpty()) {
          html.append("");
        }
        html.append("");
        for (int i = 1; i < links.size(); i++) {
          html.append("  #").append(i + 1).append("");
        }
        html.append("\n");
    return html.toString();
  }

  private String generateHtmlLessFunctionTable(List standardFunctions) {
    StringBuilder html = new StringBuilder("\n");
    List> subLists = Lists.partition(standardFunctions, 3);
    for (List subList : subLists) {
      html.append("");
      for (StandardFunction standardCssFunction : subList) {
        List links = standardCssFunction.getLinks().stream().filter(f -> f.contains("lesscss.org")).collect(Collectors.toList());
        html.append("\n");
      }
      html.append("");
    }
    html.append("");
        if (!links.isEmpty()) {
          html.append("");
        }
        html.append("").append(standardCssFunction.getName()).append("");
        if (!links.isEmpty()) {
          html.append("");
        }
        html.append("");
        for (int i = 1; i < links.size(); i++) {
          html.append("  #").append(i + 1).append("");
        }
        html.append("\n");
    return html.toString();
  }

  private String generateHtmlTableFromListOfStrings(List elements) {
    StringBuilder html = new StringBuilder("\n");
    List> subLists = Lists.partition(elements, 3);
    for (List subList : subLists) {
      html.append("");
      for (String element : subList) {
        html.append("\n");
      }
      html.append("");
    }
    html.append("");
        html.append("").append(element).append("");
        html.append("\n");
    return html.toString();
  }

  private String generateHtmlTable(List standardCssObjects) {
    StringBuilder html = new StringBuilder("\n");
    List> subLists = Lists.partition(standardCssObjects, 3);
    for (List subList : subLists) {
      html.append("");
      for (StandardCssObject standardCssObject : subList) {
        html.append("\n");
      }
      html.append("");
    }
    html.append("");
        if (!standardCssObject.getLinks().isEmpty()) {
          html.append("");
        }
        html.append("").append(standardCssObject.getName()).append("");
        if (!standardCssObject.getLinks().isEmpty()) {
          html.append("");
        }
        html.append("");
        for (int i = 1; i < standardCssObject.getLinks().size(); i++) {
          html.append("  #").append(i + 1).append("");
        }
        html.append("\n");
    return html.toString();
  }

  private String processTemplate(String rawDescription, String language) {
    String description = rawDescription;
    description = replaceTags(description);
    description = removeOtherLanguagesSpecificDetails(description, language);
    return description;
  }

  private String replaceTags(String rawDescription) {
    String description = rawDescription;
    for (Map.Entry tag : tags.entrySet()) {
      description = description.replace(tag.getKey(), tag.getValue());
    }
    return description;
  }

  private String replaceLinks(String rawValidator) {
    String validator = rawValidator;
    for (Map.Entry link : CSS_OBJECT_LINKS.entrySet()) {
      Matcher m = Pattern.compile(link.getKey()).matcher(validator);
      while (m.find()) {
        validator = m.replaceAll("" + StringEscapeUtils.escapeHtml(m.group(0)) + "");
      }
    }
    return validator;
  }

  private String removeOtherLanguagesSpecificDetails(String rawDescription, String language) {
    String description = rawDescription;
    if ("css".equals(language)) {
      description = description.replaceAll("(?s)\\[begin-scss].*?\\[end-scss]", "");
      description = description.replaceAll("(?s)\\[begin-less].*?\\[end-less]", "");
    } else if ("scss".equals(language)) {
      description = description.replaceAll("(?s)\\[begin-less].*?\\[end-less]", "");
      description = description.replaceAll("\\[begin-scss]", "");
      description = description.replaceAll("\\[end-scss]", "");
    } else if ("less".equals(language)) {
      description = description.replaceAll("(?s)\\[begin-scss].*?\\[end-scss]", "");
      description = description.replaceAll("\\[begin-less]", "");
      description = description.replaceAll("\\[end-less]", "");
    } else {
      throw new IllegalStateException("Cannot remove other languages specific details. Unknown language: " + language);
    }
    return description;
  }

}