Eliminate middleware vector code duplication

Author: bbatsov

src/cider/nrepl.clj

@@ -8,6 +8,7 @@
   defers the loading of the actual middleware."
   (:require
    [cider.nrepl.version :as version]
+   [cider.nrepl.middleware :as mw]
    [cider.nrepl.middleware.util.cljs :as cljs]
    [cider.nrepl.print-method] ;; we load this namespace, so it's directly available to clients
    [nrepl.middleware :refer [set-descriptor!]]
@@ -524,34 +525,8 @@
 ;; end users might opt to build custom handlers that don't
 ;; include every middleware available.
 
-(def cider-middleware
-  "A vector of all CIDER middleware."
-  `[wrap-apropos
-    wrap-classpath
-    wrap-clojuredocs
-    wrap-complete
-    wrap-content-type
-    wrap-debug
-    wrap-enlighten
-    wrap-format
-    wrap-info
-    wrap-inspect
-    wrap-macroexpand
-    wrap-ns
-    wrap-out
-    wrap-slurp
-    wrap-profile
-    wrap-refresh
-    wrap-resource
-    wrap-spec
-    wrap-stacktrace
-    wrap-test
-    wrap-trace
-    wrap-tracker
-    wrap-undef
-    wrap-version
-    wrap-xref])
+(def cider-middleware mw/cider-middleware) ;; for backwards compatibility
 
 (def cider-nrepl-handler
   "CIDER's nREPL handler."
-  (apply nrepl-server/default-handler (map resolve-or-fail cider-middleware)))
+  (apply nrepl-server/default-handler (map resolve-or-fail mw/cider-middleware)))

src/cider/nrepl/middleware.clj

@@ -0,0 +1,32 @@
+(ns cider.nrepl.middleware
+  "This namespace mostly exists, so that
+  it's easy to share the list of middlewares.
+  Eventually the deferred loading will probably come here as well."
+  {:added "0.25"})
+
+(def cider-middleware
+  '[cider.nrepl/wrap-apropos
+    cider.nrepl/wrap-classpath
+    cider.nrepl/wrap-clojuredocs
+    cider.nrepl/wrap-complete
+    cider.nrepl/wrap-content-type
+    cider.nrepl/wrap-debug
+    cider.nrepl/wrap-enlighten
+    cider.nrepl/wrap-format
+    cider.nrepl/wrap-info
+    cider.nrepl/wrap-inspect
+    cider.nrepl/wrap-macroexpand
+    cider.nrepl/wrap-ns
+    cider.nrepl/wrap-out
+    cider.nrepl/wrap-slurp
+    cider.nrepl/wrap-profile
+    cider.nrepl/wrap-refresh
+    cider.nrepl/wrap-resource
+    cider.nrepl/wrap-spec
+    cider.nrepl/wrap-stacktrace
+    cider.nrepl/wrap-test
+    cider.nrepl/wrap-trace
+    cider.nrepl/wrap-tracker
+    cider.nrepl/wrap-undef
+    cider.nrepl/wrap-version
+    cider.nrepl/wrap-xref])

src/cider_nrepl/plugin.clj

@@ -2,6 +2,7 @@
   "Provides a simple way to setup the CIDER nREPL middleware in
   Leiningen projects."
   (:require
+   [cider.nrepl.middleware :as mw]
    [cider.nrepl.version :refer [version-string]]
    [clojure.java.io :as io]
    [leiningen.core.main :as lein]))
@@ -59,34 +60,4 @@
                      [['cider/cider-nrepl version-string]])
           (update-in [:repl-options :nrepl-middleware]
                      (fnil into [])
-                     ;; TODO: it would be better to avoid this duplication, but
-                     ;; we can't require the `cider.nrepl` namespace because it
-                     ;; requires `nrepl.*` namespaces which might conflict with
-                     ;; Leiningen. Consider adding another namespace that
-                     ;; contains the below definition (as data only, not
-                     ;; requiring `cider.nrepl`).
-                     '[cider.nrepl/wrap-apropos
-                       cider.nrepl/wrap-classpath
-                       cider.nrepl/wrap-clojuredocs
-                       cider.nrepl/wrap-complete
-                       cider.nrepl/wrap-content-type
-                       cider.nrepl/wrap-debug
-                       cider.nrepl/wrap-enlighten
-                       cider.nrepl/wrap-format
-                       cider.nrepl/wrap-info
-                       cider.nrepl/wrap-inspect
-                       cider.nrepl/wrap-macroexpand
-                       cider.nrepl/wrap-ns
-                       cider.nrepl/wrap-out
-                       cider.nrepl/wrap-slurp
-                       cider.nrepl/wrap-profile
-                       cider.nrepl/wrap-refresh
-                       cider.nrepl/wrap-resource
-                       cider.nrepl/wrap-spec
-                       cider.nrepl/wrap-stacktrace
-                       cider.nrepl/wrap-test
-                       cider.nrepl/wrap-trace
-                       cider.nrepl/wrap-tracker
-                       cider.nrepl/wrap-undef
-                       cider.nrepl/wrap-version
-                       cider.nrepl/wrap-xref])))))
+                     mw/cider-middleware)))))

test/clj/cider/nrepl/middleware/format_test.clj

@@ -150,7 +150,7 @@
                                          :edn "{:b 2 :c 3 :a 1}"
                                          ::print/print "fake.nrepl.pprint/puget-pprint"})
                        (dissoc :id :session))]
-      (is (= {:formatted-edn "{:b 2, :c 3, :a 1}",
-              :status #{"done" "nrepl.middleware.print/error"},
+      (is (= {:formatted-edn "{:b 2, :c 3, :a 1}"
+              :status #{"done" "nrepl.middleware.print/error"}
               :nrepl.middleware.print/error "Couldn't resolve var fake.nrepl.pprint/puget-pprint"}
              response)))))

test/clj/cider/nrepl/plugin_test.clj

@@ -1,39 +1,14 @@
 (ns cider.nrepl.plugin-test
-  (:require [cider-nrepl.plugin :refer :all]
-            [cider.nrepl.version :refer [version-string]]
-            [clojure.test :refer :all]))
+  (:require
+   [cider-nrepl.plugin :refer :all]
+   [cider.nrepl.middleware :as mw]
+   [cider.nrepl.version :refer [version-string]]
+   [clojure.test :refer :all]))
 
 (def expected-output
-  {:dependencies
-   [['org.clojure/clojure]
-    ['cider/cider-nrepl version-string]],
-   :repl-options
-   {:nrepl-middleware
-    '[cider.nrepl/wrap-apropos
-      cider.nrepl/wrap-classpath
-      cider.nrepl/wrap-clojuredocs
-      cider.nrepl/wrap-complete
-      cider.nrepl/wrap-content-type
-      cider.nrepl/wrap-debug
-      cider.nrepl/wrap-enlighten
-      cider.nrepl/wrap-format
-      cider.nrepl/wrap-info
-      cider.nrepl/wrap-inspect
-      cider.nrepl/wrap-macroexpand
-      cider.nrepl/wrap-ns
-      cider.nrepl/wrap-out
-      cider.nrepl/wrap-slurp
-      cider.nrepl/wrap-profile
-      cider.nrepl/wrap-refresh
-      cider.nrepl/wrap-resource
-      cider.nrepl/wrap-spec
-      cider.nrepl/wrap-stacktrace
-      cider.nrepl/wrap-test
-      cider.nrepl/wrap-trace
-      cider.nrepl/wrap-tracker
-      cider.nrepl/wrap-undef
-      cider.nrepl/wrap-version
-      cider.nrepl/wrap-xref]}})
+  {:dependencies [['org.clojure/clojure]
+                  ['cider/cider-nrepl version-string]]
+   :repl-options {:nrepl-middleware mw/cider-middleware}})
 
 (deftest version-checks
   (testing "undefined versions work"

test/cljs/cider/nrepl/piggieback_test.clj

@@ -2,7 +2,7 @@
   (:require
    [cider.piggieback :as piggieback]
    [cider.nrepl.test-session :as session]
-   [cider.nrepl :refer [cider-middleware]]
+   [cider.nrepl.middleware :refer [cider-middleware]]
    [cljs.repl.nashorn :as nashorn]
    [clojure.test :refer :all]
    [nrepl.core :as nrepl]

test/common/cider_nrepl/plugin_test.clj

@@ -1,6 +1,6 @@
 (ns cider-nrepl.plugin-test
   (:require [cider-nrepl.plugin :as plugin]
-            [cider.nrepl :refer [cider-middleware]]
+            [cider.nrepl.middleware :refer [cider-middleware]]
             [clojure.test :refer :all]
             [leiningen.core.main :as lein]))