Scala API - please review

build.gradle

@@ -1,23 +1,131 @@
+apply from: "gradle/vertx.gradle"
+
 /*
- * Copyright 2012 the original author or authors.
- *
- * 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.
+Usage:
+
+./gradlew task_name
+
+(or gradlew.bat task_name if you have the misfortune to have to use Windows)
+
+If no task name is specified then the default task 'assemble' is run
+
+Task names are:
+
+idea - generate a skeleton IntelliJ IDEA project
+
+eclipse - generate a skeleton Eclipse IDE project
+
+assemble - builds the outputs, by default this is the module zip file. It can also include a jar file if produceJar
+          in gradle.properties is set to true. Outputs are created in build/libs.
+          if pullInDeps in gradle.properties is set to 'true' then the modules dependencies will be
+          automatically pulled into a nested mods directory inside the module during the build
+
+copyMod - builds and copies the module to the local 'mods' directory so you can execute vertx runmod (etc)
+          directly from the command line
+
+modZip - creates the module zip into build/libs
+
+clean - cleans everything up
+
+test - runs the tests. An nice html test report is created in build/reports/tests (index.html)
+
+runMod - runs the module. This is similar to executing vertx runmod from the command line except that it does
+         not use the version of Vert.x installed and on the PATH to run it. Instead it uses the version of Vert.x
+         that the module was compiled and tested against.
+
+runModIDEA - run the module from the project resources in IDEA. This allows you to run the module without building it
+first!
+
+runModEclipse - run the module from the project resources in Eclipse. This allows you to run the module without
+building it  first!
+
+pullInDeps - pulls in all dependencies of the module into a nested module directory
+
+uploadArchives - upload the module zip file (and jar if one has been created) to Nexus. You will need to
+                 configure sonatypeUsername and sonatypePassword in ~/.gradle/gradle.properties.
+
+install - install any jars produced to the local Maven repository (.m2)
+
  */
-apply from: "gradle/setup.gradle"
-apply from: "gradle/vertx.gradle"
 
-dependencies { }
+dependencies {
+  /*
+  Add your module jar dependencies here
+  E.g.
+  compile "com.foo:foo-lib:1.0.1" - for compile time deps - this will end up in your module too!
+  testCompile "com.foo:foo-lib:1.0.1" - for test time deps
+  provided "com.foo:foo-lib:1.0.1" - if you DON'T want it to be packaged in the module zip
+  */
+
+  compile "org.scala-lang:scala-library:$scalaVersion"
+  compile "org.scala-lang:scala-compiler:$scalaVersion"
+
+}
 
 test {
-  systemProperty 'vertx.test.timeout', 10
-}
+  /* Configure which tests are included
+  include 'org/foo/**'
+  exclude 'org/boo/**'
+  */
+
+  jvmArgs "-XX:MaxPermSize=256m"
+  systemProperty 'vertx.test.resources', 'src/test/testscripts'
+}
+
+/*
+If you're uploading stuff to Maven, Gradle needs to generate a POM.
+Please edit the details below.
+ */
+def configurePom(def pom) {
+  pom.project {
+    name rootProject.name
+    description 'Vert.x module that provides Scala support'
+    inceptionYear '2013'
+    packaging 'jar'
+
+    url 'http://vertx.io'
+
+    developers {
+      developer {
+        id 'swilliams-vmw'
+        name 'Stuart Williams'
+      }
+      developer {
+        id 'edgarchan'
+        name 'Edgar Chan'
+      }
+      developer {
+        id 'nfmelendez'
+        name 'Nicolas Melendez'
+      }
+      developer {
+        id 'Narigo'
+        name 'Joern Bernhardt'
+      }
+      developer {
+        id 'raniejade'
+        name 'Ranie Jade Ramiso'
+      }
+      developer {
+        id 'galderz'
+        name 'Galder Zamarreño'
+      }
+    }
+
+    scm {
+      url 'https://github.com/vert-x/mod-lang-scala'
+    }
+
+    licenses {
+      license {
+        name 'The Apache Software License, Version 2.0'
+        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
+        distribution 'repo'
+      }
+    }
+
+    properties {
+      setProperty('project.build.sourceEncoding', 'UTF8')
+    }
+  }
+}

gradle.properties

@@ -1,8 +1,41 @@
+# E.g. your domain name
 modowner=io.vertx
+
+# Your module name
 modname=lang-scala
+
+# Your module version
 version=0.2.0-SNAPSHOT
+
+# The test timeout in seconds
+testtimeout=10
+
+# Set to true if you want module dependencies to be pulled in and nested inside the module itself
+pullInDeps=true
+
+# Set to true if you want to build a fat executable jar containing everything needed to run the module
+createFatJar=true
+
+# Scala version
+scalaVersion=2.10.2
+
+# Gradle version
 gradleVersion=1.6
