Compare commits

...

7 Commits

Author SHA1 Message Date
Dustin Farris
0799985296 feat!(capture): add option to create entry ids
This un-breaks a breaking change where we addressed an issue that
prevented ids from being generated for 'entry' capture types.  While
this was a much-asked feature, the change also disrupted user workflows
that depend on the old behavior of entries creating org headings and
nothing more.

Users can now opt in to generating a heading id by passing
`:entry-node t` in their org-roam capture templates definition.

Amend: ed94524964
2025-09-29 16:20:57 -07:00
Dustin Farris
41f9a10be5 fix(capture): self-remove org-roam-capture-run-new-node-hook-a advice
This was incorrectly removing advice that doesn't exist, leading to the
actual advice being perpetually added without removal.

Amend: ed94524964
2025-09-27 15:43:53 -07:00
Dustin Farris
2bdeb7ed25 fix!(capture): move plain capture point past properties drawer
- Fix org-roam-capture--adjust-point-for-capture-type to properly handle
  cases where point is positioned after head content but not at a heading
- Remove redundant location-type logic that incorrectly assumed point > 1
  means we're at a heading (file+head can position point after keywords)
- Restore call to adjust-point-for-capture-type that was removed in ed94524
- Add comprehensive tests for plain capture ordering and assertion error fix
- Refactor adjust-point-for-capture-type for better readability

Amend: ed94524964
Fix: #2540
2025-09-26 10:08:13 -07:00
Dustin Farris
b7483a1df5 test: add tests for link replacement optimization
Added integration tests for the roam link replacement functionality
to validate the performance optimization that limits the scope of
link replacement by searching specifically for "[[roam:" instead
of any org link bracket pattern. The tests ensure:

1. Special regex characters in buffer content don't break the
   search functionality when using search-forward
2. Only roam: links are processed, not other link types like
   file: or https:

These tests validate the optimization maintains correctness while
improving performance by avoiding unnecessary replacement attempts
on non-roam links.

Ref: fc8638759b
Ref: 89dfaef38b
2025-09-23 07:13:35 -07:00
Dustin Farris
2ac1760620 test: clean up demotable.org
This test had been leaving demotable.org in a modified state which was
getting picked up by git requiring devs to manually reset it before
committing other changes.
2025-09-22 18:24:35 -07:00
Jethro Kuan
ed94524964 (feat!)capture: change id creation to headline on entry-type capture-templates 2025-09-22 18:24:35 -07:00
Liam Hupfer
89dfaef38b Fix link replacement optimization
We are searching for a string literal for speed, so don’t treat it as a
regexp.

Fixes: fc8638759b ("feat: Limit link replacement scope")
Fixes: #2529
2025-07-01 00:28:11 -05:00
9 changed files with 565 additions and 65 deletions

View File

@@ -1,5 +1,8 @@
# Changelog
## 2.3.2
- [#2056](https://github.com/org-roam/org-roam/pull/2056) capture: IDs are now created for entries in capture templates
## 2.3.1 (2025-06-26)
* (fix): Use correct type specifications to suppress warnings by @okomestudio in https://github.com/org-roam/org-roam/pull/2522

View File

@@ -847,7 +847,9 @@ of the template are similar to ~org-capture~ templates.
automatically chooses this template for you.
2. The template is given a description of ~"default"~.
3. ~plain~ text is inserted. Other options include Org headings via
~entry~.
~entry~. Note that ~entry~ type captures create regular Org headings
without IDs by default. To create an Org-roam node with an ID, use
the ~:entry-node t~ option.
4. Notice that the ~target~ that's usually in Org-capture templates is missing
here.
5. ~"%?"~ is the template inserted on each call to ~org-roam-capture-~.
@@ -1221,6 +1223,10 @@ Here is a sane default configuration:
"#+title: %<%Y-%m-%d>\n"))))
#+end_src
Note: The ~entry~ type capture above creates a regular Org heading without an
ID. If you want each daily entry to be an Org-roam node with its own ID, add
~:entry-node t~ to the template.
See [[*The Templating System][The Templating System]] for creating new templates.
*** Usage

