org.jboss.maven.plugins.qstools.fixers.PomElementOrderFixer.java Source code

Introduction

Here is the source code for org.jboss.maven.plugins.qstools.fixers.PomElementOrderFixer.java

Source

/*
 * 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.fixers;

import java.io.FileInputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

import javax.xml.xpath.XPathConstants;

import org.apache.maven.project.MavenProject;
import org.codehaus.plexus.component.annotations.Component;
import org.codehaus.plexus.component.annotations.Requirement;
import org.jboss.maven.plugins.qstools.common.PomOrderUtil;
import org.jboss.maven.plugins.qstools.xml.PositionalXMLReader;
import org.jboss.maven.plugins.qstools.xml.XMLUtil;
import org.w3c.dom.Document;
import org.w3c.dom.Node;

@Component(role = QSFixer.class, hint = "PomElementOrderFixer")
public class PomElementOrderFixer extends AbstractBaseFixerAdapter {

    @Requirement
    private PomOrderUtil pomOrderUtil;

    @Override
    public String getFixerDescription() {
        return "Fix the pom.xml element order";
    }

    @Override
    public void fixProject(MavenProject project, Document doc) throws Exception {
        List<String> pomElementsOrder = getConfigurationProvider().getQuickstartsRules(project.getGroupId())
                .getPomOrder();
        Map<String, Node> elementsFound = pomOrderUtil.getElementsOrder(project, doc, pomElementsOrder);
        List<String> elementsList = new ArrayList<String>(elementsFound.keySet());

        for (String element : elementsList) {
            Node commentNode = null;
            Node elementNode = (Node) getxPath().evaluate("/project/" + element, doc, XPathConstants.NODE);
            // Get comment over the element
            if (elementNode.getPreviousSibling() != null
                    && elementNode.getPreviousSibling().getNodeType() == Node.COMMENT_NODE) {
                commentNode = elementNode.getPreviousSibling();
            }
            for (String anotherElement : elementsList) {
                if (elementsList.indexOf(element) < elementsList.indexOf(anotherElement)) {

                    Node anotherElementNode = (Node) getxPath().evaluate("/project/" + anotherElement, doc,
                            XPathConstants.NODE);
                    XMLUtil.removePreviousWhiteSpace(anotherElementNode);
                    anotherElementNode.getParentNode().insertBefore(elementNode, anotherElementNode);

                    // If the element had a comment, move it too.
                    if (commentNode != null) {
                        XMLUtil.removePreviousWhiteSpace(commentNode);
                        elementNode.getParentNode().insertBefore(commentNode, elementNode);
                    }
                }
            }
        }
        XMLUtil.writeXML(doc, project.getFile());
        doc = PositionalXMLReader.readXML(new FileInputStream(project.getFile()));
        for (String element : elementsList) {
            Node commentNode = null;
            Node elementNode = (Node) getxPath().evaluate("/project/" + element, doc, XPathConstants.NODE);
            if (elementNode.getChildNodes().getLength() > 1) {
                commentNode = null;
                // Get comment over the element
                if (elementNode.getPreviousSibling() != null
                        && elementNode.getPreviousSibling().getPreviousSibling() != null && elementNode
                                .getPreviousSibling().getPreviousSibling().getNodeType() == Node.COMMENT_NODE) {
                    commentNode = elementNode.getPreviousSibling().getPreviousSibling();
                    XMLUtil.removePreviousWhiteSpace(commentNode);
                    elementNode.getParentNode().insertBefore(doc.createTextNode("\n\n    "), commentNode);
                } else {
                    XMLUtil.removePreviousWhiteSpace(elementNode);
                    elementNode.getParentNode().insertBefore(doc.createTextNode("\n\n    "), elementNode);
                }
            }
        }
        XMLUtil.writeXML(doc, project.getFile());
    }

    @Override
    public int order() {
        return 10;
    }

}