[Fix #3200] Improve browse-ns interface with filters and groupings (#3217)

Major re-work of the browse-ns interface, as well as fixing
misc bug.

- cider-browse-ns--thing-at-point didn't distinguish a ns without '.'
- Added helper nrepl-dict-filter to filter entries in a nrepl-dict
- added grouping feature and corresponding keybindings
- added filtering features and corresponding keybindings
- added new local vars to aid in re-displaying buffer

Author: zkry

CHANGELOG.md

@@ -9,6 +9,7 @@
 ## Changes
 
 * Upgrade injected `cider-nrepl` to [0.28.5](https://github.com/clojure-emacs/cider-nrepl/releases/tag/v0.28.5).
+* [#3200](https://github.com/clojure-emacs/cider/issues/3200): Improve cider-browse-ns interface to allow selective hiding of var types as well as grouping options.  Include private vars in result list.
 
 ## 1.4.1 (2022-05-25)
 

cider-browse-ns.el

@@ -743,6 +743,15 @@ returned."
                 (cider-nrepl-send-sync-request)
                 (nrepl-dict-get "ns-vars-with-meta")))
 
+(defun cider-sync-request:private-ns-vars-with-meta (ns)
+  "Get a map of the vars in NS to its metadata information."
+  (thread-first `("op" "ns-vars-with-meta"
+                  "ns" ,ns
+                  "var-query" ,(nrepl-dict "private?" "t"
+                                           "include-meta-key" '("private")))
+                (cider-nrepl-send-sync-request)
+                (nrepl-dict-get "ns-vars-with-meta")))
+
 (defun cider-sync-request:ns-load-all ()
   "Load all project namespaces."
   (thread-first '("op" "ns-load-all")

cider-client.el

@@ -103,29 +103,24 @@ configure `cider-debug-prompt' instead."
 
 
 ;;; Implementation
+(declare-function cider-browse-ns--combined-vars-with-meta "cider-browse-ns")
+
 (defun cider-browse-instrumented-defs ()
   "List all instrumented definitions."
   (interactive)
   (if-let* ((all (thread-first (cider-nrepl-send-sync-request '("op" "debug-instrumented-defs"))
                                (nrepl-dict-get "list"))))
       (with-current-buffer (cider-popup-buffer cider-browse-ns-buffer t)
         (let ((inhibit-read-only t))
-          (erase-buffer)
           (dolist (list all)
             (let* ((ns (car list))
-                   (ns-vars-with-meta (cider-sync-request:ns-vars-with-meta ns))
-                   ;; seq of metadata maps of the instrumented vars
-                   (instrumented-meta (mapcar (apply-partially #'nrepl-dict-get ns-vars-with-meta)
-                                              (cdr list))))
+                   (ns-vars-with-meta (cider-browse-ns--combined-vars-with-meta ns))
+                   (instrumented-meta (nrepl-dict-filter (lambda (k _)
+                                                           (member k list))
+                                                         ns-vars-with-meta)))
               (cider-browse-ns--list (current-buffer) ns
-                                     (seq-mapn #'cider-browse-ns--properties
-                                               (cdr list)
-                                               instrumented-meta)
-
-                                     ns 'noerase)
-              (goto-char (point-max))
-              (insert "\n"))))
-        (goto-char (point-min)))
+                                     instrumented-meta
+                                     ns)))))
     (message "No currently instrumented definitions")))
 
 (defun cider--debug-response-handler (response)

cider-debug.el

@@ -224,6 +224,11 @@ image::ns_browser.png[Namespace Browser]
 You can also browse all available namespaces with kbd:[M-x]
 `cider-browse-ns-all`.
 
+The UI contains buttons in the header which allow you to control how
+the buffer is displayed (see below for keybindings).  You may also
+configure the `cider-browse-ns-default-filters` variable to a list of
+the element types you want to be hidden by default.
+
 There are a bunch of useful keybindings that are defined in browser buffers.
 
 |===
@@ -244,6 +249,27 @@ There are a bunch of useful keybindings that are defined in browser buffers.
 | kbd:[n]
 | Go to next line.
 
+| kbd:[h p]
+| Toggle visibility of private items.
+
+| kbd:[h t]
+| Toggle visibility of tests.
+
+| kbd:[h m]
+| Toggle visibility of macros.
+
+| kbd:[h f]
+| Toggle visibility of functions.
+
+| kbd:[h v]
+| Toggle visibility of vars.
+
+| kbd:[g t]
+| Group items by type (function, macro, var, etc.).
+
+| kbd:[g v]
+| Group items by visibility (public vs. private).
+
 | kbd:[p]
 | Go to previous line.
 |===

doc/modules/ROOT/assets/images/ns_browser.png

@@ -128,6 +128,18 @@ also always return a sequence (since the result will be flattened)."
   (when dict
     (apply #'append (nrepl-dict-map function dict))))
 
+(defun nrepl-dict-filter (function dict)
+  "For all key-values of DICT, return new dict where FUNCTION returns non-nil.
+
+FUNCTION should be a function taking two arguments, key and value."
+  (let ((new-map (nrepl-dict))
+        (keys (nrepl-dict-keys dict)))
+    (dolist (key keys)
+      (let ((val (nrepl-dict-get dict key)))
+        (when (funcall function key val)
+          (nrepl-dict-put new-map key val))))
+    new-map))
+
 
 ;;; More specific functions
 (defun nrepl--cons (car list-or-dict)

doc/modules/ROOT/pages/usage/misc_features.adoc

@@ -50,6 +50,7 @@
             '(dict "blank?"
                    (dict "arglists" "fn arg list"
                          "doc" "\"True if s is nil, empty, or contains only whitespace.\"")))
+    (spy-on 'cider-sync-request:private-ns-vars-with-meta :and-return-value '(dict))
 
     (with-temp-buffer
       (setq cider-browse-ns-buffer (buffer-name (current-buffer)))
@@ -59,7 +60,11 @@
       (search-forward "blank")
       (expect (get-text-property (point) 'font-lock-face) :to-equal 'font-lock-function-name-face)
       (search-forward "True")
-      (expect (get-text-property (point) 'font-lock-face) :to-equal 'font-lock-doc-face))))
+      (expect (get-text-property (point) 'font-lock-face) :to-equal 'font-lock-doc-face)
+      ;; filter out the functions and ensure that blank? doesn't show up
+      (cider-browse-ns-toggle-hide-function)
+      (goto-char (point-min))
+      (expect (not (search-forward "blank" nil t))))))
 
 (describe "cider-browse-ns--first-doc-line"
   (it "returns Not documented if the doc string is missing"