decorator are now different from before/after filters

Author: jknack

TODO

@@ -1,6 +1,5 @@
 * tests and coverage
 
-* flash scope
 * make reset headers on error configurable
 
 * websockets

docs/asciidoc/responses.adoc

@@ -609,9 +609,9 @@ Jooby allows you to use this experimental API by setting the `coroutineStart` op
 
 === Send methods
 
-Jooby provides a family of `sendXXX()` methods that produces a response via side effects.
+Jooby provides a family of `send()` methods that produces a response via side effects.
 
-.sendString example
+.send text
 [source,java,role="primary"]
 ----
 {

docs/asciidoc/routing.adoc

@@ -334,17 +334,11 @@ interface Decorator {
 <3> Compute and print latency
 <4> Returns a response
 
-[NOTE]
-====
-A `decorator` lacks of a `path pattern`. Sound strange? It is explained in the <<router-pipeline, pipeline>> section.
-====
-
-==== Before Decorator
+==== Before
 
-The javadoc:Route.Before[text=before] decorator is a specialized decorator that runs before a 
-`handler`.
+The javadoc:Route.Before[text=before] filter runs before a `handler` or `decorator`.
 
-A `before` decorator takes a `context` as argument and don't produces a response. It expected to operate
+A `before` filter takes a `context` as argument and don't produces a response. It expected to operates
 via side effects (usually modifying the HTTP response).
 
 [source,java]
@@ -382,18 +376,18 @@ interface Before {
 }
 ----
 
-==== After Decorator
+==== After
 
-The javadoc:Route.After[text=after] decorator is a specialized decorator that runs after a 
-`handler`.
+The javadoc:Route.After[text=after] filter runs after a `handler` or `decorator`.
 
-An `after` decorator takes two arguments. The first argument is the `HTTP context`, while the second
-argument is the result/response from a `handler`.  
+An `after` filter takes two arguments. The first argument is the `HTTP context`, while the second
+argument is the result/response from a `handler` and don't produces a response. It expected to operates
+via side effects (usually modifying the HTTP response).  
 
 [source,java]
 ----
 interface After {
-  Object apply(Context ctx, Object result);
+  void apply(Context ctx, Object result);
 }
 ----
 
@@ -402,7 +396,7 @@ interface After {
 ----
 {
   after((ctx, result) -> {
-    return "Hello " + result;
+    System.out.println(result);
   });
 
   get("/", ctx -> {
@@ -416,7 +410,7 @@ interface After {
 ----
 {
   after {
-    "Hello $result"
+    println("Hello $result")
   }
 
   get("/") {
@@ -526,7 +520,7 @@ sequentially one by one. The following `filter` is always executed in Jooby 1.x
 }
 ----
 
-Suppose there is bot trying to access and causing lot of `404` responses (path doesn't exist).
+Suppose there is a bot trying to access and causing lot of `404` responses (path doesn't exist).
 In Jooby 1.x the `filter` is executed for every single request sent by the bot just to realize 
 there is NO matching route and all we need is a `404`.
 
@@ -590,7 +584,7 @@ Output:
 
 ==== Scoped Decorator
 
-The javadoc:Router[route, java.lang.Runnable] and javadoc:Router[path, java.lang.Runnable] operators
+The javadoc:Router[route, java.lang.Runnable] and javadoc:Router[path, java.lang.String, java.lang.Runnable] operators
 are used to group one or more routes.
 
 A `scoped decorator` looks like:
@@ -684,7 +678,7 @@ and allows you to selectively apply one or more routes.
 
 Route operator is for grouping one or more routes and apply cross cutting concerns to all them.
 
-In similar fashin the javadoc:Router[path, java.lang.String, java.lang.Runnable] operator groups
+In similar fashion the javadoc:Router[path, java.lang.String, java.lang.Runnable] operator groups
 one or more routes under a common path pattern.
 
 .Routes with path prefix:

docs/src/main/java/io/jooby/adoc/JavadocProcessor.java

@@ -71,7 +71,7 @@ public Object process(ContentNode parent, String clazz, Map<String, Object> attr
         index += 1;
 
         if (attributes.get(String.valueOf(index)) != null) {
-          link.append(",");
+          link.append("-");
           text.append(",");
         }
       }

jooby/src/main/java/io/jooby/Route.java

@@ -50,7 +50,7 @@ public class Route {
    * @author edgar
    * @since 2.0.0
    */
-  public interface Decorator {
+  public interface Decorator extends Serializable {
     /**
      * Chain the decorator within next handler.
      *
@@ -86,7 +86,7 @@ public interface Decorator {
    * @author edgar
    * @since 2.0.0
    */
-  public interface Before {
+  public interface Before extends Serializable {
     /**
      * Execute application code before next handler.
      *
@@ -128,7 +128,7 @@ public interface Before {
    * @author edgar
    * @since 2.0.0
    */
-  public interface After {
+  public interface After extends Serializable {
 
     /**
      * Chain this decorator with next one and produces a new after decorator.
@@ -226,6 +226,8 @@ public interface Handler extends Serializable {
 
   private Before before;
 
+  private Decorator decorator;
+
   private Handler handler;
 
   private After after;
@@ -261,6 +263,7 @@ public Route(@Nonnull String method,
       @Nonnull Type returnType,
       @Nonnull Handler handler,
       @Nullable Before before,
+      @Nullable Decorator decorator,
       @Nullable After after,
       @Nonnull Renderer renderer,
       @Nonnull Map<String, Parser> parsers) {
@@ -269,13 +272,18 @@ public Route(@Nonnull String method,
     this.returnType = returnType;
     this.handler = handler;
     this.before = before;
+    this.decorator = decorator;
     this.after = after;
     this.renderer = renderer;
     this.pathKeys = pathKeys;
     this.parsers = parsers;
     this.handle = handler;
 
     this.pipeline = handler;
+
+    if (decorator != null) {
+      this.pipeline = decorator.then(pipeline);
+    }
     if (before != null) {
       this.pipeline = before.then(pipeline);
     }
@@ -292,6 +300,7 @@ public Route(@Nonnull String method,
    * @param returnType Return type.
    * @param handler Route handler.
    * @param before Before pipeline.
+   * @param decorator Decorator pipeline.
    * @param after After pipeline.
    * @param renderer Route renderer.
    * @param parsers Route parsers.
@@ -301,10 +310,12 @@ public Route(@Nonnull String method,
       @Nonnull Type returnType,
       @Nonnull Handler handler,
       @Nullable Before before,
+      @Nullable Decorator decorator,
       @Nullable After after,
       @Nonnull Renderer renderer,
       @Nonnull Map<String, Parser> parsers) {
-    this(method, pattern, Router.pathKeys(pattern), returnType, handler, before, after, renderer,
+    this(method, pattern, Router.pathKeys(pattern), returnType, handler, before, decorator, after,
+        renderer,
         parsers);
   }
 
@@ -382,6 +393,10 @@ public Route(@Nonnull String method,
     return after;
   }
 
+  public @Nullable Decorator getDecorator() {
+    return decorator;
+  }
+
   /**
    * Set route handle instance, required when handle is different from {@link #getHandler()}.
    *

jooby/src/main/java/io/jooby/internal/RouterImpl.java

@@ -62,41 +62,41 @@ public class RouterImpl implements Router {
   private static class Stack {
     private String pattern;
     private Executor executor;
-    private List<Route.Decorator> filters = new ArrayList<>();
+    private List<Route.Decorator> decoratorList = new ArrayList<>();
     private List<Route.Before> beforeList = new ArrayList<>();
-    private List<Route.After> afters = new ArrayList<>();
+    private List<Route.After> afterList = new ArrayList<>();
 
     public Stack(String pattern) {
       this.pattern = pattern;
     }
 
     public void then(Route.Decorator filter) {
-      filters.add(filter);
+      decoratorList.add(filter);
     }
 
     public void then(Route.After after) {
-      afters.add(after);
+      afterList.add(after);
     }
 
     public void then(Route.Before before) {
       beforeList.add(before);
     }
 
-    public Stream<Route.Decorator> toFilter() {
-      return filters.stream();
+    public Stream<Route.Decorator> toDecorator() {
+      return decoratorList.stream();
     }
 
     public Stream<Route.After> toAfter() {
-      return afters.stream();
+      return afterList.stream();
     }
 
     public Stream<Route.Before> toBefore() {
       return beforeList.stream();
     }
 
     public void clear() {
-      this.filters.clear();
-      this.afters.clear();
+      this.decoratorList.clear();
+      this.afterList.clear();
       this.beforeList.clear();
       executor = null;
     }
@@ -356,32 +356,26 @@ private Route defineRoute(@Nonnull String method, @Nonnull String pattern,
     stack.stream().filter(it -> it.pattern != null).forEach(it -> pat.append(it.pattern));
     pat.append(pattern);
 
-    /** Decorators: */
-    List<Route.Decorator> filters = stack.stream()
-        .flatMap(Stack::toFilter)
-        .collect(Collectors.toList());
-
     /** Before: */
     Route.Before before = stack.stream()
         .flatMap(Stack::toBefore)
         .reduce(null, (it, next) -> it == null ? next : it.then(next));
 
-    /** Pipeline: */
-    //    Route.Handler pipeline = before == null ? handler : before.then(handler);
+    /** Decorator: */
+    Route.Decorator decorator = stack.stream()
+        .flatMap(Stack::toDecorator)
+        .reduce(null, (it, next) -> it == null ? next : it.then(next));
 
     /** After: */
     Route.After after = stack.stream()
         .flatMap(Stack::toAfter)
         .reduce(null, (it, next) -> it == null ? next : it.then(next));
 
-    //    if (after != null) {
-    //      pipeline = pipeline.then(after);
-    //    }
-
     /** Route: */
     String safePattern = normalizePath(pat.toString(), options.isCaseSensitive(),
         options.isIgnoreTrailingSlash());
-    Route route = new Route(method, safePattern, null, handler, before, after, renderer, parsers);
+    Route route = new Route(method, safePattern, null, handler, before, decorator, after, renderer,
+        parsers);
     Stack stack = this.stack.peekLast();
     if (stack.executor != null) {
       routeExecutor.put(route, stack.executor);
@@ -422,11 +416,20 @@ private Route defineRoute(@Nonnull String method, @Nonnull String pattern,
       if (route.getConsumes().size() > 0) {
         before = before == null ? SUPPORT_MEDIA_TYPE : SUPPORT_MEDIA_TYPE.then(before);
       }
-      Route.Handler pipeline = route.getHandler();
+
+      Route.Decorator decorator = route.getDecorator();
+      Route.Handler handler = route.getHandler();
+      Route.Handler pipeline;
+      if (decorator == null) {
+        pipeline = handler;
+      } else {
+        pipeline = decorator.then(handler);
+      }
 
       if (before != null) {
         pipeline = before.then(pipeline);
       }
+
       Route.After after = route.getAfter();
       if (after != null) {
         pipeline = pipeline.then(after);
@@ -558,8 +561,8 @@ public void destroy() {
   }
 
   private Router newStack(@Nonnull String pattern, @Nonnull Runnable action,
-      Route.Decorator... filter) {
-    return newStack(push(pattern), action, filter);
+      Route.Decorator... decorator) {
+    return newStack(push(pattern), action, decorator);
   }
 
   private Stack push() {
@@ -638,7 +641,8 @@ private void find(String prefix, Class type, Sneaky.Consumer<MvcMethod> consumer
           if (executor == null) {
             // TODO: replace with usage exception
             throw new IllegalArgumentException(
-                "Missing executor: " + executorKey + ", required by: " + mvc.getMethod().getDeclaringClass().getName() + "." + mvc.getMethod()
+                "Missing executor: " + executorKey + ", required by: " + mvc.getMethod()
+                    .getDeclaringClass().getName() + "." + mvc.getMethod()
                     .getName() + ", at line: " + mvc.getLine());
           }
           dispatch(executor, () -> consumer.accept(mvc));

jooby/src/main/java/io/jooby/internal/RouterMatch.java

@@ -84,7 +84,7 @@ public RouterMatch missing(String method, String path, Renderer renderer) {
     } else {
       h = this.handler;
     }
-    this.route = new Route(method, path, emptyList(), String.class, h, null, null, renderer, emptyMap());
+    this.route = new Route(method, path, emptyList(), String.class, h, null, null, null, renderer, emptyMap());
     return this;
   }
 }

jooby/src/test/java/io/jooby/internal/ChiBenchmark.java

@@ -63,7 +63,7 @@ public void setup() {
   }
 
   private Route route(String method, String pattern) {
-    return new Route(method, pattern, String.class, null, null, null, null, null);
+    return new Route(method, pattern, String.class, null, null, null, null, null, null);
   }
 
   @Benchmark

jooby/src/test/java/io/jooby/internal/ChiTest.java

@@ -94,7 +94,7 @@ private Route.Handler stringHandler(String foo) {
   }
 
   private Route route(String method, String pattern, Route.Handler handler) {
-    return new Route(method, pattern, String.class, handler, null, null,
+    return new Route(method, pattern, String.class, handler, null, null, null,
         Renderer.TO_STRING, Collections.emptyMap());
   }
 

jooby/src/test/java/io/jooby/internal/PipelineTest.java

@@ -224,7 +224,7 @@ private Route.Handler pipeline(Route route, ExecutionMode mode, Executor executo
   }
 
   private Route route(Type returnType, Route.Handler handler) {
-    return new Route("GET", "/", returnType, handler, null, null,
+    return new Route("GET", "/", returnType, handler, null, null, null,
         Renderer.TO_STRING, Collections.emptyMap());
   }
 }