mining: pass compiler options to hint guards

Author: carstenartur

sandbox_mining_cli/src/main/java/org/sandbox/mining/scanner/SourceScanner.java

@@ -22,6 +22,7 @@
 import java.nio.file.attribute.BasicFileAttributes;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.Map;
 
 import org.eclipse.jdt.core.dom.CompilationUnit;
 import org.sandbox.jdt.triggerpattern.api.BatchTransformationProcessor;
@@ -35,6 +36,8 @@
  */
 public class SourceScanner {
 
+	private static final Map<String, String> NO_COMPILER_OPTIONS = Map.of();
+
 	private final StandaloneAstParser parser;
 	private final int maxFiles;
 
@@ -81,7 +84,7 @@ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) {
 					if (javaFiles.size() >= maxFiles) {
 						return FileVisitResult.TERMINATE;
 					}
-					if (file.toString().endsWith(".java")) {
+					if (file.toString().endsWith(".java")) { //$NON-NLS-1$
 						javaFiles.add(file);
 					}
 					return FileVisitResult.CONTINUE;
@@ -98,7 +101,7 @@ public FileVisitResult visitFileFailed(Path file, IOException exc) {
 	}
 
 	/**
-	 * Scans all Java files using the given hint file and produces a mining report.
+	 * Scans all Java files using the given hint files and produces a mining report.
 	 *
 	 * @param repoName  name of the repository being scanned
 	 * @param rootDir   the root directory of the cloned repository
@@ -109,37 +112,57 @@ public FileVisitResult visitFileFailed(Path file, IOException exc) {
 	 */
 	public MiningReport scan(String repoName, Path rootDir, List<String> subPaths, List<HintFile> hintFiles)
 			throws IOException {
-			MiningReport report = new MiningReport();
-			List<Path> javaFiles = findJavaFiles(rootDir, subPaths);
-			report.addFileCount(repoName, javaFiles.size());
-
-			for (HintFile hintFile : hintFiles) {
-				BatchTransformationProcessor processor = new BatchTransformationProcessor(hintFile);
-
-				for (Path javaFile : javaFiles) {
-					String source = Files.readString(javaFile, StandardCharsets.UTF_8);
-					CompilationUnit cu = parser.parse(source);
-					List<TransformationResult> results = processor.process(cu);
-
-					for (TransformationResult result : results) {
-						String relativePath = rootDir.relativize(javaFile).toString();
-						int line = cu.getLineNumber(result.match().getOffset());
-						String hintFileName = hintFile.getId() != null ? hintFile.getId() : "unknown";
-						TransformationRule rule = result.rule();
-						String ruleName = rule.getDescription();
-						if (ruleName == null) {
-							ruleName = rule.getRuleId();
-						}
-						if (ruleName == null) {
-							int ruleIndex = hintFile.getRules().indexOf(rule);
-							ruleName = ruleIndex >= 0 ? hintFileName + (ruleIndex + 1) : hintFileName;
-						}
-						report.addMatch(repoName, hintFileName, ruleName, relativePath, line, result.matchedText(),
-								result.hasReplacement() ? result.replacement() : null);
+		return scan(repoName, rootDir, subPaths, hintFiles, NO_COMPILER_OPTIONS);
+	}
+
+	/**
+	 * Scans all Java files using the given hint files and compiler options, producing
+	 * a mining report. Compiler options are forwarded to guard evaluation so rules
+	 * such as {@code sourceVersionGE(11)} behave like they do in Eclipse cleanup
+	 * execution.
+	 *
+	 * @param repoName        name of the repository being scanned
+	 * @param rootDir         the root directory of the cloned repository
+	 * @param subPaths        optional sub-paths to restrict scanning to
+	 * @param hintFiles       list of parsed hint files to apply
+	 * @param compilerOptions compiler options for guard evaluation
+	 * @return the mining report with all matches
+	 * @throws IOException if file reading fails
+	 */
+	public MiningReport scan(String repoName, Path rootDir, List<String> subPaths, List<HintFile> hintFiles,
+			Map<String, String> compilerOptions) throws IOException {
+		MiningReport report = new MiningReport();
+		Map<String, String> effectiveCompilerOptions = compilerOptions != null ? compilerOptions : NO_COMPILER_OPTIONS;
+		List<Path> javaFiles = findJavaFiles(rootDir, subPaths);
+		report.addFileCount(repoName, javaFiles.size());
+
+		for (HintFile hintFile : hintFiles) {
+			BatchTransformationProcessor processor = new BatchTransformationProcessor(hintFile);
+
+			for (Path javaFile : javaFiles) {
+				String source = Files.readString(javaFile, StandardCharsets.UTF_8);
+				CompilationUnit cu = parser.parse(source);
+				List<TransformationResult> results = processor.process(cu, effectiveCompilerOptions);
+
+				for (TransformationResult result : results) {
+					String relativePath = rootDir.relativize(javaFile).toString();
+					int line = cu.getLineNumber(result.match().getOffset());
+					String hintFileName = hintFile.getId() != null ? hintFile.getId() : "unknown"; //$NON-NLS-1$
+					TransformationRule rule = result.rule();
+					String ruleName = rule.getRuleId();
+					if (ruleName == null || ruleName.isBlank()) {
+						ruleName = rule.getDescription();
 					}
+					if (ruleName == null || ruleName.isBlank()) {
+						int ruleIndex = hintFile.getRules().indexOf(rule);
+						ruleName = ruleIndex >= 0 ? hintFileName + (ruleIndex + 1) : hintFileName;
+					}
+					report.addMatch(repoName, hintFileName, ruleName, relativePath, line, result.matchedText(),
+							result.hasReplacement() ? result.replacement() : null);
 				}
 			}
+		}
 
-			return report;
+		return report;
 	}
-}
+}