com.github.ferstl.depgraph.AbstractDependencyGraphMojo Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of depgraph-maven-plugin Show documentation
This Maven plugin generates dependency graphs on single modules or in an aggregated form on multi-module projects. The graphs are represented by .dot files. In case that Graphviz is installed on the machine where this plugin is run, the .dot file can be directly converted into all supported image files.
There is a newer version: 4.0.3
Show newest version
package com.github.ferstl.depgraph;

import java.util.List;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.resolver.filter.AndArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.shared.artifact.filter.ScopeArtifactFilter;
import org.apache.maven.shared.artifact.filter.StrictPatternExcludesArtifactFilter;
import org.apache.maven.shared.artifact.filter.StrictPatternIncludesArtifactFilter;
import com.github.ferstl.depgraph.dependency.GraphFactory;
import com.github.ferstl.depgraph.dependency.GraphStyleConfigurer;
import static org.apache.maven.artifact.Artifact.SCOPE_COMPILE;
import static org.apache.maven.artifact.Artifact.SCOPE_PROVIDED;
import static org.apache.maven.artifact.Artifact.SCOPE_RUNTIME;
import static org.apache.maven.artifact.Artifact.SCOPE_SYSTEM;
import static org.apache.maven.artifact.Artifact.SCOPE_TEST;

/**
 * Abstract mojo that is intended to create dependency graphs. It adds dependency-related filtering
 * capabilities to the base implementation.
 */
abstract class AbstractDependencyGraphMojo extends AbstractGraphMojo {

  /**
   * The scope of the artifacts that should be included in the graph. An empty string indicates all scopes (default).
   * The scopes being interpreted are the scopes as Maven sees them, not as specified in the pom. In summary:
   * 
   * {@code compile}: Shows compile, provided and system dependencies
   * {@code provided}: Shows provided dependencies
   * {@code runtime}: Shows compile and runtime dependencies
   * {@code system}: Shows system dependencies
   * {@code test} (default): Shows all dependencies
   * 
   *
   * @since 1.0.0
   * @deprecated Use {@link #classpathScope} instead.
   */
  @Deprecated
  @Parameter(property = "scope")
  private String scope;

  /**
   * The scope of the artifacts that should be included in the graph. An empty string indicates all scopes (default).
   * The scopes being interpreted are the scopes as Maven sees them, not as specified in the pom. In summary:
   * 
   * {@code compile}: Equivalent to `-Dscopes=compile,provided,system`
   * {@code provided}: Equivalent to `-Dscopes=provided`
   * {@code runtime}: Equivalent to `-Dscopes=compile,runtime`
   * {@code system}: Equivalent to `-Dscopes=system`
   * {@code test} (default): Shows all dependencies
   * 
   * This parameter replaces the former {@code scope} parameter which was introduced in version 1.0.0.
   *
   * @since 4.0.0
   */
  @Parameter(property = "classpathScope")
  private String classpathScope;

  /**
   * List of dependency scopes to be included in the graph. If empty, all scopes are included.
   *
   * @since 4.0.0
   */
  @Parameter(property = "scopes")
  private List scopes;

  /**
   * List of artifacts to be included in the form of {@code groupId:artifactId:type:classifier}.
   *
   * @since 1.0.0
   */
  @Parameter(property = "includes")
  private List includes;

  /**
   * List of artifacts to be excluded in the form of {@code groupId:artifactId:type:classifier}.
   *
   * @since 1.0.0
   */
  @Parameter(property = "excludes")
  private List excludes;

  /**
   * List of artifacts in the form of {@code groupId:artifactId:type:classifier} to be included if they are
   * transitive.
   *
   * @since 3.0.0
   */
  @Parameter(property = "transitiveIncludes")
  private List transitiveIncludes;

  /**
   * List of artifacts in the form of {@code groupId:artifactId:type:classifier} to be excluded if they are
   * transitive.
   *
   * @since 3.0.0
   */
  @Parameter(property = "transitiveExcludes")
  private List transitiveExcludes;

  /**
   * List of artifacts, in the form of {@code groupId:artifactId:type:classifier}, to restrict the dependency graph
   * only to artifacts that depend on them.
   *
   * @since 1.0.4
   */
  @Parameter(property = "targetIncludes")
  private List targetIncludes;

