Removed additional properties and put the build version as a standard property like the build time.

Author: Cousnouf

README.md

@@ -204,6 +204,20 @@ It's really simple to setup this plugin; below is a sample pom that you may base
                       <!-- <excludeProperty>git.user.*</excludeProperty> -->
                     </excludeProperties>
 
+                    <!-- @since 2.1.14 -->
+                    <!--
+                        Can be used to include only certain properties into the resulting file.
+                        Will be overruled by the exclude properties.
+
+                        Each value may be globbing, that is, you can write {@code git.commit.user.*} to include both, the {@code name},
+                        as well as {@code email} properties into the resulting files.
+
+                        Please note that the strings here are Java regexes ({@code .*} is globbing, not plain {@code *}).
+                    -->
+                    <includeOnlyProperties>
+                      <!-- <includeOnlyProperty>^git.commit.id$</includeOnlyProperty> -->
+                    </includeOnlyProperties>
+
                     <!-- @since 2.1.10 -->
                     <!-- 
                       false is default here, if set to true it uses native `git` excutable for extracting all data.
@@ -605,6 +619,7 @@ Optional parameters:
 * **skip** - `(default: false)` *(available since v2.1.8)* - Skip the plugin execution completely.
 * **runOnlyOnce** - `(default: false)` *(available since v2.1.12)* - Use with caution! In a multi-module build, only run once. This means that the plugins effects will only execute once, for the parent project. This probably won't "do the right thing" if your project has more than one git repository. Important: If you're using `generateGitPropertiesFile`, setting `runOnlyOnce` will make the plugin only generate the file in the directory where you started your build :warning:. The `git.*` maven properties are available in all modules.
 * **excludeProperties** - `(default: empty)` *(available since v2.1.9)* - Allows to filter out properties that you *don't* want to expose. This feature was implemented in response to [this issue](https://github.com/ktoso/maven-git-commit-id-plugin/issues/91), so if you're curious about the use-case, check that issue.
+* **includeOnlyProperties** - `(default: empty)` *(available since v2.1.14)* - Allows to include only properties that you want to expose. This feature was implemented to avoid big exclude properties tag when we only want very few specific properties.
 * **useNativeGit** - `(default: false)` *(available since v2.1.10)* - Uses the native `git` binary instead of the custom `jgit` implementation shipped with this plugin to obtain all information. Although this should usualy give your build some performance boost, it may randomly break if you upgrade your git version and it decides to print information in a different format suddenly. As rule of thumb, keep using the default `jgit` implementation (keep this option set to `false`) until you notice performance problems within your build (usualy when you have *hundreds* of maven modules).
 * **abbrevLength** - `(default: 7)` *(available since v2.0.4)* - Configure the "git.commit.id.abbrev" property to be at least of length N (see gitDescribe abbrev for special case abbrev = 0).
 

src/main/java/pl/project13/maven/git/GitCommitIdMojo.java

