net.kemitix.pdg.maven.DigraphMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pdg-maven-plugin Show documentation
Generates a DOT Digraph of dependencies between packages within a project
The newest version!
/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2018 Paul Campbell
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
 * and associated documentation files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies
 * or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

package net.kemitix.pdg.maven;

import com.google.inject.Guice;
import lombok.Getter;
import lombok.Setter;
import lombok.val;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;

import java.io.File;
import java.util.List;

/**
 * Generates digraph.
 *
 * @author Paul Campbell ([email protected])
 */
@Mojo(name = "digraph", aggregator = true)
public class DigraphMojo extends AbstractMojo {

    @Setter
    @Getter
    @Parameter(defaultValue = "${project}", readonly = true)
    private MavenProject project;

    @Setter
    @Getter
    @Parameter(defaultValue = "${reactorProjects}", readonly = true)
    private List projects;

    @Setter
    @Getter
    @Parameter(defaultValue = "${project.outputDirectory}")
    private File outputDirectory;

    @Getter
    @Parameter(name = "includeTests", defaultValue = "false")
    private boolean includeTests;

    @Setter
    @Getter
    @Parameter(name = "basePackage", required = true)
    private String basePackage;

    @Getter
    @Parameter(name = "debug", defaultValue = "true")
    private boolean debug;

    @Setter
    @Getter
    @Parameter(name = "format", defaultValue = "nested")
    private String format;

    @Setter
    @Parameter(name = "exclude")
    private String exclude;

    @Setter
    @Parameter(name = "include")
    private String include;

    @Override
    public final void execute() {
        val graphFilter = GraphFilter.of(exclude, include, new DefaultNodePathGenerator());
        val digraphModule = new DigraphModule(this, graphFilter);
        Guice.createInjector(digraphModule)
             .getInstance(DigraphService.class)
             .execute(this);
    }
}