src/main/java/org/apache/maven/dist/tools/prerequisites/ListPluginsPrerequisitesReport.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.maven.dist.tools.prerequisites;

import java.util.List;
import java.util.Locale;
import java.util.Map;

import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;

/**
 * <p>ListPluginsPrerequisitesReport class.</p>
 *
 * @author Karl Heinz Marbaise
 */
@Mojo(name = "list-plugins-prerequisites", requiresProject = false)
public class ListPluginsPrerequisitesReport extends AbstractMavenReport {
    /**
     * List Plugins Prerequisites Report
     */
    public ListPluginsPrerequisitesReport() {}

    /** {@inheritDoc} */
    @Override
    public String getName(Locale locale) {
        return "Dist Tool> List Plugins Prerequisites";
    }

    /** {@inheritDoc} */
    @Override
    public String getDescription(Locale locale) {
        return "Maven and JDK version prerequisites for plugins";
    }

    /** {@inheritDoc} */
    @Override
    protected void executeReport(Locale locale) throws MavenReportException {
        if (!outputDirectory.exists()) {
            outputDirectory.mkdirs();
        }

        GetPrerequisites prerequisites = new GetPrerequisites();

        Sink sink = getSink();

        sink.head();
        sink.title();
        sink.text("Display Plugins Prerequisites");
        sink.title_();
        sink.head_();
        sink.body();

        sink.table();
        prerequisites.getGroupedPrequisites().entrySet().stream()
                .sorted(Map.Entry.comparingByKey())
                .forEachOrdered(plugin -> {
                    List<PluginPrerequisites> pluginsPrerequisites = plugin.getValue();

                    sink.tableRow();
                    sink.tableHeaderCell();
                    sink.rawText("Maven Version Prerequisite " + plugin.getKey()
                            + " (" + pluginsPrerequisites.size()
                            + " / "
                            + GetPrerequisites.PLUGIN_NAMES.length + ")");
                    sink.tableHeaderCell_();

                    sink.tableHeaderCell();
                    sink.rawText("Maven Version");
                    sink.tableHeaderCell_();

                    sink.tableHeaderCell();
                    sink.rawText("JDK Version");
                    sink.tableHeaderCell_();

                    sink.tableHeaderCell();
                    sink.rawText("Release Date");
                    sink.tableHeaderCell_();

                    sink.tableRow_();

                    for (PluginPrerequisites pluginPrerequisites : pluginsPrerequisites) {
                        sink.tableRow();
                        sink.tableCell();
                        sink.link(prerequisites.getPluginInfoUrl(pluginPrerequisites.getPluginName()));
                        sink.text(pluginPrerequisites.getPluginName());
                        sink.link_();
                        sink.text(" ");
                        sink.text(pluginPrerequisites.getPluginVersion());
                        sink.tableCell_();

                        sink.tableCell();
                        sink.text(pluginPrerequisites.getMavenVersion().toString());
                        sink.tableCell_();

                        sink.tableCell();
                        sink.text(pluginPrerequisites.getJdkVersion());
                        sink.tableCell_();

                        sink.tableCell();
                        sink.text(pluginPrerequisites.getReleaseDate());
                        sink.tableCell_();
                        sink.tableRow_();
                    }
                });

        sink.table_();
        sink.body_();
    }

    /** {@inheritDoc} */
    @Override
    public String getOutputName() {
        return "dist-tool-prerequisites";
    }
}