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.

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

Jump to bottom

Indent with spaces rather than with tabs #4202

Closed
wants to merge 1 commit into from
Closed

Indent with spaces rather than with tabs #4202

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
26 changes: 13 additions & 13 deletions ...re-generators/src/main/java/com/github/javaparser/generator/CompilationUnitGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,18 +29,18 @@

public abstract class CompilationUnitGenerator extends Generator {

protected CompilationUnitGenerator(SourceRoot sourceRoot) {
super(sourceRoot);
}

@Override
public void generate() throws Exception {
List<ParseResult<CompilationUnit>> parsedCus = sourceRoot.tryToParse();
for (ParseResult<CompilationUnit> cu : parsedCus) {
cu.ifSuccessful(this::generateCompilationUnit);
}
}

protected abstract void generateCompilationUnit(CompilationUnit compilationUnit);
protected CompilationUnitGenerator(SourceRoot sourceRoot) {
super(sourceRoot);
}

@Override
public void generate() throws Exception {
List<ParseResult<CompilationUnit>> parsedCus = sourceRoot.tryToParse();
for (ParseResult<CompilationUnit> cu : parsedCus) {
cu.ifSuccessful(this::generateCompilationUnit);
}
}

protected abstract void generateCompilationUnit(CompilationUnit compilationUnit);

}
308 changes: 154 additions & 154 deletions ...nerators/src/main/java/com/github/javaparser/generator/core/quality/NotNullGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,159 +50,159 @@
*/
public class NotNullGenerator extends CompilationUnitGenerator {

public NotNullGenerator(SourceRoot sourceRoot) {
super(sourceRoot);
}

@Override
public void generateCompilationUnit(CompilationUnit compilationUnit) {
compilationUnit.findAll(ConstructorDeclaration.class).forEach(this::generateQualityForConstructor);
compilationUnit.findAll(MethodDeclaration.class).forEach(this::generateQualityForMethod);
}

/**
* Generate the pre conditions based on the method parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param methodDeclaration The method declaration to generate.
*/
protected void generateQualityForMethod(MethodDeclaration methodDeclaration) {
methodDeclaration.getBody().ifPresent(blockStmt ->
generateQualityForParameter(methodDeclaration, methodDeclaration.getParameters(), blockStmt));
}

/**
* Generate the pre conditions based on the constructor parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param constructorDeclaration The constructor declaration to generate.
*/
protected void generateQualityForConstructor(ConstructorDeclaration constructorDeclaration) {
generateQualityForParameter(constructorDeclaration, constructorDeclaration.getParameters(), constructorDeclaration.getBody());
}

/**
* Generate the pre conditions for the parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param callableDeclaration The declaration where the parameters belong.
* @param parameters The list of parameters.
* @param blockStmt The block where the assertions should be added.
*
* @param <N> The callable declaration type.
*/
protected <N extends CallableDeclaration<?>>
void generateQualityForParameter(N callableDeclaration, NodeList<Parameter> parameters, BlockStmt blockStmt) {

List<Statement> assertions = new ArrayList<>();

for (Parameter parameter : parameters) {
Optional<AnnotationExpr> nonNullAnnotation = parameter.getAnnotationByClass(NotNull.class);
if (nonNullAnnotation.isPresent()) {
assertions.add(createAssertion(parameter));
}
}

insertAssertionsInBlock(callableDeclaration, blockStmt, assertions);
}

/**
* Create assertion for the parameters.
*
* @param parameter The parameter to create the assertion.
*
* @return The assertion to be added to the code.
*/
private Statement createAssertion(Parameter parameter) {

parameter.tryAddImportToParentCompilationUnit(Preconditions.class);
return StaticJavaParser.parseStatement(
f("Preconditions.checkNotNull(%s, \"Parameter %s can't be null.\");", parameter.getNameAsString(),
parameter.getNameAsString())
);
}

/**
* Insert the assertions into the block.
*
* @param callableDeclaration The declaration where the parameters belong.
* @param blockStmt The block where the assertions should be added.
* @param assertions The list of assertions to be inserted.
*
* @param <N> The callable declaration type.
*/
private <N extends CallableDeclaration<?>>
void insertAssertionsInBlock(N callableDeclaration, BlockStmt blockStmt, List<Statement> assertions) {

// If there's nothing to add, just ignore
if (assertions.isEmpty())
return;

int position = 0;
NodeList<Statement> statements = blockStmt.getStatements();

// When the callable is a constructor we must check if is a ExplicitConstructorInvocationStmt.
if (callableDeclaration.isConstructorDeclaration()) {
Optional<Statement> optionalFirstStatement = statements.getFirst();
if (optionalFirstStatement.isPresent()) {

// Check if the first item is a "super" expr. If it's then we add the assertions after it.
Statement firstStatement = optionalFirstStatement.get();
if (firstStatement instanceof ExplicitConstructorInvocationStmt) {
position = 1;
}
}
}

// Register assertions
for (int i = 0 ; i < assertions.size() ; i++) {
Statement assertion = assertions.get(i);

Optional<? extends Statement> optOldStmt = getSimilarAssertionInBlock(assertion, blockStmt);

if (optOldStmt.isPresent()) {
optOldStmt.get().replace(assertion);
} else {
blockStmt.addStatement(position + i, assertion);
}
}
}

private Optional<? extends Statement> getSimilarAssertionInBlock(Statement assertion, BlockStmt blockStmt) {

MethodCallExpr assertionCall = assertion.asExpressionStmt().getExpression().asMethodCallExpr();
List<MethodCallExpr> methodCallExpressions = blockStmt.findAll(MethodCallExpr.class);

for (MethodCallExpr blockMethodCall : methodCallExpressions) {

// Check if the method calls name match
if (
blockMethodCall.getNameAsExpression().equals(assertionCall.getNameAsExpression()) &&
blockMethodCall.getScope().equals(assertionCall.getScope()) &&
blockMethodCall.getArguments().size() == 2 &&
blockMethodCall.getArguments().get(0).equals(assertionCall.getArgument(0))
) {
return blockMethodCall.findAncestor(ExpressionStmt.class);
}

}
// TODO:
return Optional.empty();
}
public NotNullGenerator(SourceRoot sourceRoot) {
super(sourceRoot);
}

@Override
public void generateCompilationUnit(CompilationUnit compilationUnit) {
compilationUnit.findAll(ConstructorDeclaration.class).forEach(this::generateQualityForConstructor);
compilationUnit.findAll(MethodDeclaration.class).forEach(this::generateQualityForMethod);
}

/**
* Generate the pre conditions based on the method parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param methodDeclaration The method declaration to generate.
*/
protected void generateQualityForMethod(MethodDeclaration methodDeclaration) {
methodDeclaration.getBody().ifPresent(blockStmt ->
generateQualityForParameter(methodDeclaration, methodDeclaration.getParameters(), blockStmt));
}

/**
* Generate the pre conditions based on the constructor parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param constructorDeclaration The constructor declaration to generate.
*/
protected void generateQualityForConstructor(ConstructorDeclaration constructorDeclaration) {
generateQualityForParameter(constructorDeclaration, constructorDeclaration.getParameters(), constructorDeclaration.getBody());
}

/**
* Generate the pre conditions for the parameters.
* <br>
* If parameters are annotated with {@link com.github.javaparser.quality.NotNull} and a {@code null} is
* passed, the method should throw an {@link IllegalArgumentException}.
* <br>
* If annotated with {@link com.github.javaparser.quality.Nullable}, other annotation or none, nothing should be
* changed.
*
* @param callableDeclaration The declaration where the parameters belong.
* @param parameters The list of parameters.
* @param blockStmt The block where the assertions should be added.
*
* @param <N> The callable declaration type.
*/
protected <N extends CallableDeclaration<?>>
void generateQualityForParameter(N callableDeclaration, NodeList<Parameter> parameters, BlockStmt blockStmt) {

List<Statement> assertions = new ArrayList<>();

for (Parameter parameter : parameters) {
Optional<AnnotationExpr> nonNullAnnotation = parameter.getAnnotationByClass(NotNull.class);
if (nonNullAnnotation.isPresent()) {
assertions.add(createAssertion(parameter));
}
}

insertAssertionsInBlock(callableDeclaration, blockStmt, assertions);
}

/**
* Create assertion for the parameters.
*
* @param parameter The parameter to create the assertion.
*
* @return The assertion to be added to the code.
*/
private Statement createAssertion(Parameter parameter) {

parameter.tryAddImportToParentCompilationUnit(Preconditions.class);
return StaticJavaParser.parseStatement(
f("Preconditions.checkNotNull(%s, \"Parameter %s can't be null.\");", parameter.getNameAsString(),
parameter.getNameAsString())
);
}

/**
* Insert the assertions into the block.
*
* @param callableDeclaration The declaration where the parameters belong.
* @param blockStmt The block where the assertions should be added.
* @param assertions The list of assertions to be inserted.
*
* @param <N> The callable declaration type.
*/
private <N extends CallableDeclaration<?>>
void insertAssertionsInBlock(N callableDeclaration, BlockStmt blockStmt, List<Statement> assertions) {

// If there's nothing to add, just ignore
if (assertions.isEmpty())
return;

int position = 0;
NodeList<Statement> statements = blockStmt.getStatements();

// When the callable is a constructor we must check if is a ExplicitConstructorInvocationStmt.
if (callableDeclaration.isConstructorDeclaration()) {
Optional<Statement> optionalFirstStatement = statements.getFirst();
if (optionalFirstStatement.isPresent()) {

// Check if the first item is a "super" expr. If it's then we add the assertions after it.
Statement firstStatement = optionalFirstStatement.get();
if (firstStatement instanceof ExplicitConstructorInvocationStmt) {
position = 1;
}
}
}

// Register assertions
for (int i = 0 ; i < assertions.size() ; i++) {
Statement assertion = assertions.get(i);

Optional<? extends Statement> optOldStmt = getSimilarAssertionInBlock(assertion, blockStmt);

if (optOldStmt.isPresent()) {
optOldStmt.get().replace(assertion);
} else {
blockStmt.addStatement(position + i, assertion);
}
}
}

private Optional<? extends Statement> getSimilarAssertionInBlock(Statement assertion, BlockStmt blockStmt) {

MethodCallExpr assertionCall = assertion.asExpressionStmt().getExpression().asMethodCallExpr();
List<MethodCallExpr> methodCallExpressions = blockStmt.findAll(MethodCallExpr.class);

for (MethodCallExpr blockMethodCall : methodCallExpressions) {

// Check if the method calls name match
if (
blockMethodCall.getNameAsExpression().equals(assertionCall.getNameAsExpression()) &&
blockMethodCall.getScope().equals(assertionCall.getScope()) &&
blockMethodCall.getArguments().size() == 2 &&
blockMethodCall.getArguments().get(0).equals(assertionCall.getArgument(0))
) {
return blockMethodCall.findAncestor(ExpressionStmt.class);
}

}
// TODO:
return Optional.empty();
}

}