Merge pull request #80 from jsonschema2dataclass/target-dir-prefix

Author: eirnym

README.adoc

@@ -109,6 +109,7 @@ Help wanted for this task
 | source | ConfigurableFileCollection | | Location of the JSON Schema file(s). Note: this may refer to a single file or a directory of files.
 | sourceSortOrder | String | OS | The sort order to be applied when recursively processing the source files. By default the OS can influence the processing order. Supported values: OS (Let the OS influence the order the source files are processed.) FILES_FIRST (Case sensitive sort, visit the files first. The source files are processed in a breadth first sort order.) SUBDIRS_FIRST (Case sensitive sort, visit the sub-directories before the files. The source files are processed in a depth first sort order.)
 | sourceType | String | jsonschema | The type of input documents that will be read Supported values: jsonschema (schema documents, containing formal rules that describe the structure of JSON data) json (documents that represent an example of the kind of JSON data that the generated Java types will be mapped to) yamlschema (JSON schema documents, represented as YAML) yaml (documents that represent an example of the kind of YAML (or JSON) data that the generated Java types will be mapped to)
+| targetDirecotryPrefix | String | generated/source/js2d | Directory prefix under build directory where underlying tool will generate sources |
 | targetPackage | String | | Package name used for generated Java classes (for types where a fully qualified name has not been supplied in the schema using the 'javaType' property).
 | targetVersion | String | | The target version for generated source files.
 | timeType | String | | What type to use instead of string when adding string type fields of format time (not date-time) to generated Java types.

demo/androidDev/app/build.gradle

@@ -65,6 +65,7 @@ jsonSchema2Pojo {
     //source = files("${sourceSets.main.output.resourcesDir}/json")
     source.setFrom files("${project.rootDir}/schema")
 
+    targetDirectoryPrefix = 'generated/source/jsonschema2dataclass'
     // Target directory for generated Java source files. The plugin will ignore this value for Android projects and will generate the classes into a generated source folder for each build variant and add this directory to the
     // java source set so the compiler will find and compile the newly generated source files.
     // targetDirectory = file("${project.rootDir}/build/generated-sources/js2p")

src/main/groovy/com/github/eirnym/js2p/JsonSchemaExtension.groovy

@@ -18,16 +18,21 @@ package com.github.eirnym.js2p
 import groovy.transform.ToString
 import org.gradle.api.NamedDomainObjectContainer
 import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
 
 import javax.inject.Inject
 
+import static com.github.eirnym.js2p.JsonSchemaPlugin.TARGET_FOLDER_BASE
+
 @ToString
 class JsonSchemaExtension extends JsonSchema2PojoPluginConfiguration {
     final NamedDomainObjectContainer<JsonSchema2PojoPluginConfiguration> executions
+    final Property<String> targetDirectoryPrefix
 
     @Inject
     JsonSchemaExtension(ObjectFactory objectFactory) {
         super("main", objectFactory)
+        targetDirectoryPrefix = objectFactory.property(String.class).convention(TARGET_FOLDER_BASE)
         executions = objectFactory.domainObjectContainer(JsonSchema2PojoPluginConfiguration)
     }
 }

src/main/groovy/com/github/eirnym/js2p/JsonSchemaPlugin.groovy

@@ -119,9 +119,9 @@ class JsonSchemaPlugin implements Plugin<Project> {
     private static Path getAndroidJsonPath(Project project) {
         def sets
         if (project.android.hasProperty('sourceSets')) {
-            sets = project.android.sourceSets;
+            sets = project.android.sourceSets
         } else {
-            sets = project.android.sourceSetsContainer;
+            sets = project.android.sourceSetsContainer
         }
 
         def main = sets.find { it.name.startsWith("main") }
@@ -160,6 +160,7 @@ class JsonSchemaPlugin implements Plugin<Project> {
                     taskNameSuffix,
                     execId,
                     execution.source,
+                    extension.targetDirectoryPrefix.get(),
                     targetDirectorySuffix
             )
             postConfigure(task)
@@ -173,6 +174,7 @@ class JsonSchemaPlugin implements Plugin<Project> {
             String taskNameSuffix,
             int executionId,
             ConfigurableFileCollection source,
+            String targetDirectoryPrefix,
             String targetDirectorySuffix
     ) {
 
@@ -187,7 +189,7 @@ class JsonSchemaPlugin implements Plugin<Project> {
         task.execution = executionId
         task.sourceFiles.setFrom(source)
         task.targetDirectory.set(
-                project.layout.buildDirectory.dir("${TARGET_FOLDER_BASE}${executionId}${targetDirectorySuffix}")
+                project.layout.buildDirectory.dir("${targetDirectoryPrefix}${executionId}${targetDirectorySuffix}")
         )
         task.inputs.files({ task.sourceFiles.filter({ it.exists() }) })
                 .skipWhenEmpty()
@@ -214,7 +216,7 @@ class JsonSchemaPlugin implements Plugin<Project> {
             }
         }
     }
-    private void verifyGradleVersion() {
+    private static void verifyGradleVersion() {
         if (GradleVersion.current() < GradleVersion.version(MINIMUM_GRADLE_VERSION)) {
             throw new GradleException("Plugin ${PLUGIN_ID} requires at least Gradle $MINIMUM_GRADLE_VERSION, but you are using ${GradleVersion.current().version}")
         }

src/test/groovy/com/github/eirnym/js2p/JavaTaskFunctionalTest.groovy

@@ -26,8 +26,11 @@ class JavaTaskFunctionalTest {
     private static final String COLON_TASK_NAME = ':' + TASK_NAME
     private static final String COLON_TASK_NAME0 = COLON_TASK_NAME + '0'
     private static final String COLON_TASK_NAME1 = COLON_TASK_NAME + '1'
+
     private static final String TARGET_FOLDER_BASE0 = TARGET_FOLDER_BASE + '0'
-    private static final String TARGET_FOLDER_BASE1 = TARGET_FOLDER_BASE + '1'
+    private static final String TARGET_FOLDER_BASE_CUSTOM = TARGET_FOLDER_BASE + 's'
+    private static final String TARGET_FOLDER_BASE_CUSTOM0 = TARGET_FOLDER_BASE_CUSTOM + '0'
+    private static final String TARGET_FOLDER_BASE_CUSTOM1 = TARGET_FOLDER_BASE_CUSTOM + '1'
     private static final List<String> GRADLE_RELEASES = [
             '6.8.3', '6.8', '6.7.1', '6.6.1', '6.5.1', '6.4.1', '6.3', '6.2.2', '6.2.1', '6.1.1', '6.0.1',  // 6.x
     ]
@@ -52,9 +55,7 @@ class JavaTaskFunctionalTest {
         def result = executeRunner(gradleVersion, testProjectDir)
 
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME0).outcome)
-        def js2pDir = testProjectDir.resolve("build/${TARGET_FOLDER_BASE0}")
-        assertExists(js2pDir.toFile())
-        assertExists(js2pDir.resolve("Address.java").toFile())
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE0}")
     }
 
     @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}")
@@ -68,9 +69,7 @@ class JavaTaskFunctionalTest {
         def result = executeRunner(gradleVersion, testProjectDir)
 
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME0).outcome)
-        def js2pDir = testProjectDir.resolve("build/${TARGET_FOLDER_BASE0}/com/example")
-        assertExists(js2pDir.toFile())
-        assertExists(js2pDir.resolve("Address.java").toFile())
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE0}/com/example")
     }
     @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}")
     @NullSource
