[PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Joseph Turner]

When :results header arg is set to a value that doesn't include
"file", insert txt output in buffer below src block.

TINYCHANGE
---
 etc/ORG-NEWS        |  7 +++++++
 lisp/ob-plantuml.el | 13 ++++++++++---
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index 4cda357f1..b8cd05d4e 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -295,6 +295,13 @@ files that are exported to Texinfo.
 
 =org-at-heading-p= now returns t by default on headings inside folds.
 Passing optional argument will produce the old behaviour.
+
+*** =org-babel-execute:plantuml= can output ASCII graphs in the buffer
+
+Previously, executing PlantUML src blocks always exported to a file.  Now, if
+:results is set to a value which does not include "file", no file will be
+exported and an ASCII graph will be inserted below the src block.
+
 ** Removed or renamed functions and variables
 *** =org-plantump-executable-args= is renamed and applies to jar as well
 
diff --git a/lisp/ob-plantuml.el b/lisp/ob-plantuml.el
index ebbcdf166..85dd34e62 100644
--- a/lisp/ob-plantuml.el
+++ b/lisp/ob-plantuml.el
@@ -109,8 +109,12 @@ If BODY does not contain @startXXX ... @endXXX clauses, @startuml
 (defun org-babel-execute:plantuml (body params)
   "Execute a block of plantuml code with org-babel.
 This function is called by `org-babel-execute-src-block'."
-  (let* ((out-file (or (cdr (assq :file params))
-		       (error "PlantUML requires a \":file\" header argument")))
+  (let* ((do-export (member "file"
+                            (split-string (cdr (assq :results params)))))
+         (out-file (if do-export
+                       (or (cdr (assq :file params))
+                           (error "No :file provided but :results set to file. For plain text output, set :results to verbatim"))
+		     (org-babel-temp-file "plantuml-" ".txt")))
 	 (cmdline (cdr (assq :cmdline params)))
 	 (in-file (org-babel-temp-file "plantuml-"))
 	 (java (or (cdr (assq :java params)) ""))
@@ -155,7 +159,10 @@ This function is called by `org-babel-execute-src-block'."
     (if (and (string= (file-name-extension out-file) "svg")
              org-babel-plantuml-svg-text-to-path)
         (org-babel-eval (format "inkscape %s -T -l %s" out-file out-file) ""))
-    nil)) ;; signal that output has already been written to file
+    (unless do-export (with-temp-buffer
+                        (insert-file-contents out-file)
+                        (buffer-substring-no-properties
+                         (point-min) (point-max))))))
 
 (defun org-babel-prep-session:plantuml (_session _params)
   "Return an error because plantuml does not support sessions."
-- 
2.37.0

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Ihor Radchenko]

Joseph Turner <joseph@breatheoutbreathe.in> writes:

> When :results header arg is set to a value that doesn't include
> "file", insert txt output in buffer below src block.

This looks reasonable. Thanks!

> -  (let* ((out-file (or (cdr (assq :file params))
> -		       (error "PlantUML requires a \":file\" header argument")))
> +  (let* ((do-export (member "file"
> +                            (split-string (cdr (assq :results params)))))

Let's take this opportunity and fix another omission in ob-plantuml.
:results may generally contain Elisp sexps to be evaluated and the whole
split-string busyness is not accurate. Please use :result-params list
instead of :results.

Also, can you please update the ob-plantuml documentation according to
the changes made. The current version is in
https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-plantuml.html

You will need to create a patch against
https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages/ob-doc-plantuml.org
repo.

Best,
Ihor

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Joseph Turner]

Ihor Radchenko <yantar92@gmail.com> writes:

> Let's take this opportunity and fix another omission in ob-plantuml.
> :results may generally contain Elisp sexps to be evaluated and the whole
> split-string busyness is not accurate. Please use :result-params list
> instead of :results.

Good catch! I will submit a v3 patch. Is this still a TINYCHANGE or
shall I do a copyright assignment?

> Also, can you please update the ob-plantuml documentation according to
> the changes made. The current version is in
> https://orgmode.org/worg/org-contrib/babel/languages/ob-doc-plantuml.html

Gladly.

Best,

Joseph

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Ihor Radchenko]

Joseph Turner <joseph@breatheoutbreathe.in> writes:

> Ihor Radchenko <yantar92@gmail.com> writes:
>
>> Let's take this opportunity and fix another omission in ob-plantuml.
>> :results may generally contain Elisp sexps to be evaluated and the whole
>> split-string busyness is not accurate. Please use :result-params list
>> instead of :results.
>
> Good catch! I will submit a v3 patch. Is this still a TINYCHANGE or
> shall I do a copyright assignment?

WORG does not have the copyright requirement.
As long as your contribution to Org core does not exceed 15LOC, you are
good to go with TINYCHANGE. Of course, having copyright assignment will
be good to have if you plan to submit more patches.


-- 
Ihor Radchenko,
Org mode contributor,
Learn more about Org mode at https://orgmode.org/.
Support Org development at https://liberapay.com/org-mode,
or support my work at https://liberapay.com/yantar92

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Ihor Radchenko]

Joseph Turner <joseph@breatheoutbreathe.in> writes:

> Ihor Radchenko <yantar92@gmail.com> writes:
>
>> Let's take this opportunity and fix another omission in ob-plantuml.
>> :results may generally contain Elisp sexps to be evaluated and the whole
>> split-string busyness is not accurate. Please use :result-params list
>> instead of :results.
>
> Good catch! I will submit a v3 patch.

Did you have a chance to work on the patch?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Ihor Radchenko]

Ihor Radchenko <yantar92@posteo.net> writes:

>> Good catch! I will submit a v3 patch.
>
> Did you have a chance to work on the patch?

Oops. I missed that you did and I even merged it. :facepalm:
Sorry for the noise.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: [PATCH v2] lisp/ob-plantuml.el: Insert results in buffer

[Joseph Turner]

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

No worries!!

Have a good day :)

On October 30, 2022 11:02:18 PM PDT, Ihor Radchenko <yantar92@posteo.net> wrote:
>Ihor Radchenko <yantar92@posteo.net> writes:
>
>>> Good catch! I will submit a v3 patch.
>>
>> Did you have a chance to work on the patch?
>
>Oops. I missed that you did and I even merged it. :facepalm:
>Sorry for the noise.
>
>-- 
>Ihor Radchenko // yantar92,
>Org mode contributor,
>Learn more about Org mode at <https://orgmode.org/>.
>Support Org development at <https://liberapay.com/org-mode>,
>or support my work at <https://liberapay.com/yantar92>

[-- Attachment #2: Type: text/html, Size: 1312 bytes --]