refactor: move RouteSet as inner class of Route and rename to Set, so Route.Set

Author: jknack

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

@@ -25,7 +25,6 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.Properties;
-import java.util.Set;
 import java.util.concurrent.Executor;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -310,7 +309,7 @@ public String getContextPath() {
    * @param factory Application factory.
    * @return Created routes.
    */
-  @NonNull public RouteSet install(@NonNull SneakyThrows.Supplier<Jooby> factory) {
+  @NonNull public Route.Set install(@NonNull SneakyThrows.Supplier<Jooby> factory) {
     return install("/", factory);
   }
 
@@ -344,7 +343,7 @@ public String getContextPath() {
    * @param factory Application factory.
    * @return Created routes.
    */
-  @NonNull public RouteSet install(@NonNull String path, @NonNull SneakyThrows.Supplier<Jooby> factory) {
+  @NonNull public Route.Set install(@NonNull String path, @NonNull SneakyThrows.Supplier<Jooby> factory) {
     try {
       owner = this;
       return path(path, factory::get);
@@ -468,27 +467,27 @@ public Jooby setTrustProxy(boolean trustProxy) {
   }
 
   @NonNull @Override
-  public RouteSet domain(@NonNull String domain, @NonNull Router subrouter) {
+  public Route.Set domain(@NonNull String domain, @NonNull Router subrouter) {
     return this.router.domain(domain, subrouter);
   }
 
   @NonNull @Override
-  public RouteSet domain(@NonNull String domain, @NonNull Runnable body) {
+  public Route.Set domain(@NonNull String domain, @NonNull Runnable body) {
     return router.domain(domain, body);
   }
 
   @NonNull @Override
-  public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Runnable body) {
+  public Route.Set mount(@NonNull Predicate<Context> predicate, @NonNull Runnable body) {
     return router.mount(predicate, body);
   }
 
   @NonNull @Override
-  public RouteSet mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
+  public Route.Set mount(@NonNull Predicate<Context> predicate, @NonNull Router subrouter) {
     return this.router.mount(predicate, subrouter);
   }
 
   @NonNull @Override
-  public RouteSet mount(@NonNull String path, @NonNull Router router) {
+  public Route.Set mount(@NonNull String path, @NonNull Router router) {
     var rs = this.router.mount(path, router);
     if (router instanceof Jooby) {
       Jooby child = (Jooby) router;
@@ -498,7 +497,7 @@ public RouteSet mount(@NonNull String path, @NonNull Router router) {
   }
 
   @NonNull @Override
-  public RouteSet mount(@NonNull Router router) {
+  public Route.Set mount(@NonNull Router router) {
     return mount("/", router);
   }
 
@@ -508,11 +507,11 @@ public RouteSet mount(@NonNull Router router) {
    * @param router Mvc extension.
    * @return Route set.
    */
-  @NonNull public RouteSet mvc(@NonNull Extension router) {
+  @NonNull public Route.Set mvc(@NonNull Extension router) {
     try {
       int start = this.router.getRoutes().size();
       router.install(this);
-      return new RouteSet(this.router.getRoutes().subList(start, this.router.getRoutes().size()));
+      return new Route.Set(this.router.getRoutes().subList(start, this.router.getRoutes().size()));
     } catch (Exception cause) {
       throw SneakyThrows.propagate(cause);
     }
@@ -618,12 +617,12 @@ public Jooby dispatch(@NonNull Executor executor, @NonNull Runnable action) {
   }
 
   @NonNull @Override
-  public RouteSet path(@NonNull String pattern, @NonNull Runnable action) {
+  public Route.Set path(@NonNull String pattern, @NonNull Runnable action) {
     return router.path(pattern, action);
   }
 
   @NonNull @Override
-  public RouteSet routes(@NonNull Runnable action) {
+  public Route.Set routes(@NonNull Runnable action) {
     return router.routes(action);
   }
 
@@ -1302,7 +1301,7 @@ private static void configurePackage(Class owner) {
   }
 
   private static void configurePackage(String packageName) {
-    var defaultPackages = Set.of("io.jooby", "io.jooby.kt");
+    var defaultPackages = java.util.Set.of("io.jooby", "io.jooby.kt");
     if (!defaultPackages.contains(packageName)) {
       ifSystemProp(
           AvailableSettings.PACKAGE,

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

@@ -5,21 +5,16 @@
  */
 package io.jooby;
 
+import static java.util.Optional.ofNullable;
+
 import java.io.Serializable;
 import java.lang.invoke.MethodHandle;
 import java.lang.invoke.MethodHandles;
 import java.lang.reflect.Method;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.Collection;
-import java.util.Collections;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-import java.util.Set;
-import java.util.TreeMap;
+import java.util.*;
 import java.util.concurrent.Executor;
+import java.util.function.Consumer;
+import java.util.function.Predicate;
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import edu.umd.cs.findbugs.annotations.Nullable;
@@ -455,7 +450,7 @@ public MethodHandle toMethodHandle() {
 
   private Map<String, Object> attributes = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
 
-  private Set<String> supportedMethod;
+  private java.util.Set<String> supportedMethod;
 
   private String executorKey;
 
@@ -1101,4 +1096,239 @@ private Route.Handler computePipeline() {
     }
     return pipeline;
   }
+
+  /**
+   * Give you access to all routes created inside a {@link Router#path(String, Runnable)}. Allow
+   * globally applying attributes or metadata.
+   *
+   * @author edgar
+   * @since 2.7.3
+   */
+  public static class Set implements Iterable<Route> {
+
+    private List<Route> routes;
+
+    private List<String> tags;
+
+    private String summary;
+
+    private String description;
+
+    public Set(List<Route> routes) {
+      this.routes = routes;
+    }
+
+    /**
+     * Sub-routes. Always empty except when used it from {@link Router#path(String, Runnable)} or
+     * {@link Router#routes(Runnable)}.
+     *
+     * @return Sub-routes.
+     */
+    public @NonNull List<Route> getRoutes() {
+      return routes;
+    }
+
+    /**
+     * Set sub-routes.
+     *
+     * @param routes Sub-routes.
+     * @return This route.
+     */
+    public @NonNull Set setRoutes(@NonNull List<Route> routes) {
+      this.routes = routes;
+      return this;
+    }
+
+    /**
+     * Add one or more response types (format) produces by this route.
+     *
+     * @param produces Produce types.
+     * @return This route.
+     */
+    public @NonNull Set produces(@NonNull MediaType... produces) {
+      return setProduces(Arrays.asList(produces));
+    }
+
+    /**
+     * Add one or more response types (format) produces by this route.
+     *
+     * @param produces Produce types.
+     * @return This route.
+     */
+    public @NonNull Set setProduces(@NonNull Collection<MediaType> produces) {
+      routes.forEach(
+          it -> {
+            if (it.getProduces().isEmpty()) {
+              it.setProduces(produces);
+            }
+          });
+      return this;
+    }
+
+    /**
+     * Add one or more request types (format) consumed by this route.
+     *
+     * @param consumes Consume types.
+     * @return This route.
+     */
+    public @NonNull Set consumes(@NonNull MediaType... consumes) {
+      return setConsumes(Arrays.asList(consumes));
+    }
+
+    /**
+     * Add one or more request types (format) consumed by this route.
+     *
+     * @param consumes Consume types.
+     * @return This route.
+     */
+    public @NonNull Set setConsumes(@NonNull Collection<MediaType> consumes) {
+      routes.forEach(
+          it -> {
+            if (it.getConsumes().isEmpty()) {
+              it.setConsumes(consumes);
+            }
+          });
+      return this;
+    }
+
+    /**
+     * Add one or more attributes applied to this route.
+     *
+     * @param attributes .
+     * @return This route.
+     */
+    public @NonNull Set setAttributes(@NonNull Map<String, Object> attributes) {
+      routes.forEach(it -> attributes.forEach((k, v) -> it.getAttributes().putIfAbsent(k, v)));
+      return this;
+    }
+
+    /**
+     * Add one or more attributes applied to this route.
+     *
+     * @param name attribute name
+     * @param value attribute value
+     * @return This route.
+     */
+    public @NonNull Set setAttribute(@NonNull String name, @NonNull Object value) {
+      routes.forEach(it -> it.getAttributes().putIfAbsent(name, value));
+      return this;
+    }
+
+    /**
+     * Set executor key. The route is going to use the given key to fetch an executor. Possible
+     * values are:
+     *
+     * <p>- <code>null</code>: no specific executor, uses the default Jooby logic to choose one,
+     * based on the value of {@link ExecutionMode}; - <code>worker</code>: use the executor provided
+     * by the server. - <code>arbitrary name</code>: use an named executor which as registered using
+     * {@link Router#executor(String, Executor)}.
+     *
+     * @param executorKey Executor key.
+     * @return This route.
+     */
+    public @NonNull Set setExecutorKey(@Nullable String executorKey) {
+      routes.forEach(it -> it.setExecutorKey(ofNullable(it.getExecutorKey()).orElse(executorKey)));
+      return this;
+    }
+
+    /**
+     * Route tags.
+     *
+     * @return Route tags.
+     */
+    public @NonNull List<String> getTags() {
+      return tags == null ? List.of() : tags;
+    }
+
+    /**
+     * Tag this route. Tags are used for documentation purpose from openAPI generator.
+     *
+     * @param tags Tags.
+     * @return This route.
+     */
+    public @NonNull Set setTags(@NonNull List<String> tags) {
+      this.tags = tags;
+      routes.forEach(it -> tags.forEach(it::addTag));
+      return this;
+    }
+
+    /**
+     * Tag this route. Tags are used for documentation purpose from openAPI generator.
+     *
+     * @param tags Tags.
+     * @return This route.
+     */
+    public @NonNull Set tags(@NonNull String... tags) {
+      return setTags(Arrays.asList(tags));
+    }
+
+    /**
+     * Route summary useful for documentation purpose from openAPI generator.
+     *
+     * @return Summary.
+     */
+    public @Nullable String getSummary() {
+      return summary;
+    }
+
+    /**
+     * Route summary useful for documentation purpose from openAPI generator.
+     *
+     * @param summary Summary.
+     * @return This route.
+     */
+    public @NonNull Set summary(@Nullable String summary) {
+      return setSummary(summary);
+    }
+
+    /**
+     * Route summary useful for documentation purpose from openAPI generator.
+     *
+     * @param summary Summary.
+     * @return This route.
+     */
+    public @NonNull Set setSummary(@Nullable String summary) {
+      this.summary = summary;
+      return this;
+    }
+
+    /**
+     * Route description useful for documentation purpose from openAPI generator.
+     *
+     * @return Route description.
+     */
+    public @Nullable String getDescription() {
+      return description;
+    }
+
+    /**
+     * Route description useful for documentation purpose from openAPI generator.
+     *
+     * @param description Description.
+     * @return This route.
+     */
+    public @NonNull Set setDescription(@Nullable String description) {
+      this.description = description;
+      return this;
+    }
+
+    /**
+     * Route description useful for documentation purpose from openAPI generator.
+     *
+     * @param description Description.
+     * @return This route.
+     */
+    public @NonNull Set description(@Nullable String description) {
+      return setDescription(description);
+    }
+
+    public void forEach(Predicate<Route> predicate, Consumer<? super Route> action) {
+      routes.stream().filter(predicate).forEach(action);
+    }
+
+    @Override
+    public Iterator<Route> iterator() {
+      return routes.iterator();
+    }
+  }
 }