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

Change ModuleReader to be an instance with state #6

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Change ModuleReader to be an instance with state #6

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions avaje-spi-core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,13 @@
<optional>true</optional>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>io.avaje</groupId>
<artifactId>junit</artifactId>
<version>1.1</version>
<scope>test</scope>
</dependency>

</dependencies>
</project>
83 changes: 49 additions & 34 deletions avaje-spi-core/src/main/java/io/avaje/spi/internal/ModuleReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,58 +8,68 @@
import java.util.Set;
import java.util.regex.Pattern;

public class ModuleReader {
import static java.util.stream.Collectors.toSet;

private ModuleReader() {}
public final class ModuleReader {

private static final Pattern regex = Pattern.compile("provides\\s+(.*?)\\s+with");

/** Keeps Track of found services by SPI and implementation set */
private static final Map<String, Set<String>> foundServices = new HashMap<>();
private final Map<String, Set<String>> foundServices = new HashMap<>();

private final Map<String, Set<String>> missingServicesMap = new HashMap<>();

private static Pattern regex = Pattern.compile("provides\\s+(.*?)\\s+with");
private boolean staticWarning;
private boolean inProvides = false;

private static boolean staticWarning;
public ModuleReader(Map<String, Set<String>> services) {
services.forEach(this::add);
}

private void add(String k, Set<String> v) {
missingServicesMap.put(
ProcessorUtils.shortType(k).replace("$", "."),
v.stream().map(ProcessorUtils::shortType).collect(toSet()));
}

public static void read(Map<String, Set<String>> missingServicesMap, BufferedReader reader)
throws IOException {
public void read(BufferedReader reader) throws IOException {
String line;
String service = null;
boolean inProvides = false;
while ((line = reader.readLine()) != null) {

// retrieve service from provides statement
if (line.contains("provides")) {
inProvides = true;
var matcher = regex.matcher(line);
if (matcher.find()) {
readLine(line);
}
}

service = ProcessorUtils.shortType(matcher.group(1)).replace("$", ".");
}
void readLine(String line) {
String service = null;
if (line.contains("provides")) {
inProvides = true;
var matcher = regex.matcher(line);
if (matcher.find()) {
service = ProcessorUtils.shortType(matcher.group(1)).replace("$", ".");
}
}

// if not part of a provides statement skip
if (!inProvides || line.isBlank()) {

if (!staticWarning && line.contains("io.avaje.spi") && !line.contains("static")) {
staticWarning = true;
}

continue;
// if not part of a provides statement skip
if (!inProvides || line.isBlank()) {
if (!staticWarning && line.contains("io.avaje.spi") && !line.contains("static")) {
staticWarning = true;
}
return;
}

processLine(line, missingServicesMap, service);
processLine(line, service);

// provides statement has ended
if (line.contains(";")) {
inProvides = false;
}
// provides statement has ended
if (line.contains(";")) {
inProvides = false;
}
}

/** as service implementations are discovered, remove from missing strings map */
private static void processLine(
String line, Map<String, Set<String>> missingServicesMap, String service) {
Set<String> missingServiceImpls = missingServicesMap.get(service);
Set<String> foundServiceImpls = foundServices.computeIfAbsent(service, k -> new HashSet<>());
private void processLine(String line, String service) {
final Set<String> missingServiceImpls = missingServicesMap.get(service);
final Set<String> foundServiceImpls = foundServices.computeIfAbsent(service, k -> new HashSet<>());
if (!foundServiceImpls.containsAll(missingServiceImpls)) {
parseServices(line, missingServiceImpls, foundServiceImpls);
}
Expand All @@ -83,7 +93,12 @@ private static void parseServices(
}
}

public static boolean staticWarning() {
public boolean staticWarning() {
return staticWarning;
}

public Map<String, Set<String>> missing() {
return missingServicesMap;
}

}
28 changes: 13 additions & 15 deletions avaje-spi-core/src/main/java/io/avaje/spi/internal/ServiceProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,13 +272,7 @@ ModuleElement getModuleElement(Element e) {
void validateModule() {
if (moduleElement != null && !moduleElement.isUnnamed()) {
// Keep track of missing services and their impls
Map<String, Set<String>> missingServicesMap = new HashMap<>();
services.forEach(
(k, v) ->
missingServicesMap.put(
ProcessorUtils.shortType(k).replace("$", "."),
v.stream().map(ProcessorUtils::shortType).collect(toSet())));

var moduleReader = new ModuleReader(services);
try (var inputStream =
processingEnv
.getFiler()
Expand All @@ -287,12 +281,12 @@ void validateModule() {
.toURL()
.openStream();
var reader = new BufferedReader(new InputStreamReader(inputStream))) {
ModuleReader.read(missingServicesMap, reader);
if (ModuleReader.staticWarning()) {
moduleReader.read(reader);
if (moduleReader.staticWarning()) {
logWarn(
moduleElement, "`requires io.avaje.spi` should be `requires static io.avaje.spi;`");
}
logModuleError(missingServicesMap);
logModuleError(moduleReader);

} catch (Exception e) {
// can't read module
Expand All @@ -301,11 +295,10 @@ void validateModule() {
}
}

private void logModuleError(Map<String, Set<String>> missingStringsMap) {
final Map<String, String> shortQualifiedMap =
services.keySet().stream()
.collect(toMap(s -> ProcessorUtils.shortType(s).replace("$", "."), s -> s));
missingStringsMap.forEach(
private void logModuleError(ModuleReader moduleReader) {
final Map<String, String> shortQualifiedMap = servicesShortMap();

moduleReader.missing().forEach(
(k, v) -> {
if (!v.isEmpty()) {
logError(
Expand All @@ -316,4 +309,9 @@ private void logModuleError(Map<String, Set<String>> missingStringsMap) {
}
});
}

private Map<String, String> servicesShortMap() {
return services.keySet().stream()
.collect(toMap(s -> ProcessorUtils.shortType(s).replace("$", "."), s -> s));
}
}
63 changes: 63 additions & 0 deletions avaje-spi-core/src/test/java/io/avaje/spi/internal/ModuleReaderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
package io.avaje.spi.internal;

import org.junit.jupiter.api.Test;

import java.util.HashMap;
import java.util.Set;

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

class ModuleReaderTest {

@Test
void singleMatch_when_fullyQualified() {
var services = new HashMap<String, Set<String>>();
services.put("javax.annotation.processing.Processor", Set.of("io.avaje.spi.internal.ServiceProcessor"));

var mr = new ModuleReader(services);
mr.readLine("provides javax.annotation.processing.Processor with io.avaje.spi.internal.ServiceProcessor;");
var missing = mr.missing();

assertThat(missing.get("Processor")).isEmpty();
}

@Test
void singleMatch_when_bothShortNames() {
var services = new HashMap<String, Set<String>>();
services.put("javax.annotation.processing.Processor", Set.of("io.avaje.spi.internal.ServiceProcessor"));

var mr = new ModuleReader(services);
mr.readLine("import javax.annotation.processing.Processor;");
mr.readLine("import io.avaje.spi.internal.ServiceProcessor;");
mr.readLine("provides Processor with ServiceProcessor;");
var missing = mr.missing();

assertThat(missing.get("Processor")).isEmpty();
}

@Test
void singleMatch_when_shortNameInterface() {
var services = new HashMap<String, Set<String>>();
services.put("javax.annotation.processing.Processor", Set.of("io.avaje.spi.internal.ServiceProcessor"));

var mr = new ModuleReader(services);
mr.readLine("import javax.annotation.processing.Processor;");
mr.readLine("provides Processor with io.avaje.spi.internal.ServiceProcessor;");
var missing = mr.missing();

assertThat(missing.get("Processor")).isEmpty();
}

@Test
void singleMatch_when_shortNameImplementation() {
var services = new HashMap<String, Set<String>>();
services.put("javax.annotation.processing.Processor", Set.of("io.avaje.spi.internal.ServiceProcessor"));

var mr = new ModuleReader(services);
mr.readLine("import io.avaje.spi.internal.ServiceProcessor;");
mr.readLine("provides javax.annotation.processing.Processor with ServiceProcessor;");
var missing = mr.missing();

assertThat(missing.get("Processor")).isEmpty();
}
}
Loading