Contribute Gradle plugin

.gitignore

@@ -11,6 +11,9 @@
 target/
 apidocs
 
+# Gradle derived files #
+build/
+
 # IntelliJ files #
 .idea
 *.iml

jsonschema2pojo-gradle-plugin/NOTICE

@@ -0,0 +1,13 @@
+Copyright © 2010-2013 Nokia
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

jsonschema2pojo-gradle-plugin/README.md

@@ -0,0 +1,138 @@
+# Gradle jsonschema2pojo plugin
+
+[jsonschema2pojo](http://www.jsonschema2pojo.org) generates a Java representation of your
+json schema. The [schema reference](https://code.google.com/p/jsonschema2pojo/wiki/Reference)
+describes the rules and their effect on generated Java types.
+
+## Usage
+
+This plugin is hosted on the Maven Central Repository. All actions are logged at the `info` level.
+
+```groovy
+apply plugin: 'jsonschema2pojo'
+
+buildscript {
+  repositories {
+    mavenCentral()
+  }
+
+  dependencies {
+    // this plugin
+    classpath 'org.jsonschema2pojo:jsonschema2pojo-gradle-plugin:${js2p.version}'
+    // add additional dependencies here if you wish to reference instead of generate them (see example directory)
+  }
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  // Required if generating equals, hashCode, or toString methods
+  compile 'commons-lang:commons-lang:2.6'
+  // Required if generating JSR-303 annotations
+  compile 'javax.validation:validation-api:1.1.0.CR2'
+  // Required if generating Jackson 2 annotations
+  compile 'com.fasterxml.jackson.core:jackson-databind:2.1.4'
+  // Required if generating JodaTime data types
+  compile 'joda-time:joda-time:2.2'
+}
+
+// Each configuration is set to the default value
+jsonSchema2Pojo {
+  // Whether to generate builder-style methods of the form withXxx(value) (that return this),
+  // alongside the standard, void-return setters.
+  generateBuilders = false
+
+  // Whether to use primitives (long, double, boolean) instead of wrapper types where possible
+  // when generating bean properties (has the side-effect of making those properties non-null).
+  usePrimitives = false
+
+  // Location of the JSON Schema file(s). This may refer to a single file or a directory of files.
+  source = files("${sourceSets.main.output.resourcesDir}/json")
+
+  // Target directory for generated Java source files. The plugin will add this directory to the
+  // java source set so the compiler will find and compile the newly generated source files.
+  targetDirectory = file("${project.buildDir}/generated-sources/js2p")
+
+  // 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).
+  targetPackage = ''
+
+  // The characters that should be considered as word delimiters when creating Java Bean property
+  // names from JSON property names. If blank or not set, JSON properties will be considered to
+  // contain a single word when creating Java Bean property names.
+  propertyWordDelimiters = [] as char[]
+
+  // Whether to use the java type long (or Long) instead of int (or Integer) when representing the
+  // JSON Schema type 'integer'.
+  useLongIntegers = false
+
+  // Whether to include hashCode and equals methods in generated Java types.
+  includeHashcodeAndEquals = true
+
+  // Whether to include a toString method in generated Java types.
+  includeToString = true
+
+  // The style of annotations to use in the generated Java types. Supported values:
+  //  - jackson (alias of jackson2)
+  //  - jackson2 (apply annotations from the Jackson 2.x library)
+  //  - jackson1 (apply annotations from the Jackson 1.x library)
+  //  - gson (apply annotations from the Gson library)
+  //  - none (apply no annotations at all)
+  annotationStyle = 'jackson'
+
+  // A fully qualified class name, referring to a custom annotator class that implements
+  // com.googlecode.jsonschema2pojo.Annotator and will be used in addition to the one chosen
+  // by annotationStyle. If you want to use the custom annotator alone, set annotationStyle to none.
+  customAnnotator = 'com.googlecode.jsonschema2pojo.NoopAnnotator'
+
+  // Whether to include JSR-303 annotations (for schema rules like minimum, maximum, etc) in
+  // generated Java types. Schema rules and the annotation they produce:
+  //  - maximum = @DecimalMax
+  //  - minimum = @DecimalMin
+  //  - minItems,maxItems = @Size
+  //  - minLength,maxLength = @Size
+  //  - pattern = @Pattern
+  //  - required = @NotNull
+  // Any Java fields which are an object or array of objects will be annotated with @Valid to
+  // support validation of an entire document tree.
+  includeJsr303Annotations = false
+
+  // 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)
+  sourceType = 'jsonschema'
+
+  // Whether to empty the target directory before generation occurs, to clear out all source files
+  // that have been generated previously. <strong>Be warned</strong>, when activated this option
+  // will cause jsonschema2pojo to <strong>indiscriminately delete the entire contents of the target
+  // directory (all files and folders)</strong> before it begins generating sources.
+  boolean removeOldOutput = false
+
+  // The character encoding that should be used when writing the generated Java source files
+  String outputEncoding = 'UTF-8'
+
+  // Whether to use {@link org.joda.time.DateTime} instead of {@link java.util.Date} when adding
+  // date type fields to generated Java types.
+  boolean useJodaDates = false
+}
+```
+
+### Working with pre-existing java classes
+
+jsonschema2pojo allows to reference any pre-existing java classes. In general, if the generator finds a
+class already exists on the classpath, then it will not be generated but only referenced. To make this
+work as expected with this gradle plugin, the dependencies in question must be added to the buildscript
+classpath, the project classpath alone will not suffice. For a little example of how to do this have
+a look at the `example` directory.
+
+## Tasks
+
+### `generateJsonSchema2Pojo`
+
+This task will automatically run in a project where the `jsonSchema2Pojo` configuration closure is present.
+It will invoke the jsonschema2pojo generator, make the compileJava task dependent of itself and add
+the `targetDirectory` to the main/java source set so the java compiler will find and compile the newly
+generated source files.

jsonschema2pojo-gradle-plugin/example/build.gradle

@@ -0,0 +1,34 @@
+apply plugin: 'jsonschema2pojo'
+
+buildscript {
+  repositories {
+    mavenLocal()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath 'org.jsonschema2pojo:jsonschema2pojo-gradle-plugin:latest.integration'
+
+    // see src/main/resources/json/external_dependencies.json
+    classpath 'joda-time:joda-time:2.2'
+  }
+}
+
+repositories {
+  mavenCentral()
+}
+
+dependencies {
+  compile 'commons-lang:commons-lang:2.6'
+  compile 'javax.validation:validation-api:1.1.0.CR2'
+  compile 'com.fasterxml.jackson.core:jackson-databind:2.1.4'
+
+  // see src/main/resources/json/external_dependencies.json
+  compile 'joda-time:joda-time:2.2'
+}
+
+jsonSchema2Pojo {
+  targetPackage = 'example'
+  includeJsr303Annotations = true
+  propertyWordDelimiters = ['_'] as char[]
+}

jsonschema2pojo-gradle-plugin/example/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,6 @@
+#Wed May 01 02:20:18 PDT 2013
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists
+distributionUrl=http\://services.gradle.org/distributions/gradle-1.6-bin.zip

jsonschema2pojo-gradle-plugin/example/gradlew

@@ -0,0 +1,164 @@
+#!/usr/bin/env bash
+
+##############################################################################
+##
+##  Gradle start up script for UN*X
+##
+##############################################################################
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS=""
+
+APP_NAME="Gradle"
+APP_BASE_NAME=`basename "$0"`
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD="maximum"
+
+warn ( ) {
+    echo "$*"
+}
+
+die ( ) {
+    echo
+    echo "$*"
+    echo
+    exit 1
+}
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+case "`uname`" in
+  CYGWIN* )
+    cygwin=true
+    ;;
+  Darwin* )
+    darwin=true
+    ;;
+  MINGW* )
+    msys=true
+    ;;
+esac
+
+# For Cygwin, ensure paths are in UNIX format before anything is touched.
+if $cygwin ; then
+    [ -n "$JAVA_HOME" ] && JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
+fi
+
+# Attempt to set APP_HOME
+# Resolve links: $0 may be a link
+PRG="$0"
+# Need this for relative symlinks.
+while [ -h "$PRG" ] ; do
+    ls=`ls -ld "$PRG"`
+    link=`expr "$ls" : '.*-> \(.*\)$'`
+    if expr "$link" : '/.*' > /dev/null; then
+        PRG="$link"
+    else
+        PRG=`dirname "$PRG"`"/$link"
+    fi
+done
+SAVED="`pwd`"
+cd "`dirname \"$PRG\"`/" >&-
+APP_HOME="`pwd -P`"
+cd "$SAVED" >&-
+
+CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD="$JAVA_HOME/jre/sh/java"
+    else
+        JAVACMD="$JAVA_HOME/bin/java"
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD="java"
+    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+fi
+
+# Increase the maximum file descriptors if we can.
+if [ "$cygwin" = "false" -a "$darwin" = "false" ] ; then
+    MAX_FD_LIMIT=`ulimit -H -n`
+    if [ $? -eq 0 ] ; then
+        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
+            MAX_FD="$MAX_FD_LIMIT"
+        fi
+        ulimit -n $MAX_FD
+        if [ $? -ne 0 ] ; then
+            warn "Could not set maximum file descriptor limit: $MAX_FD"
+        fi
+    else
+        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
+    fi
+fi
+
+# For Darwin, add options to specify how the application appears in the dock
+if $darwin; then
+    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
+fi
+
+# For Cygwin, switch paths to Windows format before running java
+if $cygwin ; then
+    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
+    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
+
+    # We build the pattern for arguments to be converted via cygpath
+    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
+    SEP=""
+    for dir in $ROOTDIRSRAW ; do
+        ROOTDIRS="$ROOTDIRS$SEP$dir"
+        SEP="|"
+    done
+    OURCYGPATTERN="(^($ROOTDIRS))"
+    # Add a user-defined pattern to the cygpath arguments
+    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
+        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
+    fi
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    i=0
+    for arg in "$@" ; do
+        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
+        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
+
+        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
+            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
+        else
+            eval `echo args$i`="\"$arg\""
+        fi
+        i=$((i+1))
+    done
+    case $i in
+        (0) set -- ;;
+        (1) set -- "$args0" ;;
+        (2) set -- "$args0" "$args1" ;;
+        (3) set -- "$args0" "$args1" "$args2" ;;
+        (4) set -- "$args0" "$args1" "$args2" "$args3" ;;
+        (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
+        (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
+        (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
+        (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
+        (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+    esac
+fi
+
+# Split up the JVM_OPTS And GRADLE_OPTS values into an array, following the shell quoting and substitution rules
+function splitJvmOpts() {
+    JVM_OPTS=("$@")
+}
+eval splitJvmOpts $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS
+JVM_OPTS[${#JVM_OPTS[*]}]="-Dorg.gradle.appname=$APP_BASE_NAME"
+
+exec "$JAVACMD" "${JVM_OPTS[@]}" -classpath "$CLASSPATH" org.gradle.wrapper.GradleWrapperMain "$@"