Merge pull request #164 from metosin/ordering

Ordered routes

Author: ikitommi

examples/src/examples/ordered.clj

@@ -1,34 +1,23 @@
 (ns examples.ordered
-  (:require [schema.core :as s]
-            [flatland.ordered.map :as fom]
-            [compojure.api.sweet :refer :all]
+  (:require [compojure.api.sweet :refer :all]
             [ring.util.http-response :refer :all]))
 
-;; does not work with AOT
-(s/defschema Ordered
-  (fom/ordered-map
-    :a s/Str
-    :b s/Str
-    :c s/Str
-    :d s/Str
-    :e s/Str
-    :f s/Str
-    :g s/Str
-    :h s/Str))
+(defroutes* more-ordered-routes
+  (GET* "/6" [] (ok))
+  (GET* "/7" [] (ok))
+  (GET* "/8" [] (ok)))
 
 (defroutes* ordered-routes
   (context* "/ordered" []
     :tags ["ordered"]
-    (GET* "/" []
-      :return Ordered
-      :summary "Ordered data"
-      (ok
-        (fom/ordered-map
-          :a "a"
-          :b "b"
-          :c "c"
-          :d "d"
-          :e "e"
-          :f "f"
-          :g "g"
-          :h "h")))))
+    (context* "/a" []
+      (GET* "/1" [] (ok))
+      (GET* "/2" [] (ok))
+      (GET* "/3" [] (ok))
+      (context* "/b" []
+        (GET* "/4" [] (ok))
+        (GET* "/5" [] (ok)))
+      (context* "/c" []
+        more-ordered-routes
+        (GET* "/9" [] (ok))
+        (GET* "/10" [] (ok))))))

examples/src/examples/thingie.clj

@@ -41,7 +41,7 @@
             {:name "primitives", :description "Returning primitive values"}
             {:name "context*", :description "context* routes"}
             {:name "echo", :description "Echoes data"}
-            {:name "ordered", :description "Ordered schema"}
+            {:name "ordered", :description "Ordered routes"}
             {:name "file", :description "File upload"}]})
 
   (context* "/math" []
@@ -89,8 +89,6 @@
 
   pizza-routes
 
-  #_ordered-routes
-
   (context* "/dates" []
     :tags ["dates"]
     date-routes)
@@ -196,4 +194,6 @@
     :tags ["component"]
     (GET* "/example" req
       :components [example]
-      (ok example))))
+      (ok example)))
+
+  ordered-routes)

project.clj

@@ -20,7 +20,8 @@
   :profiles {:uberjar {:aot :all
                        :ring {:handler examples.thingie/app}
                        :source-paths ["examples/src"]
-                       :dependencies [[http-kit "2.1.19"]
+                       :dependencies [[org.clojure/clojure "1.7.0"]
+                                      [http-kit "2.1.19"]
                                       [com.stuartsierra/component "0.2.3"]]}
              :dev {:repl-options {:init-ns user}
                    :plugins [[lein-clojars "0.9.1"]

src/compojure/api/core.clj

@@ -5,7 +5,6 @@
             [compojure.api.routes :as routes]
             [compojure.core :refer :all]
             [potemkin :refer [import-vars]]
-            [ring.swagger.middleware :as rsm]
             [ring.swagger.common :refer [extract-parameters]]
             [clojure.walk :as walk]
             backtick))
@@ -16,12 +15,11 @@
   lookup table via wrap-options. Returned handler retains the original
   meta-data."
   [handler options]
-  (let [{:keys [routes lookup] :as meta} (meta handler)]
+  (let [meta (-> handler meta (assoc :options options))]
     (-> handler
-        (rsm/wrap-swagger-data routes)
         (mw/api-middleware options)
-        (mw/wrap-options {:lookup lookup})
-        (with-meta (assoc meta :options options)))))
+        (mw/wrap-options (select-keys meta [:routes :lookup]))
+        (with-meta meta))))
 
 (defmacro api
   "Returns a ring handler wrapped in compojure.api.middleware/api-middlware.

src/compojure/api/routes.clj

@@ -4,7 +4,8 @@
             [cheshire.core :as json]
             [ring.swagger.swagger2 :as rss]
             [compojure.api.middleware :as mw]
-            [clojure.string :as str]))
+            [clojure.string :as str]
+            [flatland.ordered.map :as om]))
 
 (defn- un-quote [s]
   (str/replace s #"^\"(.+(?=\"$))\"$" "$1"))
@@ -67,13 +68,20 @@
 
 (defmulti collect-routes identity)
 
+(defn route-vector-to-route-map [v]
+  {:paths (apply om/ordered-map (apply concat v))})
+
+(defn route-map-to-route-vector [m]
+  (->> m :paths (apply vector) reverse vec))
+
 (defmacro api-root [& body]
   (let [[all-routes body] (collect-routes body)
         lookup (route-lookup-table all-routes)
         documented-routes (->> all-routes
                                (rss/transform-operations non-nil-routes)
-                               (rss/transform-operations strip-no-doc-endpoints))]
-    `(with-meta (routes ~@body) {:routes '~documented-routes
+                               (rss/transform-operations strip-no-doc-endpoints))
+        route-vector (route-map-to-route-vector documented-routes)]
+    `(with-meta (routes ~@body) {:routes '~route-vector
                                  :lookup ~lookup})))
 
 (defn path-for*

src/compojure/api/swagger.clj

@@ -14,6 +14,7 @@
             [ring.swagger.middleware :as rsm]
             [ring.swagger.core :as swagger]
             [ring.swagger.ui]
+            [flatland.ordered.map :as om]
             [ring.swagger.swagger2 :as swagger2]
             [schema.core :as s]))
 
@@ -231,7 +232,7 @@
        path-vals
        (map create-api-route)
        (map attach-meta-data-to-route)
-       (apply deep-merge {})))
+       (apply deep-merge (om/ordered-map))))
 
 (defn swagger-info [body]
   [{:paths (extract-routes body)} body])
