even more doc updates, get ready for 0.5.0 release

Author: jknack

README.md

@@ -16,7 +16,7 @@
     <exec executable="git" dir="${workdir}">
       <arg value="clone" />
       <arg value="-b" />
-      <arg value="gh-pages" />
+      <arg value="site" />
       <arg value="--single-branch" />
       <arg value="${gitrepo}" />
       <arg value="." />
@@ -32,7 +32,7 @@
       <fileset dir="target/site/apidocs" />
     </copy>
 
-    <!-- -->
+    <!--
     <exec executable="git" dir="${workdir}">
       <arg value="add" />
       <arg value="-A" />
@@ -41,14 +41,14 @@
     <exec executable="git" dir="${workdir}">
       <arg value="commit" />
       <arg value="-m" />
-      <arg value="Sync docs from master branch to docs gh-pages directory" />
+      <arg value="prepare web site" />
     </exec>
 
     <exec executable="git" dir="${workdir}">
       <arg value="push" />
       <arg value="origin" />
-      <arg value="gh-pages" />
-    </exec>
+      <arg value="site" />
+    </exec>-->
 
   </target>
 

gh-pages.ant

@@ -0,0 +1,178 @@
+# jooby-camel
+
+[Apache Camel](http://camel.apache.org) integration for Jooby.
+
+Exposes a [CamelContext], [ProducerTemplate] and [ConsumerTemplate].
+
+NOTE: This module was designed to provide a better integration with Jooby. This module doesn't
+depend on [camel-guice](http://camel.apache.org/guice.html), but it provides similar features.
+
+## dependency
+
+```xml
+<dependency>
+  <groupId>org.jooby</groupId>
+  <artifactId>jooby-camel</artifactId>
+  <version>0.4.2.1</version>
+</dependency>
+```
+
+## usage
+
+```java
+{
+  use(new Camel()
+    .routes((rb, config) -> {
+      rb.from("direct:noop").to("mock:out");
+    })
+  );
+
+  get("/noop", req -> {
+    req.require(ProducerTemplate.class).sendBody("direct:noop", "NOOP");
+    return "/noop";
+  });
+
+}
+```
+
+Previous example, add a direct route using the Java DSL. A route builder can be created and
+injected by Guice, see next section.
+
+## camel routes
+
+```java
+public class MyRoutes extends RouteBuilder {
+
+  @Inject
+  public MyRoutes(Service service) {
+    this.service = service;
+  }
+
+  public void configure() {
+    from("direct:noop").to("mock:out").bean(service);
+  }
+}
+
+...
+{
+  use(new Camel().routes(MyRoutes.class));
+}
+```
+
+or without extending RouteBuilder:
+
+```java
+public class MyRoutes {
+
+  @Inject
+  public MyRoutes(RouteBuilder router, Service service) {
+    router.from("direct:noop").to("mock:out").bean(service);
+  }
+
+}
+
+...
+{
+  use(new Camel().routes(MyRoutes.class));
+}
+```
+
+## configuration
+
+Custom configuration is achieved in two ways:
+
+### application.conf
+
+A [CamelContext] can be configured from your ```application.conf```:
+
+```properties
+camel.handleFault = false
+camel.shutdownRoute = Default
+camel.shutdownRunningTask = CompleteCurrentTaskOnly
+camel.streamCaching.enabled = false
+camel.tracing = false
+camel.autoStartup = true
+camel.allowUseOriginalMessage = false
+camel.jmx = false
+```
+
+Same for [ShutdownStrategy]:
+
+```properties
+camel.shutdown.shutdownRoutesInReverseOrder = true
+camel.shutdown.timeUnit = SECONDS
+camel.shutdown.timeout = 10
+```
+
+[ThreadPoolProfile]:
+
+```properties
+camel.threads.poolSize = ${runtime.processors-plus1}
+camel.threads.maxPoolSize = ${runtime.processors-x2}
+camel.threads.keepAliveTime = 60
+camel.threads.timeUnit = SECONDS
+camel.threads.rejectedPolicy = CallerRuns
+camel.threads.maxQueueSize = 1000
+camel.threads.id = default
+camel.threads.defaultProfile = true
+```
+
+and [StreamCachingStrategy]:
+
+```properties
+camel.streamCaching.enabled = false
+camel.streamCaching.spoolDirectory = ${application.tmpdir}${file.separator}"camel"${file.separator}"#uuid#"
+```
+
+### programmatically
+
+Using the ```doWith(Configurer)``` method:
+
+```java
+{
+  use(new Camel().doWith((ctx, config) -> {
+    // set/override any other property.
+  }));
+}
+```
+
+That's all folks! Enjoy it!!!
+
+## appendix: camel.conf
+```properties
+# Camel defaults
+camel.handleFault = false
+
+camel.shutdownRoute = Default
+
+camel.shutdownRunningTask = CompleteCurrentTaskOnly
+
+camel.tracing = false
+
+camel.autoStartup = true
+
+camel.allowUseOriginalMessage = false
+
+camel.jmx = false
+
+# shutdown
+camel.shutdown.shutdownRoutesInReverseOrder = true
+camel.shutdown.timeUnit = SECONDS
+camel.shutdown.timeout = 10
+
+# thread pool
+camel.threads.poolSize = ${runtime.processors-plus1}
+camel.threads.maxPoolSize = ${runtime.processors-x2}
+camel.threads.keepAliveTime = 60
+camel.threads.timeUnit = SECONDS
+camel.threads.rejectedPolicy = CallerRuns
+camel.threads.maxQueueSize = 1000
+camel.threads.id = default
+camel.threads.defaultProfile = true
+
+# stream caching
+camel.streamCaching.enabled = false
+camel.streamCaching.spoolDirectory = ${application.tmpdir}${file.separator}"camel"${file.separator}"#uuid#"
+
+```
+

jooby-camel/README.md

@@ -0,0 +1,126 @@
+# jooby-ftl
+
+[Freemarker](http://freemarker.org) templates for [Jooby](/). Exposes a Configuration and [body formatter](/apidocs/org/jooby/BodyFormatter.html).
+
+## dependency
+
+```xml
+<dependency>
+  <groupId>org.jooby</groupId>
+  <artifactId>jooby-ftl</artifactId>
+  <version>0.4.2.1</version>
+</dependency>
+```
+
+## usage
+It is pretty straightforward:
+
+```java
+{
+  use(new Ftl());
+
+  get("/", req {@literal ->} View.of("index", "model", new MyModel());
+}
+```
+
+public/index.html:
+
+```java
+${model}
+```
+
+Templates are loaded from root of classpath: ```/``` and must end with: ```.html```
+file extension.
+
+## req locals
+
+A template engine has access to ```request locals```. Here is an example:
+
+```java
+{
+  use(new Ftl());
+
+  get("*", req -> {
+    req.set("req", req);
+    req.set("session", req.session());
+  });
+}
+```
+
+By default, there is no access to ```req``` or ```session``` from your template. This example shows how to do it.
+
+
+## configuration
+There are two ways of changing a Freemarker configuration:
+
+### application.conf
+Just add a ```freemarker.*``` option to your ```application.conf``` file:
+
+```properties
+freemarker.default_encoding = UTF-8
+```
+
+### programmatically
+
+```java
+{
+  use(new Ftl().doWith((freemarker, config) -> {
+    freemarker.setDefaultEncoding("UTF-8");
+  });
+}
+```
+
+Keep in mind this is just an example and you don't need to set the default encoding. Default
+encoding is set to: ```application.charset``` which is ```UTF-8``` by default.
+
+## template loader
+Templates are loaded from the root of classpath and must end with ```.html```. You can
+change the default template location and extensions too:
+
+```java
+{
+  use(new Ftl("/", ".ftl"));
+}
+```
+
+## cache
+
+Cache is OFF when ```env=dev``` (useful for template reloading), otherwise is ON.
+
+Cache is backed by [Guava](https://github.com/google/guava) and default cache will expire after ```100``` entries.
+
+If ```100``` entries is not enough or you need a more advanced cache setting, just set the
+```freemarker.cache``` option:
+
+```properties
+freemarker.cache = "expireAfterWrite=1h"
+```
+
+See [CacheBuilderSpec](http://docs.guava-libraries.googlecode.com/git/javadoc/com/google/common/cache/CacheBuilderSpec.html) for more detailed expressions.
+
+That's all folks! Enjoy it!!!
+
+## appendix: freemarker.conf
+```properties
+#freemarker defaults
+
+freemarker.locale = ${application.lang}
+
+freemarker.number_format = ${application.numberFormat}
+
+freemarker.date_format = ${application.dateFormat}
+
+freemarker.time_zone = ${application.tz}
+
+freemarker.object_wrapper = default
+
+freemarker.template_exception_handler = default
+
+freemarker.defaultEncoding = ${application.charset}
+
+# cache for env != dev
+freemarker.cache = "maximumSize=100"
+
+```
+
+

jooby-ftl/README.md

@@ -6,9 +6,22 @@
 <dependency>
   <groupId>org.jooby</groupId>
   <artifactId>jooby-hbm</artifactId>
-  <version>0.4.2</version>
+  <version>0.4.2.1</version>
 </dependency>
 ```
 ## usage
 
 
+## appendix: hbm.conf
+```properties
+hibernate {
+  id.new_generator_mappings = true
+  archive.autodetection = class
+  hbm2ddl.auto = update
+}
+
+javax.persistence {
+}
+
+```
+