  /**
   * Indicates whether optional dependencies should be excluded from the graph.
   *
   * @since 3.2.0
   */
  @Parameter(property = "excludeOptionalDependencies", defaultValue = "false")
  private boolean excludeOptionalDependencies;

  @Override
  protected final GraphFactory createGraphFactory(GraphStyleConfigurer graphStyleConfigurer) {
    ArtifactFilter globalFilter = createGlobalArtifactFilter();
    ArtifactFilter transitiveIncludeExcludeFilter = createTransitiveIncludeExcludeFilter();
    ArtifactFilter targetFilter = createTargetArtifactFilter();

    return createGraphFactory(globalFilter, transitiveIncludeExcludeFilter, targetFilter, graphStyleConfigurer);
  }

  protected abstract GraphFactory createGraphFactory(ArtifactFilter globalFilter, ArtifactFilter transitiveIncludeExcludeFilter, ArtifactFilter targetFilter, GraphStyleConfigurer graphStyleConfigurer);

  private ArtifactFilter createGlobalArtifactFilter() {
    AndArtifactFilter filter = new AndArtifactFilter();

    if (this.scope != null) {
      getLog().warn("The 'scope' parameter is deprecated and will be removed in future versions. Use 'classpathScope' instead.");
      // Prefer the new parameter if it is set
      if (this.classpathScope == null) {
        this.classpathScope = this.scope;
      }
    }

    if (this.classpathScope != null) {
      if (this.scopes.isEmpty()) {
        filter.add(new ScopeArtifactFilter(this.classpathScope));
      } else {
        getLog().warn("Both 'classpathScope' (formerly 'scope') and 'scopes' parameters are set. The 'classpathScope' parameter will be ignored.");
      }
    }

    if (!this.scopes.isEmpty()) {
      filter.add(createScopesArtifactFilter(this.scopes));
    }

    if (!this.includes.isEmpty()) {
      filter.add(new StrictPatternIncludesArtifactFilter(this.includes));
    }

    if (!this.excludes.isEmpty()) {
      filter.add(new StrictPatternExcludesArtifactFilter(this.excludes));
    }

    if (this.excludeOptionalDependencies) {
      filter.add(new OptionalArtifactFilter());
    }

    return filter;
  }

  private ArtifactFilter createTransitiveIncludeExcludeFilter() {
    AndArtifactFilter filter = new AndArtifactFilter();

    if (!this.transitiveIncludes.isEmpty()) {
      filter.add(new StrictPatternIncludesArtifactFilter(this.transitiveIncludes));
    }

    if (!this.transitiveExcludes.isEmpty()) {
      filter.add(new StrictPatternExcludesArtifactFilter(this.transitiveExcludes));
    }

    return filter;
  }

  private ArtifactFilter createTargetArtifactFilter() {
    AndArtifactFilter filter = new AndArtifactFilter();

    if (!this.targetIncludes.isEmpty()) {
      filter.add(new StrictPatternIncludesArtifactFilter(this.targetIncludes));
    }

    return filter;
  }

  private ArtifactFilter createScopesArtifactFilter(List scopes) {
    ScopeArtifactFilter filter = new ScopeArtifactFilter();
    for (String scope : scopes) {
      if (SCOPE_COMPILE.equals(scope)) {
        filter.setIncludeCompileScope(true);
      } else if (SCOPE_RUNTIME.equals(scope)) {
        filter.setIncludeRuntimeScope(true);
      } else if (SCOPE_TEST.equals(scope)) {
        filter.setIncludeTestScope(true);
      } else if (SCOPE_PROVIDED.equals(scope)) {
        filter.setIncludeProvidedScope(true);
      } else if (SCOPE_SYSTEM.equals(scope)) {
        filter.setIncludeSystemScope(true);
      } else {
        getLog().warn("Unknown scope: " + scope);
      }
    }

    return filter;
  }

  private static class OptionalArtifactFilter implements ArtifactFilter {

    @Override
    public boolean include(Artifact artifact) {
      return !artifact.isOptional();
    }
  }
}