Ihor Radchenko <yanta...@posteo.net> writes: [...] > Thanks! > The second patch is malformed. May you please resend?
Sorry, resend with rewritten test. [...] > If you can, please avoid using `org-test-at-id'. This is much less > readable compared to explicit org-test-with-temp-text because one needs > to reach out to another file in order to understand what the test is > about. Now it's less verbose, handles both cases (with and without TARGET-FILE) and prints detailed ert explanation. > Evgenii Klimov <eugene....@lipklim.org> writes: [...] >> It wasn't clear for me: will ":tangle yes" or explicit ":tangle no" be >> affected by TARGET-FILE. Maybe if we rephrase as follows it will be >> clear for both of us: >> >> Optional argument TARGET-FILE can be used to overwrite a default >> export file in `org-babel-default-header-args' for all source >> blocks. > > In `org-babel-tangle', TARGET-FILE is set as fallback value for the > blocks that have no :tangle value at all, including inherited; including > :tangle yes. This exactly idea I wanted to add to the docstring. > The manual asserts > > ‘yes’ > Export the code block to source file. The file name for the source > file is derived from the name of the Org file, and the file > extension is derived from the source code language identifier. > Example: ‘:tangle yes’. > > So, "yes" should imply :tangle <Org file name.lang-ext> > > `org-babel-tangle-collect-blocks' handles this by > > (unless (or (string= src-tfile "no") > (and tangle-file (not (equal tangle-file src-tfile))) > (and lang-re (not (string-match-p lang-re src-lang)))) > > So, :tangle no is always excluded. > When TANGLE-FILE is set and not equal to :tangle value (including > "yes"), block is also excluded. Indeed, but later ‘no’ The *default*. Do not extract the code in a source code file. Example: ‘:tangle no’. in conjunction with TARGET-FILE's description in ~org-babel-tangle~ docstring: Optional argument TARGET-FILE can be used to specify a *default* export file for all source blocks. made me feel doubt about TARGET-FILE's effect. Anyway, probably it was my incorrect interpretation, so let's leave it as it is.
>From a5b4faec9b58b8e56512c03e4f1a1fe295900d3f Mon Sep 17 00:00:00 2001 From: Evgenii Klimov <eugene....@lipklim.org> Date: Fri, 21 Jul 2023 22:40:06 +0100 Subject: [PATCH v4 1/2] testing/lisp/test-ob-tangle.el: Test block collection into groups for tangling * testing/lisp/test-ob-tangle.el (ob-tangle/collect-blocks): Test block collection into groups for tangling. --- testing/lisp/test-ob-tangle.el | 111 +++++++++++++++++++++++++++++++++ 1 file changed, 111 insertions(+) diff --git a/testing/lisp/test-ob-tangle.el b/testing/lisp/test-ob-tangle.el index 07e75f4d3..55e1f7aa3 100644 --- a/testing/lisp/test-ob-tangle.el +++ b/testing/lisp/test-ob-tangle.el @@ -569,6 +569,117 @@ another block (set-buffer-modified-p nil)) (kill-buffer buffer)))) +(ert-deftest ob-tangle/collect-blocks () + "Test block collection into groups for tangling." + (org-test-with-temp-text-in-file + "* H1 with :tangle in properties +:PROPERTIES: +:header-args: :tangle relative.el +:END: + +#+begin_src emacs-lisp +\"H1: inherited :tangle relative.el in properties\" +#+end_src + +#+begin_src emacs-lisp :tangle yes +\"H1: :tangle yes\" +#+end_src + +#+begin_src emacs-lisp :tangle no +\"H1: should be ignored\" +#+end_src + +<point> + +#+begin_src emacs-lisp :tangle relative.el +\"H1: :tangle relative.el\" +#+end_src + +#+begin_src emacs-lisp :tangle ./relative.el +\"H1: :tangle ./relative.el\" +#+end_src + +#+begin_src emacs-lisp :tangle /tmp/absolute.el +\"H1: :tangle /tmp/absolute.el\" +#+end_src + +#+begin_src emacs-lisp :tangle ~/../../tmp/absolute.el +\"H1: :tangle ~/../../tmp/absolute.el\" +#+end_src + +* H2 without :tangle in properties + +#+begin_src emacs-lisp +\"H2: without :tangle\" +#+end_src + +#+begin_src emacs-lisp :tangle yes +\"H2: :tangle yes\" +#+end_src + +#+begin_src emacs-lisp :tangle no +\"H2: should be ignored\" +#+end_src + +#+begin_src emacs-lisp :tangle relative.el +\"H2: :tangle relative.el\" +#+end_src + +#+begin_src emacs-lisp :tangle ./relative.el +\"H2: :tangle ./relative.el\" +#+end_src + +#+begin_src emacs-lisp :tangle /tmp/absolute.el +\"H2: :tangle /tmp/absolute.el\" +#+end_src + +#+begin_src emacs-lisp :tangle ~/../../tmp/absolute.el +\"H2: :tangle ~/../../tmp/absolute.el\" +#+end_src +" + (letrec ((org-file (buffer-file-name)) + (test-dir (file-name-directory org-file)) + (el-file-abs (concat (file-name-sans-extension org-file) ".el")) + (el-file-rel (file-name-nondirectory el-file-abs)) + (sort-fn (lambda (lst) (seq-sort-by #'car #'string-lessp lst))) + (expected-targets-fn + (lambda (nblocks-el-file) + "Convert to absolute file names and sort expected targets" + (funcall sort-fn + (map-apply (lambda (file nblocks) + (cons (expand-file-name file test-dir) nblocks)) + `(("/tmp/absolute.el" . 4) + ("relative.el" . 5) + ;; single file that differs between tests + (,el-file-abs . ,nblocks-el-file)))))) + (collected-targets-fn + (lambda (collected-blocks) + (funcall sort-fn (map-apply (lambda (file blocks) + (cons file (length blocks))) + collected-blocks))))) + ;; to the first header + (insert (format "#+begin_src emacs-lisp :tangle %s +\"H1: absolute org-file.lang-ext :tangle %s\" +#+end_src" el-file-abs el-file-abs)) + (goto-char (point-max)) + ;; to the second header + (insert (format " +#+begin_src emacs-lisp :tangle %s +\"H2: relative org-file.lang-ext :tangle %s\" +#+end_src" el-file-rel el-file-rel)) + (should (equal (funcall expected-targets-fn 4) + (funcall collected-targets-fn (org-babel-tangle-collect-blocks)))) + ;; simulate TARGET-FILE to test as `org-babel-tangle' and + ;; `org-babel-load-file' would call + ;; `org-babel-tangle-collect-blocks'. + (let ((org-babel-default-header-args + (org-babel-merge-params + org-babel-default-header-args + (list (cons :tangle el-file-abs))))) + (should (equal (funcall expected-targets-fn 5) + (funcall collected-targets-fn + (org-babel-tangle-collect-blocks)))))))) + (provide 'test-ob-tangle) ;;; test-ob-tangle.el ends here -- 2.34.1
>From 4ca26a21612df18d8ff7f71726a858501e317e00 Mon Sep 17 00:00:00 2001 From: Evgenii Klimov <eugene....@lipklim.org> Date: Wed, 12 Jul 2023 19:24:48 +0100 Subject: [PATCH v4 2/2] ob-tangle.el: Avoid relative file names when grouping blocks to tangle * lisp/ob-tangle.el (org-babel-tangle-single-block, org-babel-tangle-collect-blocks): Make target file name attribute, used internally to group blocks with identical language, to be absolute. (org-babel-effective-tangled-filename): Avoid using relative file names that could cause one block to overwrite the others in `org-babel-tangle-collect-blocks' if they have the same target file but in different formats. --- lisp/ob-tangle.el | 32 ++++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/lisp/ob-tangle.el b/lisp/ob-tangle.el index b6ae4b55a..670a3dfa7 100644 --- a/lisp/ob-tangle.el +++ b/lisp/ob-tangle.el @@ -427,17 +427,19 @@ that the appropriate major-mode is set. SPEC has the form: org-babel-tangle-comment-format-end link-data))))) (defun org-babel-effective-tangled-filename (buffer-fn src-lang src-tfile) - "Return effective tangled filename of a source-code block. -BUFFER-FN is the name of the buffer, SRC-LANG the language of the -block and SRC-TFILE is the value of the :tangle header argument, -as computed by `org-babel-tangle-single-block'." - (let ((base-name (cond - ((string= "yes" src-tfile) - ;; Use the buffer name - (file-name-sans-extension buffer-fn)) - ((string= "no" src-tfile) nil) - ((> (length src-tfile) 0) src-tfile))) - (ext (or (cdr (assoc src-lang org-babel-tangle-lang-exts)) src-lang))) + "Return effective tangled absolute filename of a source-code block. +BUFFER-FN is the absolute file name of the buffer, SRC-LANG the +language of the block and SRC-TFILE is the value of the :tangle +header argument, as computed by `org-babel-tangle-single-block'." + (let* ((fnd (file-name-directory buffer-fn)) + (base-name (cond + ((string= "yes" src-tfile) + ;; Use the buffer name + (file-name-sans-extension buffer-fn)) + ((string= "no" src-tfile) nil) + ((> (length src-tfile) 0) + (expand-file-name src-tfile fnd)))) + (ext (or (cdr (assoc src-lang org-babel-tangle-lang-exts)) src-lang))) (when base-name ;; decide if we want to add ext to base-name (if (and ext (string= "yes" src-tfile)) @@ -454,7 +456,9 @@ source code blocks by languages matching a regular expression. Optional argument TANGLE-FILE can be used to limit the collected code blocks by target file." - (let ((counter 0) last-heading-pos blocks) + (let ((counter 0) + (buffer-fn (buffer-file-name (buffer-base-buffer))) + last-heading-pos blocks) (org-babel-map-src-blocks (buffer-file-name) (let ((current-heading-pos (or (org-element-begin @@ -478,7 +482,7 @@ code blocks by target file." (let* ((block (org-babel-tangle-single-block counter)) (src-tfile (cdr (assq :tangle (nth 4 block)))) (file-name (org-babel-effective-tangled-filename - (nth 1 block) src-lang src-tfile)) + buffer-fn src-lang src-tfile)) (by-fn (assoc file-name blocks))) (if by-fn (setcdr by-fn (cons (cons src-lang block) (cdr by-fn))) (push (cons file-name (list (cons src-lang block))) blocks))))))) @@ -595,7 +599,7 @@ non-nil, return the full association list to be used by comment))) (if only-this-block (let* ((file-name (org-babel-effective-tangled-filename - (nth 1 result) src-lang src-tfile))) + file src-lang src-tfile))) (list (cons file-name (list (cons src-lang result))))) result))) -- 2.34.1