review doc #495

Author: jknack

jooby-akka/README.md

@@ -22,7 +22,7 @@ Small module to build concurrent & distributed applications via [Akka](http://ak
   use(new Akka());
 
   get("/akka", promise((req, deferred) -> {
-    ActorSystem sys = req.require(ActorSystem.class);
+    ActorSystem sys = require(ActorSystem.class);
     ActorRef actor = sys.actorOf(...);
     // send the deferred to the actor
     actor.tell(deferred, actor);

jooby-archetype/src/main/resources/archetype-resources/conf/logback.xml

@@ -7,9 +7,9 @@
   </appender>
 
   <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
-    <file>log/app.log</file>
+    <file>log/${artifactId}.log</file>
     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
-      <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>
+      <fileNamePattern>log/${artifactId}.%d{yyyy-MM-dd}.log</fileNamePattern>
       <totalSizeCap>1mb</totalSizeCap>
       <maxHistory>7</maxHistory>
     </rollingPolicy>

jooby-aws/README.md

@@ -35,7 +35,7 @@ aws.secretKey =  wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
   );
 
   get("/", req -> {
-    AmazonS3 s3 = req.require(AmazonS3.class);
+    AmazonS3 s3 = require(AmazonS3.class);
     // work with s3
   });
 }

jooby-caffeine/README.md

@@ -28,7 +28,7 @@ import org.jooby.caffeine.CaffeineCache;
 
   get("/", req -> {
 
-    Cache cache = req.require(Cache.class);
+    Cache cache = require(Cache.class);
     // do with cache...
   });
 
@@ -67,9 +67,9 @@ caffeine.cacheX = "maximumSize=100"
 ```java
 {
   get("/", req -> {
-    Cache defcache = req.require(Cache.class);
-    Cache cache1 = req.require("cache1", Cache.class);
-    Cache cacheX = req.require("cacheX", Cache.class);
+    Cache defcache = require(Cache.class);
+    Cache cache1 = require("cache1", Cache.class);
+    Cache cacheX = require("cacheX", Cache.class);
   });
 }
 ```
@@ -122,7 +122,7 @@ You can access to the ```session``` via name:
 ```java
 {
   get("/", req -> {
-    Cache cache = req.require("session", Cache.class);
+    Cache cache = require("session", Cache.class);
   });
 }
 ```

jooby-camel/README.md

@@ -38,7 +38,7 @@ depend on [camel-guice](http://camel.apache.org/guice.html), but it provides sim
   );
 
   get("/noop", req -> {
-    req.require(ProducerTemplate.class).sendBody("direct:noop", "NOOP");
+    require(ProducerTemplate.class).sendBody("direct:noop", "NOOP");
     return "/noop";
   });
 

jooby-cassandra/README.md

@@ -77,22 +77,22 @@ Here is a basic API on top of [Datastore](/apidocs/org/jooby/cassandra/Datastore
 {
   use("/api/beer")
     .post(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       Beer beer = req.body().to(Beer.class);
       ds.save(beer);
       return beer;
     })
     .get("/:id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       Beer beer = ds.get(Beer.class, req.param("id").value());
       return beer;
     })
     .get(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       return ds.query(Beer.class, "select * from beer").all();
     })
     .delete("/:id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       ds.delete(Beer.class, req.param("id").value());
       return Results.noContent();
     });
@@ -129,22 +129,22 @@ Async? Of course!!! just use the Datastax async API:
 
   use("/api/beer")
     .post(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       Beer beer = req.body().to(Beer.class);
       ds.saveAsync(beer);
       return beer;
     })
     .get("/:id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       ListeneableFuture<Beer> beer = ds.getAsync(Beer.class, req.param("id").value());
       return beer;
     })
     .get(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       return ds.queryAsync(Beer.class, "select * from beer").all();
     })
     .delete("/:id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       ds.deleteAsync(Beer.class, req.param("id").value());
       return Results.noContent();
     });

jooby-commons-email/README.md