-vertxVersion=2.0.1-final
-toolsVersion=2.0.0-final
+
+# The version of Vert.x
+vertxVersion=2.0.3-SNAPSHOT
+
+# The version of Vert.x test tools
+toolsVersion=2.0.2-SNAPSHOT
+
+# The version of JUnit
 junitVersion=4.11
-scalaVersion=2.10.2
+
+# Command line arguments to use when running any of the variations of ./gradlew runMod
+# These are the exact same command line args that you would pass to 'vertx runmod <module-name>' on the command line
+runModArgs=-conf conf.json
+
+# e.g.
+# runModArgs=-conf foo.json
+# runModArgs=-conf someconf.json -ha
+# runModArgs=-cluster

gradle/maven.gradle

@@ -17,50 +17,11 @@
 apply plugin: 'maven'
 apply plugin: 'signing'
 
-// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-// custom maven tasks
-
-task sourceJar(type: Jar) {
-  description = 'Builds a source jar artifact suitable for maven deployment.'
-  classifier = 'sources'
-  from sourceSets.main.scala
-}
-
-task javadocJar(type: Jar) {
-  description = 'Builds a javadoc jar artifact suitable for maven deployment.'
-  classifier = 'javadoc'
-  from javadoc.destinationDir
-}
-javadocJar.dependsOn javadoc
-
-build.dependsOn sourceJar, javadocJar
-
-artifacts {
-  archives sourceJar, javadocJar
-}
-
-def loadProperties(String sourceFileName) {
-  def config = new Properties()
-  def propFile = new File(sourceFileName)
-  if (propFile.canRead()) {
-    config.load(new FileInputStream(propFile))
-    for (Map.Entry property in config) {
-      project.ext[property.key] = property.value;
-    }
-  }
-}
-
-// We  have to explicitly load props from the user home dir - on CI we set
-// GRADLE_USER_HOME to a different dir to avoid problems with concurrent builds corrupting
-// a shared Maven local and using Gradle wrapper concurrently
-loadProperties("${System.getProperty('user.home')}/.gradle/gradle.properties")
-
-
 if (!hasProperty('sonatypeUsername')) {
-  ext.sonatypeUsername = ''
+	ext.sonatypeUsername = ''
 }
 if (!hasProperty('sonatypePassword')) {
-  ext.sonatypePassword = ''
+	ext.sonatypePassword = ''
 }
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -69,89 +30,39 @@ if (!hasProperty('sonatypePassword')) {
 ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
 
 signing {
-  required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }
-  sign configurations.archives
+	required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }
+	sign configurations.archives
 }
 
 uploadArchives {
-  group 'build'
-  description = "Does a maven deploy of archives artifacts"
+	group 'build'
+	description = "Does a maven deploy of archives artifacts"
 
-  repositories {
-    mavenDeployer {
-      setUniqueVersion(false)
+	repositories {
+		mavenDeployer {
+      // setUniqueVersion(false)
 
-      configuration = configurations.archives
+			configuration = configurations.archives
 
-      repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
-        authentication(userName: sonatypeUsername, password: sonatypePassword)
-      }
+			repository(url: "https://oss.sonatype.org/service/local/staging/deploy/maven2/") {
+				authentication(userName: sonatypeUsername, password: sonatypePassword)
+			}
 
-      snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
-        authentication(userName: sonatypeUsername, password: sonatypePassword)
-      }
+			snapshotRepository(url: "https://oss.sonatype.org/content/repositories/snapshots/") {
+				authentication(userName: sonatypeUsername, password: sonatypePassword)
+			}
 
-      if (isReleaseVersion) {
-        beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
-      }
+			if (isReleaseVersion) {
+				beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
+			}
 
-      configurePom(pom)
-    }
-  }
+			configurePom(pom)
+		}
+	}
 }
 
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 // configuration methods
 
-def configurePom(def pom) {
-  pom.project {
-    name rootProject.name
-    description 'Vert.x module that provides Scala support'
-    inceptionYear '2013'
-    packaging 'jar'
-    url 'http://vertx.io'
-
-    developers {
-      developer {
-        id 'swilliams-vmw'
-        name 'Stuart Williams'
-      }
-      developer {
-        id 'edgarchan'
-        name 'Edgar Chan'
-      }
-      developer {
-        id 'nfmelendez'
-        name 'Nicolas Melendez'
-      }
-      developer {
-        id 'Narigo'
-        name 'Joern Bernhardt'
-      }
-      developer {
-        id 'raniejade'
-        name 'Ranie Jade Ramiso'
-      }
-      developer {
-        id 'galderz'
-        name 'Galder Zamarreño'
-      }
-    }
-
-    scm {
-      url 'https://github.com/vert-x/mod-lang-scala'
-    }
-
-    licenses {
-      license {
-        name 'The Apache Software License, Version 2.0'
-        url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
-        distribution 'repo'
-      }
-    }
-
-    properties {
-      setProperty('project.build.sourceEncoding', 'UTF8')
-    }
-  }
-}
+
+