fixed bugs with product output naming, bumped version to 0.0.11

Author: akhikhl

README.md

@@ -1,7 +1,7 @@
 #gradle-onejar 
 [![Maintainer Status](http://stillmaintained.com/akhikhl/gradle-onejar.png)](http://stillmaintained.com/akhikhl/gradle-onejar) 
 [![Build Status](https://travis-ci.org/akhikhl/gradle-onejar.png?branch=master)](https://travis-ci.org/akhikhl/gradle-onejar) 
-[![Latest Version](http://img.shields.io/badge/latest_version-0.0.10-blue.svg)](https://github.com/akhikhl/gradle-onejar/tree/v0.0.10)
+[![Latest Version](http://img.shields.io/badge/latest_version-0.0.11-blue.svg)](https://github.com/akhikhl/gradle-onejar/tree/v0.0.11)
 [![License](http://img.shields.io/badge/license-MIT-ff69b4.svg)](#copyright-and-license)
 
 Gradle plugin for generating single jar for JVM-based application.
@@ -47,7 +47,7 @@ with name:
 "build/output/${project.name}-${project.version}/${project.name}.jar".
 
 Alternatively, you can download the script from https://raw.github.com/akhikhl/gradle-onejar/master/pluginScripts/gradle-onejar.plugin
-to the project folder and include it like this:
+to the project directory and include it like this:
 
 ```groovy
 apply from: 'gradle-onejar.plugin'
@@ -86,7 +86,7 @@ for more information.
 
 ###copyExplodedResources task
 
-The task copyExplodedResources copies additional files to the folder "${project.projectDir}/build/output",
+The task copyExplodedResources copies additional files to the directory "${project.projectDir}/build/output",
 so that these files get packed by task productArchive.
 
 ###run task
@@ -119,7 +119,7 @@ onejar {
   manifest {
     attributes attrName1: attrValue1 [, ...]
   }
-  product name: 'productName', platform: ..., arch: ..., language: ..., suffix: ..., launchers: [ ... ]
+  product name: 'productName', suffix: ..., platform: ..., arch: ..., language: ..., fileSuffix: ..., launchers: [ ... ], configBaseName: ..., explodedResource: [...], explodedResources: [...]
   archiveProducts true|false
   additionalProductFiles ... [, ...]
   excludeProductFile ... [, ...]
@@ -146,24 +146,38 @@ When omitted, gradle-onejar does not alter onejar manifest.
 
 **product** - optional, multiplicity 0..N, hashmap, accepting the following properties:
 
-- **name** - required, string, denotes the name of the product.
+- **name** - optional, string, denotes the name of the product. When omitted, project name is used.
+
+- **suffix** - optional, string, denotes the suffix to be added to the generated files/directorys.
 
 - **platform** - optional, string, denotes the target platform. Possible values are "windows" and "linux".
-  When omitted, the product is platform-neutral.
-  When equals to "windows", default launcher is ".bat" and target archive format is ".zip".
-  When equals to "linux", default launcher is ".sh" and target archive format is ".tag.gz".
+  - When omitted, the product is platform-neutral.
+  - When specified, the value is appended to the name of generated directory/file name.
+  - When equals to "windows", default launcher is ".bat" and target archive format is ".zip".
+  - When equals to "linux", default launcher is ".sh" and target archive format is ".tag.gz".
 
-- **arch** - optional, string, denotes the target architecture. Does not affect product generation (yet).
+- **arch** - optional, string, denotes the target architecture.
+  - When specified, the value is appended to the name of generated directory/file name.
 
-- **language** - optional, string, denotes the target language. When specified, the value is added
-  to JVM parameters in launcher scripts in the form -Duser.language=$language.
+- **language** - optional, string, denotes the target language. 
+  - When specified, the value is added to JVM parameters in launcher scripts in the form -Duser.language=$language.
+  - When specified, the value is appended to the name of generated directory/file name.
 
-- **suffix** - optional, string, denotes the suffix to be added to the generated files/folders.
+- **fileSuffix** - optional, string denotes the suffix to be appended to the name of generated directory/file name.
+  When omitted, default fileSuffix is appended: "-${suffix}-${platform}-${arch}-${language}".
 
 - **launchers** - optional, array, contains one or more strings "windows", "shell".
-  When omitted, launchers are defined by the selected platform.
-  When equals to "windows", the product is supplied with ".bat" launcher.
-  When equals to "shell", the product is supplied with ".sh" launcher.
+  - When omitted, launchers are defined by the selected platform.
+  - When equals to "windows", the product is supplied with ".bat" launcher.
+  - When equals to "shell", the product is supplied with ".sh" launcher.
+  
+- **configBaseName** - optional, string, denotes base for gradle configuration name.
+  The effective configuration name is calculated as "product_${configBaseName}_${product.suffix}_${platform}_${arch}_${language}"
+  - When omitted, product name is used as configBaseName instead.
+
+- **explodedResource(s)** - optional string or array of strings. When specified, should denote relative file paths
+  to the resources that are to be copied to product directory/archive without compression to jar.
+  The paths are relative to the project directory.
 
 **archiveProducts** - optional, boolean. When true, gradle-onejar packs the generated product to ".zip" or ".tar.gz" archive -
 depending on the specified platform. If platform is not specified, target format is ".tar.gz".

build.gradle

@@ -11,7 +11,7 @@ buildscript {
 
 ext {
   group = 'org.akhikhl.gradle-onejar'
-  version = '0.0.10'
+  version = '0.0.11'
   groovy_version = '2.2.2'
   spock_version = '0.7-groovy-2.0'
 }

examples/build.gradle

@@ -14,7 +14,7 @@ apply plugin: 'base' // add "clean" task to the root project.
 
 ext {
   group = 'org.akhikhl.gradle-onejar'
-  version = '0.0.10'
+  version = '0.0.11'
   groovy_version = '2.2.2'
   logback_version = '1.1.1'
 }

examples/onejarMultiConfig/build.gradle

@@ -22,8 +22,8 @@ ext {
 
 onejar {
   manifest { attributes 'Built-By': 'Some user' }
-  product 'v2_3'
-  product name: 'v2_4', launchers: [ 'shell', 'windows' ]
+  product suffix: 'v2_3'
+  product suffix: 'v2_4', launchers: [ 'shell', 'windows' ]
   jvmMinMemory '512m'
   jvmMaxMemory '1024m'
 }

libs/gradle-onejar/src/main/groovy/org/akhikhl/gradle/onejar/ProductConfigurator.groovy

@@ -10,22 +10,26 @@ package org.akhikhl.gradle.onejar
 import org.gradle.api.Project
 import org.gradle.api.artifacts.Configuration
 import org.gradle.api.tasks.bundling.*
+import org.slf4j.Logger
+import org.slf4j.LoggerFactory
 
 class ProductConfigurator {
 
+  private static final Logger log = LoggerFactory.getLogger(ProductConfigurator)
+
   private final Project project
   private final Map product
   private final String platform
   private final String arch
   private final String language
-  private final String productName
-  private final String productTaskSuffix
-  private final Configuration productConfig
-  private final Configuration providedConfig
+  private final String productBaseFileName
+  private final String productQualifiedFileName
   private final String outputBaseDir
   private final String outputDir
-  private final String baseName
   private final String destFile
+  private final String productTaskSuffix
+  private final Configuration productConfig
+  private final Configuration providedConfig
   private final File mainJar
   private final List launchers
   private final String versionFileName
@@ -37,39 +41,31 @@ class ProductConfigurator {
     platform = product.platform
     arch = product.arch
     language = product.language
-    String productConfigName
-    if(product.name) {
-      productName = product.name
-      productConfigName = 'product_' + product.name
-    }
-    else {
-      String productName = project.name + '-' + project.version
-      if(product.suffix)
-        productName += '-' + product.suffix
-      else {
-        if(platform)
-          productName += '-' + platform
-        if(arch)
-          productName += '-' + arch
-        if(language)
-          productName += '-' + language
-      }
-      this.productName = productName
-      productConfigName = 'product'
-      if(platform)
-        productConfigName += '_' + platform
-      if(arch)
-        productConfigName += '_' + arch
-      if(language)
-        productConfigName += '_' + language
-    }
+
+    productBaseFileName = product.name ?: project.name
+
+    String productFileSuffix
+    if(product.fileSuffix)
+      productFileSuffix = product.fileSuffix
+    else
+      productFileSuffix = [ product.suffix, platform, arch, language ].findResults { it ?: null }.join('-')
+
+    productQualifiedFileName = [productBaseFileName, project.version, productFileSuffix].findResults { it ?: null }.join('-')
+
+    outputBaseDir = "${project.buildDir}/output"
+    outputDir = "${outputBaseDir}/${productQualifiedFileName}"
+    log.debug 'outputDir={}', outputDir
+
+    destFile = "${outputDir}/${productBaseFileName}.jar"
+
+    productTaskSuffix = [ product.name, product.suffix, platform, arch, language ].findResults { it ?: null }.join('_')
+
+    String productConfigName = [ 'product', product.configBaseName ?: product.name ?: '', product.suffix, platform, arch, language ].findResults { it ?: null }.join('_')
+    log.debug 'product config: {}', productConfigName
     productConfig = project.configurations.findByName(productConfigName)
+
     providedConfig = project.configurations.findByName('provided')
-    this.productTaskSuffix = productConfigName
-    outputBaseDir = "${project.buildDir}/output"
-    outputDir = "${outputBaseDir}/${productName}"
-    baseName = "${project.name}"
-    destFile = "${outputDir}/${baseName}.jar"
+
     mainJar = ProjectUtils.getMainJar(project)
     if(product.launchers)
       launchers = product.launchers
@@ -124,15 +120,17 @@ class ProductConfigurator {
     def archiveType = launchers.contains('windows') ? Zip : Tar
 
     project.task("archive_${productTaskSuffix}", type: archiveType) {
-      from new File(outputDir)
-      into productName
+
+      archiveName = productQualifiedFileName + (archiveType == Tar ? '.tar.gz' : '.zip')
       destinationDir = new File(outputBaseDir)
-      if(archiveType == Tar) {
-        extension = 'tar.gz'
+      if(archiveType == Tar)
         compression = Compression.GZIP
-      }
+
+      from new File(outputDir), { into productBaseFileName }
+
       doLast {
-        ant.checksum file: it.archivePath
+        project.logger.warn 'Created archive: {}', archivePath
+        ant.checksum file: archivePath
       }
       dependsOn "build_${productTaskSuffix}"
       project.tasks.build.dependsOn it
@@ -152,10 +150,10 @@ class ProductConfigurator {
       outputs.file destFile
 
       if(launchers.contains('shell'))
-        outputs.file(new File("${outputDir}/${baseName}.sh"))
+        outputs.file(new File("${outputDir}/${productBaseFileName}.sh"))
 
       if(launchers.contains('windows'))
-        outputs.file(new File("${outputDir}/${baseName}.bat"))
+        outputs.file(new File("${outputDir}/${productBaseFileName}.bat"))
 
       outputs.file versionFileName
 
@@ -205,7 +203,7 @@ class ProductConfigurator {
             obj(product, outputDir)
         }
 
-        project.logger.info 'Created one-jar: {}', destFile
+        project.logger.warn 'Created one-jar: {}', destFile
       } // doLast
 
       task.dependsOn project.tasks.assemble, project.tasks.check
@@ -263,12 +261,12 @@ class ProductConfigurator {
 
       def params = []
       addCommonParams(params)
-      params.add('-jar ${DIR}/' + baseName + '.jar')
+      params.add('-jar ${DIR}/' + productBaseFileName + '.jar')
       params.addAll(project.onejar.launchParameters)
       params.add('"$@"')
       params = params.join(' ')
 
-      def launchScriptFile = new File("${outputDir}/${baseName}.sh")
+      def launchScriptFile = new File("${outputDir}/${productBaseFileName}.sh")
       launchScriptFile.text = '''#!/bin/bash
 SOURCE="${BASH_SOURCE[0]}"
 while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
@@ -285,19 +283,19 @@ java ''' + params
 
       def params = []
       addCommonParams(params)
-      params.add('-jar %~dp0\\' + baseName + '.jar')
+      params.add('-jar %~dp0\\' + productBaseFileName + '.jar')
       params.addAll(project.onejar.launchParameters)
       params.add('%*')
       params = params.join(' ')
 
-      def launchScriptFile = new File("${outputDir}/${baseName}.bat")
+      def launchScriptFile = new File("${outputDir}/${productBaseFileName}.bat")
       launchScriptFile.text = '@java ' + params
     }
   }
 
   private void generateVersionFile() {
     new File(versionFileName).text = """\
-product: ${productName}
+product: ${productBaseFileName}
 version: ${project.version}
 platform: ${platform ?: 'any'}
 architecture: ${arch ?: 'any'}