@@ -73,6 +73,7 @@ public class GitCommitIdMojo extends AbstractMojo {
   public static final String BUILD_AUTHOR_NAME = "build.user.name";
   public static final String BUILD_AUTHOR_EMAIL = "build.user.email";
   public static final String BUILD_TIME = "build.time";
+  public static final String BUILD_VERSION = "build.version";
   public static final String BUILD_HOST = "build.host";
   public static final String COMMIT_AUTHOR_NAME = "commit.user.name";
   public static final String COMMIT_AUTHOR_EMAIL = "commit.user.email";
@@ -296,9 +297,8 @@ public class GitCommitIdMojo extends AbstractMojo {
   private List<String> excludeProperties = Collections.emptyList();
 
   /**
-   * Can be used to exclude certain properties from being emited into the resulting file.
-   * May be useful when you want to hide {@code git.remote.origin.url} (maybe because it contains your repo password?),
-   * or the email of the committer etc.
+   * Can be used to include only certain properties into the resulting file.
+   * Will be overruled by the exclude properties.
    *
    * Each value may be globbing, that is, you can write {@code git.commit.user.*} to include both, the {@code name},
    * as well as {@code email} properties into the resulting files.
@@ -309,20 +309,7 @@ public class GitCommitIdMojo extends AbstractMojo {
    * @since 2.1.14
    */
   @SuppressWarnings("UnusedDeclaration")
-  private List<String> includeProperties = Collections.emptyList();
-
-  /**
-   * Can be used to add some properties in order to gather everything in the same file.
-   *
-   * For instance, you can set the maven project version or any dependency information.
-   *
-   * The key is the property name, the value is the value.
-   *
-   * @parameter
-   * @since 2.1.14
-   */
-  @SuppressWarnings("UnusedDeclaration")
-  private Map<String, String> additionalProperties = Collections.emptyMap();
+  private List<String> includeOnlyProperties = Collections.emptyList();
 
   /**
    * The Maven Session Object
@@ -386,12 +373,11 @@ public void execute() throws MojoExecutionException {
       prefixDot = trimmedPrefix.equals("") ? "" : trimmedPrefix + ".";
 
       loadGitData(properties);
-      loadBuildTimeData(properties);
+      loadBuildVersionAndTimeData(properties);
       loadBuildHostData(properties);
       loadShortDescribe(properties);
-      filter(properties, includeProperties);
+      filter(properties, includeOnlyProperties);
       filterNot(properties, excludeProperties);
-      addAdditionalProperties(properties, additionalProperties);
       logProperties(properties);
 
       if (generateGitPropertiesFile) {
@@ -458,12 +444,6 @@ public Predicate<CharSequence> apply(String exclude) {
     }
   }
 
-  private void addAdditionalProperties(Properties properties, Map<String, String> additionalProperties) {
-    for (Map.Entry<String, String> additionalProperty : additionalProperties.entrySet()) {
-      properties.put(additionalProperty.getKey(), additionalProperty.getValue());
-    }
-  }
-
   /**
    * Reacts to an exception based on the {@code failOnUnableToExtractRepoInfo} setting.
    * If it's true, an MojoExecutionException will be throw, otherwise we just log an error message.
@@ -532,10 +512,11 @@ private boolean isOurProperty(@NotNull String keyString) {
     return keyString.startsWith(prefixDot);
   }
 
-  void loadBuildTimeData(@NotNull Properties properties) {
+  void loadBuildVersionAndTimeData(@NotNull Properties properties) {
     Date buildDate = new Date();
     SimpleDateFormat smf = new SimpleDateFormat(dateFormat);
     put(properties, BUILD_TIME, smf.format(buildDate));
+    put(properties, BUILD_VERSION, project.getVersion());
   }
 
   void loadBuildHostData(@NotNull Properties properties) {
@@ -818,12 +799,8 @@ public void setExcludeProperties(List<String> excludeProperties) {
     this.excludeProperties = excludeProperties;
   }
 
-  public void setIncludeProperties(List<String> includeProperties) {
-    this.includeProperties = includeProperties;
-  }
-
-  public void setAdditionalProperties(Map<String, String> additionalProperties) {
-    this.additionalProperties = additionalProperties;
+  public void setIncludeOnlyProperties(List<String> includeOnlyProperties) {
+    this.includeOnlyProperties = includeOnlyProperties;
   }
 
   public void useNativeGit(boolean useNativeGit) {

src/test/java/pl/project13/maven/git/GitCommitIdMojoTest.java

@@ -67,6 +67,7 @@ public void setUp() throws Exception {
     mojo.runningTests = true;
     mojo.project = mock(MavenProject.class, RETURNS_MOCKS);
     when(mojo.project.getPackaging()).thenReturn("jar");
+    when(mojo.project.getVersion()).thenReturn("3.3-SNAPSHOT");
 
     jGitProvider = JGitProvider.on(mojo.lookupGitDirectory(), mojo.getLoggerBridge());
   }
@@ -123,9 +124,9 @@ public void shouldExcludeAsConfiguredProperties() throws Exception {
   }
 
   @Test
-  public void shouldIncludeAsConfiguredProperties() throws Exception {
+  public void shouldIncludeOnlyAsConfiguredProperties() throws Exception {
     // given
-    mojo.setIncludeProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*", "^git.commit.id$"));
+    mojo.setIncludeOnlyProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*", "^git.commit.id$"));
 
     // when
     mojo.execute();
@@ -154,7 +155,7 @@ public void shouldIncludeAsConfiguredProperties() throws Exception {
   @Test
   public void shouldExcludeAndIncludeAsConfiguredProperties() throws Exception {
     // given
-    mojo.setIncludeProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*"));
+    mojo.setIncludeOnlyProperties(ImmutableList.of("git.remote.origin.url", ".*.user.*"));
     mojo.setExcludeProperties(ImmutableList.of("git.build.user.email"));
 
     // when
@@ -166,7 +167,7 @@ public void shouldExcludeAndIncludeAsConfiguredProperties() throws Exception {
     // explicitly included
     assertThat(properties).satisfies(new ContainsKeyCondition("git.remote.origin.url"));
 
-    // explicitly excluded
+    // explicitly excluded -> overrules include only properties
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.build.user.email"));
 
     // glob included
@@ -183,28 +184,6 @@ public void shouldExcludeAndIncludeAsConfiguredProperties() throws Exception {
     assertThat(properties).satisfies(new DoesNotContainKeyCondition("git.commit.time"));
   }
 
-  @Test
-  public void shouldAddAdditionalProperties() throws Exception {
-    // given
-    String buildVersionKey = "build.version";
-    String ExpectedBuildVersion = "2.0.14";
-    String jGitVersionKey = "jgit.version";
-    String expectedJGitVersion = "3.7.0.201502260915-r";
-    mojo.setAdditionalProperties(ImmutableMap.of(buildVersionKey, ExpectedBuildVersion, jGitVersionKey, expectedJGitVersion));
-
-    // when
-    mojo.execute();
-
-    // then
-    Properties properties = mojo.getProperties();
-
-    // added properties
-    assertThat(properties).satisfies(new ContainsKeyCondition(buildVersionKey));
-    assertThat(properties).satisfies(new ContainsKeyCondition(jGitVersionKey));
-    assertThat(properties.get(buildVersionKey)).isEqualTo(ExpectedBuildVersion);
-    assertThat(properties.get(jGitVersionKey)).isEqualTo(expectedJGitVersion);
-  }
-
   @Test
   @SuppressWarnings("")
   public void shouldHaveNoPrefixWhenConfiguredPrefixIsEmptyStringAsConfiguredProperties() throws Exception {