@@ -83,9 +82,7 @@ class JavaTaskFunctionalTest {
         def result = executeRunner(gradleVersion, testProjectDir)
 
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME0).outcome)
-        def js2pDir = testProjectDir.resolve("build/${TARGET_FOLDER_BASE0}/com/example")
-        assertExists(js2pDir.toFile())
-        assertExists(js2pDir.resolve("Address.java").toFile())
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE0}/com/example")
     }
 
     @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}")
@@ -99,9 +96,7 @@ class JavaTaskFunctionalTest {
         def result = executeRunner(gradleVersion, testProjectDir)
 
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME0).outcome)
-        def js2pDir = testProjectDir.resolve("build/${TARGET_FOLDER_BASE0}/com/example")
-        assertExists(js2pDir.toFile())
-        assertExists(js2pDir.resolve("Address.java").toFile())
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE0}/com/example")
     }
 
     @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}")
@@ -114,16 +109,11 @@ class JavaTaskFunctionalTest {
         copyAddressJSON()
 
         def result = executeRunner(gradleVersion, testProjectDir, COLON_TASK_NAME)
-
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME0).outcome)
-        def js2pDir0 = testProjectDir.resolve("build/${TARGET_FOLDER_BASE0}/com/example")
-        assertExists(js2pDir0.toFile())
-        assertExists(js2pDir0.resolve("Address.java").toFile())
-
         assertEquals(TaskOutcome.SUCCESS, result.task(COLON_TASK_NAME1).outcome)
-        def js2pDir1 = testProjectDir.resolve("build/${TARGET_FOLDER_BASE1}/org/example")
-        assertExists(js2pDir1.toFile())
-        assertExists(js2pDir1.resolve("Address.java").toFile())
+
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE_CUSTOM0}/com/example")
+        addressJavaExists(testProjectDir, "build/${TARGET_FOLDER_BASE_CUSTOM1}/org/example")
     }
 
     @ParameterizedTest(name = "{displayName} [{index}] {argumentsWithNames}")
@@ -198,6 +188,7 @@ class JavaTaskFunctionalTest {
     private void createBuildFilesMultiple() {
         Files.write(buildFile, (BUILD_FILE_HEADER + """
         |jsonSchema2Pojo{
+        |   targetDirectoryPrefix = "${TARGET_FOLDER_BASE_CUSTOM}"
         |   executions {
         |     com{
         |       targetPackage = 'com.example'
@@ -256,6 +247,12 @@ class JavaTaskFunctionalTest {
         assertTrue(file.exists())
     }
 
+    private static void addressJavaExists(Path testProjectDir, String targetDirectory) {
+        def js2pDir = testProjectDir.resolve(targetDirectory)
+        assertExists(js2pDir.toFile())
+        assertExists(js2pDir.resolve("Address.java").toFile())
+    }
+
     private static BuildResult executeRunner(
             String gradleVersion, Path testProjectDir, String task = COLON_TASK_NAME, boolean shouldFail = false) {
         def arguments = GradleRunner.create()