Maven plug-in

cli/src/main/java/io/github/alien/roseau/cli/RoseauCLI.java

@@ -4,13 +4,11 @@
 import io.github.alien.roseau.Library;
 import io.github.alien.roseau.Roseau;
 import io.github.alien.roseau.RoseauException;
-import io.github.alien.roseau.RoseauOptions;
 import io.github.alien.roseau.api.model.API;
 import io.github.alien.roseau.diff.RoseauReport;
-import io.github.alien.roseau.diff.changes.BreakingChange;
-import io.github.alien.roseau.diff.formatter.BreakingChangesFormatter;
 import io.github.alien.roseau.diff.formatter.BreakingChangesFormatterFactory;
 import io.github.alien.roseau.diff.formatter.CliFormatter;
+import io.github.alien.roseau.options.RoseauOptions;
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.core.config.Configurator;
@@ -19,7 +17,6 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.Arrays;
@@ -145,19 +142,6 @@ private static List<Path> buildClasspathFromString(String cp) {
 			.toList();
 	}
 
-	private void writeReport(RoseauReport report, BreakingChangesFormatterFactory format, Path path) {
-		try {
-			if (path.getParent() != null) {
-				Files.createDirectories(path.getParent());
-			}
-			BreakingChangesFormatter fmt = BreakingChangesFormatterFactory.newBreakingChangesFormatter(format);
-			Files.writeString(path, fmt.format(report), StandardCharsets.UTF_8);
-			console.printlnVerbose("Report has been written to %s".formatted(path));
-		} catch (IOException e) {
-			throw new RoseauException("Error writing report to %s".formatted(path), e);
-		}
-	}
-
 	private void writeApiReport(API api, Path apiPath) {
 		try {
 			if (apiPath.getParent() != null) {
@@ -170,24 +154,6 @@ private void writeApiReport(API api, Path apiPath) {
 		}
 	}
 
-	private RoseauReport filterReport(RoseauReport report, RoseauOptions.Diff diffOptions) {
-		List<BreakingChange> bcs = diffOptions.sourceOnly()
-			? report.getSourceBreakingChanges()
-			: diffOptions.binaryOnly()
-				? report.getBinaryBreakingChanges()
-				: report.getBreakingChanges();
-
-		Path ignorePath = diffOptions.ignore();
-		if (ignorePath != null && Files.isRegularFile(ignorePath)) {
-			IgnoredCsvFile ignoredFile = new IgnoredCsvFile(ignorePath);
-			bcs = bcs.stream()
-				.filter(bc -> !ignoredFile.isIgnored(bc))
-				.toList();
-		}
-
-		return new RoseauReport(report.v1(), report.v2(), bcs);
-	}
-
 	private void checkOptions(RoseauOptions options) {
 		Path v1Path = options.v1().location();
 
@@ -284,7 +250,7 @@ private void doApi(Library library, RoseauOptions.Library libraryOptions) {
 	private boolean doDiff(Library v1, Library v2, RoseauOptions options) {
 		buildClasspath(v1);
 		buildClasspath(v2);
-		RoseauReport report = filterReport(diff(v1, v2), options.diff());
+		RoseauReport report = diff(v1, v2).filterReport(options.diff());
 		console.println(new CliFormatter(plain ? CliFormatter.Mode.PLAIN : CliFormatter.Mode.ANSI).format(report));
 
 		if (options.v1().apiReport() != null) {
@@ -294,7 +260,7 @@ private boolean doDiff(Library v1, Library v2, RoseauOptions options) {
 			writeApiReport(report.v2(), options.v2().apiReport());
 		}
 		options.reports().forEach(reportOption ->
-			writeReport(report, reportOption.format(), reportOption.file())
+			report.writeReport(reportOption.format(), reportOption.file())
 		);
 
 		return !report.getBreakingChanges().isEmpty();

core/src/main/java/io/github/alien/roseau/Library.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.google.common.base.Suppliers;
 import io.github.alien.roseau.extractors.ExtractorType;
+import io.github.alien.roseau.options.RoseauOptions;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 

core/src/main/java/io/github/alien/roseau/diff/RoseauReport.java

@@ -2,14 +2,23 @@
 
 import com.google.common.base.Preconditions;
 import com.google.common.collect.Sets;
+import io.github.alien.roseau.RoseauException;
 import io.github.alien.roseau.api.model.API;
 import io.github.alien.roseau.api.model.TypeDecl;
 import io.github.alien.roseau.api.model.TypeMemberDecl;
 import io.github.alien.roseau.api.model.reference.TypeReference;
 import io.github.alien.roseau.diff.changes.BreakingChange;
 import io.github.alien.roseau.diff.changes.BreakingChangeDetails;
 import io.github.alien.roseau.diff.changes.BreakingChangeKind;
-
+import io.github.alien.roseau.diff.formatter.BreakingChangesFormatter;
+import io.github.alien.roseau.diff.formatter.BreakingChangesFormatterFactory;
+import io.github.alien.roseau.options.IgnoredCsvFile;
+import io.github.alien.roseau.options.RoseauOptions;
+
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.Collection;
 import java.util.Comparator;
 import java.util.List;
@@ -115,6 +124,37 @@ public Map<TypeMemberDecl, List<BreakingChange>> getBreakingChangesPerMember(Typ
 			));
 	}
 
+	public RoseauReport filterReport(RoseauOptions.Diff diffOptions) {
+		List<BreakingChange> bcs = diffOptions.sourceOnly()
+			? getSourceBreakingChanges()
+			: diffOptions.binaryOnly()
+			? getBinaryBreakingChanges()
+			: getBreakingChanges();
+
+		Path ignorePath = diffOptions.ignore();
+		if (ignorePath != null && Files.isRegularFile(ignorePath)) {
+			IgnoredCsvFile ignoredFile = new IgnoredCsvFile(ignorePath);
+			bcs = bcs.stream()
+				.filter(bc -> !ignoredFile.isIgnored(bc))
+				.toList();
+		}
+
+		return new RoseauReport(v1(), v2(), bcs);
+	}
+
+	public void writeReport(BreakingChangesFormatterFactory format, Path path) {
+		try {
+			if (path.getParent() != null) {
+				Files.createDirectories(path.getParent());
+			}
+
+			BreakingChangesFormatter fmt = BreakingChangesFormatterFactory.newBreakingChangesFormatter(format);
+			Files.writeString(path, fmt.format(this), StandardCharsets.UTF_8);
+		} catch (IOException e) {
+			throw new RoseauException("Error writing report to %s".formatted(path), e);
+		}
+	}
+
 	public static Builder builder(API v1, API v2) {
 		return new Builder(v1, v2);
 	}
@@ -145,12 +185,12 @@ public void memberBC(BreakingChangeKind kind, TypeDecl impactedType, TypeMemberD
 		}
 
 		public void memberBC(BreakingChangeKind kind, TypeDecl impactedType, TypeMemberDecl impactedMember,
-		              TypeMemberDecl newMember) {
+		                     TypeMemberDecl newMember) {
 			memberBC(kind, impactedType, impactedMember, newMember, new BreakingChangeDetails.None());
 		}
 
 		public void memberBC(BreakingChangeKind kind, TypeDecl impactedType, TypeMemberDecl impactedMember,
-		              TypeMemberDecl newMember, BreakingChangeDetails details) {
+		                     TypeMemberDecl newMember, BreakingChangeDetails details) {
 			// java.lang.Object methods are an absolute pain to handle. Many rules
 			// do not apply to them as they're implicitly provided to any class.
 			if (impactedMember.getContainingType().equals(TypeReference.OBJECT)) {

core/src/main/java/io/github/alien/roseau/diff/formatter/CliFormatter.java

@@ -51,7 +51,7 @@ public String format(RoseauReport report) {
 
 		StringBuilder sb = new StringBuilder();
 
-		sb.append(bold("Breaking Changes Found: ")).append(changes.size());
+		sb.append(bold("Breaking Changes found: ")).append(changes.size());
 		sb.append(" (").append(binaryBreaking).append(" binary-breaking, ");
 		sb.append(sourceBreaking).append(" source-breaking)");
 		sb.append(System.lineSeparator());

cli/src/main/java/io/github/alien/roseau/cli/IgnoredCsvFile.java → core/src/main/java/io/github/alien/roseau/options/IgnoredCsvFile.java

@@ -1,4 +1,4 @@
-package io.github.alien.roseau.cli;
+package io.github.alien.roseau.options;
 
 import io.github.alien.roseau.RoseauException;
 import io.github.alien.roseau.diff.changes.BreakingChange;
@@ -10,13 +10,12 @@
 import java.util.List;
 import java.util.stream.Stream;
 
-class IgnoredCsvFile {
+public class IgnoredCsvFile {
 	private final List<Ignored> ignoredBCs;
 
-	private record Ignored(String type, String symbol, BreakingChangeKind kind) {
-	}
+	private record Ignored(String type, String symbol, BreakingChangeKind kind) {}
 
-	IgnoredCsvFile(Path csv) {
+	public IgnoredCsvFile(Path csv) {
 		try (Stream<String> lines = Files.lines(csv)) {
 			ignoredBCs = lines
 				.map(String::strip)
@@ -41,7 +40,7 @@ private record Ignored(String type, String symbol, BreakingChangeKind kind) {
 		}
 	}
 
-	boolean isIgnored(BreakingChange bc) {
+	public boolean isIgnored(BreakingChange bc) {
 		return ignoredBCs.stream().anyMatch(ign -> bc.impactedType().getQualifiedName().equals(ign.type()) &&
 			bc.impactedSymbol().getQualifiedName().equals(ign.symbol()) &&
 			bc.kind() == ign.kind());

core/src/main/java/io/github/alien/roseau/RoseauOptions.java → core/src/main/java/io/github/alien/roseau/options/RoseauOptions.java

@@ -1,9 +1,10 @@
-package io.github.alien.roseau;
+package io.github.alien.roseau.options;
 
 import com.fasterxml.jackson.annotation.JsonSetter;
 import com.fasterxml.jackson.annotation.Nulls;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import io.github.alien.roseau.RoseauException;
 import io.github.alien.roseau.diff.formatter.BreakingChangesFormatterFactory;
 
 import java.io.IOException;

core/src/test/java/io/github/alien/roseau/LibraryTest.java

@@ -4,6 +4,7 @@
 import io.github.alien.roseau.api.model.MethodDecl;
 import io.github.alien.roseau.api.model.TypeDecl;
 import io.github.alien.roseau.extractors.ExtractorType;
+import io.github.alien.roseau.options.RoseauOptions;
 import io.github.alien.roseau.utils.TestUtils;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;

core/src/test/java/io/github/alien/roseau/diff/ExclusionsReportTest.java

@@ -1,7 +1,7 @@
 package io.github.alien.roseau.diff;
 
 import io.github.alien.roseau.Roseau;
-import io.github.alien.roseau.RoseauOptions;
+import io.github.alien.roseau.options.RoseauOptions;
 import io.github.alien.roseau.utils.TestUtils;
 import org.junit.jupiter.api.Test;
 

core/src/test/java/io/github/alien/roseau/RoseauOptionsTest.java → core/src/test/java/io/github/alien/roseau/options/RoseauOptionsTest.java

@@ -1,4 +1,4 @@
-package io.github.alien.roseau;
+package io.github.alien.roseau.options;
 
 import io.github.alien.roseau.diff.formatter.BreakingChangesFormatterFactory;
 import org.junit.jupiter.api.Test;

core/src/test/java/io/github/alien/roseau/utils/TestUtils.java

@@ -4,7 +4,7 @@
 import com.google.common.io.RecursiveDeleteOption;
 import io.github.alien.roseau.Library;
 import io.github.alien.roseau.Roseau;
-import io.github.alien.roseau.RoseauOptions.Exclude;
+import io.github.alien.roseau.options.RoseauOptions.Exclude;
 import io.github.alien.roseau.api.model.API;
 import io.github.alien.roseau.api.model.AnnotationDecl;
 import io.github.alien.roseau.api.model.AnnotationMethodDecl;

core/src/test/resources/api-extractor-tests/without-modules/v1/pom.xml

@@ -6,9 +6,9 @@
     <parent>
         <groupId>io.github.alien</groupId>
         <artifactId>api-extractor-tests</artifactId>
-        <version>0.5.0-SNAPSHOT</version>
+        <version>0.6.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>without-modules</artifactId>
 
-</project>
+</project>

core/src/test/resources/api-extractor-tests/without-modules/v2/pom.xml

@@ -6,9 +6,9 @@
     <parent>
         <groupId>io.github.alien</groupId>
         <artifactId>api-extractor-tests</artifactId>
-        <version>0.5.0-SNAPSHOT</version>
+        <version>0.6.0-SNAPSHOT</version>
     </parent>
 
     <artifactId>without-modules</artifactId>
 
-</project>
+</project>