Rename Renderer -> MessageEncoder

Author: jknack

docs/asciidoc/body.adoc

@@ -160,19 +160,19 @@ Response body is generated from `handler` function:
 <3> Set the `date` header
 <4> Send a `Response` string to the client
 
-==== Renderer
+==== Message Encoder
 
-Response rendering is achieved using the javadoc:Renderer[] functional interface.
+Response enconding is achieved using the javadoc:MessageEncoder[] functional interface.
 
 [source, java]
 ----
-public interface Renderer {
+public interface MessageEncoder {
 
-  byte[] render(@Nonnull Context ctx, @Nonnull Object value) throws Exception;
+  byte[] encode(@Nonnull Context ctx, @Nonnull Object value) throws Exception;
 }
 ----
 
-Renderer has a single `render` method that accepts two input arguments: `(context, result)` and 
+MessageEncoder has a single `encode` method that accepts two input arguments: `(context, result)` and 
 produces a result.
 
 .JSON example:
@@ -181,7 +181,7 @@ produces a result.
 {
   FavoriteJson lib = new FavoriteJson();           // <1>
 
-  renderer(MediaType.json, (ctx, result) -> {      // <2>
+  encoder(MediaType.json, (ctx, result) -> {      // <2>
 
     String json = lib.toJson(result);              // <3>
 
@@ -203,7 +203,7 @@ produces a result.
 {
   val lib = FavoriteJson()                         // <1>
 
-  renderer(MediaType.json, { ctx, result ->        // <2>
+  encoder(MediaType.json, { ctx, result ->        // <2>
 
     val json = lib.toJson(result)                  // <3>
 
@@ -229,7 +229,7 @@ produces a result.
 [TIP]
 ====
 
-Jooby comes with a `json` renderer built on top of https://github.com/FasterXML/jackson-databind[Jackson]:
+Jooby comes with a `json` encoder built on top of https://github.com/FasterXML/jackson-databind[Jackson]:
 
 [dependency, artifactId="jooby-jackson"]
 .

docs/asciidoc/responses.adoc

@@ -4,7 +4,7 @@ This chapter covers some special response types, like `raw responses`, `streamin
 
 === Raw
 
-Raw responses are NOT processed by a <<renderer, Renderer>>. These response types are considered `raw`:
+Raw responses are NOT processed by a <<encoder, Renderer>>. These response types are considered `raw`:
 
 - String/CharSequence
 - byte[]
@@ -35,7 +35,7 @@ Raw responses are NOT processed by a <<renderer, Renderer>>. These response type
 }
 ----
 
-No matter if there is a JSON renderer installed, a raw response is always send directly to client.
+No matter if there is a JSON encoder installed, a raw response is always send directly to client.
 
 === Streaming / Chunked
 

jooby/src/main/java/io/jooby/Context.java

@@ -1064,8 +1064,8 @@ default long getRequestLength() {
   default @Nonnull Context render(@Nonnull Object value) {
     try {
       Route route = getRoute();
-      Renderer renderer = route.getRenderer();
-      byte[] bytes = renderer.render(this, value);
+      MessageEncoder encoder = route.getEncoder();
+      byte[] bytes = encoder.encode(this, value);
       send(bytes);
       return this;
     } catch (Exception x) {

jooby/src/main/java/io/jooby/Jooby.java

@@ -288,8 +288,8 @@ public <T> Jooby mvc(@Nonnull Class<T> router, @Nonnull Provider<T> provider) {
     return this;
   }
 
-  @Nonnull @Override public Jooby renderer(@Nonnull Renderer renderer) {
-    router.renderer(renderer);
+  @Nonnull @Override public Jooby renderer(@Nonnull MessageEncoder encoder) {
+    router.renderer(encoder);
     return this;
   }
 
@@ -300,8 +300,8 @@ public <T> Jooby mvc(@Nonnull Class<T> router, @Nonnull Provider<T> provider) {
   }
 
   @Nonnull @Override
-  public Jooby renderer(@Nonnull MediaType contentType, @Nonnull Renderer renderer) {
-    router.renderer(contentType, renderer);
+  public Jooby renderer(@Nonnull MediaType contentType, @Nonnull MessageEncoder encoder) {
+    router.renderer(contentType, encoder);
     return this;
   }
 

…oby/src/main/java/io/jooby/Renderer.java …c/main/java/io/jooby/MessageEncoder.javajooby/src/main/java/io/jooby/Renderer.java renamed to jooby/src/main/java/io/jooby/MessageEncoder.java jooby/src/main/java/io/jooby/Renderer.java renamed to jooby/src/main/java/io/jooby/MessageEncoder.java

@@ -14,25 +14,25 @@
  * @author edgar
  * @since 2.0.0
  */
-public interface Renderer {
+public interface MessageEncoder {
 
   /** To string renderer. */
-  Renderer TO_STRING = (ctx, value) -> {
+  MessageEncoder TO_STRING = (ctx, value) -> {
     if (ctx.accept(ctx.getResponseType())) {
       return value.toString().getBytes(StandardCharsets.UTF_8);
     }
     throw new StatusCodeException(StatusCode.NOT_ACCEPTABLE);
   };
 
   /**
-   * Renderer a value into a byte array or <code>null</code> if given object isn't supported it.
+   * MessageEncoder a value into a byte array or <code>null</code> if given object isn't supported it.
    *
    * @param ctx Web context.
    * @param value Value to render.
    * @return Value as byte array or <code>null</code> if given object isn't supported it.
    * @throws Exception If something goes wrong.
    */
-  @Nonnull byte[] render(@Nonnull Context ctx, @Nonnull Object value) throws Exception;
+  @Nonnull byte[] encode(@Nonnull Context ctx, @Nonnull Object value) throws Exception;
 
   /**
    * Execute this renderer only if the <code>Accept</code> header matches the content-type
@@ -41,10 +41,10 @@ public interface Renderer {
    * @param contentType Mediatype to test.
    * @return A new renderer with accept header matching.
    */
-  @Nonnull default Renderer accept(@Nonnull MediaType contentType) {
+  @Nonnull default MessageEncoder accept(@Nonnull MediaType contentType) {
     return (ctx, value) -> {
       if (ctx.accept(contentType)) {
-        return render(ctx, value);
+        return encode(ctx, value);
       }
       return null;
     };

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

@@ -256,7 +256,7 @@ public interface Handler extends Serializable {
 
   private Handler pipeline;
 
-  private Renderer renderer;
+  private MessageEncoder encoder;
 
   private Type returnType;
 
@@ -433,22 +433,22 @@ public Route(@Nonnull String method, @Nonnull String pattern, @Nonnull Handler h
   }
 
   /**
-   * Route renderer.
+   * Route encoder.
    *
-   * @return Route renderer.
+   * @return Route encoder.
    */
-  public @Nonnull Renderer getRenderer() {
-    return renderer;
+  public @Nonnull MessageEncoder getEncoder() {
+    return encoder;
   }
 
   /**
-   * Set renderer.
+   * Set encoder.
    *
-   * @param renderer Renderer.
+   * @param encoder MessageEncoder.
    * @return This route.
    */
-  public @Nonnull Route setRenderer(@Nonnull Renderer renderer) {
-    this.renderer = renderer;
+  public @Nonnull Route setEncoder(@Nonnull MessageEncoder encoder) {
+    this.encoder = encoder;
     return this;
   }
 

jooby/src/main/java/io/jooby/Router.java

@@ -223,21 +223,21 @@ interface Match {
   @Nonnull List<Route> getRoutes();
 
   /**
-   * Register a route response renderer.
+   * Register a route response encoder.
    *
-   * @param renderer Renderer instance.
+   * @param encoder MessageEncoder instance.
    * @return This router.
    */
-  @Nonnull Router renderer(@Nonnull Renderer renderer);
+  @Nonnull Router renderer(@Nonnull MessageEncoder encoder);
 
   /**
-   * Register a route response renderer.
+   * Register a route response encoder.
    *
    * @param contentType Accept header should matches the content-type.
-   * @param renderer Renderer instance.
+   * @param encoder MessageEncoder instance.
    * @return This router.
    */
-  @Nonnull Router renderer(@Nonnull MediaType contentType, @Nonnull Renderer renderer);
+  @Nonnull Router renderer(@Nonnull MediaType contentType, @Nonnull MessageEncoder encoder);
 
   /**
    * Application temporary directory.

jooby/src/main/java/io/jooby/TemplateEngine.java

@@ -14,7 +14,7 @@
  * @since 2.0.0
  * @author edgar
  */
-public interface TemplateEngine extends Renderer {
+public interface TemplateEngine extends MessageEncoder {
 
   /** Name of application property that defines the template path. */
   String TEMPLATE_PATH = "templates.path";
@@ -30,11 +30,11 @@ public interface TemplateEngine extends Renderer {
    * @return Rendered template.
    * @throws Exception If something goes wrong.
    */
-  String apply(Context ctx, ModelAndView modelAndView) throws Exception;
+  String render(Context ctx, ModelAndView modelAndView) throws Exception;
 
-  @Override default byte[] render(@Nonnull Context ctx, @Nonnull Object value) throws Exception {
+  @Override default byte[] encode(@Nonnull Context ctx, @Nonnull Object value) throws Exception {
     ctx.setDefaultResponseType(MediaType.html);
-    String output = apply(ctx, (ModelAndView) value);
+    String output = render(ctx, (ModelAndView) value);
     return output.getBytes(StandardCharsets.UTF_8);
   }
 

jooby/src/main/java/io/jooby/internal/$Chi.java

@@ -6,9 +6,8 @@
 package io.jooby.internal;
 
 import io.jooby.Context;
-import io.jooby.Renderer;
+import io.jooby.MessageEncoder;
 import io.jooby.Route;
-import io.jooby.Router;
 
 import java.util.Arrays;
 import java.util.HashMap;
@@ -632,7 +631,7 @@ public void insert(Route route) {
     root.destroy();
   }
 
-  public RouterMatch find(Context context, String path, Renderer renderer, List<RadixTree> more) {
+  public RouterMatch find(Context context, String path, MessageEncoder encoder, List<RadixTree> more) {
     String method = context.getMethod();
     RouterMatch result = new RouterMatch();
     Route route = root.findRoute(result, method, path);
@@ -642,12 +641,12 @@ public RouterMatch find(Context context, String path, Renderer renderer, List<Ra
     if (more != null) {
       // expand search
       for (RadixTree tree : more) {
-        RouterMatch match = tree.find(context, path, renderer, null);
+        RouterMatch match = tree.find(context, path, encoder, null);
         if (match.matches) {
           return match;
         }
       }
     }
-    return result.missing(method, path, renderer);
+    return result.missing(method, path, encoder);
   }
 }

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

@@ -0,0 +1,64 @@
+/**
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+package io.jooby.internal;
+
+import io.jooby.Context;
+import io.jooby.MessageEncoder;
+import io.jooby.ModelAndView;
+import io.jooby.TemplateEngine;
+
+import javax.annotation.Nonnull;
+import java.util.Iterator;
+import java.util.LinkedList;
+
+public class CompositeMessageEncoder implements MessageEncoder {
+
+  private LinkedList<MessageEncoder> list = new LinkedList<>();
+
+  private MessageEncoder templateEngine;
+
+  public CompositeMessageEncoder() {
+    list.add(MessageEncoder.TO_STRING);
+  }
+
+  public CompositeMessageEncoder add(MessageEncoder encoder) {
+    if (encoder instanceof TemplateEngine) {
+      templateEngine = computeRenderer(templateEngine, encoder);
+    } else {
+      list.addFirst(encoder);
+    }
+    return this;
+  }
+
+  private MessageEncoder computeRenderer(MessageEncoder it, MessageEncoder next) {
+    if (it == null) {
+      return next;
+    } else if (it instanceof CompositeMessageEncoder) {
+      ((CompositeMessageEncoder) it).list.addFirst(next);
+      return it;
+    } else {
+      CompositeMessageEncoder composite = new CompositeMessageEncoder();
+      composite.list.addFirst(it);
+      composite.list.addFirst(next);
+      return composite;
+    }
+  }
+
+  @Override public byte[] encode(@Nonnull Context ctx, @Nonnull Object value) throws Exception {
+    if (value instanceof ModelAndView) {
+      return templateEngine.encode(ctx, value);
+    } else {
+      Iterator<MessageEncoder> iterator = list.iterator();
+      /** NOTE: looks like an infinite loop but there is a default renderer at the end of iterator. */
+      byte[] result = null;
+      while (result == null) {
+        MessageEncoder next = iterator.next();
+        result = next.encode(ctx, value);
+      }
+      return result;
+    }
+  }
+}