feat: add ability to define default or overwrite values for version a…

…nd property format

CHANGELOG.md

@@ -4,6 +4,12 @@
 
 # Changelog
 
+## 6.2.0
+* **Features**
+  * add ability to define default or overwrite values for version and property format.
+    * default value if parameter value is not set `${paramter:-<DEFAULT_VALUE>}` e.g. `${buildNumber:-0}`
+    * overwrite value if parameter has a value `${paramter:+<OVERWRITE_VALUE>}` e.g. `${dirty:+-SNAPSHOT}`
+
 ## 6.1.1
 * **Fixes**
   * fixed wrong dependency management version updates.

README.md

@@ -1,4 +1,4 @@
-# Maven Git Versioning Extension
+# Maven Git Versioning Extension [![Sparkline](https://stars.medv.io/qoomon/maven-git-versioning-extension.svg?)](https://stars.medv.io/qoomon/maven-git-versioning-extension)
 
 [![Maven Central](https://img.shields.io/maven-central/v/me.qoomon/maven-git-versioning-extension.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22me.qoomon%22%20AND%20a%3A%22maven-git-versioning-extension%22)
 [![Changelog](https://badgen.net/badge/changelog/%E2%98%85/blue)](CHANGELOG.md)
@@ -113,6 +113,12 @@ Create `${basedir}/.mvn/maven-git-versioning-extension.xml`.
 
 ℹ whole `versionFormat` will be slugified automatically, that means all `/` characters replaced by `-`
 
+ℹ define placeholder default value (placeholder is not defined) like this `${name:-default_value}`<br>
+  e.g `${buildNumber:-0}` or `${buildNumber:-local}` 
+
+ℹ define placeholder overwrite value (placeholder is defined) like this `${name:+overwrite_value}`<br>
+  e.g `${dirty:-SNAPSHOT}` resolves to `-SNAPSHOT` instead of `-DIRTY`
+
 - `${ref}`
     - current ref name (branch name, tag name or commit hash)
 - `${ref.slug}`

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>me.qoomon</groupId>
     <artifactId>maven-git-versioning-extension</artifactId>
-    <version>6.1.1</version>
+    <version>6.2.0</version>
     <packaging>maven-plugin</packaging>
 
     <name>Maven Git Versioning Extension</name>

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

@@ -48,7 +48,6 @@ public static List<String> tag_pointsAt(Repository repository, String revstr) th
                 String tagName = ref.getName().replaceFirst("^" + R_TAGS, "");
                 tagNames.add(tagName);
             }
-            System.out.println("");
         }
         return tagNames;
     }

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

@@ -9,20 +9,30 @@
 
 public final class StringUtil {
 
-    public static String substituteText(String text, Map<String, String> substitutionMap) {
-        String result = text;
-
-        final Pattern placeholderPattern = Pattern.compile("\\$\\{(.+?)}");
-        final Matcher placeholderMatcher = placeholderPattern.matcher(text);
+    public static String substituteText(String text, Map<String, String> replacements) {
+        StringBuffer result = new StringBuffer();
+        Pattern placeholderPattern = Pattern.compile("\\$\\{(?<key>[^}:]+)(?::(?<modifier>[-+])(?<value>[^}]*))?}");
+        Matcher placeholderMatcher = placeholderPattern.matcher(text);
         while (placeholderMatcher.find()) {
-            String substitutionKey = placeholderMatcher.group(1);
-            String substitutionValue = substitutionMap.get(substitutionKey);
-            if(substitutionValue != null) {
-                result = result.replaceAll("\\$\\{" + substitutionKey + "}", substitutionValue.replace("$", "\\$"));
+            String placeholderKey = placeholderMatcher.group("key");
+            String replacement = replacements.get(placeholderKey);
+            String placeholderModifier = placeholderMatcher.group("modifier");
+            if(placeholderModifier != null){
+                if (placeholderModifier.equals("-") && replacement == null) {
+                    replacement = placeholderMatcher.group("value");
+                }
+                if (placeholderModifier.equals("+") && replacement != null) {
+                    replacement = placeholderMatcher.group("value");
+                }
+            }
+            if (replacement != null) {
+                // avoid group name replacement behaviour of replacement parameter value
+                placeholderMatcher.appendReplacement(result, "");
+                result.append(replacement);
             }
         }
-
-        return result;
+        placeholderMatcher.appendTail(result);
+        return result.toString();
     }
 
     /**

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

@@ -2,9 +2,11 @@
 
 import org.junit.jupiter.api.Test;
 
+import java.util.Collections;
 import java.util.HashMap;
 import java.util.Map;
 
+import static java.util.Collections.emptyMap;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.entry;
 
@@ -39,7 +41,7 @@ void substituteText_missingValue() {
     }
 
     @Test
-    void substituteText_escape_replacement_value() {
+    void substituteText_handle_replacement_value_with_placeholder_syntax() {
 
         // Given
         String givenText = "${version}";
@@ -53,6 +55,35 @@ void substituteText_escape_replacement_value() {
         assertThat(outputText).isEqualTo("${something}");
     }
 
+    @Test
+    void substituteText_default_value() {
+
+        // Given
+        String givenText = "${foo:-xxx}";
+        Map<String, String> givenSubstitutionMap = emptyMap();
+
+        // When
+        String outputText = StringUtil.substituteText(givenText, givenSubstitutionMap);
+
+        // Then
+        assertThat(outputText).isEqualTo("xxx");
+    }
+
+    @Test
+    void substituteText_overwrite_value() {
+
+        // Given
+        String givenText = "${foo:+xxx}";
+        Map<String, String> givenSubstitutionMap = new HashMap<>();
+        givenSubstitutionMap.put("foo", "aaa");
+
+        // When
+        String outputText = StringUtil.substituteText(givenText, givenSubstitutionMap);
+
+        // Then
+        assertThat(outputText).isEqualTo("xxx");
+    }
+
 
     @Test
     void valueGroupMap() {