Skip to content

Support package private classes #300

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.

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
merged 6 commits into from
Apr 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion blackbox-test/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>2.10</version>
<version>2.11</version>
</parent>

<artifactId>validator-blackbox-test</artifactId>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
package example.avaje.pkg_private;

import io.avaje.validation.constraints.Positive;
import jakarta.validation.Valid;

@Valid
record PackagePrivate(@Positive int id) {}
2 changes: 1 addition & 1 deletion blackbox-test/src/main/java/module-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@
requires jakarta.inject;
requires org.jspecify;

provides io.avaje.validation.spi.ValidationExtension with example.avaje.valid.GeneratedValidatorComponent;
provides io.avaje.validation.spi.ValidationExtension with example.avaje.pkg_private.PkgPrivateValidatorComponent, example.avaje.valid.GeneratedValidatorComponent;
provides io.avaje.inject.spi.InjectExtension with example.avaje.GeneratedModule;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
package example.avaje.pkg_private;

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.fail;

import java.util.ArrayList;
import java.util.List;
import java.util.Locale;

import org.junit.jupiter.api.Test;

import io.avaje.validation.ConstraintViolation;
import io.avaje.validation.ConstraintViolationException;
import io.avaje.validation.Validator;

class PackagePrivateTest {

Validator validator = Validator.builder().build();

@Test
void invalid() {
var pkgPrivate = new PackagePrivate(-100);
List<ConstraintViolation> violations = violations(pkgPrivate);

assertThat(violations).hasSize(1);
}

List<ConstraintViolation> violations(Object any) {
return violations(any, Locale.ENGLISH);
}

List<ConstraintViolation> violations(Object any, Locale locale) {
try {
validator.validate(any, locale);
fail("not expected");
return null;
} catch (ConstraintViolationException e) {
return new ArrayList<>(e.violations());
}
}
}
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>2.10</version>
<version>2.11</version>

<packaging>pom</packaging>
<name>validator parent</name>
Expand All @@ -29,7 +29,7 @@
<maven.compiler.release>17</maven.compiler.release>
<inject.version>11.4</inject.version>
<spi.version>2.12</spi.version>
<project.build.outputTimestamp>2025-04-22T20:38:01Z</project.build.outputTimestamp>
<project.build.outputTimestamp>2025-04-29T01:04:37Z</project.build.outputTimestamp>
</properties>

<modules>
Expand Down
2 changes: 1 addition & 1 deletion validator-constraints/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>2.10</version>
<version>2.11</version>
</parent>
<artifactId>avaje-validator-constraints</artifactId>
<name>validator-constraints</name>
Expand Down
2 changes: 1 addition & 1 deletion validator-generator/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<parent>
<groupId>io.avaje</groupId>
<artifactId>avaje-validator-parent</artifactId>
<version>2.10</version>
<version>2.11</version>
</parent>