View File

@@ -1219,7 +1219,9 @@ automatically chooses this template for you.
The template is given a description of @code{"default"}.
@item
@code{plain} text is inserted. Other options include Org headings via
@code{entry}.
@code{entry}. Note that @code{entry} type captures create regular Org headings
without IDs by default. To create an Org-roam node with an ID, use
the @code{:entry-node t} option.
@item
Notice that the @code{target} that's usually in Org-capture templates is missing
here.
@@ -1703,6 +1705,10 @@ Here is a sane default configuration:
"#+title: %<%Y-%m-%d>\n"))))
@end lisp
Note: The @code{entry} type capture above creates a regular Org heading without an
ID@. If you want each daily entry to be an Org-roam node with its own ID, add
@code{:entry-node t} to the template.
See @ref{The Templating System} for creating new templates.
@node Usage
@@ -2421,5 +2427,5 @@ When GOTO is non-nil, go the note without creating an entry."
@printindex vr
Emacs 30.1 (Org mode 9.7.29)
Emacs 30.2 (Org mode 9.7.34)
@bye

View File

@@ -339,11 +339,12 @@ In this case, interactive selection will be bypassed."
(when goto (run-hooks 'org-roam-dailies-find-file-hook)))
(add-hook 'org-roam-capture-preface-hook #'org-roam-dailies--override-capture-time-h)
(defun org-roam-dailies--override-capture-time-h ()
"Override the `:default-time' with the time from `:override-default-time'."
(prog1 nil
(when (org-roam-capture--get :override-default-time)
(org-capture-put :default-time (org-roam-capture--get :override-default-time)))))
(when (org-roam-capture--get :override-default-time)
(org-capture-put :default-time (org-roam-capture--get :override-default-time)))
nil)
;;; Bindings
(defvar org-roam-dailies-map (make-sparse-keymap)

View File

@@ -63,9 +63,11 @@ description A short string describing the template, which will be shown
during selection.
type The type of entry. Valid types are:
entry an Org node, with a headline. Will be filed
as the child of the target entry or as a
top level entry. Its default template is:
entry an Org heading. Will be filed as the child
of the target entry or as a top level entry.
Use :entry-node t to create an ID for this
heading, making it an org-roam node.
Its default template is:
\"* %?\n %a\"
item a plain list item, will be placed in the
first plain list at the target location.
@@ -135,6 +137,11 @@ The following options are supported for the :target property:
The rest of the entry is a property list of additional options. Recognized
properties are:
:entry-node When set to t for entry-type captures, creates an ID for
the captured entry heading. When nil or not specified,
no ID is created for the entry. Only applies to templates
with type 'entry'.
:prepend Normally newly captured information will be appended at
the target location (last child, last table line,
last list item...). Setting this property will
@@ -390,7 +397,7 @@ This variable is populated dynamically, and is only non-nil
during the Org-roam capture process.")
(defconst org-roam-capture--template-keywords (list :target :id :link-description :call-location
:region)
:region :entry-node)
"Keywords used in `org-roam-capture-templates' specific to Org-roam.")
;;; Main entry point
@@ -466,22 +473,23 @@ processing by `org-capture'.
Note: During the capture process this function is run by
`org-capture-set-target-location', as a (function ...) based
capture target."
(let ((id (cond ((run-hook-with-args-until-success 'org-roam-capture-preface-hook))
(t (org-roam-capture--setup-target-location)))))
(org-roam-capture--adjust-point-for-capture-type)
(let ((template (org-capture-get :template)))
(when (stringp template)
(org-capture-put
:template
(org-roam-capture--fill-template template))))
(org-roam-capture--put :id id)
(org-roam-capture--put :finalize (or (org-capture-get :finalize)
(org-roam-capture--get :finalize)))))
(if-let ((id (run-hook-with-args-until-success 'org-roam-capture-preface-hook)))
(org-roam-capture--put :id id)
(org-roam-capture--setup-target-location)
;; Adjust point for plain captures to skip past metadata (e.g. properties drawer)
(org-roam-capture--adjust-point-for-capture-type))
(let ((template (org-capture-get :template)))
(when (stringp template)
(org-capture-put
:template
(org-roam-capture--fill-template template))))
(org-roam-capture--put :finalize (or (org-capture-get :finalize)
(org-roam-capture--get :finalize))))
(defun org-roam-capture--setup-target-location ()
"Initialize the buffer, and goto the location of the new capture.
Return the ID of the location."
(let (p new-file-p)
"Initialize the buffer, and goto the location of the new capture."
(let ((target-entry-p t)
p new-file-p id)
(pcase (org-roam-capture--get-target)
(`(file ,path)
(setq path (org-roam-capture--target-truepath path)
@@ -489,7 +497,8 @@ Return the ID of the location."
(when new-file-p (org-roam-capture--put :new-file path))
(set-buffer (org-capture-target-buffer path))
(widen)
(setq p (goto-char (point-min))))
(setq p (goto-char (point-min))
target-entry-p nil))
(`(file+olp ,path ,olp)
(setq path (org-roam-capture--target-truepath path)
new-file-p (org-roam-capture--new-file-p path))
@@ -505,9 +514,12 @@ Return the ID of the location."
(set-buffer (org-capture-target-buffer path))
(when new-file-p
(org-roam-capture--put :new-file path)
(insert (org-roam-capture--fill-template head 'ensure-newline)))
(insert (org-roam-capture--fill-template head 'ensure-newline))
(setq p (point-max)))
(widen)
(setq p (goto-char (point-min))))
(unless new-file-p
(setq p (goto-char (point-min))))
(setq target-entry-p nil))
(`(file+head+olp ,path ,head ,olp)
(setq path (org-roam-capture--target-truepath path)
new-file-p (org-roam-capture--new-file-p path))
@@ -569,17 +581,46 @@ Return the ID of the location."
(user-error "No node with title or id \"%s\"" title-or-id))))
(set-buffer (org-capture-target-buffer (org-roam-node-file node)))
(goto-char (org-roam-node-point node))
(setq p (org-roam-node-point node)))))
(setq p (org-roam-node-point node)
target-entry-p (and (derived-mode-p 'org-mode) (org-at-heading-p))))))
;; Setup `org-id' for the current capture target and return it back to the
;; caller.
(save-excursion
(goto-char p)
(if-let ((id (org-entry-get p "ID")))
(setf (org-roam-node-id org-roam-capture--node) id)
(org-entry-put p "ID" (org-roam-node-id org-roam-capture--node)))
(prog1
(org-id-get)
(run-hooks 'org-roam-capture-new-node-hook)))))
;; For entry type: only create ID if :entry-node is t
(pcase (org-capture-get :type)
('entry
(when (org-roam-capture--get :entry-node)
(advice-add #'org-capture-place-entry :after #'org-roam-capture--create-id-for-entry)
(org-roam-capture--put :new-node-p t)
(setq id (org-roam-node-id org-roam-capture--node))))
(_
(save-excursion
(goto-char p)
(unless (org-entry-get p "ID")
(org-roam-capture--put :new-node-p t))
(setq id (or (org-entry-get p "ID")
(org-roam-node-id org-roam-capture--node)))
(setf (org-roam-node-id org-roam-capture--node) id)
(org-entry-put p "ID" id))))
(org-roam-capture--put :id id)
(org-roam-capture--put :target-entry-p target-entry-p)
(advice-add #'org-capture-place-template :before #'org-roam-capture--set-target-entry-p-a)
(advice-add #'org-capture-place-template :after #'org-roam-capture-run-new-node-hook-a)))
(defun org-roam-capture--set-target-entry-p-a (_)
"Correct `:target-entry-p' in Org-capture template based on `:target.'."
(org-capture-put :target-entry-p (org-roam-capture--get :target-entry-p))
(advice-remove #'org-capture-place-template #'org-roam-capture--set-target-entry-p-a))
(defun org-roam-capture-run-new-node-hook-a (_)
"Advice to run after the Org-capture template is placed."
(when (org-roam-capture--get :new-node-p)
(run-hooks 'org-roam-capture-new-node-hook))
(advice-remove #'org-capture-place-template #'org-roam-capture-run-new-node-hook-a))
(defun org-roam-capture--create-id-for-entry ()
"Create the ID for the new entry heading."
(org-entry-put (point) "ID" (org-roam-capture--get :id))
(advice-remove #'org-capture-place-entry #'org-roam-capture--create-id-for-entry))
(defun org-roam-capture--get-target ()
"Get the current capture :target for the capture template in use."
@@ -657,27 +698,17 @@ POS is the current position of point (an integer) inside the
currently active capture buffer, where the adjustment should
start to begin from. If it's nil, then it will default to
the current value of `point'."
(or pos (setq pos (point)))
(goto-char pos)
(let ((location-type (if (= pos 1) 'beginning-of-file 'heading-at-point)))
(and (eq location-type 'heading-at-point)
(cl-assert (org-at-heading-p)))
(pcase (org-capture-get :type)
(`plain
(cl-case location-type
(beginning-of-file
(if (org-capture-get :prepend)
(let ((el (org-element-at-point)))
(while (and (not (eobp))
(memq (org-element-type el)
'(drawer property-drawer keyword comment comment-block horizontal-rule)))
(goto-char (org-element-property :end el))
(setq el (org-element-at-point))))
(goto-char (org-entry-end-position))))
(heading-at-point
(if (org-capture-get :prepend)
(org-end-of-meta-data t)
(goto-char (org-entry-end-position))))))))
(goto-char (or pos (point)))
(pcase (org-capture-get :type)
(`plain
(if (org-capture-get :prepend)
(let ((el (org-element-at-point)))
(while (and (not (eobp))
(memq (org-element-type el)
'(drawer property-drawer keyword comment comment-block horizontal-rule)))
(goto-char (org-element-property :end el))
(setq el (org-element-at-point))))
(goto-char (org-entry-end-position)))))
(point))
;;; Capture implementation

View File

@@ -810,10 +810,9 @@ Assumes that the cursor was put where the link is."
(defun org-roam-link-replace-all ()
"Replace all \"roam:\" links in buffer with \"id:\" links."
(interactive)
(let ((org-roam-link-prefix (concat "[[" org-roam-link-type ":")))
(org-with-point-at 1
(while (re-search-forward org-roam-link-prefix nil t)
(org-roam-link-replace-at-point)))))
(org-with-point-at 1
(while (search-forward (concat "[[" org-roam-link-type ":") nil t)
(org-roam-link-replace-at-point))))
(add-hook 'org-roam-find-file-hook #'org-roam--replace-roam-links-on-save-h)
(defun org-roam--replace-roam-links-on-save-h ()

View File

@@ -58,6 +58,392 @@
(org-roam-capture--fill-template (lambda () "foo"))
:to-equal "foo")))
(describe "org-roam-capture :entry-node option"
:var ((temp-dir) (org-roam-directory) (org-roam-db-location))
(before-each
(setq temp-dir (make-temp-file "org-roam-test" t))
(setq org-roam-directory temp-dir)
(setq org-roam-db-location (expand-file-name "org-roam.db" temp-dir))
(org-roam-db-sync))
(after-each
(delete-directory temp-dir t))
(it "does not create ID for entry-type capture without :entry-node option"
(let* ((test-file (expand-file-name "test-parent.org" temp-dir))
(org-roam-capture-templates
'(("t" "test" entry "* ${title}"
:target (file "test-parent.org")
:unnarrowed t))))
;; Create parent file with an existing heading
(with-temp-file test-file
(insert "#+TITLE: Parent File\n\n* Existing Heading\n"))
;; Mock the node selection to return a new node
(cl-letf (((symbol-function 'org-roam-node-read)
(lambda (&rest _)
(org-roam-node-create :title "New Entry Without ID"))))
(org-roam-capture)
;; Finalize the capture
(org-capture-finalize))
;; Verify the captured entry exists but has no ID
(with-temp-buffer
(insert-file-contents test-file)
(goto-char (point-min))
(re-search-forward "^\\* New Entry Without ID$")
(let ((has-id (org-entry-get (point) "ID")))
(expect has-id :to-be nil)))))
(it "creates ID for entry-type capture with :entry-node t option"
(let* ((test-file (expand-file-name "test-parent-with-id.org" temp-dir))
(org-roam-capture-templates
'(("t" "test" entry "* ${title}"
:target (file "test-parent-with-id.org")
:entry-node t
:unnarrowed t))))
;; Create parent file with an existing heading
(with-temp-file test-file
(insert "#+TITLE: Parent File\n\n* Existing Heading\n"))
;; Mock the node selection to return a new node
(cl-letf (((symbol-function 'org-roam-node-read)
(lambda (&rest _)
(org-roam-node-create :title "New Entry With ID"))))
(org-roam-capture)
;; Finalize the capture
(org-capture-finalize))
;; Verify the captured entry has an ID
(with-temp-buffer
(insert-file-contents test-file)
(goto-char (point-min))
(re-search-forward "^\\* New Entry With ID$")
(let ((has-id (org-entry-get (point) "ID")))
(expect has-id :not :to-be nil)))))
(it "creates ID at target for non-entry-type captures"
(let* ((temp-dir (make-temp-file "org-roam-test" t))
(test-file (expand-file-name "test-plain.org" temp-dir))
(org-roam-directory temp-dir)
(org-roam-capture--node (org-roam-node-create :id (org-id-new)))
(org-roam-capture--info (make-hash-table :test 'equal))
capture-id)
(unwind-protect
(progn
;; Create initial empty file
(with-temp-file test-file
(insert "#+TITLE: Test\n"))
;; Mock org-capture context for plain type
(cl-letf* (((symbol-function 'org-capture-get)
(lambda (prop)
(pcase prop
(:type 'plain)
(_ nil))))
((symbol-function 'org-roam-capture--get-target)
(lambda () `(file ,test-file))))
;; Call the setup function
(with-current-buffer (find-file-noselect test-file)
(org-roam-capture--setup-target-location)
(setq capture-id (org-roam-capture--get :id)))
;; For non-entry types, ID should be created at the target location
(expect capture-id :not :to-be nil)
(expect (org-roam-capture--get :new-node-p) :to-be t)))
(delete-directory temp-dir t)))))
(describe "org-roam-capture advice functions"
:var ((org-roam-capture--info))
(before-each
(setq org-roam-capture--info (make-hash-table :test 'equal)))
(it "org-roam-capture--create-id-for-entry creates and removes advice"
(cl-letf* ((entry-id nil)
((symbol-function 'org-entry-put)
(lambda (pom prop val)
(when (string= prop "ID")
(setq entry-id val))))
((symbol-function 'org-roam-capture--get)
(lambda (prop)
(if (eq prop :id)
"test-id-123"
nil))))
;; Add the advice
(advice-add #'org-capture-place-entry :after #'org-roam-capture--create-id-for-entry)
;; Call the function
(org-roam-capture--create-id-for-entry)
;; Verify ID was set and advice removed
(expect entry-id :to-equal "test-id-123")
(expect (advice-member-p #'org-roam-capture--create-id-for-entry
#'org-capture-place-entry)
:to-be nil)))
(it "org-roam-capture--set-target-entry-p-a sets and removes advice"
(cl-letf* ((captured-value nil)
((symbol-function 'org-capture-put)
(lambda (prop val)
(when (eq prop :target-entry-p)
(setq captured-value val))))
((symbol-function 'org-roam-capture--get)
(lambda (prop)
(if (eq prop :target-entry-p)
t
nil))))
;; Add the advice
(advice-add #'org-capture-place-template :before #'org-roam-capture--set-target-entry-p-a)
;; Call the function
(org-roam-capture--set-target-entry-p-a nil)
;; Verify value was set and advice removed
(expect captured-value :to-be t)
(expect (advice-member-p #'org-roam-capture--set-target-entry-p-a
#'org-capture-place-template)
:to-be nil)))
(describe "org-roam-capture-run-new-node-hook-a"
(it "runs hook when new node"
(let ((hook-ran nil))
(cl-letf* (((symbol-function 'org-roam-capture--get)
(lambda (prop)
(if (eq prop :new-node-p)
t
nil))))
;; Add test hook
(add-hook 'org-roam-capture-new-node-hook
(lambda () (setq hook-ran t)))
;; Add the advice
(advice-add #'org-capture-place-template :after #'org-roam-capture-run-new-node-hook-a)
;; Call the function
(org-roam-capture-run-new-node-hook-a nil)
;; Verify hook ran
(expect hook-ran :to-be t)
;; Clean up
(remove-hook 'org-roam-capture-new-node-hook
(lambda () (setq hook-ran t))))))
(it "removes itself as advice after running"
(cl-letf* (((symbol-function 'org-roam-capture--get)
(lambda (prop)
(if (eq prop :new-node-p)
t
nil))))
;; Add the advice
(advice-add #'org-capture-place-template :after #'org-roam-capture-run-new-node-hook-a)
;; Verify advice is added
(expect (advice-member-p #'org-roam-capture-run-new-node-hook-a
#'org-capture-place-template)
:to-be-truthy)
;; Call the function
(org-roam-capture-run-new-node-hook-a nil)
;; Verify advice was removed after running
(expect (advice-member-p #'org-roam-capture-run-new-node-hook-a
#'org-capture-place-template)
:to-be nil)))))
(describe "org-roam-capture target-entry-p detection"
(it "detects entry target for file+olp"
(let* ((temp-dir (make-temp-file "org-roam-test" t))
(test-file (expand-file-name "test-olp.org" temp-dir))
(org-roam-directory temp-dir)
(org-roam-capture--node (org-roam-node-create :id (org-id-new)))
(org-roam-capture--info (make-hash-table :test 'equal)))
(unwind-protect
(progn
(with-temp-file test-file
(insert "* Level 1\n** Level 2\n"))
(cl-letf* (((symbol-function 'org-roam-capture--get-target)
(lambda () `(file+olp ,test-file ("Level 1" "Level 2"))))
((symbol-function 'org-capture-get)
(lambda (prop) nil)))
(with-current-buffer (find-file-noselect test-file)
(org-roam-capture--setup-target-location)
(expect (org-roam-capture--get :target-entry-p) :to-be t))))
(delete-directory temp-dir t))))
(it "detects non-entry target for file"
(let* ((temp-dir (make-temp-file "org-roam-test" t))
(test-file (expand-file-name "test-file.org" temp-dir))
(org-roam-directory temp-dir)
(org-roam-capture--node (org-roam-node-create :id (org-id-new)))
(org-roam-capture--info (make-hash-table :test 'equal)))
(unwind-protect
(progn
(with-temp-file test-file
(insert "#+TITLE: Test\n"))
(cl-letf* (((symbol-function 'org-roam-capture--get-target)
(lambda () `(file ,test-file)))
((symbol-function 'org-capture-get)
(lambda (prop) nil)))
(with-current-buffer (find-file-noselect test-file)
(org-roam-capture--setup-target-location)
(expect (org-roam-capture--get :target-entry-p) :to-be nil))))
(delete-directory temp-dir t)))))
(describe "org-roam-capture plain type ordering"
:var ((temp-dir) (org-roam-directory) (org-roam-db-location))
(before-each
(setq temp-dir (make-temp-file "org-roam-test" t))
(setq org-roam-directory temp-dir)
(setq org-roam-db-location (expand-file-name "org-roam.db" temp-dir))
(org-roam-db-sync))
(after-each
(delete-directory temp-dir t))
(it "places properties drawer before captured content for plain type with file target"
(let* ((test-file (expand-file-name "test-plain-file.org" temp-dir))
(test-content "Test plain :target file")
(node (org-roam-node-create :title "Test Plain"))
(org-roam-capture--node node)
(org-roam-capture--info (make-hash-table :test 'equal)))
;; Call the setup directly to simulate capture without user interaction
(cl-letf* (((symbol-function 'org-capture-get)
(lambda (prop)
(pcase prop
(:type 'plain)
(:target-file test-file)
(_ nil))))
((symbol-function 'org-roam-capture--get-target)
(lambda () `(file ,test-file))))
;; Run the setup and insert content
(with-current-buffer (find-file-noselect test-file)
(org-roam-capture--setup-target-location)
(org-roam-capture--adjust-point-for-capture-type)
(insert test-content)
(save-buffer)))
;; Read the created file and check its structure
(with-temp-buffer
(insert-file-contents test-file)
(let ((buffer-content (buffer-string)))
;; The expected format is:
;; :PROPERTIES:
;; :ID: some-id
;; :END:
;; Test plain :target file
;; Check that properties come first
(expect buffer-content
:to-match
(rx bol ":PROPERTIES:"))
;; Verify ordering: properties, then content
(let ((props-pos (string-match ":PROPERTIES:" buffer-content))
(end-pos (string-match ":END:" buffer-content))
(content-pos (string-match (regexp-quote test-content) buffer-content)))
(expect props-pos :to-be 0)
(expect end-pos :not :to-be nil)
(expect end-pos :to-be-greater-than props-pos)
(expect content-pos :not :to-be nil)
(expect content-pos :to-be-greater-than end-pos))))))
(it "correctly orders buffer elements for plain type with file+head target"
(let* ((test-file (expand-file-name "test-plain-file-head.org" temp-dir))
(test-content "Test plain :target file+head")
(node (org-roam-node-create :title "plain file+head"))
(org-roam-capture--node node)
(org-roam-capture--info (make-hash-table :test 'equal)))
;; Populate capture info with title for template expansion
(puthash :title "plain file+head" org-roam-capture--info)
;; Call the setup directly to simulate capture without user interaction
(cl-letf* (((symbol-function 'org-capture-get)
(lambda (prop)
(pcase prop
(:type 'plain)
(:target-file test-file)
(_ nil))))
((symbol-function 'org-roam-capture--get-target)
(lambda () `(file+head ,test-file "#+title: ${title}\n"))))
;; Run the setup and insert content
(with-current-buffer (find-file-noselect test-file)
(org-roam-capture--setup-target-location)
(org-roam-capture--adjust-point-for-capture-type)
(insert test-content)
(save-buffer)))
;; Read the created file and check its structure
(with-temp-buffer
(insert-file-contents test-file)
(let ((buffer-content (buffer-string)))
;; The actual format according to org-mode property syntax is:
;; :PROPERTIES:
;; :ID: some-id
;; :END:
;; #+title: plain file+head
;; Test plain :target file+head
;;
;; This is correct - buffer-level properties must be at the top
;; Check that properties come first
(expect buffer-content
:to-match
(rx bol ":PROPERTIES:"))
;; Verify ordering: properties are at the top
(let ((props-pos (string-match ":PROPERTIES:" buffer-content))
(end-pos (string-match ":END:" buffer-content)))
;; Properties drawer should be first
(expect props-pos :to-be 0)
(expect end-pos :not :to-be nil)
(expect end-pos :to-be-greater-than props-pos))))))
(it "tests org-roam-capture--adjust-point-for-capture-type behavior"
;; Simple test to verify the fix for assertion error
(with-temp-buffer
(org-mode)
(insert "#+title: Test\n")
(goto-char (point-max))
;; Mock org-capture-get to return plain type
(cl-letf (((symbol-function 'org-capture-get)
(lambda (prop) (when (eq prop :type) 'plain))))
;; Document current state that previously caused assertion error
(let ((point-before (point))
(at-heading-before (org-at-heading-p)))
;; This should no longer trigger assertion error with our fix
(org-roam-capture--adjust-point-for-capture-type)
(expect point-before :to-be-greater-than 1)
(expect at-heading-before :to-be nil))))))
(provide 'test-org-roam-capture)
;;; test-org-roam-capture.el ends here

View File

@@ -0,0 +1,56 @@
;;; test-org-roam-link-replace.el --- Tests for Org-roam link replacement -*- lexical-binding: t; -*-
;; Copyright (C) 2025
;; Package-Requires: ((buttercup))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Tests for commits fc86387 and 89dfaef - link replacement optimization
;;; Code:
(require 'buttercup)
(require 'org-roam)
(require 'org-roam-node)
(describe "org-roam-link-replace-all optimization"
(before-all
(setq org-roam-directory (expand-file-name "tests/roam-files")
org-roam-db-location (expand-file-name "org-roam.db" temporary-file-directory))
(org-roam-db-sync))
(after-all
(org-roam-db--close)
(delete-file org-roam-db-location))
(it "only processes roam: links, not other bracket links"
(with-temp-buffer
(org-mode)
(insert "[[file:test.org][File]]\n[[roam:Foo]]\n[[https://example.com][Web]]")
(let ((replace-count 0)
(original-fn (symbol-function 'org-roam-link-replace-at-point)))
;; Wrap the original function to count calls
(cl-letf (((symbol-function 'org-roam-link-replace-at-point)
(lambda ()
(cl-incf replace-count)
(funcall original-fn))))
(org-roam-link-replace-all)
;; Should only be called once, for the roam: link
(expect replace-count :to-equal 1)
(expect (buffer-string) :to-match "\\[\\[id:.*\\]\\[Foo\\]\\]"))))))
(provide 'test-org-roam-link-replace)
;;; test-org-roam-link-replace.el ends here

View File

@@ -77,10 +77,22 @@
(cd root-directory))
(it "demotes an entire org buffer"
(find-file "tests/roam-files/demoteable.org" nil)
(org-roam-demote-entire-buffer)
(expect (buffer-substring-no-properties (point) (point-max))
:to-equal "* Demoteable\n:PROPERTIES:\n:ID: 97bf31cf-dfee-45d8-87a5-2ae0dabc4734\n:END:\n\n** Demoteable h1\n\n*** Demoteable child\n")))
(let* ((test-file "tests/roam-files/demoteable.org")
(buf (find-file-noselect test-file))
;; Store the original content before any modifications
(original-content (with-current-buffer buf
(buffer-substring-no-properties (point-min) (point-max)))))
(unwind-protect
(with-current-buffer buf
(org-roam-demote-entire-buffer)
(expect (buffer-substring-no-properties (point) (point-max))
:to-equal "* Demoteable\n:PROPERTIES:\n:ID: 97bf31cf-dfee-45d8-87a5-2ae0dabc4734\n:END:\n\n** Demoteable h1\n\n*** Demoteable child\n"))
;; Always restore the original content
(with-current-buffer buf
(erase-buffer)
(insert original-content)
(save-buffer)
(kill-buffer buf))))))
(describe "org-roam--h1-count"
(after-each