feat: add git describe placeholers

Author: qoomon

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 6.3.0 (unreleased)
+* **Features**
+    * add git describe version placeholders
+      enable describe feature by set config `describeTagPattern` at root level or at branch/tag config level
+        * new placeholders
+            * `${describe}`
+            * `${describe.tag}`
+                * `${describe.<TAG_PATTERN_GROUP_NAME or TAG_PATTERN_GROUP_INDEX>}`
+            * `${describe.distance}`
+
+    
 ## 4.1.0
 * **Features**
   * add ability to define default or overwrite values for version and property format.

build.gradle

@@ -12,7 +12,7 @@ plugins {
 }
 
 group 'me.qoomon'
-version '4.2.1'
+version '4.3.0'
 
 sourceCompatibility = JavaVersion.VERSION_1_8
 targetCompatibility = JavaVersion.VERSION_1_8

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

@@ -0,0 +1,30 @@
+package me.qoomon.gitversioning.commons;
+
+public class GitDescription {
+    private final String commit;
+    private final String tag;
+    private final int distance;
+
+    public GitDescription(String commit, String tag, int distance) {
+        this.commit = commit;
+        this.tag = tag;
+        this.distance = distance;
+    }
+
+    public String getCommit() {
+        return commit;
+    }
+
+    public String getTag() {
+        return tag;
+    }
+
+    public int getDistance() {
+        return distance;
+    }
+
+    @Override
+    public String toString() {
+        return tag + "-" + distance + "-g" + commit.substring(0,7);
+    }
+}

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

@@ -1,119 +1,118 @@
 package me.qoomon.gitversioning.commons;
 
+import org.eclipse.jgit.lib.ObjectId;
+import org.eclipse.jgit.lib.Ref;
+import org.eclipse.jgit.lib.Repository;
 
 import java.io.File;
-import java.time.Instant;
+import java.io.IOException;
 import java.time.ZonedDateTime;
 import java.util.List;
+import java.util.Map;
+import java.util.regex.Pattern;
 
+import static java.time.Instant.EPOCH;
 import static java.time.ZoneOffset.UTC;
 import static java.util.Collections.emptyList;
-import static java.util.Objects.requireNonNull;
+import static me.qoomon.gitversioning.commons.GitUtil.NO_COMMIT;
+import static org.eclipse.jgit.lib.Constants.HEAD;
 
