Add optional map syntax for :files and :resources

Fixes #27.

Author: weavejester

README.md

@@ -123,7 +123,7 @@ The following configuration keys are supported:
     Set to true to add CSRF protection via the [ring-anti-forgery][5]
     library.
 
-  - `:content-type-options` -
+  - `:contenta-type-options` -
     Prevents attacks based around media-type confusion. See:
     [wrap-content-type-options][6].
 
@@ -156,14 +156,17 @@ The following configuration keys are supported:
   A map of options to configure how to find static content.
 
   - `:files` -
-    A string or collection of strings containing paths to directories
-    to serve files from. Usually the `:resources` option below is
+    A string or a map of options to be passed to the [file][14]
+    middleware, where the `:root` key is passed as the first argument,
+    and the rest of the map is passed as options. May also be a
+    collection of the above. Usually the `:resources` option below is
     more useful.
 
   - `:resources` -
-    A string or collection of strings containing classpath
-    prefixes. This will serve any resources in locations starting with
-    the supplied prefix.
+    A string or a map of options to be passed to the [resource][15]
+    middleware, where the `:root` key is passed as the first argument,
+    and the rest of the map is passed as options. May also be a
+    collection of the above.
 
 
 [1]: https://ring-clojure.github.io/ring/ring.middleware.multipart-params.html
@@ -179,7 +182,8 @@ The following configuration keys are supported:
 [11]: https://ring-clojure.github.io/ring/ring.middleware.session.html
 [12]: https://ring-clojure.github.io/ring/ring.middleware.flash.html
 [13]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
-
+[14]: https://ring-clojure.github.io/ring/ring.middleware.file.html
+[15]: https://ring-clojure.github.io/ring/ring.middleware.resource.html
 
 ## License
 

src/ring/middleware/defaults.clj

@@ -72,13 +72,17 @@
       (middleware handler options)
       handler)))
 
-(defn- wrap-multi [handler middleware args]
-  (wrap handler
-        (fn [handler args]
-          (if (coll? args)
-            (reduce middleware handler args)
-            (middleware handler args)))
-        args))
+(defn- wrap-static [handler middleware args]
+  (let [middleware' (fn [handler args]
+                      (if (map? args)
+                        (middleware handler (:root args) (dissoc args :root))
+                        (middleware handler args)))]
+    (wrap handler
+          (fn [handler args]
+            (if (and (coll? args) (not (map? args)))
+              (reduce middleware' handler args)
+              (middleware' handler args)))
+          args)))
 
 (defn- wrap-xss-protection [handler options]
   (x/wrap-xss-protection handler (:enable? options true) (dissoc options :enable?)))
@@ -108,8 +112,8 @@
       (wrap wrap-params           (get-in config [:params :urlencoded] false))
       (wrap wrap-cookies          (get-in config [:cookies] false))
       (wrap wrap-absolute-redirects (get-in config [:responses :absolute-redirects] false))
-      (wrap-multi wrap-resource   (get-in config [:static :resources] false))
-      (wrap-multi wrap-file       (get-in config [:static :files] false))
+      (wrap-static wrap-resource   (get-in config [:static :resources] false))
+      (wrap-static wrap-file       (get-in config [:static :files] false))
       (wrap wrap-content-type     (get-in config [:responses :content-types] false))
       (wrap wrap-default-charset  (get-in config [:responses :default-charset] false))
       (wrap wrap-not-modified     (get-in config [:responses :not-modified-responses] false))

test/ring/middleware/defaults_test.clj

@@ -1,7 +1,7 @@
 (ns ring.middleware.defaults-test
   (:require [clojure.test :refer :all]
             [ring.middleware.defaults :refer :all]
-            [ring.util.response :refer [response content-type]]
+            [ring.util.response :refer [response content-type not-found]]
             [ring.mock.request :refer [request header]]))
 
 (deftest test-wrap-defaults
@@ -153,6 +153,32 @@
       (is (= (slurp (:body (handler (request :get "/foo.txt")))) "foo2\n"))
       (is (= (slurp (:body (handler (request :get "/bar.txt")))) "bar\n"))))
 
+  (testing "resource paths with options"
+    (let [handler (wrap-defaults
+                   (fn [{:keys [uri]}]
+                     (if (= uri "/foo.txt")
+                       (response "foo-custom")
+                       (not-found "")))
+                   (assoc-in site-defaults [:static :resources]
+                             {:root "ring/assets/public2"
+                              :prefer-handler? true}))]
+      (is (= (:body (handler (request :get "/foo.txt"))) "foo-custom"))
+      (is (= (slurp (:body (handler (request :get "/bar.txt")))) "bar\n"))))
+
+  (testing "multiple resource paths with options"
+    (let [handler (wrap-defaults
+                   (fn [{:keys [uri]}]
+                     (if (= uri "/bar.txt")
+                       (response "bar-custom")
+                       (not-found "")))
+                   (assoc-in site-defaults [:static :resources]
+                             [{:root "ring/assets/public2"
+                               :prefer-handler? true}
+                              {:root "ring/assets/public1"
+                               :prefer-handler? true}]))]
+      (is (= (slurp (:body (handler (request :get "/foo.txt")))) "foo2\n"))
+      (is (= (:body (handler (request :get "/bar.txt"))) "bar-custom"))))
+
   (testing "single file path"
     (let [handler (wrap-defaults
                    (constantly nil)
@@ -170,6 +196,32 @@
       (is (= (slurp (:body (handler (request :get "/foo.txt")))) "foo2\n"))
       (is (= (slurp (:body (handler (request :get "/bar.txt")))) "bar\n"))))
 
+  (testing "file paths with options"
+    (let [handler (wrap-defaults
+                   (fn [{:keys [uri]}]
+                     (if (= uri "/foo.txt")
+                       (response "foo-custom")
+                       (not-found "")))
+                   (assoc-in site-defaults [:static :files]
+                             {:root "test/ring/assets/public2"
+                              :prefer-handler? true}))]
+      (is (= (:body (handler (request :get "/foo.txt"))) "foo-custom"))
+      (is (= (slurp (:body (handler (request :get "/bar.txt")))) "bar\n"))))
+
+  (testing "multiple file paths with options"
+    (let [handler (wrap-defaults
+                   (fn [{:keys [uri]}]
+                     (if (= uri "/bar.txt")
+                       (response "bar-custom")
+                       (not-found "")))
+                   (assoc-in site-defaults [:static :files]
+                             [{:root "test/ring/assets/public2"
+                               :prefer-handler? true}
+                              {:root "test/ring/assets/public1"
+                               :prefer-handler? true}]))]
+      (is (= (slurp (:body (handler (request :get "/foo.txt")))) "foo2\n"))
+      (is (= (:body (handler (request :get "/bar.txt"))) "bar-custom"))))
+
   (testing "async handlers"
     (let [handler (-> (fn [_ respond _] (respond (response "foo")))
                       (wrap-defaults api-defaults))