Initial refactor (#225)

Remove public accessors to the following classes:
* Command
* Kind
* QueryType
* SupportCommand

Refactor ProjectModelFactory::withQueryType to withSafeQueryType and
always set quertyType to QueryType.SAFE

Author: carlosu7

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/MavenProvider.java

@@ -13,7 +13,6 @@
 import io.codemodder.plugins.maven.operator.POMScanner;
 import io.codemodder.plugins.maven.operator.ProjectModel;
 import io.codemodder.plugins.maven.operator.ProjectModelFactory;
-import io.codemodder.plugins.maven.operator.QueryType;
 import java.io.File;
 import java.io.IOException;
 import java.io.UncheckedIOException;
@@ -336,8 +335,7 @@ private CodeTFChangesetEntry getChanges(
   private Collection<DependencyGAV> getDependenciesFrom(final Path pomFile, final Path projectDir)
       throws DocumentException, IOException, URISyntaxException, XMLStreamException {
     ProjectModelFactory projectModelFactory =
-        POMScanner.legacyScanFrom(pomFile.toFile(), projectDir.toFile())
-            .withQueryType(QueryType.SAFE);
+        POMScanner.legacyScanFrom(pomFile.toFile(), projectDir.toFile()).withSafeQueryType();
 
     try {
       projectModelFactory =

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/Command.java

@@ -5,7 +5,7 @@
 import javax.xml.stream.XMLStreamException;
 
 /** Represents a Command in a Chain of Responsibility Pattern */
-public interface Command {
+interface Command {
   /**
    * Given a context, performs an operation
    *

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/Kind.java

@@ -4,7 +4,7 @@
  * Represents a Kind of Version Pinning in a Maven File, representing the `-source` and `-target`
  * flags as well as the newer `-release` flag of `javac`.
  */
-public enum Kind {
+enum Kind {
   SOURCE,
   TARGET,
   RELEASE

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/ProjectModelFactory.java

@@ -86,13 +86,9 @@ public ProjectModelFactory withOverrideIfAlreadyExists(boolean overrideIfAlready
     return this;
   }
 
-  /**
-   * Fluent Setter
-   *
-   * @param queryType query type
-   */
-  public ProjectModelFactory withQueryType(QueryType queryType) {
-    this.queryType = queryType;
+  /** Fluent Setter */
+  public ProjectModelFactory withSafeQueryType() {
+    this.queryType = QueryType.SAFE;
     return this;
   }
 

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/QueryType.java

@@ -1,6 +1,6 @@
 package io.codemodder.plugins.maven.operator;
 
-public enum QueryType {
+enum QueryType {
   NONE,
   SAFE
 }

plugins/codemodder-plugin-maven/src/main/java/io/codemodder/plugins/maven/operator/SupportCommand.java

@@ -1,4 +1,4 @@
 package io.codemodder.plugins.maven.operator;
 
 /** Tag Interface to the chain to allow it to figure out whether things were modified. */
-public interface SupportCommand {}
+interface SupportCommand {}

plugins/codemodder-plugin-maven/src/test/java/io/codemodder/plugins/maven/operator/POMOperatorDependencyQueryTest.java

@@ -23,26 +23,22 @@ final class POMOperatorDependencyQueryTest {
   @Test
   void testBasicQuery()
       throws DocumentException, IOException, URISyntaxException, XMLStreamException {
-    for (QueryType queryType : QueryType.values()) {
-      if (queryType != QueryType.NONE) {
-        ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
-        context.withQueryType(queryType);
+    ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
+    context.withSafeQueryType();
 
-        Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
+    Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
 
-        LOGGER.debug("Dependencies found: {}", dependencies);
+    LOGGER.debug("Dependencies found: {}", dependencies);
 
-        assertTrue("Dependencies are not empty", dependencies != null && !dependencies.isEmpty());
-      }
-    }
+    assertTrue("Dependencies are not empty", dependencies != null && !dependencies.isEmpty());
   }
 
   @Test
   void testFailedSafeQuery()
       throws DocumentException, IOException, URISyntaxException, XMLStreamException {
     ProjectModelFactory context =
         ProjectModelFactory.load(getClass().getResource("pom-broken.xml"));
-    context.withQueryType(QueryType.SAFE);
+    context.withSafeQueryType();
 
     Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
 
@@ -66,7 +62,7 @@ void testAllQueryTypes()
         }
 
         ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource(pomFile));
-        context.withQueryType(QueryType.SAFE);
+        context.withSafeQueryType();
 
         Collection<Dependency> dependencies =
             POMOperator.queryDependency(context.build(), commandListOverride);
@@ -79,54 +75,46 @@ void testAllQueryTypes()
   @Test
   void testTemporaryDirectory()
       throws IOException, DocumentException, URISyntaxException, XMLStreamException {
-    for (QueryType queryType : QueryType.values()) {
-      if (queryType != QueryType.NONE) {
-        File tempDirectory = new File("/tmp/mvn-repo-" + System.currentTimeMillis() + ".dir");
 
-        LOGGER.info("Using queryType: " + queryType + " at " + tempDirectory);
+    File tempDirectory = new File("/tmp/mvn-repo-" + System.currentTimeMillis() + ".dir");
 
-        assertFalse("Temp Directory does not exist initially", tempDirectory.exists());
-        assertEquals(
-            "There must be no files",
-            tempDirectory.list() != null
-                ? (int) Files.list(tempDirectory.toPath()).filter(Files::isDirectory).count()
-                : 0,
-            0);
+    assertFalse("Temp Directory does not exist initially", tempDirectory.exists());
+    assertEquals(
+        "There must be no files",
+        tempDirectory.list() != null
+            ? (int) Files.list(tempDirectory.toPath()).filter(Files::isDirectory).count()
+            : 0,
+        0);
 
-        ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
-        context.withQueryType(queryType);
-        context.withRepositoryPath(tempDirectory);
+    ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
+    context.withSafeQueryType();
+    context.withRepositoryPath(tempDirectory);
 
-        Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
+    Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
 
-        LOGGER.debug("Dependencies found: " + dependencies);
+    LOGGER.debug("Dependencies found: " + dependencies);
 
-        assertTrue("Dependencies are not empty", dependencies != null && !dependencies.isEmpty());
+    assertTrue("Dependencies are not empty", dependencies != null && !dependencies.isEmpty());
 
-        assertTrue("Temp Directory ends up existing", tempDirectory.exists());
-        assertTrue("Temp Directory is a directory", tempDirectory.isDirectory());
-      }
-    }
+    assertTrue("Temp Directory ends up existing", tempDirectory.exists());
+    assertTrue("Temp Directory is a directory", tempDirectory.isDirectory());
   }
 
   @Test
   void testTemporaryDirectoryAndFullyOffline()
       throws IOException, DocumentException, URISyntaxException, XMLStreamException {
-    for (QueryType queryType : QueryType.values()) {
-      if (queryType != QueryType.NONE && queryType == QueryType.SAFE) {
-        File tempDirectory = Files.createTempDirectory("mvn-repo").toFile();
 
-        ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
-        context.withQueryType(queryType);
-        context.withRepositoryPath(tempDirectory);
+    File tempDirectory = Files.createTempDirectory("mvn-repo").toFile();
 
-        Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
+    ProjectModelFactory context = ProjectModelFactory.load(getClass().getResource("pom-1.xml"));
+    context.withSafeQueryType();
+    context.withRepositoryPath(tempDirectory);
 
-        LOGGER.debug("Dependencies found: " + dependencies);
+    Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
 
-        assertTrue("Dependencies are not empty", !dependencies.isEmpty());
-      }
-    }
+    LOGGER.debug("Dependencies found: " + dependencies);
+
+    assertTrue("Dependencies are not empty", !dependencies.isEmpty());
   }
 
   @Test
@@ -163,7 +151,7 @@ void testOnSyntheticDependency() throws Exception {
             .getBytes());
 
     ProjectModelFactory context = ProjectModelFactory.load(tempPom.toFile());
-    context.withQueryType(QueryType.SAFE);
+    context.withSafeQueryType();
     context.withRepositoryPath(tempDirectory);
 
     Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
@@ -251,7 +239,7 @@ void testOnCompositeSyntheticDependency() throws Exception {
     Files.write(tempPom, pomContent.getBytes());
 
     ProjectModelFactory context = ProjectModelFactory.load(tempPom.toFile());
-    context.withQueryType(QueryType.SAFE);
+    context.withSafeQueryType();
     context.withRepositoryPath(tempDirectory);
 
     Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());
@@ -319,7 +307,7 @@ void testOnCompositeSyntheticDependencyIncompleteButWithParser() throws Exceptio
     Files.write(tempPom, pomContent.getBytes());
 
     ProjectModelFactory context = ProjectModelFactory.load(tempPom.toFile());
-    context.withQueryType(QueryType.SAFE);
+    context.withSafeQueryType();
     context.withRepositoryPath(tempDirectory);
 
     List<Command> commandList = getCommandListFor("QueryByParsing");
@@ -365,7 +353,7 @@ void testOfflineQueryResolution() throws Exception {
     File pomFile = new File(getClass().getResource("nested/child/pom/pom-3-child.xml").getFile());
 
     ProjectModelFactory context = ProjectModelFactory.load(pomFile);
-    context.withQueryType(QueryType.SAFE);
+    context.withSafeQueryType();
     context.withRepositoryPath(tempDirectory);
 
     Collection<Dependency> dependencies = POMOperator.queryDependency(context.build());

plugins/codemodder-plugin-maven/src/test/java/io/codemodder/plugins/maven/operator/POMOperatorMultipomTest.java

@@ -143,7 +143,7 @@ void validateDepsFrom(ProjectModel context) throws Exception {
     File pomFile = resultFiles.entrySet().iterator().next().getValue();
 
     ProjectModelFactory factory = ProjectModelFactory.load(pomFile);
-    factory.withQueryType(QueryType.SAFE);
+    factory.withSafeQueryType();
     ProjectModel projectModel = factory.build();
 
     Collection<Dependency> dependencies = POMOperator.queryDependency(projectModel);

plugins/codemodder-plugin-maven/src/test/java/io/codemodder/plugins/maven/operator/POMOperatorTest.java

@@ -87,8 +87,7 @@ void testWithMultipleDependencies() throws Exception {
     }
 
     Collection<Dependency> resolvedDeps =
-        POMOperator.queryDependency(
-            ProjectModelFactory.load(testPom).withQueryType(QueryType.SAFE).build());
+        POMOperator.queryDependency(ProjectModelFactory.load(testPom).withSafeQueryType().build());
 
     String testPomContents =
         new String(Files.readAllBytes(testPom.toPath()), Charset.defaultCharset());