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: [PATCH] migrate ob-clojure initiate session code from ob-clojure-literate.el into ob-clojure.el
Date: Tue, 23 Oct 2018 20:02:58 +0800	[thread overview]
Message-ID: <877ei8uaz1.fsf@gmail.com> (raw)
In-Reply-To: <87o9iegsn7.fsf@nicolasgoaziou.fr>

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


Nicolas Goaziou <mail@nicolasgoaziou.fr> writes:

Hi, sorry for late response, because I'm a little lazy on give effort on
review my patch and improve it again. But now I finished it. Actually I
corrected my patch as soon as you replied email with mentioned. Today I
pick up this task again, and add a new improve which support CIDER new
API which using sesman to manage REPL sessions.

>
> Would it make sense to add a few tests for this?
>
> Regards,

It is hard for me to write tests for CIDER session. It has some kind of interactive and don't know how to verify it.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: support initialize clojure session --]
[-- Type: text/x-patch, Size: 9031 bytes --]

From f495c5b4e65fd8c6a64e8619d974d6eb051fb1f7 Mon Sep 17 00:00:00 2001
From: stardiviner <numbchild@gmail.com>
Date: Thu, 19 Apr 2018 18:16:27 +0800
Subject: [PATCH 1/2] ob-clojure.el: Support `org-babel-initiate-session' to
 initialize.

* ob-clojure.el (org-babel-clojure-initiate-session): Initialize session
for src block.
(org-babel-prep-session:clojure): Prepare Clojure session.
(org-babel-clojure-var-to-clojure): Convert header argument :var into
clojure variables definitions.
(org-babel-variable-assignments:clojure): Support assign variables when
initialize session.
---
 contrib/lisp/ob-clojure-literate.el | 56 ---------------------
 lisp/ob-clojure.el                  | 55 +++++++++++++++++++++
 testing/lisp/test-ob-clojure.el     | 77 +++++++++++++++++++++++++++++
 3 files changed, 132 insertions(+), 56 deletions(-)
 create mode 100644 testing/lisp/test-ob-clojure.el

diff --git a/contrib/lisp/ob-clojure-literate.el b/contrib/lisp/ob-clojure-literate.el
index 4c4d38a0f..b1cc386ee 100644
--- a/contrib/lisp/ob-clojure-literate.el
+++ b/contrib/lisp/ob-clojure-literate.el
@@ -184,62 +184,6 @@ If it is a directory, `ob-clojure-literate' will try to create Clojure project a
                  (lambda (cons) (if (eq (car cons) :session) t cons))
                  org-babel-default-header-args:clojure)))))
 
-;;; Support `org-babel-initiate-session' / [C-c C-v z] to initialize Clojure session.
-
-(defun org-babel-clojure-initiate-session (&optional session _params)
-  "Initiate a session named SESSION according to PARAMS."
-  (when (and session (not (string= session "none")))
-    (save-window-excursion
-      (unless (org-babel-comint-buffer-livep session)
-        ;; CIDER jack-in to the Clojure project directory.
-        (cond
-         ((eq org-babel-clojure-backend 'cider)
-          (require 'cider)
-          (let ((session-buffer (save-window-excursion
-                                  (cider-jack-in t)
-                                  (current-buffer))))
-            (if (org-babel-comint-buffer-livep session-buffer)
-                (progn (sit-for .25) session-buffer))))
-         ((eq org-babel-clojure-backend 'slime)
-          (error "Session evaluation with SLIME is not supported"))
-         (t
-          (error "Session initiate failed")))
-        )
-      (get-buffer session)
-      )))
-
-(defun org-babel-prep-session:clojure (session params)
-  "Prepare SESSION according to the header arguments specified in PARAMS."
-  (let* ((session (org-babel-clojure-initiate-session session))
-         (var-lines (org-babel-variable-assignments:clojure params)))
-    (when session
-      (org-babel-comint-in-buffer session
-        (mapc (lambda (var)
-                (insert var) (comint-send-input nil t)
-		(org-babel-comint-wait-for-output session)
-		(sit-for .1) (goto-char (point-max))) var-lines)))
-    session))
-
-(defun org-babel-clojure-var-to-clojure (var)
-  "Convert src block's `VAR' to Clojure variable."
-  (if (listp var)
-      (replace-regexp-in-string "(" "'(" var)
-    (cond
-     ((stringp var)
-      ;; wrap org-babel passed in header argument value with quote in Clojure.
-      (format "\"%s\"" var))
-     (t
-      (format "%s" var))))
-  )
-
-(defun org-babel-variable-assignments:clojure (params)
-  "Return a list of Clojure statements assigning the block's variables in `PARAMS'."
-  (mapcar
-   (lambda (pair)
-     (format "(def %s %s)"
-             (car pair)
-             (org-babel-clojure-var-to-clojure (cdr pair))))
-   (org-babel--get-vars params)))
 
 ;;; Support header arguments  :results graphics :file "image.png" by inject Clojure code.
 (defun ob-clojure-literate-inject-code (args)
diff --git a/lisp/ob-clojure.el b/lisp/ob-clojure.el
index d5b918b01..048ba3735 100644
--- a/lisp/ob-clojure.el
+++ b/lisp/ob-clojure.el
@@ -43,6 +43,7 @@
 (require 'ob)
 (require 'org-macs)
 
+(declare-function cider-jack-in "ext:cider" (&optional prompt-project cljs-too))
 (declare-function cider-current-connection "ext:cider-client" (&optional type))
 (declare-function cider-current-ns "ext:cider-client" ())
 (declare-function nrepl--merge "ext:nrepl-client" (dict1 dict2))
@@ -211,6 +212,60 @@ using the :show-process parameter."
       (condition-case nil (org-babel-script-escape result)
 	(error result)))))
 
