com.github.ferstl.maven.pomenforcers.PedanticPomSectionOrderEnforcer Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pedantic-pom-enforcers Show documentation

The Pedantic POM Enforcers consist of serveral Maven enforcer rules that help you keep your project setup consistent and organized.

There is a newer version: 2.2.0

Show newest version

/*
 * Copyright (c) 2012 - 2015 by Stefan Ferstl 
 *
 * 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 com.github.ferstl.maven.pomenforcers;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.github.ferstl.maven.pomenforcers.model.PomSection;
import com.github.ferstl.maven.pomenforcers.util.CommaSeparatorUtils;
import com.google.common.collect.Ordering;
import com.google.common.collect.Sets;

import static com.github.ferstl.maven.pomenforcers.model.PomSection.pomSectionToString;
import static com.github.ferstl.maven.pomenforcers.model.PomSection.stringToPomSection;



/**
 * This enforcer makes sure that the sections in your POM files are in a defined order.
 *  * ### Example
 *     <rules>
 *       <pomSectionOrder implementation="com.github.ferstl.maven.pomenforcers.PedanticPomSectionOrderEnforcer">
 *         <!-- Use project coordinates before parent declaration -->
 *         <sectionPriorities>groupId,artifactId,version,packaging</sectionPriorities>
 *       </pomSectionOrder>
 *     </rules>
 * 
 * @id {@link PedanticEnforcerRule#POM_SECTION_ORDER}
 * @since 1.0.0
 */
public class PedanticPomSectionOrderEnforcer extends AbstractPedanticEnforcer {

  private final Set sectionPriorities;

  public PedanticPomSectionOrderEnforcer() {
    this.sectionPriorities = Sets.newLinkedHashSet();
  }

  /**
   * Comma separated list of section priorities.
   *
   * @param sectionPriorities Comma separated list of section priorities.
   * @configParam
   * @default modelVersion,prerequisites,parent,groupId,artifactId,version
   *          ,packaging,name,description,url,licenses,organization
   *          ,inceptionYear,ciManagement,mailingLists,issueManagement,
   *          developers ,contributors,scm,repositories,pluginRepositories
   *          ,distributionManagement ,modules,properties,dependencyManagement
   *          ,dependencies,build,profiles,reporting,reports
   * @since 1.0.0
   */
  public void setSectionPriorities(String sectionPriorities) {
    CommaSeparatorUtils.splitAndAddToCollection(sectionPriorities, this.sectionPriorities, stringToPomSection());
  }

  @Override
  protected PedanticEnforcerRule getDescription() {
    return PedanticEnforcerRule.POM_SECTION_ORDER;
  }

  @Override
  protected void accept(PedanticEnforcerVisitor visitor) {
    visitor.visit(this);
  }

  @Override
  protected void doEnforce(ErrorReport report) {
    Node docElement = getPom().getDocumentElement();
    NodeList sectionNodes = docElement.getChildNodes();
    ArrayList pomSections = new ArrayList<>();
    for (int i = 0; i < sectionNodes.getLength(); i++) {
      Node node = sectionNodes.item(i);
      if (node.getNodeType() == Node.ELEMENT_NODE) {
        pomSections.add(PomSection.getBySectionName(node.getNodeName()));
      }
    }

    // The default ordering is the order of the PomSection enum.
    Ordering ordering = PomSection.createPriorityOrdering(this.sectionPriorities);

    if (!ordering.isOrdered(pomSections)) {
      List sortedPomSections = ordering.immutableSortedCopy(pomSections);

      report.addLine("Your POM has to be organized this way:")
            .emptyLine()
            .addDiff(pomSections, sortedPomSections, "Actual Order", "Required Order", pomSectionToString());
    }
  }

}