Adjust the ClojureDocs middleware resolve the symbols its been given

Author: bbatsov

project.clj

@@ -6,7 +6,7 @@
   :scm {:name "git" :url "https://github.com/clojure-emacs/cider-nrepl"}
 
   :dependencies [[nrepl "0.6.0"]
-                 ^:inline-dep [cider/orchard "0.5.0-beta13"]
+                 ^:inline-dep [cider/orchard "0.5.0-beta14"]
                  ^:inline-dep [thunknyc/profile "0.5.2"]
                  ^:inline-dep [mvxcvi/puget "1.1.2"]
                  ^:inline-dep [fipp "0.6.18"] ; can be removed in unresolved-tree mode

src/cider/nrepl.clj

@@ -487,11 +487,11 @@
               :returns {"status" "\"ok\" if reloading was successful"}}
              "clojuredocs-lookup"
              {:doc "Return a map of information in ClojureDocs."
-              :requires {"ns" "The namespace where `symbol` is define."
-                         "symbol" "The symbol to lookup."}
+              :requires {"ns" "The namespace where `sym` will be resolved."
+                         "sym" "The symbol to lookup."}
               :optional {"export-edn-url" "EDN file URL exported from ClojureDocs. Defaults to \"https://clojuredocs-edn.netlify.com/export.compact.edn\"."}
               :returns {"clojuredocs" "A map of information in ClojureDocs."
-                        "status" "\"no-document\" if there is no document matching to `ns` and `symbol`."}}}})
+                        "status" "\"no-doc\" if there is no document matching to `ns` and `symbol`."}}}})
 
 ;;; Cider's Handler
 

src/cider/nrepl/middleware/clojuredocs.clj

@@ -4,12 +4,17 @@
    [cider.nrepl.middleware.util.error-handling :refer [with-safe-transport]]
    [orchard.clojuredocs :as docs]))
 
-(defn- clojuredocs-lookup-reply [{:keys [export-edn-url ns symbol]}]
-  (if-let [doc (if export-edn-url
-                 (docs/find-doc ns symbol export-edn-url)
-                 (docs/find-doc ns symbol))]
-    {:clojuredocs (util/transform-value doc)}
-    {:status :no-document}))
+(defn- clojuredocs-lookup-reply [{:keys [export-edn-url ns sym]}]
+  (try
+    (if-let [doc (if export-edn-url
+                   ;; TODO: change this to `resolve-doc` once I've added the extra arity there
+                   (docs/resolve-and-find-doc (symbol ns) (symbol sym) export-edn-url)
+                   (docs/resolve-and-find-doc (symbol ns) (symbol sym)))]
+      {:clojuredocs (util/transform-value doc)}
+      {:status :no-doc})
+    ;; TODO: Handle a missing ns directly in Orchard
+    (catch Exception e
+      {:status :no-doc})))
 
 (defn clojuredocs-refresh-cache-reply [{:keys [export-edn-url]}]
   (docs/clean-cache!)

test/clj/cider/nrepl/middleware/clojuredocs_test.clj

@@ -21,20 +21,31 @@
       (is (contains? (:status response) "ok")))))
 
 (deftest clojuredocs-lookup-integration-test
-  (testing "Find not existing document"
+  (testing "Searching for non-existing documentation"
     (let [response (session/message {:op "clojuredocs-lookup"
                                      :ns "non-existing"
-                                     :symbol "non-existing"
+                                     :sym "non-existing"
                                      :export-edn-url test-url})]
-      (is (contains? (:status response) "no-document"))))
+      (is (contains? (:status response) "no-doc"))))
 
-  (testing "Find existing document"
+  (testing "Searching for existing documentation"
     (let [response (session/message {:op "clojuredocs-lookup"
                                      :ns "clojure.core"
-                                     :symbol "first"
+                                     :sym "first"
                                      :export-edn-url test-url})
           doc (get response :clojuredocs {})]
       (is (contains? (:status response) "done"))
       (is (= "clojure.core" (:ns doc)))
       (is (= "first" (:name doc)))
+      (is (every? #(contains? doc %) [:examples :see-alsos]))))
+
+  (testing "Resolves syms in the supplied ns"
+    (let [response (session/message {:op "clojuredocs-lookup"
+                                     :ns "cider.nrepl.middleware.clojuredocs-test"
+                                     :sym "map"
+                                     :export-edn-url test-url})
+          doc (get response :clojuredocs {})]
+      (is (contains? (:status response) "done"))
+      (is (= "clojure.core" (:ns doc)))
+      (is (= "map" (:name doc)))
       (is (every? #(contains? doc %) [:examples :see-alsos])))))