org.jboss.maven.plugins.qstools.common.UnusedPropertiesUtil Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-qstools-plugin

This a Maven Plugin that helps JBoss Developer quickstarts maintenance. You can use it to verify if your project/quickstart follow the JBoss Developer Guidelines. It will run all JBoss Developer Guideline checkers and generate a report that provides information about any violations that your project/quickstarts has.

There is a newer version: 1.4.1.Final

Show newest version

/*
 * JBoss, Home of Professional Open Source
 * Copyright 2013, Red Hat, Inc. and/or its affiliates, and individual
 * contributors by the @authors tag. See the copyright.txt in the
 * distribution for a full listing of individual contributors.
 *
 * 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.jboss.maven.plugins.qstools.common;

import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.jboss.maven.plugins.qstools.config.Rules;
import org.jboss.maven.plugins.qstools.xml.PositionalXMLReader;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import javax.xml.xpath.XPath;
import javax.xml.xpath.XPathConstants;
import javax.xml.xpath.XPathFactory;
import java.io.FileInputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;

/**
 * @author [email protected] 27/11/2013
 */
@Component(role = UnusedPropertiesUtil.class)
public class UnusedPropertiesUtil {

    protected XPath xPath = XPathFactory.newInstance().newXPath();

    private Set usedProperties = new HashSet();

    public List findUnusedProperties(List reactorProjects, Rules rules) throws Exception {

        List unusedPropertyInfo = new ArrayList();
        Map> declaredProperties = new HashMap>();

        for (MavenProject mavenProject : reactorProjects) {
            Document doc = PositionalXMLReader.readXML(new FileInputStream(mavenProject.getFile()));
            NodeList propertiesNodes = (NodeList) xPath.evaluate("/project/properties/*", doc, XPathConstants.NODESET);
            NodeList allNodes = (NodeList) xPath.evaluate("//*", doc, XPathConstants.NODESET);
            // find all declared properties
            for (int x = 0; x < propertiesNodes.getLength(); x++) {
                Node property = propertiesNodes.item(x);
                String propertyName = property.getNodeName();
                int lineNumber = (Integer) property.getUserData(PositionalXMLReader.BEGIN_LINE_NUMBER_KEY_NAME);
                PomInformation pi = new PomInformation(mavenProject, lineNumber, property.getNodeName());
                if (declaredProperties.get(propertyName) == null) {
                    declaredProperties.put(propertyName, new ArrayList());
                }
                declaredProperties.get(propertyName).add(pi);
            }
            // find all uses for properties expression
            Pattern p = Pattern.compile("\\$\\{\\w+(.\\w+)*(-\\w+)*\\}");
            for (int x = 0; x < allNodes.getLength(); x++) {
                Node node = allNodes.item(x);
                String nodeContent = node.getTextContent();
                if (p.matcher(nodeContent).matches()) {
                    String usedProperty = node.getTextContent().replaceAll("[${}]", "");
                    usedProperties.add(usedProperty);
                }
            }
        }
        // search if all declared properties have been used
        for (String declared : declaredProperties.keySet()) {
            if (!declared.startsWith("project") && // Escape project configuration
                !rules.getIgnoredUnusedProperties().contains(declared) && // Escape ignored properties
                !usedProperties.contains(declared)) {

                unusedPropertyInfo.addAll(declaredProperties.get(declared));
            }
        }
        return unusedPropertyInfo;
    }

    public class PomInformation {

        private MavenProject project;

        private int line;

        private String property;

        public PomInformation(MavenProject project, int line, String property) {

            this.project = project;
            this.line = line;
            this.property = property;
        }

        public MavenProject getProject() {

            return project;
        }

        public int getLine() {

            return line;
        }

        public String getProperty() {

            return property;
        }
    }
}