Implement distanceOrZero to have 0 instead of depth when tag is not found

Author: Marc ROZANC

src/main/java/me/qoomon/gitversioning/commons/GitDescription.java

@@ -4,11 +4,13 @@ public class GitDescription {
     private final String commit;
     private final String tag;
     private final int distance;
+    private final boolean foundTag;
 
-    public GitDescription(String commit, String tag, int distance) {
+    public GitDescription(String commit, String tag, int distance, boolean foundTag) {
         this.commit = commit;
         this.tag = tag;
         this.distance = distance;
+        this.foundTag = foundTag;
     }
 
     public String getCommit() {
@@ -23,6 +25,10 @@ public int getDistance() {
         return distance;
     }
 
+    public int getDistanceOrZero() {
+        return foundTag ? distance : 0;
+    }
+
     @Override
     public String toString() {
         return tag + "-" + distance + "-g" + commit.substring(0,7);

src/main/java/me/qoomon/gitversioning/commons/GitUtil.java

@@ -53,7 +53,7 @@ public static List<String> tagsPointAt(ObjectId revObjectId, Repository reposito
     public static GitDescription describe(ObjectId revObjectId, Pattern tagPattern, Repository repository, boolean firstParent) throws IOException {
         Repository commonRepository = worktreesFix_getCommonRepository(repository);
         if (revObjectId == null) {
-            return new GitDescription(NO_COMMIT, "root", 0);
+            return new GitDescription(NO_COMMIT, "root", 0, false);
         }
 
         Map<ObjectId, List<String>> objectIdListMap = reverseTagRefMap(repository);
@@ -72,7 +72,7 @@ public static GitDescription describe(ObjectId revObjectId, Pattern tagPattern,
                         .findFirst();
 
                 if (matchingTag.isPresent()) {
-                    return new GitDescription(revObjectId.getName(), matchingTag.get(), depth);
+                    return new GitDescription(revObjectId.getName(), matchingTag.get(), depth, true);
                 }
                 depth++;
             }
@@ -81,7 +81,7 @@ public static GitDescription describe(ObjectId revObjectId, Pattern tagPattern,
                 throw new IllegalStateException("couldn't find matching tag in shallow git repository");
             }
 
-            return new GitDescription(revObjectId.getName(), "root", depth);
+            return new GitDescription(revObjectId.getName(), "root", depth, false);
         }
     }
 

src/main/java/me/qoomon/maven/gitversioning/GitVersioningModelProcessor.java

@@ -966,14 +966,9 @@ private Map<String, Supplier<String>> generateGlobalFormatPlaceholderMap(GitSitu
         placeholderMap.put("describe.tag.version.label.next", Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.label").get(), 1)));
 
         final Lazy<Integer> descriptionDistance = Lazy.by(() -> description.get().getDistance());
-        placeholderMap.put("describe.distance", Lazy.by(() -> String.valueOf(descriptionDistance.get())));
-        placeholderMap.put("describe.distance.snapshot", Lazy.by(() -> (descriptionDistance.get() == 0 ? "" : "-SNAPSHOT")));
-
-        placeholderMap.put("describe.tag.version.patch.plus.describe.distance", Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.patch").get(), descriptionDistance.get())));
-        placeholderMap.put("describe.tag.version.patch.next.plus.describe.distance", Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.patch.next").get(), descriptionDistance.get())));
-
-        placeholderMap.put("describe.tag.version.label.plus.describe.distance", Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.label").get(), descriptionDistance.get())));
-        placeholderMap.put("describe.tag.version.label.next.plus.describe.distance", Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.label.next").get(), descriptionDistance.get())));
+        setDescribeDistancePlaceholders(placeholderMap, descriptionDistance, "distance");
+        final Lazy<Integer> descriptionDistanceOrZero = Lazy.by(() -> description.get().getDistanceOrZero());
+        setDescribeDistancePlaceholders(placeholderMap, descriptionDistanceOrZero, "distanceOrZero");
 
         // describe tag pattern groups
         final Lazy<Map<String, String>> describeTagPatternValues = Lazy.by(
@@ -1002,6 +997,17 @@ private Map<String, Supplier<String>> generateGlobalFormatPlaceholderMap(GitSitu
         return placeholderMap;
     }
 
+    private static void setDescribeDistancePlaceholders(Map<String, Supplier<String>> placeholderMap, Lazy<Integer> descriptionDistance, String distanceName) {
+        placeholderMap.put("describe." + distanceName, Lazy.by(() -> String.valueOf(descriptionDistance.get())));
+        placeholderMap.put("describe." + distanceName + ".snapshot", Lazy.by(() -> (descriptionDistance.get() == 0 ? "" : "-SNAPSHOT")));
+
+        placeholderMap.put("describe.tag.version.patch.plus.describe." + distanceName, Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.patch").get(), descriptionDistance.get())));
+        placeholderMap.put("describe.tag.version.patch.next.plus.describe." + distanceName, Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.patch.next").get(), descriptionDistance.get())));
+
+        placeholderMap.put("describe.tag.version.label.plus.describe." + distanceName, Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.label").get(), descriptionDistance.get())));
+        placeholderMap.put("describe.tag.version.label.next.plus.describe." + distanceName, Lazy.by(() -> increase(placeholderMap.get("describe.tag.version.label.next").get(), descriptionDistance.get())));
+    }
+
     private Matcher matchVersion(String input) {
         Matcher matcher = VERSION_PATTERN.matcher(input);
         //noinspection ResultOfMethodCallIgnored

src/test/java/me/qoomon/gitversioning/commons/GitUtilTest.java

@@ -1,6 +1,7 @@
 package me.qoomon.gitversioning.commons;
 
 
+import org.assertj.core.api.SoftAssertions;
 import org.eclipse.jgit.api.Git;
 import org.eclipse.jgit.api.Status;
 import org.eclipse.jgit.api.errors.GitAPIException;
@@ -16,6 +17,7 @@
 import java.util.regex.Pattern;
 
 import static org.assertj.core.api.Assertions.assertThat;
+import static org.assertj.core.api.SoftAssertions.assertSoftly;
 import static org.eclipse.jgit.lib.Constants.HEAD;
 import static org.eclipse.jgit.lib.Constants.MASTER;
 
@@ -192,9 +194,24 @@ void describe() throws Exception {
         // then
         assertThat(description).satisfies(it -> {
             assertThat(it.getCommit()).isEqualTo(givenCommit.getName());
-            assertThat(it.getDistance()).isEqualTo(0);
+            assertThat(it.getDistance()).isZero();
+            assertThat(it.getDistanceOrZero()).isZero();
             assertThat(it.getTag()).isEqualTo(givenTagName);
         });
     }
 
+    @Test
+    void distanceOrZeroIsZeroWhenNoTagMatches() throws Exception {
+        // given
+        Git git = Git.init().setInitialBranch(MASTER).setDirectory(tempDir.toFile()).call();
+
+        final var softly = new SoftAssertions();
+        for (int i = 0; i < 3; ++i) {
+            GitDescription description = GitUtil.describe(head(git), Pattern.compile("v.+"), git.getRepository(), true);
+            softly.assertThat(description.getDistanceOrZero()).isZero();
+            softly.assertThat(description.getDistance()).isEqualTo(i);
+            git.commit().setMessage("commit " + (i + 1)).setAllowEmpty(true).call();
+        }
+        softly.assertAll();
+    }
 }