io.codemodder.plugins.maven.operator.ProjectModelFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of codemodder-plugin-maven Show documentation
Plugin for providing Maven dependency management functions to codemods.
The newest version!
package io.codemodder.plugins.maven.operator;

import java.io.IOException;
import java.io.InputStream;
import java.net.URISyntaxException;
import java.net.URL;
import java.nio.file.Path;
import java.util.*;
import org.dom4j.DocumentException;

/**
 * Builder Object for creating instances of the ProjectModel class, which represent the input
 * parameters for chain operations.
 */
class ProjectModelFactory {
  private POMDocument pomFile;
  private List parentPomFiles;
  private Dependency dependency;
  private boolean skipIfNewer;
  private boolean useProperties;
  private Set activeProfiles;
  private boolean overrideIfAlreadyExists;
  private QueryType queryType;
  private Path repositoryPath;

  private ProjectModelFactory() {
    parentPomFiles = new ArrayList<>();
    activeProfiles = new HashSet<>();
    queryType = QueryType.NONE;
  }

  /**
   * Fluent Setter
   *
   * @param pomFile POM File
   */
  public ProjectModelFactory withPomFile(POMDocument pomFile) {
    this.pomFile = pomFile;
    return this;
  }

  /**
   * Fluent Setter
   *
   * @param parentPomFiles Parent POM Files
   */
  public ProjectModelFactory withParentPomFiles(Collection parentPomFiles) {
    this.parentPomFiles =
        new ArrayList<>(parentPomFiles.stream().filter(Objects::nonNull).toList());
    return this;
  }

  /**
   * Fluent Setter
   *
   * @param dep dependency
   */
  public ProjectModelFactory withDependency(Dependency dep) {
    this.dependency = dep;
    return this;
  }

  /** Fluent Setter */
  public ProjectModelFactory withSkipIfNewer(boolean skipIfNewer) {
    this.skipIfNewer = skipIfNewer;
    return this;
  }

  /** Fluent Setter */
  public ProjectModelFactory withUseProperties(boolean useProperties) {
    this.useProperties = useProperties;
    return this;
  }

  /** Fluent Setter */
  public ProjectModelFactory withActiveProfiles(String... activeProfiles) {
    this.activeProfiles = new HashSet<>(Arrays.asList(activeProfiles));
    return this;
  }

  /** Fluent Setter */
  public ProjectModelFactory withOverrideIfAlreadyExists(boolean overrideIfAlreadyExists) {
    this.overrideIfAlreadyExists = overrideIfAlreadyExists;
    return this;
  }

  /** Fluent Setter */
  public ProjectModelFactory withSafeQueryType() {
    this.queryType = QueryType.SAFE;
    return this;
  }

  /**
   * Fluent Setter
   *
   * @param repositoryPath Repository Path
   */
  public ProjectModelFactory withRepositoryPath(Path repositoryPath) {
    this.repositoryPath = repositoryPath;
    return this;
  }

  /**
   * Creates a new instance of ProjectModelFactory.
   *
   * @return A new ProjectModelFactory instance.
   */
  private static ProjectModelFactory create() {
    return new ProjectModelFactory();
  }

  /**
   * Load a ProjectModelFactory instance from an InputStream.
   *
   * @param is The InputStream to load from.
   * @return A ProjectModelFactory instance with the specified POMDocument.
   * @throws DocumentException If there is an issue with document parsing.
   * @throws IOException If there is an I/O issue.
   * @throws URISyntaxException If there is an issue with the URI.
   */
  static ProjectModelFactory load(InputStream is)
      throws DocumentException, IOException, URISyntaxException {
    POMDocument pomDocument = POMDocumentFactory.load(is);
    return ProjectModelFactory.create().withPomFile(pomDocument);
  }

  /**
   * Load a ProjectModelFactory instance from a File.
   *
   * @param filePath The File to load from.
   * @return A ProjectModelFactory instance with the specified POMDocument.
   * @throws Exception If there is an issue with loading the POMDocument.
   */
  static ProjectModelFactory load(Path filePath) throws Exception {
    URL fileUrl = filePath.toUri().toURL();
    return load(fileUrl);
  }

  /**
   * Load a ProjectModelFactory instance from a URL.
   *
   * @param url The URL to load from.
   * @return A ProjectModelFactory instance with the specified POMDocument.
   * @throws DocumentException If there is an issue with document parsing.
   * @throws IOException If there is an I/O issue.
   * @throws URISyntaxException If there is an issue with the URI.
   */
  static ProjectModelFactory load(URL url)
      throws DocumentException, IOException, URISyntaxException {
    POMDocument pomFile = POMDocumentFactory.load(url);
    return ProjectModelFactory.create().withPomFile(pomFile);
  }

  /** Mostly Delegates to POMDocumentFactory */
  static ProjectModelFactory loadFor(POMDocument pomFile, Collection parentPomFiles) {
    List parentPomFilesList = new ArrayList<>(parentPomFiles);
    ProjectModelFactory pmf = ProjectModelFactory.create();
    return ProjectModelFactory.create().withPomFile(pomFile).withParentPomFiles(parentPomFilesList);
  }

  /**
   * Build and return a ProjectModel instance based on the configured parameters.
   *
   * @return A ProjectModel instance with the specified configuration.
   */
  public ProjectModel build() {
    return new ProjectModel(
        pomFile,
        parentPomFiles,
        dependency,
        skipIfNewer,
        useProperties,
        activeProfiles,
        overrideIfAlreadyExists,
        queryType,
        repositoryPath,
        null);
  }
}