Skip to content

RemoveEmptyJavaDocParameters: added tests + fixed bugs #198

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.

Sign up for GitHub

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

Merged
joanvr merged 2 commits into from
Oct 19, 2023
Merged

RemoveEmptyJavaDocParameters: added tests + fixed bugs #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e05464d
fixed some bugs and tidy up + added some tests
Oct 19, 2023
627fe38
empty javadoc
Oct 19, 2023
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
81 changes: 40 additions & 41 deletions src/main/java/org/openrewrite/staticanalysis/RemoveEmptyJavaDocParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,52 +78,63 @@ public Javadoc visitDocComment(Javadoc.DocComment javadoc, ExecutionContext ctx)
List<Javadoc> newBody = new ArrayList<>(javadoc.getBody().size());
boolean useNewBody = false;

List<Javadoc> body = javadoc.getBody();
List<Javadoc> body = new ArrayList<>(javadoc.getBody());
// We add a trailing element, to fix elements on the first line without space
// We can use null since this element is never going to be read, and nulls get filtered later on.
body.add(0, null);

for (int i = 0; i < body.size(); i++) {
// JavaDocs require a look ahead, because the current element may be an element that exists on the same line as a parameter.
// I.E. the space that precedes `* @param` will be a `Javadoc.Text` and needs to be removed along with the empty `@param`.
// A `Javadoc` will always precede a parameter even if there is empty space like `*@param`.
Javadoc currentDoc = body.get(i);
boolean skipCurrentDoc = false;
if (i + 1 < body.size()) {
Javadoc nextDoc = body.get(i + 1);
if (nextDoc instanceof Javadoc.Parameter) {
Javadoc.Parameter parameter = (Javadoc.Parameter) visitParameter((Javadoc.Parameter) nextDoc, ctx);
if (parameter == null) {
Javadoc.Parameter nextParameter = (Javadoc.Parameter) nextDoc;
if (isEmptyParameter(nextParameter)) {
// The `@param` being removed is the last item in the JavaDoc body, and contains
// relevant whitespace via the JavaDoc.LineBreak.
if (i + 1 == body.size() - 1) {
newBody.add(((Javadoc.Parameter) body.get(i + 1)).getDescription().get(0));
// If we have a previous LineBreak we need to remove it before adding the new one
if (!newBody.isEmpty() && newBody.get(newBody.size() - 1) instanceof Javadoc.LineBreak) {
newBody.remove(newBody.size() - 1);
}
if (!nextParameter.getDescription().isEmpty()) {
newBody.add(nextParameter.getDescription().get(0));
}
}

// No need to reprocess the next element.
i += 1;

useNewBody = true;
skipCurrentDoc = true;
currentDoc = null;
}
} else if (nextDoc instanceof Javadoc.Return) {
Javadoc.Return aReturn = (Javadoc.Return) visitReturn((Javadoc.Return) nextDoc, ctx);
if (aReturn == null) {
if (!newBody.isEmpty() && newBody.get(newBody.size() - 1) instanceof Javadoc.LineBreak) {
newBody.remove(newBody.size() - 1);
}

Javadoc.Return nextReturn = (Javadoc.Return) nextDoc;
if (isEmptyReturn(nextReturn)) {
// The `@return` being removed is the last item in the JavaDoc body, and contains
// relevant whitespace via the JavaDoc.LineBreak.
if (i + 1 == body.size() - 1) {
newBody.add(((Javadoc.Return) body.get(i + 1)).getDescription().get(0));
// If we have a previous LineBreak we need to remove it before adding the new one
if (!newBody.isEmpty() && newBody.get(newBody.size() - 1) instanceof Javadoc.LineBreak) {
newBody.remove(newBody.size() - 1);
}
if (!nextReturn.getDescription().isEmpty()) {
newBody.add(nextReturn.getDescription().get(0));
}
}

// No need to reprocess the next element.
i += 1;

useNewBody = true;
skipCurrentDoc = true;
currentDoc = null;
}
} else if (nextDoc instanceof Javadoc.Erroneous) {
Javadoc.Erroneous erroneous = (Javadoc.Erroneous) visitErroneous((Javadoc.Erroneous) nextDoc, ctx);
if (erroneous == null) {
Javadoc.Erroneous nextErroneous = (Javadoc.Erroneous) nextDoc;
if (isEmptyErroneous(nextErroneous)) {
if (!newBody.isEmpty() && newBody.get(newBody.size() - 1) instanceof Javadoc.LineBreak) {
newBody.remove(newBody.size() - 1);
}
Expand All @@ -132,48 +143,36 @@ public Javadoc visitDocComment(Javadoc.DocComment javadoc, ExecutionContext ctx)
i += 1;

useNewBody = true;
skipCurrentDoc = true;
currentDoc = null;
}
}
}

if (!skipCurrentDoc) {
if (currentDoc != null) {
newBody.add(currentDoc);
}
}

if (useNewBody) {
javadoc = javadoc.withBody(newBody);
}
return super.visitDocComment(javadoc, ctx);
// No need to call super visitor, already covered all cases by adding an empty first element when needed.
return javadoc;
}

@Override
public Javadoc visitParameter(Javadoc.Parameter parameter, ExecutionContext ctx) {
if (parameter.getDescription().stream().allMatch(it -> it instanceof Javadoc.LineBreak)) {
return null;
}
return super.visitParameter(parameter, ctx);
public boolean isEmptyParameter(Javadoc.Parameter parameter) {
return parameter.getDescription().stream().allMatch(it -> it instanceof Javadoc.LineBreak);
}

@Override
public Javadoc visitReturn(Javadoc.Return aReturn, ExecutionContext ctx) {
if (aReturn.getDescription().stream().allMatch(it -> it instanceof Javadoc.LineBreak)) {
return null;
}
return super.visitReturn(aReturn, ctx);
public boolean isEmptyReturn(Javadoc.Return aReturn) {
return aReturn.getDescription().stream().allMatch(it -> it instanceof Javadoc.LineBreak);
}

@Override
public Javadoc visitErroneous(Javadoc.Erroneous erroneous, ExecutionContext ctx) {
if (erroneous.getText().size() == 1 && erroneous.getText().get(0) instanceof Javadoc.Text) {
Javadoc.Text text = (Javadoc.Text) erroneous.getText().get(0);
// Empty throws result in an Erroneous type.
if ("@throws".equals(text.getText())) {
return null;
}
}
return super.visitErroneous(erroneous, ctx);
public boolean isEmptyErroneous(Javadoc.Erroneous erroneous) {
// Empty throws result in an Erroneous type.
return erroneous.getText().size() == 1 &&
erroneous.getText().get(0) instanceof Javadoc.Text &&
"@throws".equals(((Javadoc.Text) erroneous.getText().get(0)).getText());
}
}
};
Expand Down
Loading