Skip to content

Fix #770: clerk/row metadata can't be added to a def #800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
borkdude wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Fix #770: clerk/row metadata can't be added to a def #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
cc5442a
wip
borkdude Jan 20, 2026
b536034
test
borkdude Jan 20, 2026
ec780c9
wip
borkdude Jan 20, 2026
2b00266
make more self-explanatory
borkdude Jan 20, 2026
172c45a
better naming
borkdude Jan 20, 2026
6ba77d8
fini
borkdude Jan 20, 2026
b63dd67
add additional test
borkdude Jan 20, 2026
96f0dc7
improve docstring
borkdude Jan 20, 2026
b24c30d
simplify test
borkdude Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 12 additions & 9 deletions src/nextjournal/clerk/viewer.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,27 +431,30 @@
(defn var-from-def? [x]
(var? (get-safe x :nextjournal.clerk/var-from-def)))

(def unwrap-var-value (some-fn :nextjournal.clerk/var-snapshot
(comp deref :nextjournal.clerk/var-from-def)))

(def var-from-def-viewer
{:name `var-from-def-viewer
:pred var-from-def?
:transform-fn (update-val (some-fn :nextjournal.clerk/var-snapshot
(comp deref :nextjournal.clerk/var-from-def)))})
:transform-fn (update-val unwrap-var-value)})

(defn apply-viewer-unwrapping-var-from-def
"Applies the `viewer` (if set) to the given result `result`. In case
the `value` is a `var-from-def?` it will be unwrapped unless the
viewer opts out with a truthy `:nextjournal.clerk/var-from-def`."
the return value is a `var-from-def?` it will be unwrapped unless the
viewer opts out with a truthy `:var-from-def?`."
[{:as result :nextjournal/keys [value viewer]}]
(if viewer
(let [value+viewer (if (or (var? viewer) (fn? viewer))
(viewer value)
{:nextjournal/value value
:nextjournal/viewer (normalize-viewer viewer)})
{unwrap-var :transform-fn var-from-def? :pred} var-from-def-viewer]
(assoc result :nextjournal/value (cond-> value+viewer
(and (var-from-def? value)
(-> value+viewer ->viewer :var-from-def? not))
unwrap-var)))
result-value (:nextjournal/value value+viewer)
unwrap? (and (var-from-def? result-value)
(-> value+viewer ->viewer :var-from-def? not))]
(assoc result :nextjournal/value
(cond-> value+viewer
unwrap? (update :nextjournal/value unwrap-var-value))))
result))

#?(:clj
Expand Down
37 changes: 25 additions & 12 deletions test/nextjournal/clerk/viewer_test.clj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,20 +212,33 @@
(is (= [{:render-fn 'foo}] (v/get-viewers 'nextjournal.clerk.viewer-test.random-ns-name)))))

(def my-test-var [:h1 "hi"])
(def my-test-var2 1)

(def apply+get-value #(-> % v/apply-viewer-unwrapping-var-from-def :nextjournal/value :nextjournal/value))
(deftest apply-viewer-unwrapping-var-from-def
(let [apply+get-value #(-> % v/apply-viewer-unwrapping-var-from-def :nextjournal/value :nextjournal/value)]
(testing "unwraps var when viewer doens't opt out"
(is (= my-test-var
(apply+get-value {:nextjournal/value [:h1 "hi"] :nextjournal/viewer v/html})
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var} :nextjournal/viewer v/html})
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var} :nextjournal/viewer v/html-viewer}))))

(testing "leaves var wrapped when viewer opts out"
(is (= {:nextjournal.clerk/var-from-def #'my-test-var}
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var}
:nextjournal/viewer (assoc v/html-viewer :var-from-def? true)}))))))

(testing "unwraps var when viewer doens't opt out"
(is (= my-test-var
(apply+get-value {:nextjournal/value [:h1 "hi"] :nextjournal/viewer v/html})
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var} :nextjournal/viewer v/html})
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var} :nextjournal/viewer v/html-viewer}))))

(testing "leaves var wrapped when viewer opts out"
(is (= {:nextjournal.clerk/var-from-def #'my-test-var}
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var}
:nextjournal/viewer (assoc v/html-viewer :var-from-def? true)}))))

(testing "function viewer with var-from-def"
(is (= [{:nextjournal.clerk/var-from-def #'nextjournal.clerk.viewer-test/my-test-var2, :nextjournal.clerk/var-snapshot 1}]
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var2
:nextjournal.clerk/var-snapshot 1}
:nextjournal/viewer v/row}))))
(testing "function viewer that preserves var-from-def"
(let [viewer-fn (fn [v] (v/with-viewer (assoc v/html-viewer :var-from-def? true) v))]
(is (= {:nextjournal.clerk/var-from-def #'my-test-var
:nextjournal.clerk/var-snapshot [:h1 "hi"]}
(apply+get-value {:nextjournal/value {:nextjournal.clerk/var-from-def #'my-test-var
:nextjournal.clerk/var-snapshot [:h1 "hi"]}
:nextjournal/viewer viewer-fn}))))))

(deftest resolve-aliases
(testing "it resolves aliases"
Expand Down
Loading