<artifactId>avaje-validator-generator</artifactId>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,25 @@ final class AdapterName {
final String adapterPackage;
final String fullName;

AdapterName(TypeElement origin) {
String originPackage = APContext.elements().getPackageOf(origin).getQualifiedName().toString();
var name = shortName(origin);
AdapterName(TypeElement type) {
this(type, false);
}

AdapterName(BeanReader beanReader) {
this(beanReader.beanType(), beanReader.isPkgPrivate());
}

AdapterName(TypeElement type, boolean pkgPrivate) {
String originPackage = APContext.elements().getPackageOf(type).getQualifiedName().toString();
var name = shortName(type);
shortName = name.substring(0, name.length() - 1);
if ("".equals(originPackage)) {
if (pkgPrivate) {
this.adapterPackage = originPackage;
} else if ("".equals(originPackage)) {
this.adapterPackage = "valid";
} else {
this.adapterPackage = ProcessingContext.isImported(origin) ? originPackage + ".valid" : originPackage;
this.adapterPackage =
ProcessingContext.isImported(type) ? originPackage + ".valid" : originPackage;
}
this.fullName = adapterPackage + "." + shortName + "ValidationAdapter";
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ interface BeanReader {

void writeValidatorMethod(Append writer);

default boolean isPkgPrivate() {
return false;
}

String shortName();

/** Return the short name of the element. */
Expand All @@ -28,7 +32,7 @@ default int genericTypeParamsCount() {
return 0;
}

TypeElement getBeanType();
TypeElement beanType();

void cascadeTypes(Set<String> extraTypes);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import java.util.Set;
import java.util.TreeSet;

import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;

final class ClassReader implements BeanReader {
Expand All @@ -15,6 +16,7 @@ final class ClassReader implements BeanReader {
private final Set<String> importTypes = new TreeSet<>();
private final TypeReader typeReader;
private final boolean nonAccessibleField;
private final boolean pkgPrivate;

ClassReader(TypeElement beanType) {
this(beanType, null);
Expand All @@ -28,6 +30,7 @@ final class ClassReader implements BeanReader {
typeReader.process();
this.nonAccessibleField = typeReader.nonAccessibleField();
this.allFields = typeReader.allFields();
this.pkgPrivate = !beanType.getModifiers().contains(Modifier.PUBLIC);
importTypes.add("java.util.List");
importTypes.add("java.util.Set");
importTypes.add("java.util.Map");
Expand All @@ -54,7 +57,7 @@ public String shortName() {
}

@Override
public TypeElement getBeanType() {
public TypeElement beanType() {
return beanType;
}

Expand Down Expand Up @@ -137,4 +140,9 @@ public void writeValidatorMethod(Append writer) {
writer.append(" return true;", shortName).eol();
writer.append(" }").eol();
}

@Override
public boolean isPkgPrivate() {
return pkgPrivate;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ public String toString() {
return allTypes.toString();
}

/** Ensure the component name has been initialised. */
void initialiseFullName() {
fullName();
}

boolean contains(String type) {
return allTypes.contains(type);
}
Expand All @@ -45,25 +40,24 @@ void setFullName(String fullName) {
this.fullName = fullName;
}

String fullName() {
String fullName(boolean pkgPrivate) {
if (fullName == null) {
final List<String> types = new ArrayList<>(allTypes);
for (final var adapter : annotationAdapters) {
adapter.getQualifiedName().toString().transform(types::add);
}
String topPackage = TopPackage.of(types);
if (!topPackage.endsWith(".valid")) {
if (!topPackage.endsWith(".valid") && !pkgPrivate) {
topPackage += ".valid";
}
fullName = topPackage + ".GeneratedValidatorComponent";
fullName =
pkgPrivate
? topPackage + "." + name(topPackage) + "ValidatorComponent"
: topPackage + ".GeneratedValidatorComponent";
}
return fullName;
}

String packageName() {
return ProcessorUtils.packageOf(fullName());
}

List<String> all() {
return allTypes;
}
Expand All @@ -81,18 +75,20 @@ Collection<String> allImports() {
final Set<String> packageImports = new TreeSet<>();
for (final String adapterFullName : allTypes) {
packageImports.add(adapterFullName);
packageImports.add(ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));
packageImports.add(
ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));
}

for (final var adapter : annotationAdapters) {
final var adapterFullName = adapter.getQualifiedName().toString();
packageImports.add(adapterFullName);
packageImports.add(ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));
packageImports.add(
ProcessorUtils.extractEnclosingFQN(Util.baseTypeOfAdapter(adapterFullName)));

ConstraintAdapterPrism.getInstanceOn(adapter)
.value()
.toString()
.transform(packageImports::add);
.value()
.toString()
.transform(packageImports::add);
}

return packageImports;
Expand All @@ -101,4 +97,36 @@ Collection<String> allImports() {
public boolean isEmpty() {
return allTypes.isEmpty() && factoryTypes.isEmpty() && annotationAdapters.isEmpty();
}

static String name(String name) {
if (name == null) {
return null;
}
final int pos = name.lastIndexOf('.');
if (pos > -1) {
name = name.substring(pos + 1);
}
return camelCase(name).replaceFirst("Valid", "Generated");
}

private static String camelCase(String name) {
StringBuilder sb = new StringBuilder(name.length());
boolean upper = true;
for (char aChar : name.toCharArray()) {
if (Character.isLetterOrDigit(aChar)) {
if (upper) {
aChar = Character.toUpperCase(aChar);
upper = false;
}
sb.append(aChar);
} else if (toUpperOn(aChar)) {
upper = true;
}
}
return sb.toString();
}

private static boolean toUpperOn(char aChar) {
return aChar == ' ' || aChar == '-' || aChar == '_';
}
}
Loading