ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Anoop GR]

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

Comments in org babel clojure blocks are not tangled out.

Let us take an example org file with the following contents:-

This org file contains only two source blocks and a total of ten lines.
> #+begin_src clojure :noweb-ref "Define a constant"
>
(def e 2.72)

;;This is a comment on a line of its own
> (def pi 3.14) ;;This is a comment not on a line of its own
> #+end_src

The following block will be tangled
> #+begin_src clojure :noweb yes :tangle ./output.clj
> <<Define a constant>>
> #+end_src


When I tangle the above file, the contents of the output.clj file are:-

> (def e 2.72)


> (def pi 3.14) ;;This is a comment not on a line of its own


*The comment that was on a line of its own is missing from the tangled
output.*

Was able to reproduce on both emacs 29.3.50 and 29.4 on Ubuntu 22.04 LTS
Both were started using *emacs -Q* and then evaluating *(require
'ob-clojure)* as the only line of config.

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

Re: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Anoop GR]

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

The contents of the org file were
---
This file contains only two source blocks
#+begin_src clojure :noweb-ref "Define a constant"
(def e 2.72)
;;This is a comment on a line of its own
(def pi 3.14) ;;This is a comment not on a line of its own
#+end_src

The following block will be tangled
#+begin_src clojure :noweb yes :tangle output.clj
<<Define a constant>>
#+end_src
---

On Tue, Oct 15, 2024 at 11:13 PM Anoop GR <anoopemacs@gmail.com> wrote:

> Comments in org babel clojure blocks are not tangled out.
>
> Let us take an example org file with the following contents:-
>
> This org file contains only two source blocks and a total of ten lines.
>> #+begin_src clojure :noweb-ref "Define a constant"
>>
> (def e 2.72)
>
> ;;This is a comment on a line of its own
>> (def pi 3.14) ;;This is a comment not on a line of its own
>> #+end_src
>
> The following block will be tangled
>> #+begin_src clojure :noweb yes :tangle ./output.clj
>> <<Define a constant>>
>> #+end_src
>
>
> When I tangle the above file, the contents of the output.clj file are:-
>
>> (def e 2.72)
>
>
>> (def pi 3.14) ;;This is a comment not on a line of its own
>
>
> *The comment that was on a line of its own is missing from the tangled
> output.*
>
> Was able to reproduce on both emacs 29.3.50 and 29.4 on Ubuntu 22.04 LTS
> Both were started using *emacs -Q* and then evaluating *(require
> 'ob-clojure)* as the only line of config.
>

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

Re: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Anoop GR]

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

The contents of the tangled output.clj file were:-
---
(def e 2.72)

(def pi 3.14) ;;This is a comment not on a line of its own
---

On Tue, Oct 15, 2024 at 11:21 PM Anoop GR <anoopemacs@gmail.com> wrote:

> The contents of the org file were
> ---
> This file contains only two source blocks
> #+begin_src clojure :noweb-ref "Define a constant"
> (def e 2.72)
> ;;This is a comment on a line of its own
> (def pi 3.14) ;;This is a comment not on a line of its own
> #+end_src
>
> The following block will be tangled
> #+begin_src clojure :noweb yes :tangle output.clj
> <<Define a constant>>
> #+end_src
> ---
>
> On Tue, Oct 15, 2024 at 11:13 PM Anoop GR <anoopemacs@gmail.com> wrote:
>
>> Comments in org babel clojure blocks are not tangled out.
>>
>> Let us take an example org file with the following contents:-
>>
>> This org file contains only two source blocks and a total of ten lines.
>>> #+begin_src clojure :noweb-ref "Define a constant"
>>>
>> (def e 2.72)
>>
>> ;;This is a comment on a line of its own
>>> (def pi 3.14) ;;This is a comment not on a line of its own
>>> #+end_src
>>
>> The following block will be tangled
>>> #+begin_src clojure :noweb yes :tangle ./output.clj
>>> <<Define a constant>>
>>> #+end_src
>>
>>
>> When I tangle the above file, the contents of the output.clj file are:-
>>
>>> (def e 2.72)
>>
>>
>>> (def pi 3.14) ;;This is a comment not on a line of its own
>>
>>
>> *The comment that was on a line of its own is missing from the tangled
>> output.*
>>
>> Was able to reproduce on both emacs 29.3.50 and 29.4 on Ubuntu 22.04 LTS
>> Both were started using *emacs -Q* and then evaluating *(require
>> 'ob-clojure)* as the only line of config.
>>
>

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

Re: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Anoop GR]

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

We are missing the comment that was expected in the second line of the
output.
In its place, there is an empty newline.

On Tue, Oct 15, 2024 at 11:22 PM Anoop GR <anoopemacs@gmail.com> wrote:

