org.sonar.css.checks.common.UnquotedFontFamilyNamesCheck 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.common;

import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.css.checks.Tags;
import org.sonar.css.model.property.StandardProperty;
import org.sonar.css.model.property.standard.FontFamily;
import org.sonar.plugins.css.api.tree.Tree;
import org.sonar.plugins.css.api.tree.css.IdentifierTree;
import org.sonar.plugins.css.api.tree.css.PropertyDeclarationTree;
import org.sonar.plugins.css.api.tree.css.ValueCommaSeparatedListTree;
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.ArrayList;
import java.util.List;

@Rule(
  key = "unquoted-font-family-names",
  name = "Font family names should be quoted",
  priority = Priority.MAJOR,
  tags = {Tags.PITFALL})
@SqaleConstantRemediation("5min")
@ActivatedByDefault
public class UnquotedFontFamilyNamesCheck extends DoubleDispatchVisitorCheck {

  @Override
  public void visitPropertyDeclaration(PropertyDeclarationTree tree) {
    if (tree.property().standardProperty() instanceof FontFamily) {
      getAllIdentifiers(tree.value()).stream()
        .filter(t -> !FontFamily.GENERIC_FAMILY_NAMES.contains(t.text().toLowerCase())
          && !StandardProperty.COMMON_VALUES.contains(t.text().toLowerCase()))
        .forEach(t -> addPreciseIssue(t, "Quote this font family name."));
    }
    super.visitPropertyDeclaration(tree);
  }

  private List getAllIdentifiers(ValueTree valueTree) {
    List identifiers = new ArrayList<>();
    for (Tree tree : valueTree.sanitizedValueElements()) {
      if (tree.is(Tree.Kind.VALUE_COMMA_SEPARATED_LIST)) {
        for (ValueTree element : ((ValueCommaSeparatedListTree) tree).values()) {
          identifiers.addAll(getAllIdentifiersFromCommaSeparatedListElement(element));
        }
      } else if (tree.is(Tree.Kind.IDENTIFIER)) {
        identifiers.add((IdentifierTree) tree);
      }
    }
    return identifiers;
  }

  private List getAllIdentifiersFromCommaSeparatedListElement(ValueTree valueTree) {
    return valueTree.valueElementsOfType(IdentifierTree.class);
  }

}