All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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) 2013 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.apache.maven.project.MavenProject;

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

import static com.github.ferstl.maven.pomenforcers.ErrorReport.toList;


/**
 * This enforcer makes sure that your modules section is sorted
 * alphabetically. Modules that should occur at a specific position in the
 * <modules> section can be ignored.
 *
 * 
 * ### Example
 *     <rules>
 *       <moduleOrder implementation="com.github.ferstl.maven.pomenforcers.PedanticModuleOrderEnforcer">
 *         <!-- These modules may occur at any place in the modules section -->
 *         <ignoredModules>dist-deb,dist-rpm</ignoredModules>
 *        </moduleOrder>
 *     </rules>
 * 
* * @id {@link PedanticEnforcerRule#MODULE_ORDER} */ public class PedanticModuleOrderEnforcer extends AbstractPedanticEnforcer { /** All modules in this set won't be checked for the correct order. */ private final Set ignoredModules; public PedanticModuleOrderEnforcer() { this.ignoredModules = Sets.newLinkedHashSet(); } /** * Comma-separated list of ignored modules. All modules in this list may occur at any place in the * modules section. * @param ignoredModules Comma-separated list of ignored modules. * @configParam */ public void setIgnoredModules(String ignoredModules) { CommaSeparatorUtils.splitAndAddToCollection(ignoredModules, this.ignoredModules); } @Override protected PedanticEnforcerRule getDescription() { return PedanticEnforcerRule.MODULE_ORDER; } @Override protected void accept(PedanticEnforcerVisitor visitor) { visitor.visit(this); } @Override protected void doEnforce(ErrorReport report) { MavenProject project = EnforcerRuleUtils.getMavenProject(getHelper()); // Do nothing if the project is not a parent project if (!isPomProject(project)) { return; } // Remove all modules to be ignored. List declaredModules = new ArrayList<>(getProjectModel().getModules()); declaredModules.removeAll(this.ignoredModules); // Enforce the module order Ordering moduleOrdering = Ordering.natural(); if (!moduleOrdering.isOrdered(declaredModules)) { reportError(report, moduleOrdering.immutableSortedCopy(declaredModules)); } } private boolean isPomProject(MavenProject project) { return "pom".equals(project.getPackaging()); } private ErrorReport reportError(ErrorReport report, List orderedModules) { report.addLine("You have to sort your modules alphabetically:") .addLine(toList(orderedModules)); if (!this.ignoredModules.isEmpty()) { report.emptyLine() .addLine("You may place these modules anywhere in your section:") .addLine(toList(this.ignoredModules)); } return report; } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy