test(metamodel): enforce the package design of the metamodel

src/main/java/spoon/reflect/factory/CompilationUnitFactory.java

@@ -16,10 +16,6 @@
  */
 package spoon.reflect.factory;
 
-import java.io.File;
-import java.util.Map;
-import java.util.TreeMap;
-
 import spoon.reflect.cu.CompilationUnit;
 import spoon.reflect.cu.Import;
 import spoon.reflect.reference.CtFieldReference;
@@ -28,6 +24,10 @@
 import spoon.support.compiler.jdt.JDTSnippetCompiler;
 import spoon.support.reflect.cu.ImportImpl;
 
+import java.io.File;
+import java.util.Map;
+import java.util.TreeMap;
+
 /**
  * A factory to create some evaluation utilities on the Spoon metamodel.
  */
@@ -66,7 +66,7 @@ public CompilationUnit create(String filePath) {
 		CompilationUnit cu = cachedCompilationUnits.get(filePath);
 		if (cu == null) {
 			if (filePath.startsWith(JDTSnippetCompiler.SNIPPET_FILENAME_PREFIX)) {
-				cu = factory.Core().createVirtualCompilationUnit();
+				cu = factory.Core().createCompilationUnit();
 				//put the virtual compilation unit of code snippet into cache too, so the JDTCommentBuilder can found it
 				cachedCompilationUnits.put(filePath, cu);
 				return cu;

src/main/java/spoon/reflect/factory/CoreFactory.java

@@ -485,11 +485,6 @@ SourcePosition createSourcePosition(
 	 */
 	CompilationUnit createCompilationUnit();
 
-	/**
-	 * Creates a virtual compilation unit.
-	 */
-	CompilationUnit createVirtualCompilationUnit();
-
 	/**
 	 * Create an access to annotation value
 	 *

src/main/java/spoon/reflect/reference/CtTypeReference.java

@@ -20,6 +20,7 @@
 import spoon.reflect.declaration.CtShadowable;
 import spoon.reflect.declaration.CtType;
 import spoon.reflect.declaration.CtTypeInformation;
+import spoon.support.SpoonClassNotFoundException;
 
 /**
  * This interface defines a reference to a
@@ -49,7 +50,7 @@ public interface CtTypeReference<T> extends CtReference, CtActualTypeContainer,
 	 *
 	 * @return the Java class or null if the class is not found (not in
 	 * classpath)
-	 * @throws spoon.support.reflect.reference.SpoonClassNotFoundException
+	 * @throws SpoonClassNotFoundException
 	 * 		if the class is not in the classpath
 	 */
 	Class<T> getActualClass();

src/main/java/spoon/support/DefaultCoreFactory.java

@@ -141,7 +141,6 @@
 import spoon.support.reflect.code.CtWhileImpl;
 import spoon.support.reflect.cu.CompilationUnitImpl;
 import spoon.support.reflect.cu.SourcePositionImpl;
-import spoon.support.reflect.declaration.CompilationUnitVirtualImpl;
 import spoon.support.reflect.declaration.CtAnnotationImpl;
 import spoon.support.reflect.declaration.CtAnnotationMethodImpl;
 import spoon.support.reflect.declaration.CtAnnotationTypeImpl;
@@ -648,12 +647,6 @@ public CompilationUnit createCompilationUnit() {
 		return cu;
 	}
 
-	public CompilationUnit createVirtualCompilationUnit() {
-		CompilationUnit cu = new CompilationUnitVirtualImpl();
-		cu.setFactory(getMainFactory());
-		return cu;
-	}
-
 	public <T> CtThisAccess<T> createThisAccess() {
 		CtThisAccess<T> e = new CtThisAccessImpl<>();
 		e.setFactory(getMainFactory());

src/main/java/spoon/support/reflect/reference/SpoonClassNotFoundException.java → src/main/java/spoon/support/SpoonClassNotFoundException.java

@@ -14,7 +14,7 @@
  * The fact that you are presently reading this means that you have had
  * knowledge of the CeCILL-C license and that you accept its terms.
  */
-package spoon.support.reflect.reference;
+package spoon.support;
 
 import spoon.SpoonException;
 

src/main/java/spoon/support/compiler/jdt/ContextBuilder.java

@@ -46,7 +46,7 @@
 import spoon.reflect.reference.CtTypeReference;
 import spoon.reflect.visitor.DefaultJavaPrettyPrinter;
 import spoon.reflect.visitor.EarlyTerminatingScanner;
-import spoon.support.reflect.reference.SpoonClassNotFoundException;
+import spoon.support.SpoonClassNotFoundException;
 
 import java.util.ArrayDeque;
 import java.util.ArrayList;

src/main/java/spoon/support/reflect/declaration/CtTypeImpl.java

@@ -46,7 +46,7 @@
 import spoon.reflect.visitor.Query;
 import spoon.reflect.visitor.filter.ReferenceTypeFilter;
 import spoon.support.compiler.SnippetCompilationHelper;
-import spoon.support.reflect.reference.SpoonClassNotFoundException;
+import spoon.support.SpoonClassNotFoundException;
 import spoon.support.util.QualifiedNameBasedSortedSet;
 import spoon.support.util.SignatureBasedSortedSet;
 

src/main/java/spoon/support/reflect/reference/CtTypeReferenceImpl.java

@@ -31,6 +31,7 @@
 import spoon.reflect.reference.CtTypeParameterReference;
 import spoon.reflect.reference.CtTypeReference;
 import spoon.reflect.visitor.CtVisitor;
+import spoon.support.SpoonClassNotFoundException;
 import spoon.support.reflect.declaration.CtElementImpl;
 import spoon.support.util.QualifiedNameBasedSortedSet;
 import spoon.support.util.RtHelper;

src/main/java/spoon/support/util/RtHelper.java

@@ -16,6 +16,15 @@
  */
 package spoon.support.util;
 
+import spoon.reflect.code.CtExpression;
+import spoon.reflect.code.CtInvocation;
+import spoon.reflect.code.CtLiteral;
+import spoon.reflect.declaration.ModifierKind;
+import spoon.reflect.factory.Factory;
+import spoon.reflect.reference.CtExecutableReference;
+import spoon.reflect.reference.CtFieldReference;
+import spoon.reflect.reference.CtTypeReference;
+
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
 import java.lang.reflect.InvocationTargetException;
@@ -27,15 +36,6 @@
 import java.util.List;
 import java.util.Set;
 
-import spoon.reflect.code.CtExpression;
-import spoon.reflect.code.CtInvocation;
-import spoon.reflect.code.CtLiteral;
-import spoon.reflect.declaration.ModifierKind;
-import spoon.reflect.factory.Factory;
-import spoon.reflect.reference.CtExecutableReference;
-import spoon.reflect.reference.CtFieldReference;
-import spoon.reflect.reference.CtTypeReference;
-
 /**
  * This class is a helper for runtime reflection.
  */

src/test/java/spoon/test/api/NoClasspathTest.java

@@ -22,7 +22,7 @@
 import spoon.reflect.reference.CtExecutableReference;
 import spoon.reflect.reference.CtTypeReference;
 import spoon.reflect.visitor.filter.TypeFilter;
-import spoon.support.reflect.reference.SpoonClassNotFoundException;
+import spoon.support.SpoonClassNotFoundException;
 import spoon.support.visitor.SignaturePrinter;
 import spoon.test.api.testclasses.Bar;
 

src/test/java/spoon/test/architecture/SpoonArchitectureEnforcer.java

@@ -1,12 +1,6 @@
 package spoon.test.architecture;
 
-import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.fail;
-
-import java.util.TreeSet;
-
 import org.junit.Test;
-
 import spoon.Launcher;
 import spoon.SpoonAPI;
 import spoon.reflect.code.CtConstructorCall;
@@ -15,6 +9,12 @@
 import spoon.reflect.declaration.ModifierKind;
 import spoon.reflect.visitor.filter.AbstractFilter;
 
+import java.util.TreeSet;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
 public class SpoonArchitectureEnforcer {
 
 	@Test
@@ -57,4 +57,26 @@ public boolean matches(CtConstructorCall element) {
 		}).size());
 	}
 
+	@Test
+	public void metamodelPackageRule() throws Exception {
+		// all implementations of the metamodel classes have a corresponding interface in the appropriate package
+		SpoonAPI implementations = new Launcher();
+		implementations.addInputResource("src/main/java/spoon/support/reflect/declaration");
+		implementations.addInputResource("src/main/java/spoon/support/reflect/code");
+		implementations.addInputResource("src/main/java/spoon/support/reflect/reference");
+		implementations.buildModel();
+
+		SpoonAPI interfaces = new Launcher();
+		interfaces.addInputResource("src/main/java/spoon/reflect/declaration");
+		interfaces.addInputResource("src/main/java/spoon/reflect/code");
+		interfaces.addInputResource("src/main/java/spoon/reflect/reference");
+		interfaces.buildModel();
+
+		for(CtType<?> t : implementations.getModel().getAllTypes()) {
+			String impl = t.getQualifiedName().replace(".support", "").replace("Impl", "");
+			CtType itf = interfaces.getFactory().Type().get(impl);
+			assertTrue(t.isAssignableFrom(itf.getReference()));
+		}
+	}
+
 }

src/test/java/spoon/test/compilation/CompilationTest.java

@@ -21,7 +21,7 @@
 import spoon.reflect.visitor.filter.TypeFilter;
 import spoon.support.compiler.jdt.JDTBasedSpoonCompiler;
 import spoon.support.compiler.jdt.JDTBatchCompiler;
-import spoon.support.reflect.reference.SpoonClassNotFoundException;
+import spoon.support.SpoonClassNotFoundException;
 import spoon.test.compilation.testclasses.Bar;
 import spoon.test.compilation.testclasses.IBar;
 import spoon.testing.utils.ModelUtils;

src/test/java/spoon/test/type/TypeTest.java

@@ -35,7 +35,7 @@
 import spoon.reflect.reference.CtIntersectionTypeReference;
 import spoon.reflect.reference.CtTypeReference;
 import spoon.reflect.visitor.filter.TypeFilter;
-import spoon.support.reflect.reference.SpoonClassNotFoundException;
+import spoon.support.SpoonClassNotFoundException;
 import spoon.test.type.testclasses.Mole;
 import spoon.test.type.testclasses.Pozole;