org.sonar.plugins.web.checks.attributes.RequiredAttributeCheck Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of sonar-web-plugin Show documentation
Show all versions of sonar-web-plugin Show documentation
Enables scanning of HTML, and JSP/JSF files.
/*
* SonarSource :: Web :: Sonar Plugin
* Copyright (c) 2010-2016 SonarSource SA and Matthijs Galesloot
* [email protected]
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.sonar.plugins.web.checks.attributes;
import org.apache.commons.lang.StringUtils;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.plugins.web.checks.AbstractPageCheck;
import org.sonar.plugins.web.node.Node;
import org.sonar.plugins.web.node.TagNode;
import java.util.ArrayList;
import java.util.List;
@Rule(key = "RequiredAttributeCheck")
public class RequiredAttributeCheck extends AbstractPageCheck {
private static final String DEFAULT_ATTRIBUTES = "";
@RuleProperty(
key = "attributes",
description = "Comma-separated list of tag.attributes that are required. E.G. specify img.alt to require an \"alt\" attribute in an \"img\" tag.",
defaultValue = DEFAULT_ATTRIBUTES)
public String attributes = DEFAULT_ATTRIBUTES;
private final List attributesList = new ArrayList<>();
private static final class RequiredAttribute {
private String elementName;
private String attributeName;
}
@Override
public void startDocument(List nodes) {
attributesList.clear();
for (String item : trimSplitCommaSeparatedList(attributes)) {
String[] pair = StringUtils.split(item, ".");
if (pair.length > 1) {
RequiredAttribute a = new RequiredAttribute();
a.elementName = pair[0];
a.attributeName = pair[1];
attributesList.add(a);
}
}
}
@Override
public void startElement(TagNode node) {
for (RequiredAttribute attribute : attributesList) {
String attributeName = attribute.attributeName;
String elementName = attribute.elementName;
if (node.equalsElementName(elementName) && node.getAttribute(attributeName) == null) {
createViolation(node.getStartLinePosition(), "Add the missing \"" + attributeName + "\" to element \"" + elementName + "\".");
}
}
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy