Use bundled ClojureDocs documents (#679)

Now cache updates have to performed explicitly by the clients.

Author: liquidz

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 * [#667](https://github.com/clojure-emacs/cider-nrepl/pull/667): Filter non file urls from classpath response.
 
+### Changes
+
+* [#679](https://github.com/clojure-emacs/cider-nrepl/pull/679): Update to use bundled ClojureDocs documents.
+
 ## 0.25.2 (2020-06-07)
 
 ### Bugs fixed

doc/modules/ROOT/pages/nrepl-api/ops.adoc

@@ -80,10 +80,6 @@ Required parameters::
 * `:sym` The symbol to lookup.
 
 
-Optional parameters::
-* `: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-doc" if there is no document matching to ``ns`` and ``symbol``.

project.clj

@@ -5,7 +5,7 @@
             :url "http://www.eclipse.org/legal/epl-v10.html"}
   :scm {:name "git" :url "https://github.com/clojure-emacs/cider-nrepl"}
   :dependencies [[nrepl "0.7.0"]
-                 ^:inline-dep [cider/orchard "0.5.11"]
+                 ^:inline-dep [cider/orchard "0.6.0"]
                  ^:inline-dep [thunknyc/profile "0.5.2"]
                  ^:inline-dep [mvxcvi/puget "1.3.1"]
                  ^:inline-dep [fipp "0.6.23"] ; can be removed in unresolved-tree mode

src/cider/nrepl.clj

@@ -512,7 +512,6 @@
              {:doc "Return a map of information in ClojureDocs."
               :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-doc\" if there is no document matching to `ns` and `symbol`."}}}})
 

src/cider/nrepl/middleware/clojuredocs.clj

@@ -7,23 +7,21 @@
    [cider.nrepl.middleware.util.error-handling :refer [with-safe-transport]]
    [orchard.clojuredocs :as docs]))
 
-(defn- clojuredocs-lookup-reply [{:keys [export-edn-url ns sym]}]
+(defn- clojuredocs-lookup-reply [{:keys [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)))]
+    ;; TODO: change this to `resolve-doc` once I've added the extra arity there
+    (if-let [doc (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
+    (catch Exception _
       {:status :no-doc})))
 
 (defn clojuredocs-refresh-cache-reply [{:keys [export-edn-url]}]
   (docs/clean-cache!)
   (if export-edn-url
-    (docs/load-cache! export-edn-url)
-    (docs/load-cache!))
+    (docs/update-cache! export-edn-url)
+    (docs/update-cache!))
   {:status :ok})
 
 (defn handle-clojuredocs [handler msg]

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

@@ -24,15 +24,13 @@
   (testing "Searching for non-existing documentation"
     (let [response (session/message {:op "clojuredocs-lookup"
                                      :ns "non-existing"
-                                     :sym "non-existing"
-                                     :export-edn-url test-url})]
+                                     :sym "non-existing"})]
       (is (contains? (:status response) "no-doc"))))
 
   (testing "Searching for existing documentation"
     (let [response (session/message {:op "clojuredocs-lookup"
                                      :ns "clojure.core"
-                                     :sym "first"
-                                     :export-edn-url test-url})
+                                     :sym "first"})
           doc (get response :clojuredocs {})]
       (is (contains? (:status response) "done"))
       (is (= "clojure.core" (:ns doc)))
@@ -42,8 +40,7 @@
   (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})
+                                     :sym "map"})
           doc (get response :clojuredocs {})]
       (is (contains? (:status response) "done"))
       (is (= "clojure.core" (:ns doc)))