Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate classpath entries for FQN references #19

Merged
merged 7 commits into from
Aug 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 4 additions & 29 deletions src/main/java/org/openrewrite/java/template/TemplateProcessor.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import com.sun.tools.javac.tree.JCTree.JCCompilationUnit;
import com.sun.tools.javac.tree.TreeScanner;
import com.sun.tools.javac.util.Context;
import org.openrewrite.java.template.internal.ClasspathJarNameDetector;
import org.openrewrite.java.template.internal.ImportDetector;
import org.openrewrite.java.template.internal.JavacResolution;
import org.openrewrite.java.template.internal.Permit;
Expand All @@ -47,11 +48,8 @@
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.net.URI;
import java.util.*;
import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Matcher;
import java.util.regex.Pattern;

import static java.util.Collections.*;

Expand Down Expand Up @@ -247,8 +245,6 @@ public void visitIdent(JCTree.JCIdent ident) {
out.write("package " + classDecl.sym.packge().toString() + ";\n");
out.write("import org.openrewrite.java.*;\n");

boolean hasParserClasspath = false;
StringJoiner parserClasspath = new StringJoiner(", ");

for (JCTree.JCVariableDecl parameter : parameters) {
if (parameter.type.tsym instanceof Symbol.ClassSymbol) {
Expand All @@ -266,31 +262,10 @@ public void visitIdent(JCTree.JCIdent ident) {
out.write(" .builder(\"" + templateSource + "\")");

List<Symbol> imports = ImportDetector.imports(resolved.get(template));
for (Symbol anImport : imports) {
Symbol.ClassSymbol enclClass = anImport instanceof Symbol.ClassSymbol ? (Symbol.ClassSymbol) anImport : anImport.enclClass();
while (enclClass.enclClass() != null && enclClass.enclClass() != enclClass) {
enclClass = enclClass.enclClass();
}
JavaFileObject classfile = enclClass.classfile;
if (classfile == null) {
// TODO this shouldn't really happen, but it does. Need to investigate why.
continue;
}
URI uri = classfile.toUri();
if (uri.toString().contains(".jar!/")) {
Matcher matcher = Pattern.compile("([^/]*)?\\.jar!/").matcher(uri.toString());
if (matcher.find()) {
hasParserClasspath = true;
String jarName = matcher.group(1);
jarName = jarName.replaceAll("-\\d.*$", "");
parserClasspath.add("\"" + jarName + "\"");
}
}
}

if (hasParserClasspath) {
String classpath = ClasspathJarNameDetector.classpathFor(resolved.get(template), imports);
if (!classpath.isEmpty()) {
out.write("\n .javaParser(JavaParser.fromJavaVersion().classpath(" +
parserClasspath + "))");
classpath + "))");
}

for (Symbol anImport : imports) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
/*
* Copyright 2022 the original author or authors.
* <p>
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* <p>
* https://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.openrewrite.java.template.internal;

import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.tree.JCTree;
import com.sun.tools.javac.tree.JCTree.JCFieldAccess;
import com.sun.tools.javac.tree.TreeScanner;

import javax.tools.JavaFileObject;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

public class ClasspathJarNameDetector {

/**
* Locate types that are directly referred to by name in the
* given tree and therefore need an import in the template.
*
* @return The list of imports to add.
*/
public static String classpathFor(JCTree input, List<Symbol> imports) {
Set<String> jarNames = new LinkedHashSet<>();

for (Symbol anImport : imports) {
jarNames.add(jarNameFor(anImport));
}

// Detect fully qualified classes
new TreeScanner() {
@Override
public void scan(JCTree tree) {
if (tree instanceof JCFieldAccess &&
((JCFieldAccess) tree).sym instanceof Symbol.ClassSymbol &&
Character.isUpperCase(((JCFieldAccess) tree).getIdentifier().toString().charAt(0))) {
jarNames.add(jarNameFor(((JCFieldAccess) tree).sym));
}
super.scan(tree);
}
}.scan(input);

return jarNames.stream()
.filter(Objects::nonNull)
.map(jarName -> '"' + jarName + '"')
.sorted()
.collect(Collectors.joining(", "));
}


private static String jarNameFor(Symbol anImport) {
Symbol.ClassSymbol enclClass = anImport instanceof Symbol.ClassSymbol ? (Symbol.ClassSymbol) anImport : anImport.enclClass();
while (enclClass.enclClass() != null && enclClass.enclClass() != enclClass) {
enclClass = enclClass.enclClass();
}
JavaFileObject classfile = enclClass.classfile;
if (classfile != null) {
String uriStr = classfile.toUri().toString();
Matcher matcher = Pattern.compile("([^/]*)?\\.jar!/").matcher(uriStr);
if (matcher.find()) {
String jarName = matcher.group(1);
return jarName.replaceAll("-\\d.*$", "");
}
}
return null;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
import com.google.testing.compile.Compilation;
import com.google.testing.compile.JavaFileObjects;
import org.jetbrains.annotations.NotNull;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

import java.io.File;
import java.net.URL;
Expand All @@ -32,8 +33,12 @@

class TemplateProcessorTest {

@Test
void generateRecipeTemplates() {
@ParameterizedTest
@ValueSource(strings = {
"Unqualified",
"FullyQualified",
})
void generateRecipeTemplates(String qualifier) {
// As per https://github.com/google/compile-testing/blob/v0.21.0/src/main/java/com/google/testing/compile/package-info.java#L53-L55
Compilation compilation = javac()
.withProcessors(new RefasterTemplateProcessor(), new TemplateProcessor())
Expand All @@ -42,11 +47,11 @@ void generateRecipeTemplates() {
assertThat(compilation).succeeded();
compilation.generatedSourceFiles().forEach(System.out::println);
assertThat(compilation)
.generatedSourceFile("foo/ShouldAddClasspathRecipe$1_before")
.hasSourceEquivalentTo(JavaFileObjects.forResource("recipes/ShouldAddClasspathRecipe$1_before.java"));
.generatedSourceFile("foo/ShouldAddClasspathRecipes$" + qualifier + "Recipe$1_before")
.hasSourceEquivalentTo(JavaFileObjects.forResource("recipes/ShouldAddClasspathRecipe$" + qualifier + "Recipe$1_before.java"));
assertThat(compilation)
.generatedSourceFile("foo/ShouldAddClasspathRecipe$1_after")
.hasSourceEquivalentTo(JavaFileObjects.forResource("recipes/ShouldAddClasspathRecipe$1_after.java"));
.generatedSourceFile("foo/ShouldAddClasspathRecipes$" + qualifier + "Recipe$1_after")
.hasSourceEquivalentTo(JavaFileObjects.forResource("recipes/ShouldAddClasspathRecipe$" + qualifier + "Recipe$1_after.java"));
}

@NotNull
Expand Down
28 changes: 21 additions & 7 deletions src/test/resources/recipes/ShouldAddClasspath.java
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,28 @@

public class ShouldAddClasspath {

@BeforeTemplate
void before(String message) {
System.out.println(message);
class Unqualified {
@BeforeTemplate
void before(String message) {
System.out.println(message);
}

@AfterTemplate
void after(String message) {
LoggerFactory.getLogger(message);
}
}

@AfterTemplate
void after(String message) {
LoggerFactory.getLogger("ROOT").info(message);
class FullyQualified {
@BeforeTemplate
void before(String message) {
System.out.println(message);
}

@AfterTemplate
void after(String message) {
org.slf4j.LoggerFactory.getLogger(message);
}
}

}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package foo;
import org.openrewrite.java.*;

public class ShouldAddClasspathRecipes$FullyQualifiedRecipe$1_after {
public static JavaTemplate.Builder getTemplate(JavaVisitor<?> visitor) {
return JavaTemplate
.builder("org.slf4j.LoggerFactory.getLogger(#{any(java.lang.String)})")
.javaParser(JavaParser.fromJavaVersion().classpath("slf4j-api"));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package foo;
import org.openrewrite.java.*;

public class ShouldAddClasspathRecipes$FullyQualifiedRecipe$1_before {
public static JavaTemplate.Builder getTemplate(JavaVisitor<?> visitor) {
return JavaTemplate
.builder("System.out.println(#{any(java.lang.String)})");
}
}
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
package foo;
import org.openrewrite.java.*;

public class ShouldAddClasspathRecipe$1_after {
public class ShouldAddClasspathRecipes$UnqualifiedRecipe$1_after {
public static JavaTemplate.Builder getTemplate(JavaVisitor<?> visitor) {
return JavaTemplate
.builder("LoggerFactory.getLogger(\"ROOT\").inf#{any(java.lang.String)}ge)")
.builder("LoggerFactory.getLogger(#{any(java.lang.String)})")
.javaParser(JavaParser.fromJavaVersion().classpath("slf4j-api"))
.imports("org.slf4j.LoggerFactory");
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
package foo;
import org.openrewrite.java.*;

public class ShouldAddClasspathRecipe$1_before {
public class ShouldAddClasspathRecipes$UnqualifiedRecipe$1_before {
public static JavaTemplate.Builder getTemplate(JavaVisitor<?> visitor) {
return JavaTemplate
.builder("System.out.println(#{any(java.lang.String)})");
Expand Down