Add a ScopedVariable trait
#604
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
…e.java Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
| import org.openrewrite.trait.Trait; | ||
|
|
||
| @Value | ||
| public class ScopedVariable implements Trait<J.VariableDeclarations.NamedVariable> { |
There was a problem hiding this comment.
Shouldn't we instead create this trait in the rewrite repo?
| protected @Nullable ScopedVariable test(Cursor cursor) { | ||
| if (cursor.getValue() instanceof J.VariableDeclarations.NamedVariable) { | ||
| J.VariableDeclarations.NamedVariable variable = cursor.getValue(); | ||
| return new ScopedVariable(cursor, variable.getDeclaringScope(cursor), variable.getName()); |
There was a problem hiding this comment.
This getDeclaringScope() utility method is probably a good starting point. But to me it looks like it misses cases like try-with-resources and exception handlers, for example. Also note that the flow scoping of instanceof patterns is quite different and probably a bad fit. Maybe worth thinking about at least.
|
|
||
| @Override | ||
| protected @Nullable ScopedVariable test(Cursor cursor) { | ||
| if (cursor.getValue() instanceof J.VariableDeclarations.NamedVariable) { |
There was a problem hiding this comment.
We can likely just use variable.getDeclaringScope(cursor) to obtain the variable's scope; using a trait might be overkill.
A scenario where a trait could be useful, suppose I'm at an identifier and need to determine the declaring scope of the variable that this identifier references.
void foo() {
int x = 5;
if (true) {
print(x) // find the declaring scope of x at this point,
}
}
There was a problem hiding this comment.
Ideally we'd pull the logic from variable.getDeclaringScope(cursor) into this trait.
Any recipe wanting to do something with variable scope or checking whether an identifier is of a variable that is in scope can create an inline visitor based on this trait, visit the top level tree element they're interested in and have a list of ScopedVariables
|
Continued here |
What's changed?
Added a trait to pull together the scope and identifier of
NamedVariables and added testcases to showcase its usageAnyone you would like to review specifically?
@sambsnyd @timtebeek
Checklist