@@ -38,7 +38,7 @@ application.conf:
   use(new CommonsEmail());
 
   get("/send", req -> {
-    req.require(SimpleEmail.class)
+    require(SimpleEmail.class)
        .setMsg("you got an email!")
        .setTo("foo@bar.com")
        .send();

jooby-couchbase/README.md

@@ -35,7 +35,7 @@ Via couchbase connection string:
   use(new Couchbase("couchbase://locahost/beers"));
 
   get("/", req -> {
-    Bucket beers = req.require(Bucket.class);
+    Bucket beers = require(Bucket.class);
     // do with beer bucket
   });
 }
@@ -48,7 +48,7 @@ Via property:
   use(new Couchbase("db"));
 
   get("/", req -> {
-    Bucket beers = req.require(Bucket.class);
+    Bucket beers = require(Bucket.class);
     // do with beer bucket
   });
 
@@ -71,23 +71,23 @@ import org.jooby.couchbase.N1Q;
   use("/api/beers")
     /** List beers */
     .get(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       return ds.query(N1Q.from(Beer.class));
     })
     /** Create a new beer */
     .post(req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       Beer beer = req.body().to(Beer.class);
       return ds.upsert(beer);
     })
     /** Get a beer by ID */
     .get(":id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       return ds.get(Beer.class, req.param("id").value());
     })
     /** Delete a beer by ID */
     .delete(":id", req -> {
-      Datastore ds = req.require(Datastore.class);
+      Datastore ds = require(Datastore.class);
       return ds.delete(Beer.class, req.param("id").value());
     });
 }
@@ -181,7 +181,7 @@ Couchbase SDK allows two programming model: ```blocking``` and ```reactive```. W
 
   get("/", req -> {
 
-    AsyncBucket bucket = req.require(AsyncBucket.class);
+    AsyncBucket bucket = require(AsyncBucket.class);
     // do with async bucket ;)
   });
 
@@ -202,7 +202,7 @@ import org.jooby.rx.Rx;
 
   get("/api/beer/:id", req -> {
 
-    AsyncDatastore ds = req.require(AsyncDatastore.class);
+    AsyncDatastore ds = require(AsyncDatastore.class);
     String id = req.param("id").value();
     Observable<Beer> beer = ds.get(Beer.class, id);
     return beer;
@@ -223,8 +223,8 @@ If for any reason your application requires more than 1 bucket... then:
     .buckets("extra-bucket"));
   get("/", req -> {
 
-    Bucket bucket = req.require("beers", Bucket.class);
-    Bucket extra = req.require("extra-bucket", Bucket.class);
+    Bucket bucket = require("beers", Bucket.class);
+    Bucket extra = require("extra-bucket", Bucket.class);
   });
 
 }

jooby-ebean/README.md

@@ -27,7 +27,7 @@ This module extends [jdbc module](/doc/jdbc), before going forward, make sure yo
   }));
 
   get("/pets", req -> {
-    EbeanServer ebean = req.require(EbeanServer.class);
+    EbeanServer ebean = require(EbeanServer.class);
     return ebean.createQuery(Pet.class)
        .findList();
   });

jooby-ehcache/README.md

@@ -24,10 +24,10 @@ Provides advanced cache features via [Ehcache](http://ehcache.org)
   use(new Eh());
 
   get("/", req -> {
-    CacheManager cm = req.require(CacheManager.class);
+    CacheManager cm = require(CacheManager.class);
     // work with cm
 
-    Ehcache ehcache = req.require(Ehcache.class);
+    Ehcache ehcache = require(Ehcache.class);
     // work with ehcache
   });
 }
@@ -51,7 +51,7 @@ Later, we can access to ```mycache``` with:
 ```java
 {
   get("/", req -> {
-    Ehcache mycache = req.require(Ehcache.class);
+    Ehcache mycache = require(Ehcache.class);
   });
 }
 ```
@@ -77,9 +77,9 @@ Later, we can access to our caches with:
 ```java
 {
   get("/", req -> {
-    Ehcache cache1 = req.require("cache1", Ehcache.class);
+    Ehcache cache1 = require("cache1", Ehcache.class);
     // ..
-    Ehcache cache2 = req.require("cache2", Ehcache.class);
+    Ehcache cache2 = require("cache2", Ehcache.class);
     // ..
   });
 }