Add trait to identify java package references in xml #4587
Conversation
|
|
||
| public static class Matcher extends SimpleTraitMatcher<ContainsPackageReference> { | ||
| private final Pattern PACKAGE_OR_TYPE_REFERENCE = Pattern.compile("^([a-zA-Z_][a-zA-Z0-9_]*)(\\.[a-zA-Z_][a-zA-Z0-9_]*)*(\\.[A-Z][a-zA-Z0-9_]*|\\$[A-Z][a-zA-Z0-9_]*)*(\\.\\*)?$"); | ||
| private final List<String> ATTRIBUTES_THAT_REFERENCE_PACKAGE_OR_TYPE = Arrays.asList("class", "type"); |
There was a problem hiding this comment.
Obviously these aren't all attributes and elements that could contain a package reference, these lists need to be carefully expanded
There was a problem hiding this comment.
I think regular expressions are an unsafe way to go about it, but I'm not exactly sure what a better approach would be. XPath would be a little more predictable, but also feel out of place here to have Spring/Micronaut/Quarkus/EE expressions all in here to be picked up when changing types.
Perhaps @knutwannheden has some suggestions on using service discovery where frameworks specific recipe modules can provide a mechanism to provide additional paths to check and convert.
There was a problem hiding this comment.
I think it would probably be best if we could register some kind of "extensions" with parsers like those for XML, YAML, Properties, etc. So we could then already while ingesting the source file attach some kind of JavaTypeReference marker to the LST elements. Then the ChangeType recipe could check if the SourceFile if it has some kind of HasJavaTypeReferences marker or possibly it even uses the TypesInUse we use for JavaSourceFile.
An additional complication may be that these "parser extensions" might have to be registered dynamically (e.g. depending on whether the project is a Spring project or not).
This could quickly end up being quite a bit of work. But I get the impression that this would long-term be the better and more sustainable solution. Maybe we can still do something like this, but start out small?
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
rewrite-xml/src/main/java/org/openrewrite/xml/internal/JavaTypeReferences.java
Show resolved
Hide resolved
…eReferences.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
This should be moved to rewrite-spring
rewrite-xml/src/main/java/org/openrewrite/xml/trait/JavaTypeReference.java
Show resolved
Hide resolved
|
|
||
| public static JavaTypeReferences build(Xml.Document doc) { | ||
| Set<JavaTypeReference> typeReferences = new HashSet<>(); | ||
| new SpringJavaTypeReference.Matcher().asVisitor(reference -> { |
There was a problem hiding this comment.
Need to figure out a way to dynamically pass a trait to use here
Anyone you would like to review specifically?
@timtebeek
Checklist