Add --commit argument to allow specifying which commit/reference to use instead of HEAD

Migrate cli code to sub-project so Eclipse works
Relocate all shaded libraries

Author: LexManos

.gitignore

@@ -14,4 +14,4 @@
 /output/
 
 # Jonathan's IntelliJ Fuckery
-/.idea/
+/**/.idea/

build.gradle

@@ -24,27 +24,10 @@ java {
     withSourcesJar()
 }
 
-final cli = sourceSets.create('cli')
-
 configurations {
-    dependencyScope('cliShadowImplementation')
-    dependencyScope('cliShadowRuntimeOnly')
-
-    resolvable('cliShadowClasspath') {
-        extendsFrom cliShadowImplementation, cliShadowRuntimeOnly
-    }
-
-    named(cli.runtimeClasspathConfigurationName) {
-        extendsFrom runtimeClasspath
-    }
-
-    named(cli.implementationConfigurationName) {
-        extendsFrom cliShadowImplementation
-    }
-
-    named(cli.runtimeOnlyConfigurationName) {
-        extendsFrom cliShadowRuntimeOnly
-    }
+	cli {
+	    extendsFrom implementation
+	}
 }
 
 dependencies {
@@ -60,10 +43,7 @@ dependencies {
     // JSON Output
     implementation libs.gson
 
-    // CLI
-    cliImplementation sourceSets.main.output
-    cliShadowImplementation libs.jopt
-    cliShadowRuntimeOnly libs.slf4j
+    cli project(':gitversion-cli')
 }
 
 license {
@@ -93,10 +73,27 @@ tasks.named('shadowJar', ShadowJar) {
     }
 
     archiveClassifier = 'fatjar'
-    from cli.output
-    configurations = provider { [ project.configurations.getByName('runtimeClasspath'), project.configurations.getByName('cliShadowClasspath') ] }
 
-    minimize()
+    configurations = project.configurations.named('cli').map { [it] }
+
+    enableAutoRelocation = true
+    relocationPrefix = 'net.minecraftforge.gitver.shadow'
+    relocate('net.minecraftforge.gitver', 'net.minecraftforge.gitver')
+    // Rewrite JOpt's message files, so that help text is displayed nicely.
+    transform(com.github.jengelman.gradle.plugins.shadow.transformers.PropertiesFileTransformer) {
+        paths = [ 'Messages.properties$' ]
+        keyTransformer = { key -> 'net.minecraftforge.gitver.shadow.' + key }
+    }
+    transform(com.github.jengelman.gradle.plugins.shadow.transformers.Log4j2PluginsCacheFileTransformer)
+    transform(com.github.jengelman.gradle.plugins.shadow.transformers.ServiceFileTransformer)
+
+    minimize {
+        exclude(project(':gitversion-cli'))
+    }
+
+    exclude('OSGI-INF/**')
+    exclude('META-INF/maven/**')
+    exclude('META-INF/proguard/**')
 }
 
 changelog {

gitversion-cli/build.gradle

@@ -0,0 +1,21 @@
+plugins {
+	id 'application'
+}
+
+group = 'net.minecraftforge'
+version = gitversion.tagOffset
+
+java {
+    toolchain.languageVersion = JavaLanguageVersion.of(17)
+    withSourcesJar()
+}
+
+application {
+    mainClass = 'net.minecraftforge.gitver.cli.Main'
+}
+
+dependencies {
+    implementation rootProject
+    implementation libs.jopt
+    runtimeOnly libs.slf4j
+}

src/cli/java/module-info.java …rsion-cli/src/main/java/module-info.javasrc/cli/java/module-info.java renamed to gitversion-cli/src/main/java/module-info.java src/cli/java/module-info.java renamed to gitversion-cli/src/main/java/module-info.java

@@ -83,6 +83,11 @@ The root directory to use (ideally containing the .git directory).
             If the generated changelog should be in plain text instead of Markdown.""")
             .availableIf(changelogO);
 
+        var commitO = parser.accepts("commit",
+    		"The commit or reference to use instead of HEAD")
+    		.availableUnless(changelogO)
+    		.withRequiredArg().ofType(String.class);
+
         var jsonO = parser.accepts("json",
             """
             Use to output the Git Version info as JSON.
@@ -103,13 +108,15 @@ The root directory to use (ideally containing the .git directory).
         var rootDir = options.valueOfOptional(rootDir0).orElse(null);
         var gitDir = options.valueOfOptional(gitDir0).orElse(null);
         var output = options.valueOfOptional(outputO).orElse(null);
+        var commit = options.valueOfOptional(commitO).orElse(null);
         try (var version = GitVersion
             .builder()
             .gitDir(gitDir)
             .root(rootDir)
             .project(projectDir)
             .config(configFile)
             .strict(strict)
+            .commit(commit)
             .build()
         ) {
             String result;

…/net/minecraftforge/gitver/cli/Main.java …/net/minecraftforge/gitver/cli/Main.javasrc/cli/java/net/minecraftforge/gitver/cli/Main.java renamed to gitversion-cli/src/main/java/net/minecraftforge/gitver/cli/Main.java src/cli/java/net/minecraftforge/gitver/cli/Main.java renamed to gitversion-cli/src/main/java/net/minecraftforge/gitver/cli/Main.java

@@ -27,7 +27,7 @@ dependencyResolutionManagement {
     versionCatalogs.register('libs') {
         // Plugins
         plugin 'licenser',      'net.minecraftforge.licenser'    version '1.2.0'
-        plugin 'gradleutils',   'net.minecraftforge.gradleutils' version '3.3.33'
+        plugin 'gradleutils',   'net.minecraftforge.gradleutils' version '3.4.1'
         plugin 'shadow',        'com.gradleup.shadow'            version '9.2.2'
 
         // Git
@@ -37,7 +37,7 @@ dependencyResolutionManagement {
         library 'toml', 'org.tomlj', 'tomlj' version '1.1.1'
 
         // JSON Output
-        library 'gson', 'com.google.code.gson', 'gson' version '2.13.1'
+        library 'gson', 'com.google.code.gson', 'gson' version '2.13.2'
 
         // CLI
         library 'jopt',  'net.sf.jopt-simple', 'jopt-simple'  version '6.0-alpha-3'
@@ -48,3 +48,5 @@ dependencyResolutionManagement {
     }
     //@formatter:on
 }
+
+include 'gitversion-cli'

settings.gradle

@@ -78,6 +78,8 @@ sealed interface Builder permits GitVersionInternal.Builder {
 
         Builder strict(boolean strict);
 
+        Builder commit(@Nullable String ref);
+
         /**
          * Builds the GitVersion instance.
          *

src/main/java/net/minecraftforge/gitver/api/GitVersion.java

@@ -84,6 +84,31 @@ static int countCommits(Git git, String tag, String tagPrefix, Iterable<String>
         return countCommits(git, GitUtils.getCommitToTagMap(git), ObjectId.fromString(commitHash), tagPrefix, includePaths, excludePaths);
     }
 
+    /**
+     * Counts commits, for the given Git repository, from the given tag to {@linkplain Constants#HEAD HEAD}. If the
+     * given tag cannot be found, this method will return {@code -1}.
+     * <p>
+     * See {@link #countCommits(Git, Map, ObjectId, String, Iterable, Iterable)} for more information.
+     *
+     * @param git          The git repository to count commits in
+     * @param tag          The tag name to start counting from
+     * @param to           The object ID (typically a commit or tag reference) to stop counting at, typically HEAD
+     * @param includePaths The paths to include in the count
+     * @param excludePaths The paths to exclude from the count
+     * @return The commit count
+     * @throws GitAPIException If an error occurs when running the log command (see
+     *                         {@link org.eclipse.jgit.api.LogCommand#call() LogCommand.call()}
+     * @throws IOException     If an I/O error occurs when reading the Git repository
+     * @see #countCommits(Git, Map, ObjectId, String, Iterable, Iterable)
+     */
+    static int countCommits(Git git, String tag, ObjectId to, String tagPrefix, Iterable<String> includePaths, Iterable<String> excludePaths) throws GitAPIException, IOException {
+        var tags = GitUtils.getTagToCommitMap(git);
+        var commitHash = tags.get(tag);
+        if (commitHash == null) return -1;
+
+        return countCommits(git, GitUtils.getCommitToTagMap(git), ObjectId.fromString(commitHash), to, tagPrefix, includePaths, excludePaths);
+    }
+
     /**
      * Counts commits, for the given Git repository, from the given object ID to {@linkplain Constants#HEAD HEAD}.
      * Additional paths can be given to include or exclude from the count.
@@ -108,6 +133,31 @@ static int countCommits(Git git, Map<String, String> commitsToTags, ObjectId fro
         return Util.count(getCommitLogFromTo(git, commitsToTags, from, getHead(git), tagPrefix, includePaths, excludePaths));
     }
 
+    /**
+     * Counts commits, for the given Git repository, from the given object ID to the other given object ID..
+     * Additional paths can be given to include or exclude from the count.
+     * <p>
+     * An important detail to note is that the commit given is <strong>not included</strong> in the count. This means
+     * that if the given commit is also the HEAD, the returned count will be {@code 0}. Additionally, if there are no
+     * commits barring the paths given from the object ID, the count will be {@code -1}. Please handle this
+     * accordingly.
+     *
+     * @param git          The git repository to count commits in
+     * @param from         The object ID (typically a commit or tag reference) to start counting from
+     * @param to           The object ID (typically a commit or tag reference) to stop counting at, typically HEAD
+     * @param includePaths The paths to include in the count
+     * @param excludePaths The paths to exclude from the count
+     * @return The commit count
+     * @throws GitAPIException If an error occurs when running the log command (see
+     *                         {@link org.eclipse.jgit.api.LogCommand#call() LogCommand.call()}
+     * @throws IOException     If an I/O error occurs when reading the Git repository
+     * @see org.eclipse.jgit.api.LogCommand LogCommand
+     * @see <a href="https://git-scm.com/docs/git-log"><code>git-log</code></a>
+     */
+    static int countCommits(Git git, Map<String, String> commitsToTags, ObjectId from, ObjectId to, String tagPrefix, Iterable<String> includePaths, Iterable<String> excludePaths) throws GitAPIException, IOException {
+        return Util.count(getCommitLogFromTo(git, commitsToTags, from, to, tagPrefix, includePaths, excludePaths));
+    }
+
     /**
      * Gets the {@linkplain Constants#HEAD HEAD} commit of the given Git repository.
      *

src/main/java/net/minecraftforge/gitver/internal/GitUtils.java

@@ -29,11 +29,11 @@
 import java.util.Objects;
 import java.util.Set;
 import java.util.function.Function;
-import java.util.function.Predicate;
 
 public final class GitVersionImpl implements GitVersionInternal {
     // Git
     private final boolean strict;
+    private final @Nullable String commit;
     private Git git;
     private final Lazy<Info> info = Lazy.of(() -> this.calculateInfo(this::getSubprojectCommitCount));
     private final Lazy<String> url = Lazy.of(this::calculateUrl);
@@ -61,8 +61,9 @@ public final class GitVersionImpl implements GitVersionInternal {
     private final Set<String> allIncludingPaths;
     private final Set<String> allExcludingPaths;
 
-    public GitVersionImpl(File gitDir, File root, File project, GitVersionConfig config, boolean strict) {
+    public GitVersionImpl(File gitDir, File root, File project, GitVersionConfig config, boolean strict, @Nullable String commit) {
         this.strict = strict;
+        this.commit = commit;
 
         this.gitDir = gitDir;
         this.root = root;
@@ -141,14 +142,32 @@ public GitVersion.Info getInfo() {
         return this.url.get();
     }
 
+    private ObjectId resolve(String ref) {
+        try {
+        	var ret = this.git.getRepository().resolve(ref);
+        	if (ret == null)
+        		throw new IllegalArgumentException("Unknown commit reference: " + ref);
+        	return ret;
+        } catch (IOException e) {
+        	return Util.sneak(e);
+        }
+    }
+
     /** @see #info */
     private Info calculateInfo(CommitCountProvider commitCountProvider) {
         try {
             this.open();
 
+            var commitId = resolve(this.commit == null ? Constants.HEAD : this.commit);
+
             var describedTag = Util.make(this.git.describe(), it -> {
                 it.setTags(true);
                 it.setLong(true);
+                try {
+                	it.setTarget(commitId);
+                } catch (IOException e) {
+                	Util.sneak(e);
+                }
 
                 try {
                     it.setMatch(this.tagPrefix + "[[:digit:]]**");
@@ -180,10 +199,10 @@ private Info calculateInfo(CommitCountProvider commitCountProvider) {
             var tag = desc[0].substring(Util.indexOf(desc[0], Character::isDigit, 0));
 
             var offset = commitCountProvider.getAsString(this.git, desc[0], desc[1], this.strict);
-            var hash = desc[2];
+            var hash = desc[2]; // Technically this has a 'g' prefix but its been around for so long I don't really care
             var branch = longBranch != null ? Repository.shortenRefName(longBranch) : null;
-            var commit = ObjectId.toString(head.getObjectId());
-            var abbreviatedId = head.getObjectId().abbreviate(8).name();
+            var commit = ObjectId.toString(commitId);
+            var abbreviatedId = commitId.abbreviate(8).name();
 
             return new Info(tag, offset, hash, branch, commit, abbreviatedId);
         } catch (Exception e) {
@@ -337,7 +356,8 @@ private int getSubprojectCommitCount(Git git, String tag) {
         if (this.localPath.isEmpty() && this.allExcludingPaths.isEmpty()) return -1;
 
         try {
-            int count = GitUtils.countCommits(git, tag, this.tagPrefix, this.allIncludingPaths, this.allExcludingPaths);
+        	var end = resolve(this.commit == null ? Constants.HEAD : this.commit);
+            int count = GitUtils.countCommits(git, tag, end, this.tagPrefix, this.allIncludingPaths, this.allExcludingPaths);
             return Math.max(count, 0);
         } catch (GitAPIException | IOException e) {
             throw new GitVersionExceptionInternal("Failed to count commits with the following parameters: Tag %s, Include Paths [%s], Exclude Paths [%s]".formatted(tag, String.join(", ", this.allIncludingPaths), String.join(", ", this.allExcludingPaths)));

src/main/java/net/minecraftforge/gitver/internal/GitVersionImpl.java

@@ -33,6 +33,7 @@ final class Builder implements GitVersion.Builder {
         private @Nullable File root;
         private @Nullable File project;
         private @Nullable GitVersionConfig config;
+        private @Nullable String commit;
         private boolean strict = true;
 
         private Builder() { }
@@ -73,6 +74,12 @@ public GitVersion.Builder strict(boolean strict) {
             return this;
         }
 
+        @Override
+        public GitVersion.Builder commit(@Nullable String ref) {
+        	this.commit = ref;
+        	return this;
+        }
+
         @Override
         public GitVersion build() {
             if (this.root == null && this.project == null)
@@ -100,7 +107,7 @@ public GitVersion build() {
                     }
                 }
 
-                return new GitVersionImpl(this.gitDir, this.root, this.project, this.config, this.strict);
+                return new GitVersionImpl(this.gitDir, this.root, this.project, this.config, this.strict, this.commit);
             } catch (GitVersionException e) {
                 if (!this.strict)
                     return GitVersionImpl.empty(this.project);