> The contents of the tangled output.clj file were:-
> ---
> (def e 2.72)
>
> (def pi 3.14) ;;This is a comment not on a line of its own
> ---
>
> On Tue, Oct 15, 2024 at 11:21 PM Anoop GR <anoopemacs@gmail.com> wrote:
>
>> The contents of the org file were
>> ---
>> This file contains only two source blocks
>> #+begin_src clojure :noweb-ref "Define a constant"
>> (def e 2.72)
>> ;;This is a comment on a line of its own
>> (def pi 3.14) ;;This is a comment not on a line of its own
>> #+end_src
>>
>> The following block will be tangled
>> #+begin_src clojure :noweb yes :tangle output.clj
>> <<Define a constant>>
>> #+end_src
>> ---
>>
>> On Tue, Oct 15, 2024 at 11:13 PM Anoop GR <anoopemacs@gmail.com> wrote:
>>
>>> Comments in org babel clojure blocks are not tangled out.
>>>
>>> Let us take an example org file with the following contents:-
>>>
>>> This org file contains only two source blocks and a total of ten lines.
>>>> #+begin_src clojure :noweb-ref "Define a constant"
>>>>
>>> (def e 2.72)
>>>
>>> ;;This is a comment on a line of its own
>>>> (def pi 3.14) ;;This is a comment not on a line of its own
>>>> #+end_src
>>>
>>> The following block will be tangled
>>>> #+begin_src clojure :noweb yes :tangle ./output.clj
>>>> <<Define a constant>>
>>>> #+end_src
>>>
>>>
>>> When I tangle the above file, the contents of the output.clj file are:-
>>>
>>>> (def e 2.72)
>>>
>>>
>>>> (def pi 3.14) ;;This is a comment not on a line of its own
>>>
>>>
>>> *The comment that was on a line of its own is missing from the tangled
>>> output.*
>>>
>>> Was able to reproduce on both emacs 29.3.50 and 29.4 on Ubuntu 22.04 LTS
>>> Both were started using *emacs -Q* and then evaluating *(require
>>> 'ob-clojure)* as the only line of config.
>>>
>>

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

Re: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Ihor Radchenko]

Anoop GR <anoopemacs@gmail.com> writes:

> Comments in org babel clojure blocks are not tangled out.
> ...

This seems to be intentional (commit b1f564b4b6):

In ob-clojure.el, we have:

	 ;; Remove comments, they break (let [...] ...) bindings
	 (body (replace-regexp-in-string "^[ 	]*;+.*$" "" body))

It seems that there is some weirdness in Clojure interaction with
comments inside let [...] clauses.

I am not familiar enough with closure to comment on this. Maybe you know
more?

CCing Bastien, the author of the commit.

I guess that we may leave the comments intact if the code block does not
have :var.

-- 
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: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Anoop GR]

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

>
> I guess that we may leave the comments intact if the code block does not
> have :var.
>

I moved the comment stripping code in org-babel-expand-body:clojure to
follow the above idea:-
---
(defun org-babel-expand-body:clojure (body params)
  "Expand BODY according to PARAMS, return the expanded body."
  (let* ((vars (org-babel--get-vars params))
         (backend-override (cdr (assq :backend params)))
         (org-babel-clojure-backend
          (cond
           (backend-override (intern backend-override))
           (org-babel-clojure-backend org-babel-clojure-backend)
           (t (user-error "You need to customize `org-babel-clojure-backend'
or set the `:backend' header argument"))))
         (ns (or (cdr (assq :ns params))
                 (if (eq org-babel-clojure-backend 'cider)
                     (or cider-buffer-ns
                         (let ((repl-buf (cider-current-connection)))
                           (and repl-buf (buffer-local-value
                                          'cider-buffer-ns repl-buf))))
                   org-babel-clojure-default-ns)))
         (result-params (cdr (assq :result-params params)))
         (print-level nil)
         (print-length nil)
         (body (org-trim
                (concat
                 ;; Source block specified namespace :ns.
                 (and (cdr (assq :ns params)) (format "(ns %s)\n" ns))
                 ;; Variables binding.
                 (if (null vars)
                     (org-trim body)
                   (let ((body (replace-regexp-in-string "^[    ]*;+.*$" ""
body)))   ; Remove comments, they break (let [...] ...) bindings
                     (format "(let [%s]\n%s)"
                             (mapconcat
                              (lambda (var)
                                (format "%S '%S" (car var) (cdr var)))
                              vars
                              "\n      ")
                             body)))))))
    (if (or (member "code" result-params)
            (member "pp" result-params))
        (format "(clojure.pprint/pprint (do %s))" body)
      body)))
---

Now, it no longer loses comments on tangling.

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

Re: ob-clojure breaks tangling of comments using org-babel-tangle for clojure source code blocks

[Ihor Radchenko]

Anoop GR <anoopemacs@gmail.com> writes:

>>
>> I guess that we may leave the comments intact if the code block does not
>> have :var.
>>
>
> I moved the comment stripping code in org-babel-expand-body:clojure to
> follow the above idea:-
> ...

The code look reasonable.
Would you be interested to convert it into a patch?
See https://orgmode.org/worg/org-contribute.html

-- 
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>