[inspect] Introduce support for :view-mode config and inspect-toggle-view-mode op

Author: alexander-yakushev

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 * [#877](https://github.com/clojure-emacs/cider-nrepl/pull/877): `inspect-refresh` middleware is now capable of setting all config options that `orchard.inspect` supports.
 * [#877](https://github.com/clojure-emacs/cider-nrepl/pull/877): Deprecate all `inspect-set-*` middleware ops.
+* [#879](https://github.com/clojure-emacs/cider-nrepl/pull/879): Add support for `:view-mode` inspector config and `inspect-toggle-view-mode` op.
 * Bump `orchard` to [0.26.0](https://github.com/clojure-emacs/orchard/blob/master/CHANGELOG.md#0260-2024-06-30).
 
 ## 0.48.0 (2024-05-13)

src/cider/nrepl.clj

@@ -340,7 +340,12 @@ if applicable, and re-render the updated value."
                :optional {"page-size" "New page size"
                           "max-atom-length" "New max length of single rendered value"
                           "max-coll-size" "New max size of rendered collection"
-                          "max-nested-depth" "New max nested depth of rendered collection"}
+                          "max-nested-depth" "New max nested depth of rendered collection"
+                          "view-mode" "Mode of viewing the value - either `:normal` or `:object`"}
+               :returns inspector-returns}
+              "inspect-toggle-view-mode"
+              {:doc "Toggles the viewing mode of the inspector. This influences the way how inspector is rendering the current value. `:normal` is the default. When view mode is `:object`, any value will be rendered as a Java object (fields shown as is)."
+               :requires {"session" "The current session"}
                :returns inspector-returns}
               "inspect-next-page"
               {:doc "Jumps to the next page in paginated collection view."

src/cider/nrepl/middleware/inspect.clj

@@ -62,14 +62,20 @@
         (doseq [^Class interface (.getInterfaces clazz)]
           (info/info 'user (-> interface .getCanonicalName symbol)))))))
 
+(defn- update-if-present [m k update-fn & args]
+  (if (contains? m k)
+    (apply update m k update-fn args)
+    m))
+
 (defn- msg->inspector-config [msg]
   (let [config (select-keys msg [:page-size :max-atom-length :max-coll-size
-                                 :max-value-length :max-nested-depth :spacious])]
-    (if (contains? config :spacious)
-      (update config :spacious #(case %
-                                  ("false" "nil") false
-                                  true))
-      config)))
+                                 :max-value-length :max-nested-depth :spacious
+                                 :view-mode])]
+    (-> config
+        (update-if-present :spacious #(case %
+                                        ("false" "nil") false
+                                        true))
+        (update-if-present :view-mode keyword))))
 
 (defn inspect-reply*
   [msg value]
@@ -141,6 +147,14 @@
   (let [overrides (msg->inspector-config msg)]
     (inspector-response msg (swap-inspector! msg #(inspect/refresh % overrides)))))
 
+(defn- toggle-view-mode [{:keys [view-mode] :as inspector}]
+  (let [toggle-order {:normal :object, :object :normal}
+        next-view-mode (toggle-order view-mode :normal)]
+    (inspect/refresh inspector {:view-mode next-view-mode})))
+
+(defn toggle-view-mode-reply [msg]
+  (inspector-response msg (swap-inspector! msg toggle-view-mode)))
+
 (defn ^:deprecated set-page-size-reply [msg] (refresh-reply msg))
 (defn ^:deprecated set-max-atom-length-reply [msg] (refresh-reply msg))
 (defn ^:deprecated set-max-coll-size-reply [msg] (refresh-reply msg))
@@ -170,6 +184,7 @@
       "inspect-next-page" next-page-reply
       "inspect-prev-page" prev-page-reply
       "inspect-refresh" refresh-reply
+      "inspect-toggle-view-mode" toggle-view-mode-reply
       "inspect-set-page-size" refresh-reply
       "inspect-set-max-atom-length" refresh-reply
       "inspect-set-max-coll-size" refresh-reply

test/clj/cider/nrepl/middleware/inspect_test.clj

@@ -164,6 +164,9 @@
 (defn value [{:keys [value]}]
   (edn/read-string (first value)))
 
+(defn value-skip-header [resp]
+  (drop 7 (value resp)))
+
 ;; integration tests
 
 (deftest nil-integration-test
@@ -676,6 +679,64 @@
         (is (string/includes? (extract-text tight)
                               "\"[[[[[[[[[[1]]]]]]]]]]\""))))))
 
+(def normal-mode-prefix
+  ["--- Contents:"
+   [:newline]
+   "  " "0" ". " [:value "1" number?]
+   [:newline]
+   "  " "1" ". " [:value "2" number?]
+   [:newline]
+   "  " "2" ". " [:value "3" number?]])
+
+(def object-mode-prefix
+  ["--- Instance fields:"
+   [:newline]
+   "  " [:value "_count" number?] " = " [:value "3" number?]
+   [:newline]
+   "  " [:value "_first" number?] " = " [:value "1" number?]
+   [:newline]
+   "  " [:value "_hash" number?] " = " [:value "0" number?]
+   [:newline]
+   "  " [:value "_hasheq" number?] " = " [:value "0" number?]
+   [:newline]
+   "  " [:value "_meta" number?] " = " [:value "nil" number?]
+   [:newline]
+   "  " [:value "_rest" number?] " = " [:value "( 2 3 )" number?]
+   [:newline]])
+
+(deftest object-view-mode-integration-test
+  (testing "object view can be enabled to render the value as POJO"
+    (is (match? (matchers/prefix object-mode-prefix)
+                (value-skip-header (session/message {:op        "eval"
+                                                     :inspect   "true"
+                                                     :view-mode "object"
+                                                     :code      "(list 1 2 3)"})))))
+
+  (testing "object view can be enabled with refresh op"
+    (session/message {:op "inspect-clear"})
+    (session/message {:op      "eval"
+                      :inspect "true"
+                      :code    "(list 1 2 3)"})
+    (is (match? (matchers/prefix object-mode-prefix)
+                (value-skip-header (session/message {:op        "inspect-refresh"
+                                                     :view-mode "object"}))))
+
+    (testing "goes back to normal when :normal view-mode is passed"
+      (is (match? (matchers/prefix normal-mode-prefix)
+                  (value-skip-header (session/message {:op        "inspect-refresh"
+                                                       :view-mode "normal"}))))))
+
+  (testing "view-mode can be toggled with inspect-toggle-view-mode op"
+    (session/message {:op "inspect-clear"})
+    (is (match? (matchers/prefix normal-mode-prefix)
+                (value-skip-header (session/message {:op      "eval"
+                                                     :inspect "true"
+                                                     :code    "(list 1 2 3)"}))))
+    (is (match? (matchers/prefix object-mode-prefix)
+                (value-skip-header (session/message {:op "inspect-toggle-view-mode"}))))
+    (is (match? (matchers/prefix normal-mode-prefix)
+                (value-skip-header (session/message {:op "inspect-toggle-view-mode"}))))))
+
 (deftest print-length-independence-test
   (testing "*print-length* doesn't break rendering of long collections"
     (is (re-find #"showing page: \d+ of \d+"