From e76b410e1327692a39b42bc49466dc21fd1e443c Mon Sep 17 00:00:00 2001
From: Danny van Bruggen <hexagonaal@gmail.com>
Date: Sat, 3 Mar 2018 11:56:38 +0100
Subject: [PATCH] Improve SourceRoot's quality a bit

---
 .../github/javaparser/utils/SourceRoot.java   | 15 ++++++++--
 .../javaparser/utils/SourceRootTest.java      | 28 +++++++++++++++----
 .../utils/{source/root => source.root}/Y.java |  0
 3 files changed, 35 insertions(+), 8 deletions(-)
 rename javaparser-testing/src/test/resources/com/github/javaparser/utils/{source/root => source.root}/Y.java (100%)

diff --git a/javaparser-core/src/main/java/com/github/javaparser/utils/SourceRoot.java b/javaparser-core/src/main/java/com/github/javaparser/utils/SourceRoot.java
index 02a90ffec7..cb73c0828c 100644
--- a/javaparser-core/src/main/java/com/github/javaparser/utils/SourceRoot.java
+++ b/javaparser-core/src/main/java/com/github/javaparser/utils/SourceRoot.java
@@ -33,8 +33,9 @@
 import static java.nio.file.FileVisitResult.SKIP_SUBTREE;
 
 /**
- * A collection of Java source files located in one directory and its subdirectories on the file system. Files can be
- * parsed and written back one by one or all together. <b>Note that</b> the internal cache used is thread-safe.
+ * A collection of Java source files located in one directory and its subdirectories on the file system. The root directory
+ * corresponds to the root of the package structure of the source files within. Files can be parsed and written back one
+ * by one or all together. <b>Note that</b> the internal cache used is thread-safe.
  * <ul>
  * <li>methods called "tryToParse..." will return their result inside a "ParseResult", which supports parse successes and failures.</li>
  * <li>methods called "parse..." will return "CompilationUnit"s. If a file fails to parse, an exception is thrown.</li>
@@ -62,6 +63,10 @@ enum Result {
     private Function<CompilationUnit, String> printer = new PrettyPrinter()::print;
     private static final Pattern JAVA_IDENTIFIER = Pattern.compile("\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*");
 
+    /**
+     * @param root the root directory of a set of source files. It corresponds to the root of the package structure of the
+     * source files within, like "javaparser/javaparser-core/src/main/java"
+     */
     public SourceRoot(Path root) {
         assertNotNull(root);
         if (!Files.isDirectory(root)) {
@@ -71,6 +76,10 @@ public SourceRoot(Path root) {
         Log.info("New source root at \"%s\"", this.root);
     }
 
+    /**
+     * @param root the root directory of a set of source files. It corresponds to the root of the package structure of the
+     * source files within, like "javaparser/javaparser-core/src/main/java"
+     */
     public SourceRoot(Path root, ParserConfiguration parserConfiguration) {
         this(root);
         setParserConfiguration(parserConfiguration);
@@ -160,7 +169,9 @@ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) th
 
     private static boolean isSensibleDirectoryToEnter(Path dir) throws IOException {
         final String dirToEnter = dir.getFileName().toString();
+        // Don't enter directories that cannot be packages.
         final boolean directoryIsAValidJavaIdentifier = JAVA_IDENTIFIER.matcher(dirToEnter).matches();
+        // Don't enter directories that are hidden, assuming that people don't store source files in hidden directories.
         if (Files.isHidden(dir) || !directoryIsAValidJavaIdentifier) {
             Log.trace("Not processing directory \"%s\"", dirToEnter);
             return false;
diff --git a/javaparser-testing/src/test/java/com/github/javaparser/utils/SourceRootTest.java b/javaparser-testing/src/test/java/com/github/javaparser/utils/SourceRootTest.java
index a0bb50e2e9..58270e78bc 100644
--- a/javaparser-testing/src/test/java/com/github/javaparser/utils/SourceRootTest.java
+++ b/javaparser-testing/src/test/java/com/github/javaparser/utils/SourceRootTest.java
@@ -1,10 +1,12 @@
 package com.github.javaparser.utils;
 
+import com.github.javaparser.ParseProblemException;
 import com.github.javaparser.ParseResult;
+import com.github.javaparser.ParserConfiguration;
 import com.github.javaparser.ast.CompilationUnit;
+import org.junit.Before;
 import org.junit.Test;
 
-import java.io.File;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.List;
@@ -13,9 +15,14 @@
 import static org.junit.Assert.assertTrue;
 
 public class SourceRootTest {
-    private final Path root = CodeGenerationUtils.classLoaderRoot(SourceRootTest.class).resolve("com/github/javaparser/utils/");
+    private final Path root = CodeGenerationUtils.mavenModuleRoot(SourceRootTest.class).resolve("src/test/resources/com/github/javaparser/utils/");
     private final SourceRoot sourceRoot = new SourceRoot(root);
 
+    @Before
+    public void before() {
+        sourceRoot.getParserConfiguration().setLanguageLevel(ParserConfiguration.LanguageLevel.BLEEDING_EDGE);
+    }
+
     @Test
     public void parseTestDirectory() throws IOException {
 
@@ -24,15 +31,24 @@ public void parseTestDirectory() throws IOException {
 
         assertEquals(2, units.size());
         assertTrue(units.stream().allMatch(unit -> !unit.getTypes().isEmpty() || unit.getModule().isPresent()));
-        assertTrue(parseResults.stream().anyMatch(cu -> cu.getResult().get().getStorage().get().getPath().toString().contains("source" + File.separator + "root")));
+        assertTrue(parseResults.stream().noneMatch(cu -> cu.getResult().get().getStorage().get().getPath().toString().contains("source.root")));
     }
 
     @Test(expected = IllegalArgumentException.class)
     public void fileAsRootIsNotAllowed() {
-        Path path = CodeGenerationUtils.classLoaderRoot(SourceRootTest.class).resolve("/com/github/javaparser/utils/Bla.java");
+        Path path = CodeGenerationUtils.classLoaderRoot(SourceRootTest.class).resolve("com/github/javaparser/utils/Bla.java");
         new SourceRoot(path);
     }
-    
-    
 
+    @Test
+    public void dotsInRootDirectoryAreAllowed() throws IOException {
+        Path path = CodeGenerationUtils.mavenModuleRoot(SourceRootTest.class).resolve("src/test/resources/com/github/javaparser/utils/source.root");
+        new SourceRoot(path).tryToParse();
+    }
+
+    @Test(expected = ParseProblemException.class)
+    public void dotsInPackageAreNotAllowed() {
+        Path path = CodeGenerationUtils.mavenModuleRoot(SourceRootTest.class).resolve("src/test/resources/com/github/javaparser/utils");
+        new SourceRoot(path).parse("source.root", "Y.java");
+    }
 }
diff --git a/javaparser-testing/src/test/resources/com/github/javaparser/utils/source/root/Y.java b/javaparser-testing/src/test/resources/com/github/javaparser/utils/source.root/Y.java
similarity index 100%
rename from javaparser-testing/src/test/resources/com/github/javaparser/utils/source/root/Y.java
rename to javaparser-testing/src/test/resources/com/github/javaparser/utils/source.root/Y.java