Support grouping XSDs with different configurations (e.g. package names)

README.md

@@ -1,11 +1,11 @@
-[![Gradle Plugin Release](https://img.shields.io/badge/Gradle%20plugin-1.5.1-blue.svg?logo=data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA5MCA2Ni4wNiI+PGRlZnM+PHN0eWxlPi5jbHMtMXtmaWxsOiNmZmY7fTwvc3R5bGU+PC9kZWZzPjx0aXRsZT5ncmFkbGUtZWxlcGhhbnQtaWNvbi13aGl0ZS1wcmltYXJ5PC90aXRsZT48cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik04NS4xMSw0LjE4YTE0LjI3LDE0LjI3LDAsMCwwLTE5LjgzLS4zNCwxLjM4LDEuMzgsMCwwLDAsMCwyTDY3LDcuNmExLjM2LDEuMzYsMCwwLDAsMS43OC4xMkE4LjE4LDguMTgsMCwwLDEsNzkuNSwyMC4wNkM2OC4xNywzMS4zOCw1My4wNS0uMzYsMTguNzMsMTZhNC42NSw0LjY1LDAsMCwwLTIsNi41NGw1Ljg5LDEwLjE3YTQuNjQsNC42NCwwLDAsMCw2LjMsMS43M2wuMTQtLjA4LS4xMS4wOEwzMS41MywzM2E2MC4yOSw2MC4yOSwwLDAsMCw4LjIyLTYuMTMsMS40NCwxLjQ0LDAsMCwxLDEuODctLjA2aDBhMS4zNCwxLjM0LDAsMCwxLC4wNiwyQTYxLjYxLDYxLjYxLDAsMCwxLDMzLDM1LjM0bC0uMDksMC0yLjYxLDEuNDZhNy4zNCw3LjM0LDAsMCwxLTMuNjEuOTQsNy40NSw3LjQ1LDAsMCwxLTYuNDctMy43MWwtNS41Ny05LjYxQzQsMzItMi41NCw0Ni41NiwxLDY1YTEuMzYsMS4zNiwwLDAsMCwxLjMzLDEuMTFIOC42MUExLjM2LDEuMzYsMCwwLDAsMTAsNjQuODdhOS4yOSw5LjI5LDAsMCwxLDE4LjQyLDAsMS4zNSwxLjM1LDAsMCwwLDEuMzQsMS4xOUgzNS45YTEuMzYsMS4zNiwwLDAsMCwxLjM0LTEuMTksOS4yOSw5LjI5LDAsMCwxLDE4LjQyLDBBMS4zNiwxLjM2LDAsMCwwLDU3LDY2LjA2SDYzLjFhMS4zNiwxLjM2LDAsMCwwLDEuMzYtMS4zNGMuMTQtOC42LDIuNDYtMTguNDgsOS4wNy0yMy40M0M5Ni40MywyNC4xNiw5MC40MSw5LjQ4LDg1LjExLDQuMThaTTYxLjc2LDMwLjA1bC00LjM3LTIuMTloMGEyLjc0LDIuNzQsMCwxLDEsNC4zNywyLjJaIi8+PC9zdmc+)](https://plugins.gradle.org/plugin/com.github.bjornvester.xjc)
+[![Gradle Plugin Release](https://img.shields.io/badge/Gradle%20plugin-1.6.0-blue.svg?logo=data:image/svg+xml;base64,PHN2ZyBpZD0iTGF5ZXJfMSIgZGF0YS1uYW1lPSJMYXllciAxIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCA5MCA2Ni4wNiI+PGRlZnM+PHN0eWxlPi5jbHMtMXtmaWxsOiNmZmY7fTwvc3R5bGU+PC9kZWZzPjx0aXRsZT5ncmFkbGUtZWxlcGhhbnQtaWNvbi13aGl0ZS1wcmltYXJ5PC90aXRsZT48cGF0aCBjbGFzcz0iY2xzLTEiIGQ9Ik04NS4xMSw0LjE4YTE0LjI3LDE0LjI3LDAsMCwwLTE5LjgzLS4zNCwxLjM4LDEuMzgsMCwwLDAsMCwyTDY3LDcuNmExLjM2LDEuMzYsMCwwLDAsMS43OC4xMkE4LjE4LDguMTgsMCwwLDEsNzkuNSwyMC4wNkM2OC4xNywzMS4zOCw1My4wNS0uMzYsMTguNzMsMTZhNC42NSw0LjY1LDAsMCwwLTIsNi41NGw1Ljg5LDEwLjE3YTQuNjQsNC42NCwwLDAsMCw2LjMsMS43M2wuMTQtLjA4LS4xMS4wOEwzMS41MywzM2E2MC4yOSw2MC4yOSwwLDAsMCw4LjIyLTYuMTMsMS40NCwxLjQ0LDAsMCwxLDEuODctLjA2aDBhMS4zNCwxLjM0LDAsMCwxLC4wNiwyQTYxLjYxLDYxLjYxLDAsMCwxLDMzLDM1LjM0bC0uMDksMC0yLjYxLDEuNDZhNy4zNCw3LjM0LDAsMCwxLTMuNjEuOTQsNy40NSw3LjQ1LDAsMCwxLTYuNDctMy43MWwtNS41Ny05LjYxQzQsMzItMi41NCw0Ni41NiwxLDY1YTEuMzYsMS4zNiwwLDAsMCwxLjMzLDEuMTFIOC42MUExLjM2LDEuMzYsMCwwLDAsMTAsNjQuODdhOS4yOSw5LjI5LDAsMCwxLDE4LjQyLDAsMS4zNSwxLjM1LDAsMCwwLDEuMzQsMS4xOUgzNS45YTEuMzYsMS4zNiwwLDAsMCwxLjM0LTEuMTksOS4yOSw5LjI5LDAsMCwxLDE4LjQyLDBBMS4zNiwxLjM2LDAsMCwwLDU3LDY2LjA2SDYzLjFhMS4zNiwxLjM2LDAsMCwwLDEuMzYtMS4zNGMuMTQtOC42LDIuNDYtMTguNDgsOS4wNy0yMy40M0M5Ni40MywyNC4xNiw5MC40MSw5LjQ4LDg1LjExLDQuMThaTTYxLjc2LDMwLjA1bC00LjM3LTIuMTloMGEyLjc0LDIuNzQsMCwxLDEsNC4zNywyLjJaIi8+PC9zdmc+)](https://plugins.gradle.org/plugin/com.github.bjornvester.xjc)
 [![GitHub Actions status](https://github.com/bjornvester/xjc-gradle-plugin/workflows/CI/badge.svg)](https://github.com/bjornvester/xjc-gradle-plugin/actions)
 
 # xjc-gradle-plugin
 A Gradle plugin for running the XJC binding compiler to generate Java source code from XML schemas (xsd files) using JAXB.
 
 ## Requirements and features
-* **The plugin requires Gradle version 6.0 or later**. (Tested with Gradle 6.0 and 7.0.) 
+* **The plugin requires Gradle version 6.0 or later**. (Tested with Gradle 6.0 and 7.0.)
 
 * It has been tested with Java 8, Java 11 and Java 16.
 
@@ -27,7 +27,7 @@ Apply the plugin ID "com.github.bjornvester.xjc" as documented in the [Gradle Pl
 
 ```kotlin
 plugins {
-  id("com.github.bjornvester.xjc") version "1.5.1"
+  id("com.github.bjornvester.xjc") version "1.6.0"
 }
 ```
 
@@ -41,18 +41,19 @@ xjc {
 
 Here is a list of all available properties:
 
-| Property           | Type                  | Default                                                                            | Description                                                                                                  |
-|--------------------|-----------------------|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
-| xsdDir             | DirectoryProperty     | "$projectDir/src<br>/main/resources"                                               | The directory holding the xsd files to compile.                                                              |
-| xsdFiles           | FileCollection        | xsdDir<br>&nbsp;&nbsp;.asFileTree<br>&nbsp;&nbsp;.matching { include("**/*.xsd") } | The schemas to compile.<br>If empty, all files in the xsdDir will be compiled.                               |
-| outputJavaDir      | DirectoryProperty     | "$buildDir/generated<br>/sources/xjc/java"                                         | The output directory for the generated Java sources.<br>Note that it will be deleted when running XJC.       |
-| outputResourcesDir | DirectoryProperty     | "$buildDir/generated<br>/sources/xjc/resources"                                    | The output directory for the generated resources (if any).<br>Note that it will be deleted when running XJC. |
-| xjcVersion         | Provider\<String>     | "2.3.3"                                                                            | The version of XJC to use.                                                                                   |
-| defaultPackage     | Provider\<String>     | \[not set\]                                                                        | The default package for the generated Java classes.<br>If empty, XJC will infer it from the namespace.       |
-| generateEpisode    | Provider\<Boolean>    | false                                                                              | If true, generates an Episode file for the generated Java classes.                                           |
-| markGenerated      | Provider\<Boolean>    | true                                                                               | If true, marks the generated code with the annotation `@javax.annotation.Generated`.                           |
-| bindingFiles       | FileCollection        | \[empty\]                                                                          | The binding files to use in the schema compiler                                                              |
-| options            | ListProperty\<String> | \[empty\]                                                                          | Options to pass to either the XJC core, or to third party plugins in the `xjcPlugins` configuration          |
+| Property           | Type                       | Default                                                                            | Description                                                                                                  |
+|--------------------|----------------------------|------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------|
+| xsdDir             | DirectoryProperty          | "$projectDir/src<br>/main/resources"                                               | The directory holding the xsd files to compile.                                                              |
+| xsdFiles           | FileCollection             | xsdDir<br>&nbsp;&nbsp;.asFileTree<br>&nbsp;&nbsp;.matching { include("**/*.xsd") } | The schemas to compile.<br>If empty, all files in the xsdDir will be compiled.                               |
+| outputJavaDir      | DirectoryProperty          | "$buildDir/generated<br>/sources/xjc/java"                                         | The output directory for the generated Java sources.<br>Note that it will be deleted when running XJC.       |
+| outputResourcesDir | DirectoryProperty          | "$buildDir/generated<br>/sources/xjc/resources"                                    | The output directory for the generated resources (if any).<br>Note that it will be deleted when running XJC. |
+| xjcVersion         | Provider\<String>          | "2.3.3"                                                                            | The version of XJC to use.                                                                                   |
+| defaultPackage     | Provider\<String>          | \[not set\]                                                                        | The default package for the generated Java classes.<br>If empty, XJC will infer it from the namespace.       |
+| generateEpisode    | Provider\<Boolean>         | false                                                                              | If true, generates an Episode file for the generated Java classes.                                           |
+| markGenerated      | Provider\<Boolean>         | true                                                                               | If true, marks the generated code with the annotation `@javax.annotation.Generated`.                         |
+| bindingFiles       | FileCollection             | \[empty\]                                                                          | The binding files to use in the schema compiler                                                              |
+| options            | ListProperty\<String>      | \[empty\]                                                                          | Options to pass to either the XJC core, or to third party plugins in the `xjcPlugins` configuration          |
+| groups             | NamedDomainObjectContainer | \[empty\]                                                                          | Allows you to group a set of XSDs and generate sources with different configurations. Requires Gradle 7.0 or higher. See below for details. |
 
 ### Choosing which schemas to generate source code for
 By default, it will compile all XML schemas (xsd files) found in the src/main/resource folder.
@@ -215,11 +216,7 @@ For XJC 2.x, it could be:
 </bindings>
 ```
 
-For XJC 3.x, it could be:
-
-```xml
-TODO
-```
+For XJC 3.x, you have to supply your own adapter methods as the format has changed.
 
 Lastly, configure XJC to use the binding file (in this case it is called `src/main/bindings/bindings.xml`):
 
@@ -229,27 +226,52 @@ xjc {
 }
 ```
 
+## Generate resources with different configurations
+_The grouping functionality described here requires Gradle 7.0 or higher_
+
+If you require building a subset of XSDs with different configurations (e.g. package names), you can use `group` property.
+Each group has the same configuration properties as otherwise, except for the XJC version as this can't be controlled individually.
+The configurations in the outermost block are considered defaults, and you can then override them in each group.
+
+Example:
+
+```kotlin
+xjc {
+    // Defaults
+    xjcVersion.set("3.0.0")
+
+    groups {
+        register("group1") {
+            xsdFiles = files(xsdDir.file("schema1.xsd"))
+            defaultPackage.set("com.example.group1")
+        }
+        register("group2") {
+            xsdFiles = files(xsdDir.file("schema2.xsd"))
+            defaultPackage.set("com.example.group2")
+        }
+    }
+}
+```
+
+Note that if you enable episode generation, XJC will generate multiple files (one for each group) but with the same name.
+You will have to merge these yourself.
+You will also not be able to reference between groups.
+If you require this, you should instead separate the build into individual projects.
+
 ## Road map
-Here are some of the features not yet implemented but I have planned for whenever I get the time.
+Here are some of the features I like to implement at some point.
 
-Consumer facing:
 * Support the "-npa" option in XJC, suppressing the generation of package level annotations.
 * Support for catalog files.
 * Support for schemas in wsdl files.
-* Support for optionally adding "if-exists" attributes to generated episode files to prevent failures on unreferenced schemas. 
+* Support for optionally adding "if-exists" attributes to generated episode files to prevent failures on unreferenced schemas.
 * Support for choosing which, if any, Gradle configuration to add the required dependencies to (e.g. `implementation`, `compileOnly` or none).
 * Support for the @Generated annotation on Java 9+
 * Document how to use the XJC task directly (for having multiple XJC tasks in the same Gradle project)
-
-Internal:
-* Automatic test of the integration-test project (it is currently tested manually)
-* Add additional tests or additional assertions to the current ones
+* Support date/time adapters for XJC 3.0+
 
 You are welcome to create issues and PRs for anything else.
-
-## Alternatives
-If you need additional functionality than what is provided here, you may want to try the one from [rackerlabs](https://github.com/rackerlabs/gradle-jaxb-plugin).
-There are also a few other plugins for XJC out there.
 
-However, the reason I started this plugin in the first place was because the others ignored the caching aspect, wasn't compatible with Java 11, had file leaks or other problems.
-All this may have been solved since, but this is something you may want to consider and be aware of. 
+## Alternatives
+If you need additional functionality than what is provided here, you may want to try the one from [unbroken-dome](https://github.com/unbroken-dome/gradle-xjc-plugin).
+It was created after this project, so I haven't tried it myself. It appears to be of high quality.

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "com.github.bjornvester"
-version = "1.5.1"
+version = "1.6.0"
 
 allprojects {
     repositories {
@@ -60,7 +60,7 @@ pluginBundle {
     (plugins) {
         "xjcPlugin" {
             description = """Changes:
-                            |- Restore support for Gradle 6.0 (while also supporting Gradle 7.0)""".trimMargin()
+                            |- Support grouping XSDs and generate them with different configurations""".trimMargin()
         }
     }
 }

integration-test/build.gradle.kts

@@ -1,3 +1,3 @@
 plugins {
     base
-}
+}

integration-test/gradle.properties

@@ -1 +1,3 @@
 org.gradle.jvmargs=-Dfile.encoding=UTF-8
+org.gradle.warning.mode=fail
+org.gradle.priority=low

integration-test/settings.gradle.kts

@@ -1,8 +1,9 @@
 include(
-    "test-producer-2x",
-    "test-producer-3x",
-    "test-consumer-2x",
-    "test-consumer-3x"
+        "test-producer-2x",
+        "test-producer-3x",
+        "test-producer-3x-grouped",
+        "test-consumer-2x",
+        "test-consumer-3x"
 )
 
 includeBuild("..")

integration-test/test-consumer-2x/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 }
 
 repositories {
-    jcenter()
+    mavenCentral()
 }
 
 dependencies {

integration-test/test-consumer-3x/build.gradle.kts

@@ -4,12 +4,11 @@ plugins {
 }
 
 repositories {
-    jcenter()
+    mavenCentral()
 }
 
 dependencies {
     implementation(project(":test-producer-3x"))
-    //implementation("io.github.threeten-jaxb:threeten-jaxb-core:1.2")
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.1")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.1")
 }
@@ -20,5 +19,4 @@ tasks.test {
 
 xjc {
     xjcVersion.set("3.0.0")
-    //bindingFiles = files("$projectDir/src/main/bindings/bindings.xml")
 }

integration-test/test-producer-2x/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 }
 
 repositories {
-    jcenter()
+    mavenCentral()
 }
 
 xjc {

integration-test/test-producer-3x-grouped/build.gradle.kts

@@ -0,0 +1,33 @@
+plugins {
+    id("com.github.bjornvester.xjc")
+    id("com.github.bjornvester.xjc.internal.java-conventions")
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    implementation(project(":test-producer-3x"))
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.7.1")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.7.1")
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+xjc {
+    xjcVersion.set("3.0.0")
+
+    groups {
+        register("group1") {
+            xsdFiles = files(xsdDir.file("MySchemaWithFunnyChar.xsd"))
+            defaultPackage.set("com.example.group1")
+        }
+        register("group2") {
+            xsdFiles = files(xsdDir.file("MySchemaWithFunnyChar.xsd"))
+            defaultPackage.set("com.example.group2")
+        }
+    }
+}

integration-test/test-producer-3x-grouped/src/main/resources/MyIgnoredElement.xsd

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:tsk="http://github.com/bjornvester/producer"
+           targetNamespace="http://github.com/bjornvester/producer"
+           elementFormDefault="qualified"
+           version="1.0">
+    <xs:include schemaLocation="MySchemaWithSimpleType.xsd"/>
+    <xs:element name="MyIgnoredElement">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref="tsk:MyDate"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+</xs:schema>

integration-test/test-producer-3x-grouped/src/main/resources/MySchemaWithFunnyChar.xsd

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:tsk="http://github.com/bjornvester/producer"
+           targetNamespace="http://github.com/bjornvester/producer"
+           elementFormDefault="qualified"
+           version="1.0">
+    <xs:include schemaLocation="MySchemaWithSimpleType.xsd"/>
+    <xs:element name="MyElementØ">
+        <xs:complexType>
+            <xs:sequence>
+                <xs:element ref="tsk:MyDate"/>
+            </xs:sequence>
+        </xs:complexType>
+    </xs:element>
+</xs:schema>

integration-test/test-producer-3x-grouped/src/main/resources/MySchemaWithSimpleType.xsd

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
+           xmlns:tsk="http://github.com/bjornvester/producer"
+           targetNamespace="http://github.com/bjornvester/producer"
+           elementFormDefault="qualified"
+           version="1.0">
+    <xs:element name="MyDate" type="tsk:MyDateType">
+    </xs:element>
+    <xs:simpleType name="MyDateType">
+        <xs:restriction base="xs:dateTime"/>
+    </xs:simpleType>
+</xs:schema>

integration-test/test-producer-3x-grouped/src/test/java/com/github/bjornvester/xjc/XjcTest.java

@@ -0,0 +1,11 @@
+package com.github.bjornvester.xjc;
+
+import org.junit.jupiter.api.Test;
+
+class XjcTest {
+    @Test
+    void testXjc() {
+        new com.example.group1.ObjectFactory().createMyElementØ();
+        new com.example.group2.ObjectFactory().createMyElementØ();
+    }
+}

integration-test/test-producer-3x/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
 }
 
 repositories {
-    jcenter()
+    mavenCentral()
 }
 
 xjc {