@@ -304,9 +305,12 @@
          :name ::swagger
          (let [runtime-info# (rsm/get-swagger-data request#)
                base-path# {:basePath (base-path request#)}
-               options# (:ring-swagger (mw/get-options request#))]
+               options# (:ring-swagger (mw/get-options request#))
+               routes# (:routes (mw/get-options request#))
+               paths# (routes/route-vector-to-route-map routes#)]
            (ok
              (let [swagger# (merge runtime-info#
+                                   paths#
                                    base-path#
                                    ~extra-info)
                    result# (swagger2/swagger-json swagger# options#)]
@@ -339,7 +343,8 @@
   endpoint is requested. Returns either the (valid) api or throws an
   exception."
   [api]
-  (let [{:keys [routes options]} (meta api)]
+  (let [{:keys [routes options]} (meta api)
+        routes (routes/route-vector-to-route-map routes)]
     (assert (not (nil? routes)) "Api did not contain route definitions.")
     (when (swagger-api? api)
 

test/compojure/api/swagger_ordering_test.clj

@@ -1,36 +1,38 @@
 (ns compojure.api.swagger-ordering-test
-  (:require [compojure.api.routes :as routes]
-            [compojure.api.sweet :refer :all]
+  (:require [compojure.api.sweet :refer :all]
             [midje.sweet :refer :all]))
 
-;; TODO: order!
-#_(facts "with 9+ routes"
+(defroutes* more-routes
+  (GET* "/6" [] identity)
+  (GET* "/7" [] identity)
+  (GET* "/8" [] identity))
 
-    (defapi api
-      (context "/a" []
-        (GET* "/1" [] identity)
-        (GET* "/2" [] identity)
-        (GET* "/3" [] identity)
-        (context "/b" []
-          (GET* "/4" [] identity)
-          (GET* "/5" [] identity))
-        (context "/c" []
-          (GET* "/6" [] identity)
-          (GET* "/7" [] identity)
-          (GET* "/8" [] identity)
-          (GET* "/9" [] identity)
-          (GET* "/10" [] identity))))
+(facts "with 10+ routes"
+  (let [app (api
+              (swagger-docs)
+              (context* "/a" []
+                (GET* "/1" [] identity)
+                (GET* "/2" [] identity)
+                (GET* "/3" [] identity)
+                (context* "/b" []
+                  (GET* "/4" [] identity)
+                  (GET* "/5" [] identity))
+                (context* "/c" []
+                  more-routes
+                  (GET* "/9" [] identity)
+                  (GET* "/10" [] identity))))]
 
     (fact "swagger-api order is maintained"
-      (->> (routes/get-routes)
+      (->> app
+           meta
            :routes
-           (map :uri)) => ["/a/1"
-                           "/a/2"
-                           "/a/3"
-                           "/a/b/4"
-                           "/a/b/5"
-                           "/a/c/6"
-                           "/a/c/7"
-                           "/a/c/8"
-                           "/a/c/9"
-                           "/a/c/10"]))
+           (map first)) => ["/a/1"
+                            "/a/2"
+                            "/a/3"
+                            "/a/b/4"
+                            "/a/b/5"
+                            "/a/c/6"
+                            "/a/c/7"
+                            "/a/c/8"
+                            "/a/c/9"
+                            "/a/c/10"])))

test/compojure/api/sweet_test.clj

@@ -5,7 +5,8 @@
             [ring.mock.request :refer :all]
             [schema.core :as s]
             [clojure.java.io :as io]
-            [scjsv.core :as scjsv]))
+            [scjsv.core :as scjsv]
+            [compojure.api.routes :as routes]))
 
 (def validate
   (scjsv/validator (slurp (io/resource "ring/swagger/v2.0_schema.json"))))
@@ -71,7 +72,7 @@
 (facts "api documentation"
   (fact "details are generated"
 
-    (-> app meta :routes)
+    (-> app meta :routes routes/route-vector-to-route-map)
 
     => {:paths {"/ping" {:get {}}
                 "/api/ping" {:get {}}