emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: stardiviner <numbchild@gmail.com>
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: Org Mode <emacs-orgmode@gnu.org>
Subject: Re: [FEATURE] Make header argument :mkdirp yes work for other header arguments not just :tangle
Date: Sun, 03 Mar 2019 23:15:01 +0800	[thread overview]
Message-ID: <871s3ogfbe.fsf@gmail.com> (raw)
In-Reply-To: <87k1hge652.fsf@nicolasgoaziou.fr>

[-- Attachment #1: Type: text/plain, Size: 2147 bytes --]


Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

> Hello,
>
> stardiviner <numbchild@gmail.com> writes:
>
>> I hope ~:mkdirp~ header argument can also work for other related header arguments
>> like ~:dir~, ~:file~ etc not just ~:tangle~. Like following example.
>>
>> #+begin_src sh :mkdirp yes :dir "data/code/mkdirp/dir" :file "test" :results file link
>> echo "hello"
>> #+end_src
>>
>> So I added a simple patch to make it work.
>
> Thank you. Some comments follow.
>
>>  #+cindex: @samp{mkdirp}, header argument
>> -The =mkdirp= header argument creates parent directories for tangled
>> -files if the directory does not exist.  =yes= enables directory
>> -creation and =no= inhibits directory creation.
>> +The =mkdirp= header argument creates parent directories for =dir=
>> +header argument specified path and tangled files if the directory does
>> +not exist.  =yes= enables directory creation and =no= inhibits
>> +directory creation.
>
> Please also support "t" and "nil", or, more generally, make "no" and
> "nil" equivalent, and anything else would be "t".

I use ~cond~ to handle this. Don't know whether have better. I can use ~if~ to
exclusive on "no" and "nil". But it is not robust.

>
>> -		   (or (and dir (file-name-as-directory (expand-file-name dir)))
>> +		   (or (and dir
>> +			    ;; Possibly create the parent directories for file.
>> +			    (let (fnd (file-name-as-directory (expand-file-name dir)))
>> +			      (if (and (string= mkdirp "yes") fnd)
>> +				  (make-directory fnd 'parents))))
>
>> +;;; test-ob-core.el --- tests for ob-core.el
>
> Tests are in "test-ob.el" file. You should add yours there instead of
> creating a new file.

I though it is "test-ob-core.el", but have not found it. So I created a new one. :)

>
>> +(ert-deftest test-ob-core/dir-mkdirp ()
>> +  (org-test-with-temp-text
>> +   "#+begin_src sh :mkdirp yes :dir \"data/code\"
>> +pwd
>> +#+end_src"
>> +   (org-babel-execute-src-block)
>> +   (should (file-directory-p "data/code"))))
>
> Nitpick: `should' is better outside `org-test-with-temp-text'?

Updated.

>
> Could you send an updated patch?

New patch in attachment.
      

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-ob-core.el-Make-mkdirp-work-for-dir-too.patch --]
[-- Type: text/x-patch, Size: 3663 bytes --]

From aafdd41f7ae5f6218a2be890f58d45be443de4a9 Mon Sep 17 00:00:00 2001
From: stardiviner <numbchild@gmail.com>
Date: Sat, 2 Mar 2019 12:11:47 +0800
Subject: [PATCH] ob-core.el: Make :mkdirp work for :dir too

* lisp/ob-core.el (org-babel-execute-src-block): make directory if :dir
  path does not exist when :mkdirp yes exist.

* doc/org-manualo.rg (mkdirp): declare new change in manual.

* etc/ORG-NEWS: declare changes in ORG-NEWS.

* testing/lisp/test-ob.el: Add a specific testing file for ob-core.el,
  and add a testing for :mkdir yes work with :dir header argument usage.
---
 doc/org-manual.org      | 7 ++++---
 etc/ORG-NEWS            | 6 ++++++
 lisp/ob-core.el         | 9 ++++++++-
 testing/lisp/test-ob.el | 8 ++++++++
 4 files changed, 26 insertions(+), 4 deletions(-)

diff --git a/doc/org-manual.org b/doc/org-manual.org
index 00e5e1072..30c797ad7 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -17476,9 +17476,10 @@ to source file(s).
   location.  Example: =:tangle FILENAME=.
 
 #+cindex: @samp{mkdirp}, header argument
-The =mkdirp= header argument creates parent directories for tangled
-files if the directory does not exist.  =yes= enables directory
-creation and =no= inhibits directory creation.
+The =mkdirp= header argument creates parent directories for =dir=
+header argument specified path and tangled files if the directory does
+not exist.  =yes= enables directory creation and =no= inhibits
+directory creation.
 
 #+cindex: @samp{comments}, header argument
 The =comments= header argument controls inserting comments into
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 057440a71..cd5e4d900 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -157,6 +157,12 @@ A call of ~org-set-tags-command~ with prefix argument C-u C-u avoids
 the fast tag selection interface and instead offers the plain
 interface.
 
+*** ~:mkdirp~ now supports create directory for ~:dir~ path
+
+The ~:mkdirp~ header argument used to only work for ~:tangle~ tangle
+files. Now ~:mkdirp~ works for ~:dir~ too. This is more convenient for
+specify default directory and with ~:file~ header argument.
+
 * Version 9.2
 ** Incompatible changes
 *** Removal of OrgStruct mode mode and radio lists
diff --git a/lisp/ob-core.el b/lisp/ob-core.el
index e6f0edba5..c2b629bab 100644
--- a/lisp/ob-core.el
+++ b/lisp/ob-core.el
@@ -677,8 +677,15 @@ block."
 		      (replace-regexp-in-string
 		       (org-src-coderef-regexp coderef) "" expand nil nil 1))))
 		 (dir (cdr (assq :dir params)))
+		 (mkdirp (cdr (assq :mkdirp params)))
 		 (default-directory
-		   (or (and dir (file-name-as-directory (expand-file-name dir)))
+		   (or (and dir
+			    ;; Possibly create the parent directories for file.
+			    (let ((fnd (file-name-as-directory (expand-file-name dir))))
+			      (cond
+			       ((member mkdirp '("yes" "t")) (make-directory fnd 'parents))
+			       ((member mkdirp '("no" "nil")) nil)
+			       (t (make-directory fnd 'parents)))))
 		       default-directory))
 		 (cmd (intern (concat "org-babel-execute:" lang)))
 		 result)
diff --git a/testing/lisp/test-ob.el b/testing/lisp/test-ob.el
index 427c11c6d..33d6ae8f7 100644
--- a/testing/lisp/test-ob.el
+++ b/testing/lisp/test-ob.el
@@ -1607,6 +1607,14 @@ echo \"$data\"
 		   (cdr (assq :file (nth 2 (org-babel-get-src-block-info t))))))
     ))
 
+(ert-deftest test-ob-core/dir-mkdirp ()
+  (org-test-with-temp-text
+   "#+begin_src sh :mkdirp yes :dir \"data/code\"
+pwd
+#+end_src"
+   (org-babel-execute-src-block))
+  (should (file-directory-p "data/code")))
+
 (ert-deftest test-ob/script-escape ()
   ;; Delimited lists of numbers
   (should (equal '(1 2 3)
-- 
2.21.0


[-- Attachment #3: Type: text/plain, Size: 271 bytes --]


>
> Regards,

Regards,

-- 
[ stardiviner ]
       I try to make every word tell the meaning what I want to express.

       Blog: https://stardiviner.github.io/
       IRC(freenode): stardiviner, Matrix: stardiviner
       GPG: F09F650D7D674819892591401B5DF1C95AE89AC3

  reply	other threads:[~2019-03-03 23:19 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-02-19  5:40 [Proposal] Make header argument :mkdirp yes work for other header arguments not just :tangle Christopher M. Miles
2019-03-02  4:55 ` stardiviner
2019-03-03  7:23   ` [FEATURE] " stardiviner
2019-03-03  8:03     ` Nicolas Goaziou
2019-03-03 15:15       ` stardiviner [this message]
2019-03-04 22:21         ` Nicolas Goaziou
2019-03-05  5:13           ` stardiviner
2019-03-05  6:02           ` [Discuss] make :tangle header argument respect :dir could save info typing stardiviner
2019-03-19 13:08             ` Sean O'Halpin
2019-03-20  5:47               ` stardiviner
2019-03-03  4:32 ` [Proposal] Make header argument :mkdirp yes work for other header arguments not just :tangle stardiviner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=871s3ogfbe.fsf@gmail.com \
    --to=numbchild@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    --cc=mail@nicolasgoaziou.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).