forked from jonas-grgt/bob
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: enforce mandatory fields through Step Builder
This should close: jonas-grgt#9
- Loading branch information
1 parent
bc9240f
commit 6134f81
Showing
17 changed files
with
768 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
138 changes: 138 additions & 0 deletions
138
processor/src/main/java/io/jonasg/bob/StepBuilderInterfaceTypeSpecFactory.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| package io.jonasg.bob; | ||
|
|
||
| import static io.jonasg.bob.ConstructorPolicy.ENFORCED; | ||
| import static io.jonasg.bob.ConstructorPolicy.ENFORCED_STEPWISE; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
| import java.util.concurrent.atomic.AtomicReference; | ||
|
|
||
| import javax.lang.model.element.Modifier; | ||
|
|
||
| import com.squareup.javapoet.ClassName; | ||
| import com.squareup.javapoet.MethodSpec; | ||
| import com.squareup.javapoet.TypeName; | ||
| import com.squareup.javapoet.TypeSpec; | ||
| import com.squareup.javapoet.TypeSpec.Builder; | ||
| import io.jonasg.bob.TypeSpecInterfaceBuilder.InterfaceBuilder; | ||
| import io.jonasg.bob.definitions.TypeDefinition; | ||
|
|
||
| public class StepBuilderInterfaceTypeSpecFactory { | ||
|
|
||
| private final Buildable buildable; | ||
|
|
||
| private final TypeDefinition typeDefinition; | ||
|
|
||
| private final List<BuildableField> buildableFields; | ||
|
|
||
| private final String packageName; | ||
|
|
||
| public StepBuilderInterfaceTypeSpecFactory(TypeDefinition typeDefinition, | ||
| Buildable buildable, | ||
| List<BuildableField> buildableFields, | ||
| String packageName) { | ||
| this.buildable = buildable; | ||
| this.typeDefinition = typeDefinition; | ||
| this.buildableFields = buildableFields; | ||
| this.packageName = packageName; | ||
| } | ||
|
|
||
| record BuilderDetails(TypeSpec typeSpec, Set<TypeName> interfaces) { | ||
|
|
||
| } | ||
|
|
||
| BuilderDetails typeSpec(String builderImplName) { | ||
| Set<TypeName> interfaces = new HashSet<>(); | ||
| String builderInterfaceName = String.format("%sBuilder", this.typeDefinition.typeName()); | ||
| Builder stepBuilderBuilder = TypeSpec.interfaceBuilder(builderInterfaceName) | ||
| .addModifiers(Modifier.PUBLIC); | ||
| interfaces.add(ClassName.get(this.packageName, builderInterfaceName)); | ||
|
|
||
| // add static newBuilder method | ||
| stepBuilderBuilder.addMethod(MethodSpec.methodBuilder("newBuilder") | ||
| .addModifiers(Modifier.PUBLIC, Modifier.STATIC) | ||
| .returns(ClassName.get(this.packageName, builderInterfaceName)) | ||
| .addStatement("return new $L()", builderImplName) | ||
| .build()); | ||
|
|
||
| List<BuildableField> reversedBuildableFields = reverseList(this.buildableFields); | ||
|
|
||
| // add final BuildStep containing all none mandatory fields | ||
| InterfaceBuilder buildStepInterfaceBuilder = TypeSpecInterfaceBuilder.anInterface("BuildStep"); | ||
| reversedBuildableFields.stream() | ||
| .filter(this::notExcluded) | ||
| .filter(field -> (!field.isConstructorArgument()) && !field.isMandatory()) | ||
| .forEach(field -> buildStepInterfaceBuilder.addMethod(MethodSpec.methodBuilder(field.name()) | ||
| .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT) | ||
| .returns(ClassName.get("", "BuildStep")) | ||
| .addParameter(TypeName.get(field.type()), field.name()) | ||
| .build())); | ||
| // add terminal build method | ||
| buildStepInterfaceBuilder.addMethod(MethodSpec.methodBuilder("build") | ||
| .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT) | ||
| .returns(ClassName.get(this.typeDefinition.packageName(), this.typeDefinition.typeName())) | ||
| .build()); | ||
| buildStepInterfaceBuilder.build(); | ||
| TypeSpec buildStep = buildStepInterfaceBuilder.build(); | ||
| stepBuilderBuilder.addType(buildStep); | ||
| interfaces.add(ClassName.get("", builderInterfaceName + "." + "BuildStep")); | ||
|
|
||
| // add each mandatory field as a separate interface | ||
| // skipping the last element because that should be defined as a method within | ||
| // the interface itself | ||
| AtomicReference<TypeSpec> nextStep = new AtomicReference<>(buildStep); | ||
| List<BuildableField> mandatoryFields = reversedBuildableFields | ||
| .stream() | ||
| .filter(field -> (field.isConstructorArgument() && isEnforcedConstructorPolicy()) | ||
| || field.isMandatory()) | ||
| .toList(); | ||
| mandatoryFields | ||
| .subList(0, mandatoryFields.size() - 1) | ||
| .stream() | ||
| .filter(this::notExcluded) | ||
| .map(field -> { | ||
| String name = String.format("%sStep", capitalize(field.name())); | ||
| interfaces.add(ClassName.get("", builderInterfaceName + "." + name)); | ||
| return TypeSpecInterfaceBuilder.functionalInterface(name) | ||
| .methodName(field.name()) | ||
| .addArgument(TypeName.get(field.type()), field.name()) | ||
| .returns(ClassName.get("", nextStep.get().name)) | ||
| .build(); | ||
| }) | ||
| .peek(nextStep::set) | ||
| .forEach(stepBuilderBuilder::addType); | ||
|
|
||
| // the initial field to be built | ||
| BuildableField buildableField = mandatoryFields | ||
| .get(mandatoryFields.size() - 1); | ||
| stepBuilderBuilder.addMethod(MethodSpec.methodBuilder(buildableField.name()) | ||
| .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT) | ||
| .addParameter(TypeName.get(buildableField.type()), buildableField.name()) | ||
| .returns(ClassName.get("", nextStep.get().name)) | ||
| .build()); | ||
| return new BuilderDetails(stepBuilderBuilder.build(), interfaces); | ||
| } | ||
|
|
||
| private String capitalize(String value) { | ||
| return value.substring(0, 1).toUpperCase() + value.substring(1); | ||
| } | ||
|
|
||
| private boolean isEnforcedConstructorPolicy() { | ||
| return List.of(ENFORCED, ENFORCED_STEPWISE).contains(this.buildable.constructorPolicy()); | ||
| } | ||
|
|
||
| private boolean notExcluded(BuildableField field) { | ||
| return !Arrays.asList(buildable.excludeFields()).contains(field.name()); | ||
| } | ||
|
|
||
| private <T> List<T> reverseList(List<T> originalList) { | ||
| List<T> reversedList = new ArrayList<>(); | ||
| for (int i = originalList.size() - 1; i >= 0; i--) { | ||
| reversedList.add(originalList.get(i)); | ||
| } | ||
| return reversedList; | ||
| } | ||
| } |
Oops, something went wrong.