Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
Randgalt committed Mar 27, 2024
1 parent b72ec9a commit ce7df91
Show file tree
Hide file tree
Showing 10 changed files with 394 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,12 @@
*/
String interfaceSuffix() default "Record";

/**
* Used by {@code RecordDeconstructor}. The generated record will have the same name as the annotated element
* plus this suffix. E.g. if the element name is "Foo", the record will be named "FooTuple".
*/
String deconstructorSuffix() default "Tuple";

/**
* The name to use for the copy builder
*/
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* Copyright 2019 The original author or authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.soabase.recordbuilder.core;

import java.lang.annotation.*;

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
@Inherited
public @interface RecordDeconstructor {
String deconstructorSuffix() default "Tuple";

String fromMethodName() default "from";

@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.METHOD)
@interface Component {
String value() default "";
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,12 @@
import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.*;
import javax.lang.model.type.TypeMirror;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.*;
import java.util.stream.Collectors;

public class ElementUtils {
private static final Set<String> javaBeanPrefixes = Set.of("get", "is");

public static Optional<? extends AnnotationMirror> findAnnotationMirror(ProcessingEnvironment processingEnv,
Element element, String annotationClass) {
return processingEnv.getElementUtils().getAllAnnotationMirrors(element).stream()
Expand Down Expand Up @@ -164,6 +163,14 @@ public static Optional<? extends Element> findCanonicalConstructor(TypeElement r
}).findFirst();
}

public static Optional<String> stripBeanPrefix(String name) {
return javaBeanPrefixes.stream().filter(prefix -> name.startsWith(prefix) && (name.length() > prefix.length()))
.findFirst().map(prefix -> {
var stripped = name.substring(prefix.length());
return Character.toLowerCase(stripped.charAt(0)) + stripped.substring(1);
});
}

private static String getBuilderNamePrefix(Element element) {
// prefix enclosing class names if nested in a class
if (element instanceof TypeElement) {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,204 @@
/*
* Copyright 2019 The original author or authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.soabase.recordbuilder.processor;

import com.squareup.javapoet.*;
import io.soabase.recordbuilder.core.RecordBuilder;
import io.soabase.recordbuilder.core.RecordDeconstructor;

import javax.annotation.processing.ProcessingEnvironment;
import javax.lang.model.element.ElementKind;
import javax.lang.model.element.ExecutableElement;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
import javax.lang.model.type.TypeKind;
import javax.tools.Diagnostic;
import java.util.*;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

import static io.soabase.recordbuilder.processor.ElementUtils.getBuilderName;
import static io.soabase.recordbuilder.processor.RecordBuilderProcessor.*;

class InternalRecordDeconstructorProcessor {
private final ProcessingEnvironment processingEnv;
private final String packageName;
private final TypeSpec recordType;
private final List<Component> recordComponents;
private final ClassType recordClassType;
private final List<TypeVariableName> typeVariables;

private record Component(ExecutableElement element, Optional<String> alternateName) {
}

InternalRecordDeconstructorProcessor(ProcessingEnvironment processingEnv, TypeElement element,
RecordBuilder.Options metaData, Optional<String> packageNameOpt, boolean fromTemplate) {
this.processingEnv = processingEnv;
packageName = packageNameOpt.orElseGet(() -> ElementUtils.getPackageName(element));
recordComponents = getRecordComponents(element);

ClassType ifaceClassType = ElementUtils.getClassType(element, element.getTypeParameters());
recordClassType = ElementUtils.getClassType(packageName,
getBuilderName(element, metaData, ifaceClassType, metaData.deconstructorSuffix()),
element.getTypeParameters());
typeVariables = element.getTypeParameters().stream().map(TypeVariableName::get).collect(Collectors.toList());

TypeSpec.Builder builder = TypeSpec.recordBuilder(recordClassType.name()).addTypeVariables(typeVariables);
if (metaData.addClassRetainedGenerated()) {
builder.addAnnotation(generatedRecordDeconstructorAnnotation);
}

var actualPackage = ElementUtils.getPackageName(element);
addVisibility(builder, actualPackage.equals(packageName), element.getModifiers());

recordComponents.forEach(component -> {
String name = component.alternateName.orElseGet(() -> component.element.getSimpleName().toString());
FieldSpec parameterSpec = FieldSpec.builder(ClassName.get(component.element.getReturnType()), name).build();
builder.addTypeVariables(component.element.getTypeParameters().stream().map(TypeVariableName::get)
.collect(Collectors.toList()));
builder.addField(parameterSpec);
});

addFromMethod(builder, element, metaData.fromMethodName());

recordType = builder.build();
}

boolean isValid() {
return !recordComponents.isEmpty();
}

TypeSpec recordType() {
return recordType;
}

String packageName() {
return packageName;
}

ClassType recordClassType() {
return recordClassType;
}

private void addFromMethod(TypeSpec.Builder builder, TypeElement element, String fromName) {
MethodSpec.Builder methodBuilder = MethodSpec.methodBuilder(fromName)
.addAnnotation(generatedRecordDeconstructorAnnotation).addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(recordClassType.typeName()).addTypeVariables(typeVariables)
.addParameter(ClassName.get(element.asType()), fromName);

CodeBlock.Builder codeBuilder = CodeBlock.builder();
codeBuilder.add("return new $T(", recordClassType.typeName());
IntStream.range(0, recordComponents.size()).forEach(index -> {
if (index > 0) {
codeBuilder.add(", ");
}

Component component = recordComponents.get(index);
codeBuilder.add("$L.$L()", fromName, component.element.getSimpleName());
});
codeBuilder.addStatement(")");

methodBuilder.addCode(codeBuilder.build());

builder.addMethod(methodBuilder.build());
}

private void addVisibility(TypeSpec.Builder builder, boolean builderIsInRecordPackage, Set<Modifier> modifiers) {
if (builderIsInRecordPackage) {
if (modifiers.contains(Modifier.PUBLIC) || modifiers.contains(Modifier.PRIVATE)
|| modifiers.contains(Modifier.PROTECTED)) {
builder.addModifiers(Modifier.PUBLIC); // builders are top level classes - can only be public or
// package-private
}
// is package-private
} else {
builder.addModifiers(Modifier.PUBLIC);
}
}

private List<Component> getRecordComponents(TypeElement iface) {
List<Component> components = new ArrayList<>();
try {
getRecordComponents(iface, components, new HashSet<>(), new HashSet<>());
if (components.isEmpty()) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR,
"Annotated interface has no component methods", iface);
}
} catch (IllegalDeconstructor e) {
processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, e.getMessage(), iface);
components = Collections.emptyList();
}
return components;
}

private static class IllegalDeconstructor extends RuntimeException {
public IllegalDeconstructor(String message) {
super(message);
}
}

private void getRecordComponents(TypeElement iface, Collection<Component> components, Set<String> visitedSet,
Set<String> usedNames) {
if (!visitedSet.add(iface.getQualifiedName().toString())) {
return;
}

iface.getEnclosedElements().forEach(element -> {
RecordDeconstructor.Component component = element.getAnnotation(RecordDeconstructor.Component.class);

if (component == null) {
return;
}

if (element.getKind() != ElementKind.METHOD || element.getModifiers().contains(Modifier.STATIC)
|| !element.getModifiers().contains(Modifier.PUBLIC)) {
throw new IllegalDeconstructor(String.format(
"RecordDeconstructor.Components must be public non-static methods. Bad method: %s.%s()",
iface.getSimpleName(), element.getSimpleName()));
}

ExecutableElement executableElement = (ExecutableElement) element;

if (!executableElement.getParameters().isEmpty()
|| executableElement.getReturnType().getKind() == TypeKind.VOID) {
throw new IllegalDeconstructor(String.format(
"RecordDeconstructor.Components methods must take no arguments and must return a value. Bad method: %s.%s()",
iface.getSimpleName(), executableElement.getSimpleName()));
}
if (!executableElement.getTypeParameters().isEmpty()) {
throw new IllegalDeconstructor(String.format(
"RecordDeconstructor.Components methods cannot have type parameters. Bad method: %s.%s()",
iface.getSimpleName(), element.getSimpleName()));
}

if (usedNames.add(element.getSimpleName().toString())) {
Optional<String> alternateName;
if (component.value().isEmpty()) {
alternateName = ElementUtils.stripBeanPrefix(element.getSimpleName().toString());
} else {
alternateName = Optional.of(component.value());
}
components.add(new Component(executableElement, alternateName));
}
});

iface.getInterfaces().forEach(parentIface -> {
TypeElement parentIfaceElement = (TypeElement) processingEnv.getTypeUtils().asElement(parentIface);
getRecordComponents(parentIfaceElement, components, visitedSet, usedNames);
});
}

}
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ class InternalRecordInterfaceProcessor {
private final List<Component> recordComponents;
private final ClassType recordClassType;

private static final Set<String> javaBeanPrefixes = Set.of("get", "is");

private record Component(ExecutableElement element, Optional<String> alternateName) {
}

Expand Down Expand Up @@ -154,7 +152,6 @@ private static class IllegalInterface extends RuntimeException {
public IllegalInterface(String message) {
super(message);
}

}

private void getRecordComponents(TypeElement iface, Collection<Component> components, Set<String> visitedSet,
Expand Down Expand Up @@ -183,19 +180,12 @@ private void getRecordComponents(TypeElement iface, Collection<Component> compon
iface.getSimpleName(), element.getSimpleName()));
}
}).filter(element -> usedNames.add(element.getSimpleName().toString()))
.map(element -> new Component(element, stripBeanPrefix(element.getSimpleName().toString())))
.map(element -> new Component(element,
ElementUtils.stripBeanPrefix(element.getSimpleName().toString())))
.collect(Collectors.toCollection(() -> components));
iface.getInterfaces().forEach(parentIface -> {
TypeElement parentIfaceElement = (TypeElement) processingEnv.getTypeUtils().asElement(parentIface);
getRecordComponents(parentIfaceElement, components, visitedSet, usedNames);
});
}

private Optional<String> stripBeanPrefix(String name) {
return javaBeanPrefixes.stream().filter(prefix -> name.startsWith(prefix) && (name.length() > prefix.length()))
.findFirst().map(prefix -> {
var stripped = name.substring(prefix.length());
return Character.toLowerCase(stripped.charAt(0)) + stripped.substring(1);
});
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import com.squareup.javapoet.TypeSpec;
import io.soabase.recordbuilder.core.RecordBuilder;
import io.soabase.recordbuilder.core.RecordBuilderGenerated;
import io.soabase.recordbuilder.core.RecordDeconstructor;
import io.soabase.recordbuilder.core.RecordInterface;

import javax.annotation.processing.AbstractProcessor;
Expand All @@ -45,11 +46,14 @@ public class RecordBuilderProcessor extends AbstractProcessor {
private static final String RECORD_BUILDER_INCLUDE = RecordBuilder.Include.class.getName().replace('$', '.');
private static final String RECORD_INTERFACE = RecordInterface.class.getName();
private static final String RECORD_INTERFACE_INCLUDE = RecordInterface.Include.class.getName().replace('$', '.');
private static final String RECORD_DECONSTRUCTOR = RecordDeconstructor.class.getName();

static final AnnotationSpec generatedRecordBuilderAnnotation = AnnotationSpec.builder(Generated.class)
.addMember("value", "$S", RecordBuilder.class.getName()).build();
static final AnnotationSpec generatedRecordInterfaceAnnotation = AnnotationSpec.builder(Generated.class)
.addMember("value", "$S", RecordInterface.class.getName()).build();
static final AnnotationSpec generatedRecordDeconstructorAnnotation = AnnotationSpec.builder(Generated.class)
.addMember("value", "$S", RecordDeconstructor.class.getName()).build();
static final AnnotationSpec recordBuilderGeneratedAnnotation = AnnotationSpec.builder(RecordBuilderGenerated.class)
.build();

Expand Down Expand Up @@ -83,6 +87,9 @@ private void process(TypeElement annotation, Element element) {
var typeElement = (TypeElement) element;
processRecordInterface(typeElement, element.getAnnotation(RecordInterface.class).addRecordBuilder(),
getMetaData(typeElement), Optional.empty(), false);
} else if (annotationClass.equals(RECORD_DECONSTRUCTOR)) {
var typeElement = (TypeElement) element;
processRecordDeconstructor(typeElement, getMetaData(typeElement), Optional.empty(), false);
} else if (annotationClass.equals(RECORD_BUILDER_INCLUDE) || annotationClass.equals(RECORD_INTERFACE_INCLUDE)) {
processIncludes(element, getMetaData(element), annotationClass);
} else {
Expand Down Expand Up @@ -178,6 +185,19 @@ private void processRecordInterface(TypeElement element, boolean addRecordBuilde
internalProcessor.recordType(), metaData);
}

private void processRecordDeconstructor(TypeElement element, RecordBuilder.Options metaData,
Optional<String> packageName, boolean fromTemplate) {
validateMetaData(metaData, element);

var internalProcessor = new InternalRecordDeconstructorProcessor(processingEnv, element, metaData, packageName,
fromTemplate);
if (!internalProcessor.isValid()) {
return;
}
writeRecordInterfaceJavaFile(element, internalProcessor.packageName(), internalProcessor.recordClassType(),
internalProcessor.recordType(), metaData);
}

private void processRecordBuilder(TypeElement record, RecordBuilder.Options metaData,
Optional<String> packageName) {
// we use string based name comparison for the element kind,
Expand Down
2 changes: 2 additions & 0 deletions record-builder-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@

<properties>
<license-file-path>${project.parent.basedir}/src/etc/header.txt</license-file-path>

<jdk-version>21</jdk-version>
</properties>

<dependencies>
Expand Down
Loading

0 comments on commit ce7df91

Please sign in to comment.