moved stuff around

Author: unixunion

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+# Guide to contributing
+
+Please read this if you intend to contribute to the project.
+
+## First things
+
+* Get a github account if you don't have one already
+* Submit a github issue if there isn't one already.
+  * Clearly describe the bug or feature
+  * Provide exact reproducable steps to reproduce the issue if its a bug
+  * Include the versions of all components
+* Fork the repository on github
+
+## Making your changes
+
+* Create a new branch for your changes
+* Make your changes
+* Make sure you include tests
+* Make sure the test suite passes after your changes
+* Commit your changes into that branch
+* Use descriptive and meaningful commit messages
+* If you have a lot of commits squash them into a single commit
+* Push your changes to your branch in your forked repository
+
+## Submitting the changes
+
+Before submitting your pull request you must sign the [Eclipse Foundation Contributor License Agreement](http://www.eclipse.org/legal/CLA.php).
+
+We will NOT ACCEPT any contributions without this first being signed.
+
+To sign the Eclipse CLA you need to:
+
+* Obtain an Eclipse Foundation userid. Anyone who currently uses Eclipse Bugzilla or Gerrit systems already has one of those.
+If you don’t, you need to [register](https://dev.eclipse.org/site_login/createaccount.php).
+
+* Login into the [projects portal](https://projects.eclipse.org/), select “My Account”, and then the “Contributor License Agreement” tab.
+ 
+## After submitting
+
+* Once you have signed the Eclipse CLA, make a note on the github issue that you have signed the CLA, and then you can submit a pull request via github.
+* Do not use your branch for any other development, otherwise further changes that you make will be visible in the PR.
+
+
+

LICENSE.txt

@@ -0,0 +1,6 @@
+vert.x is 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

README.md

@@ -1,22 +1,12 @@
-# Vertx.io (Vert.x) Couchbase 
-### Message Bus SDK/Wrapper
+# Vert.x Gradle Template
 
-Message Bus based style of working with Couchbase Server with command message, callbacks and futures depending on operation type/style.
-You can instantiate multiple mods of course, and mix the styles (sync/async) depending on what you are trying to achieve.
+Template project for creating a Vert.x module with a Gradle build.
 
-The `CouchbaseCommandPacketSync` and `CouchbaseCommandPacketAsync` classes describe the message formats for couchbase commands.
+Clone this and adapt it to easily develop Vert.x modules using Gradle as your build tool.
 
-Two different mods for different styles of operations:
+By default this module contains a simple Java verticle which listens on the event bus and responds to `ping!`
+messages with `pong!`.
 
-`com.scalabl3.vertxmods.couchbase.async`
+This template also shows you how to write tests in Java, Groovy, Ruby and Python
 
-`com.scalabl3.vertxmods.couchbase.sync`
-
-I worked on this last in June 2013 and got a lot of it working, but need to refresh it all and see where it was left off.
-
-TODO
----
-* Needs updating to gradle style project
-* Was created for older vert.x release (2.0.0)
-* Full test coverage not there yet
-* Needs to be updated to latest Couchbase Java SDK
+See the [build script](build.gradle) for the list of useful tasks

build.gradle

@@ -0,0 +1,105 @@
+apply from: "gradle/vertx.gradle"
+
+/*
+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.
+
+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)
+
+ */
+
+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
+  */
+
+  // If you're creating Groovy compiled verticles you may need the following dependencies
+  provided "org.codehaus.groovy:groovy-all:$groovyVersion"
+  provided "io.vertx:lang-groovy:$groovyLangModVersion@jar"
+
+}
+
+test {
+  /* Configure which tests are included
+  include 'org/foo/**'
+  exclude 'org/boo/**'
+  */
+
+}
+
+/*
+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 'Description of your module here'
+    inceptionYear '2013'
+    packaging 'jar'
+
+    url 'Your project url'
+
+    developers {
+      developer {
+        id 'developer id (e.g. github username)'
+        name 'developer name'
+        email 'developer email'
+      }
+    }
+
+    scm {
+      url 'url to your repo - e.g. github repo url'
+    }
+
+    licenses {
+      license {
+        name 'The name of the license used, e.g.: The Apache Software License, Version 2.0'
+        url 'URl to the license, e.g.: http://www.apache.org/licenses/LICENSE-2.0.txt'
+        distribution 'repo'
+      }
+    }
+
+    properties {
+      setProperty('project.build.sourceEncoding', 'UTF8')
+    }
+  }
+}

conf.json

@@ -0,0 +1,5 @@
+// Example JSON config file
+
+{
+  "foo": "bar"
+}

gradle.properties

@@ -0,0 +1,44 @@
+# E.g. your domain name
+modowner=com.mycompany
+
+# Your module name
+modname=my-module
+
+# Your module version
+version=1.0.0-final
+
+# The test timeout in seconds
+testtimeout=300
+
+# 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
+
+# The version of Groovy language to compile against (if you are using Groovy compiled verticles or VertxTests)
+groovyLangModVersion=2.0.0-final
+
+# The version of Groovy to use (if you are using Groovy)
+groovyVersion=2.1.5
+
+# Gradle version
+gradleVersion=1.10
+
+# The version of Vert.x
+vertxVersion=2.1RC2
+
+# The version of Vert.x test tools
+toolsVersion=2.0.3-final
+
+# The version of JUnit
+junitVersion=4.10
+
+# 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

@@ -0,0 +1,68 @@
+/*
+ * 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.
+ */
+
+apply plugin: 'maven'
+apply plugin: 'signing'
+
+if (!hasProperty('sonatypeUsername')) {
+	ext.sonatypeUsername = ''
+}
+if (!hasProperty('sonatypePassword')) {
+	ext.sonatypePassword = ''
+}
+
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// maven task configuration
+
+ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
+
+signing {
+	required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }
+	sign configurations.archives
+}
+
+uploadArchives {
+	group 'build'
+	description = "Does a maven deploy of archives artifacts"
+
+	repositories {
+		mavenDeployer {
+      // setUniqueVersion(false)
+
+			configuration = configurations.archives
+
+			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)
+			}
+
+			if (isReleaseVersion) {
+				beforeDeployment { MavenDeployment deployment -> signing.signPom(deployment) }
+			}
+
+			configurePom(pom)
+		}
+	}
+}
+
+// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+// configuration methods
+
+
+

gradle/setup.gradle

@@ -0,0 +1,5 @@
+
+task wrapper(type: Wrapper, description: "Create a Gradle self-download wrapper") {
+    group = 'Project Setup'
+    gradleVersion = rootProject.gradleVersion
+}