Adding support for format

Author: GladeDiviney

README.md

@@ -8,7 +8,7 @@ A gradle plugin to calculate Android-friendly version names and codes from git t
 Add the plugin the top of your `app/build.gradle` (or equivalent):
 ```groovy
 plugins {
-    id 'com.gladed.androidgitversion' version '0.2.13'
+    id 'com.gladed.androidgitversion' version '0.2.18'
 }
 ```
 
@@ -82,6 +82,7 @@ androidGitVersion {
     parts 2
     baseCode 2000
     hideBranches = [ 'develop' ]
+    format = '%tag%%.count%%<commit>%%-branch%%...dirty%'
 }
 ```
 
@@ -128,7 +129,7 @@ Use caution when increasing this value, as the maximum version code is 214748364
 The default number of parts is 3.
 
 ### baseCode (int)
-`baseCode` set a floor for all generated version codes. Use this when you have already released a version with a code, and don't want to go backwards.
+`baseCode` sets a floor for all generated version codes. Use this when you have already released a version with a code, and don't want to go backwards.
 
 The default baseCode is 0.
 
@@ -137,6 +138,13 @@ The default baseCode is 0.
 
 The default hideBranches are `[ 'master', 'release' ]`, meaning that intermediate builds will not show these branch names.
 
+### format (string)
+`format` defines the form of the version name.
+
+Parts include `tag` (the last tag), `count` (number of commits, if any, since last tag), `commit` (most recent commit prefix, if any, since the last tag), `branch` (branch name, if current branch is not in `hideBranches`), and `dirty` (inserting the word "dirty" if the build was made with uncommitted changes).
+
+Parts are delimited as `%PARTNAME%`. Other characters appearing between % marks are preserved. Parts may be omitted in which case they will not appear in the version name.
+
 ## License
 
 All code here is Copyright 2015 by Glade Diviney, and licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0).

build.gradle

@@ -6,7 +6,7 @@ buildscript {
         }
     }
     dependencies {
-        classpath 'com.gradle.publish:plugin-publish-plugin:0.9.2'
+        classpath 'com.gradle.publish:plugin-publish-plugin:0.9.5'
     }
 }
 
@@ -31,7 +31,7 @@ task wrapper(type: Wrapper) {
     gradleVersion = '2.4'
 }
 
-version = '0.2.13'
+version = '0.2.18'
 group = 'com.gladed.gradle.androidgitversion'
 
 pluginBundle {

src/main/groovy/com/gladed/gradle/androidgitversion/AndroidGitVersion.groovy

@@ -68,6 +68,11 @@ class AndroidGitVersionExtension {
      */
     List<String> hideBranches = [ "master", "release" ]
 
+    /**
+     * Format of version string.
+     */
+    String format = '%tag%%-count%%-commit%%-branch%%-dirty%'
+
     /** Project referenced by this plugin extension */
     private Project project
     private Results results
@@ -86,15 +91,24 @@ class AndroidGitVersionExtension {
         String name = results.lastVersion
 
         if (name.equals("unknown")) return name
+        name = this.format
 
+        def parts = [tag: results.lastVersion]
         if (results.revCount > 0) {
-            name += "-${results.revCount}-${results.commitPrefix}"
+            parts['count'] = results.revCount
+            parts['commit'] = results.commitPrefix
             if (!hideBranches.contains(results.branchName)) {
-                name += "-" + results.branchName.replaceAll("[^a-zA-Z0-9.-]", "_")
+                parts['branch'] = results.branchName.replaceAll("[^a-zA-Z0-9.-]", "_")
             }
         }
+        if (results.dirty) parts['dirty'] = 'dirty'
 
-        if (results.dirty) name += "-dirty"
+        parts.each { part, value ->
+            name = name.replaceAll(/%([^%]*)$part([^%]*)%/) { all, start, end ->
+                start + value + end
+            }
+        }
+        name = name.replaceAll(/%[^%]+%/,'')
 
         return name
     }

src/test/groovy/com/gladed/gradle/androidgitversion/AndroidGitVersionTest.groovy

@@ -237,6 +237,33 @@ class AndroidGitVersionTest extends GroovyTestCase {
         }
     }
 
+    void testFormat() {
+        addCommit()
+        addTag("1.0")
+        addBranch("release/1.x")
+        new File(projectFolder.root, "build.gradle").append("// addition 1")
+        addCommit()
+        new File(projectFolder.root, "build.gradle").append("// addition 2") // Dirty
+
+        plugin.format = '%tag%%!count%%_commit%%.branch%%+dirty%'
+        // Should be something like '1.0!1_10a984.release_1.x+dirty'
+        assert plugin.name().startsWith('1.0!1_')
+        assert plugin.name().endsWith('.release_1.x+dirty')
+    }
+
+    void testCleanFormat() {
+        addCommit()
+        addTag("1.0")
+        addBranch("release/1.x")
+        new File(projectFolder.root, "build.gradle").append("// addition 1")
+        addCommit()
+
+        plugin.format = '%tag%%!count%%(commit)%%.branch%%+dirty%'
+        // Should be something like '1.0!1_10a984.release_1.x'
+        assert plugin.name().startsWith('1.0!1(')
+        assert plugin.name().endsWith(').release_1.x')
+    }
+
     private void addCommit() {
         new File(projectFolder.root, "build.gradle").append("// addition")
         git.add().addFilepattern("build.gradle").call()