+//TODO rename to GitSituation
 public class GitSituation {
 
-    public static String NO_COMMIT = "0000000000000000000000000000000000000000";
-
+    private final Repository repository;
     private final File rootDirectory;
-    private final String headCommit;
-    private final long headCommitTimestamp;
-    private final String headBranch;
-    private final List<String> headTags;
-    private final boolean clean;
 
-    public GitSituation(File rootDirectory, String headCommit, long headCommitTimestamp, String headBranch, List<String> headTags, boolean clean) {
-        this.rootDirectory = requireNonNull(rootDirectory);
-        this.headCommit = requireNonNull(headCommit);
-        this.headCommitTimestamp = headCommitTimestamp;
-        this.headBranch = headBranch;
-        this.headTags = requireNonNull(headTags);
-        this.clean = clean;
+    private final ObjectId head;
+    private final String hash;
+    private final Lazy<ZonedDateTime> timestamp = Lazy.of(this::timestamp);
+    private Lazy<String> branch = Lazy.of(this::branch);
+
+    private final Lazy<Map<ObjectId, List<Ref>>> reverseTagRefMap = Lazy.of(this::reverseTagRefMap);
+    private Lazy<List<String>> tags = Lazy.of(this::tags);
+
+    private final Lazy<Boolean> clean = Lazy.of(this::clean);
+
+    private final Pattern describeTagPattern;
+    private final Lazy<GitDescription> description = Lazy.of(this::describe);
+
+    public GitSituation(Repository repository, Pattern describeTagPattern) throws IOException {
+        this.repository = repository;
+        this.rootDirectory = repository.getWorkTree();
+        this.head = repository.resolve(HEAD);
+        this.hash = head != null ? head.getName() : NO_COMMIT;
+        this.describeTagPattern = describeTagPattern != null ? describeTagPattern : Pattern.compile(".*");
+    }
+
+    public GitSituation(Repository repository) throws IOException {
+        this(repository, null);
     }
 
     public File getRootDirectory() {
         return rootDirectory;
     }
 
-    public String getHeadCommit() {
-        return headCommit;
+    public String getHash() {
+        return hash;
     }
 
-    public long getHeadCommitTimestamp() {
-        return headCommitTimestamp;
+    public ZonedDateTime getTimestamp() {
+        return timestamp.get();
     }
 
-    public ZonedDateTime getHeadCommitDateTime() {
-        Instant headCommitTimestamp = Instant.ofEpochSecond(getHeadCommitTimestamp());
-        return ZonedDateTime.ofInstant(headCommitTimestamp, UTC);
+    public String getBranch() {
+        return branch.get();
     }
 
-    public String getHeadBranch() {
-        return headBranch;
+    public void setBranch(String branch) {
+        this.branch = Lazy.of(branch);
     }
 
-    public List<String> getHeadTags() {
-        return headTags;
+    public boolean isDetached() {
+        return branch.get() == null;
+    }
+
+    public List<String> getTags() {
+        return tags.get();
+    }
+
+    public void setTags(List<String> tags) {
+        this.tags = Lazy.of(tags);
     }
 
     public boolean isClean() {
-        return clean;
+        return clean.get();
     }
 
-    public boolean isDetached() {
-        return headBranch == null;
-    }
-
-    public static class Builder {
-        private File rootDirectory;
-        private String headCommit = NO_COMMIT;
-        private long headCommitTimestamp = 0;
-        private String headBranch = null;
-        private List<String> headTags = emptyList();
-        private boolean clean = true;
-
-
-        public Builder setRootDirectory(File rootDirectory) {
-            this.rootDirectory = rootDirectory;
-            return this;
-        }
-
-        public Builder setHeadCommit(String headCommit) {
-            this.headCommit = headCommit;
-            return this;
-        }
-
-        public Builder setHeadCommitTimestamp(long headCommitTimestamp) {
-            this.headCommitTimestamp = headCommitTimestamp;
-            return this;
-        }
-
-        public Builder setHeadBranch(String headBranch) {
-            this.headBranch = headBranch;
-            return this;
-        }
-
-        public Builder setHeadTags(List<String> headTags) {
-            this.headTags = headTags;
-            return this;
-        }
-
-        public Builder setClean(boolean clean) {
-            this.clean = clean;
-            return this;
-        }
-
-        public GitSituation build() {
-            return new GitSituation(rootDirectory, headCommit, headCommitTimestamp, headBranch, headTags, clean);
-        }
-
-        public static Builder of(GitSituation gitSituation) {
-            return new Builder()
-                    .setRootDirectory(gitSituation.rootDirectory)
-                    .setClean(gitSituation.clean)
-                    .setHeadCommit(gitSituation.headCommit)
-                    .setHeadCommitTimestamp(gitSituation.headCommitTimestamp)
-                    .setHeadBranch(gitSituation.headBranch)
-                    .setHeadTags(gitSituation.headTags);
-        }
+    public GitDescription getDescription() {
+        return description.get();
+    }
+
+    // ----- initialization methods ------------------------------------------------------------------------------------
+
+    private ZonedDateTime timestamp() throws IOException {
+        return head != null
+                ? GitUtil.revTimestamp(repository, head)
+                : ZonedDateTime.ofInstant(EPOCH, UTC);
+    }
+
+    private String branch() throws IOException {
+        return GitUtil.branch(repository);
+    }
+
+    private List<String> tags() {
+        return head != null ? GitUtil.tagsPointAt(repository, head, reverseTagRefMap.get()) : emptyList();
+    }
+
+    private boolean clean() {
+        return GitUtil.status(repository).isClean();
+    }
+
+    private GitDescription describe() throws IOException {
+        return GitUtil.describe(repository, head, describeTagPattern, reverseTagRefMap.get());
+    }
+
+    private Map<ObjectId, List<Ref>> reverseTagRefMap() throws IOException {
+        return GitUtil.reverseTagRefMap(repository);
     }
 }