+(defun org-babel-clojure-initiate-session (&optional session _params)
+  "Initiate a session named SESSION according to PARAMS."
+  (when (and session (not (string= session "none")))
+    (save-window-excursion
+      (cond
+       ((org-babel-comint-buffer-livep session) nil)
+       ;; CIDER jack-in to the Clojure project directory.
+       ((eq org-babel-clojure-backend 'cider)
+        (require 'cider)
+        (let ((session-buffer (save-window-excursion
+                                (cider-jack-in t)
+                                (current-buffer))))
+          (if (org-babel-comint-buffer-livep session-buffer)
+              (progn (sit-for .25) session-buffer))))
+       ((eq org-babel-clojure-backend 'slime)
+        (error "Session evaluation with SLIME is not supported"))
+       (t
+        (error "Session initiate failed")))
+      (get-buffer session))))
+
+(defun org-babel-prep-session:clojure (session params)
+  "Prepare SESSION according to the header arguments specified in PARAMS."
+  (let ((session (org-babel-clojure-initiate-session session))
+        (var-lines (org-babel-variable-assignments:clojure params)))
+    (when session
+      (org-babel-comint-in-buffer session
+	(dolist (var var-lines)
+	  (insert var)
+	  (comint-send-input nil t)
+	  (org-babel-comint-wait-for-output session)
+	  (sit-for .1)
+	  (goto-char (point-max)))))
+    session))
+
+(defun org-babel-clojure-var-to-clojure (var)
+  "Convert src block's VAR to Clojure variable."
+  (cond
+   ((listp var)
+    (replace-regexp-in-string "(" "'(" var))
+   ((stringp var)
+    ;; Wrap Babel passed-in header argument value with quotes in Clojure.
+    (format "\"%s\"" var))
+   (t
+    (format "%S" var))))
+
+(defun org-babel-variable-assignments:clojure (params)
+  "Return a list of Clojure statements assigning the block's variables in PARAMS."
+  (mapcar
+   (lambda (pair)
+     (format "(def %s %s)"
+             (car pair)
+             (org-babel-clojure-var-to-clojure (cdr pair))))
+   (org-babel--get-vars params)))
+
 (provide 'ob-clojure)
 
 ;;; ob-clojure.el ends here
diff --git a/testing/lisp/test-ob-clojure.el b/testing/lisp/test-ob-clojure.el
new file mode 100644
index 000000000..f917ca4cc
--- /dev/null
+++ b/testing/lisp/test-ob-clojure.el
@@ -0,0 +1,77 @@
+;;; test-ob-clojure.el
+
+;; Copyright (c) 2018-2022 Free Software Foundation, Inc.
+;; Authors: stardiviner
+
+;; This file is not part of GNU Emacs.
+
+;; 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 <http://www.gnu.org/licenses/>.
+
+;;; Comments:
+
+;; Org tests for ob-clojure.el live here
+
+;;; Code:
+(org-test-for-executable "cider")
+(unless (featurep 'cider)
+  (signal 'missing-test-dependency "CIDER"))
+(unless (featurep 'ob-clojure)
+  (signal 'missing-test-dependency "Support for Clojure code blocks"))
+
+(ert-deftest ob-clojure/simple-session ()
+  (org-test-with-temp-text
+      "#+begin_src clojure :session
+(print \"hello, world\")
+#+end_src
+"
+    (should (string= "hello, world" (org-babel-execute-src-block)))))
+
+(ert-deftest ob-clojure/initiate-session ()
+  (org-test-with-temp-text
+      "#+begin_src clojure :session :var a=1 :results output
+(print \"hello, world\")
+#+end_src
+
+#+begin_src clojure :session :results output
+(print a)
+#+end_src"
+    (goto-char (point-min))
+    (org-babel-switch-to-session)
+    (sleep-for 2)
+    (org-babel-execute-maybe)
+    (org-babel-next-src-block)
+    (goto-char (org-babel-result-end))
+    (forward-line 2)
+    (should (string=
+	     ": 1"
+	     (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
+
+(ert-deftest ob-clojure/initiate-session-with-var ()
+  (org-test-with-temp-text
+      "#+begin_src clojure :session :var a=1 :results output
+(print a)
+#+end_src"
+    (org-babel-next-src-block)
+    (org-babel-initiate-session)
+    (sleep-for 2)
+    (org-babel-execute-maybe)
+    (goto-char (org-babel-result-end))
+    (forward-line 2)
+    (should (string=
+	     ": 1"
+	     (buffer-substring-no-properties (point-at-bol) (point-at-eol))))))
+
+(provide 'test-ob-clojure)
+
+ ;;; test-ob-clojure.el ends here
-- 
2.19.1


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: support new CIDER API with sesman to manage REPL sessions --]
[-- Type: text/x-patch, Size: 1361 bytes --]

From 18810dbf156172598f94795e801191ba2ca51f7a Mon Sep 17 00:00:00 2001
From: stardiviner <numbchild@gmail.com>
Date: Tue, 23 Oct 2018 19:23:45 +0800
Subject: [PATCH 2/2] ob-clojure.el: Support new CIDER using sesman to manage
 sessions.

* ob-clojure.el (org-babel-clojure-initiate-session): improve ob-clojure
  initialize session way to support CIDER new API.
---
 lisp/ob-clojure.el | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/lisp/ob-clojure.el b/lisp/ob-clojure.el
index 048ba3735..b0a38cb0f 100644
--- a/lisp/ob-clojure.el
+++ b/lisp/ob-clojure.el
@@ -222,7 +222,13 @@ using the :show-process parameter."
        ((eq org-babel-clojure-backend 'cider)
         (require 'cider)
         (let ((session-buffer (save-window-excursion
-                                (cider-jack-in t)
+				(if (version< cider-version "0.18.0")
+				    ;; older CIDER (without sesman) still need to use old way.
+				    (cider-jack-in nil) ; nil for jack-in without project.
+				  ;; new CIDER (with sesman to manage sessions)
+				  (unless (cider-repls)
+				    (let ((sesman-system 'CIDER))
+				      (call-interactively 'sesman-link-with-directory))))
                                 (current-buffer))))
           (if (org-babel-comint-buffer-livep session-buffer)
               (progn (sit-for .25) session-buffer))))
-- 
2.19.1


[-- Attachment #4: Type: text/plain, Size: 373 bytes --]


As always, thank you for maintaining Org Mode and reviewing my patches and patient of my stupidity. Point out any issue if you found. Thanks again.

--
[ stardiviner ]
       I try to make every word tell the meaning what I want to express.
       Blog: https://stardiviner.github.io/
       IRC(freenode): stardiviner
       GPG: F09F650D7D674819892591401B5DF1C95AE89AC3

  reply	other threads:[~2018-10-23 12:03 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-19 10:22 [PATCH] migrate ob-clojure initiate session code from ob-clojure-literate.el into ob-clojure.el stardiviner
2018-04-20  8:59 ` Nicolas Goaziou
2018-10-23 12:02   ` stardiviner [this message]
2018-10-24 11:41     ` Nicolas Goaziou
2018-10-25  5:51       ` stardiviner
2018-10-25  8:37         ` Nicolas Goaziou
2018-10-25 23:38           ` 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=877ei8uaz1.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).