feat: Abstract Git log calls

Author: ibbem

src/main/java/org/variantsync/diffdetective/datasets/CommitLister.java

@@ -0,0 +1,46 @@
+package org.variantsync.diffdetective.datasets;
+
+import java.io.IOException;
+import java.util.Iterator;
+
+import org.eclipse.jgit.api.errors.GitAPIException;
+import org.eclipse.jgit.revwalk.RevCommit;
+import org.tinylog.Logger;
+
+/**
+ * A functional interface for listing the commits in a {@link Repository}.
+ * Apart from listing a fixed set of commits, this is mainly useful to configure a {@link org.eclipse.jgit.api.Git#log() Git log} call.
+ *<p>
+ * This is mainly intended to be used as an argument for the {@code listCommits} argument of
+ * {@link Repository#Repository(RepositoryLocationType, Path, URI, String, Function<Repository, Iterator<RevCommit>>, PatchDiffParseOptions, DiffFilter)}.
+ */
+@FunctionalInterface
+public interface CommitLister {
+	Iterator<RevCommit> listCommits(Repository repository);
+
+	/**
+	 * List all commits reachable by the current {@code HEAD} of the repository.
+	 */
+	public static final CommitLister TraverseHEAD =
+		(Repository repository) -> {
+			try {
+				return repository.getGitRepo().log().call().iterator();
+			} catch (GitAPIException e) {
+				Logger.warn("Could not get log for git repository {}", repository.getRepositoryName());
+				throw new RuntimeException(e);
+			}
+		};
+
+	/**
+	 * List all commits reachable from all branches of the repository.
+	 */
+	public static final CommitLister AllCommits =
+		(Repository repository) -> {
+			try {
+				return repository.getGitRepo().log().all().call().iterator();
+			} catch (GitAPIException | IOException e) {
+				Logger.warn("Could not get log for git repository {}", repository.getRepositoryName());
+				throw new RuntimeException(e);
+			}
+		};
+}

src/main/java/org/variantsync/diffdetective/datasets/Repository.java

@@ -1,7 +1,6 @@
 package org.variantsync.diffdetective.datasets;
 
 import org.eclipse.jgit.api.Git;
-import org.eclipse.jgit.api.errors.GitAPIException;
 import org.eclipse.jgit.lib.ObjectId;
 import org.eclipse.jgit.revwalk.RevCommit;
 import org.tinylog.Logger;
@@ -44,6 +43,11 @@ public class Repository {
 	 */
 	private final String repositoryName;
 
+	/**
+	 * A function that extracts the list of commits that are represented by this repository instance.
+	 */
+	private CommitLister commitLister;
+
 	/**
 	 * Filter determining which files and commits to consider for diffs.
 	 */
@@ -55,14 +59,15 @@ public class Repository {
 	private PatchDiffParseOptions parseOptions;
 
 	private final Lazy<Git> git = Lazy.of(this::load);
-	
+
 	/**
 	 * Creates a repository.
 	 * 
 	 * @param repoLocation {@link RepositoryLocationType} From which location the repository is read from
 	 * @param localPath The local path where the repository can be found or should be cloned to.
 	 * @param remote The remote url of the repository. May be <code>null</code> if local.
 	 * @param repositoryName Name of the cloned repository (<code>null</code> if local)
+	 * @param commitLister extracts the commits from {@link #getGitRepo()} that should be represented.
 	 * @param parseOptions Omit some debug data to save RAM.
 	 * @param diffFilter Filter determining which files and commits to consider for diffs.
 	 */
@@ -71,27 +76,38 @@ public Repository(
 			final Path localPath,
 			final URI remote,
 			final String repositoryName,
+			final CommitLister commitLister,
 			final PatchDiffParseOptions parseOptions,
 			final DiffFilter diffFilter) {
 		this.repoLocation = repoLocation;
 		this.localPath = localPath;
 		this.remote = remote;
 		this.repositoryName = repositoryName;
+		this.commitLister = commitLister;
 		this.parseOptions = parseOptions;
 		this.diffFilter = diffFilter;
 	}
 
 	/**
 	 * Creates repository of the given source and with all other settings set to default values.
 	 * @see Repository
+	 * <p>
+	 * Defaults to {@link CommitLister#TraverseHEAD}, {@link PatchDiffParseOptions#Default} and {@link DiffFilter#ALLOW_ALL}.
 	 */
 	public Repository(
 			final RepositoryLocationType repoLocation,
 			final Path localPath,
 			final URI remote,
 			final String repositoryName) {
-		this(repoLocation, localPath, remote, repositoryName,
-                PatchDiffParseOptions.Default, DiffFilter.ALLOW_ALL);
+		this(
+			repoLocation,
+			localPath,
+			remote,
+			repositoryName,
+			CommitLister.TraverseHEAD,
+			PatchDiffParseOptions.Default,
+			DiffFilter.ALLOW_ALL
+		);
 	}
 
 	/**
@@ -251,12 +267,7 @@ public RevCommit getCommit(String commitHash) throws IOException {
 	 * Returns all commits in the repository's history.
 	 */
 	public Iterator<RevCommit> getCommits() {
-		try {
-			return getGitRepo().log().call().iterator();
-		} catch (GitAPIException e) {
-			Logger.warn("Could not get log for git repository {}", getRepositoryName());
-			throw new RuntimeException(e);
-		}
+		return commitLister.listCommits(this);
 	}
 
 	/**