Merge branch 'maint'
[org-mode/org-tableheadings.git] / lisp / ob-ruby.el
blob6d5c682952ca420bd28b6085472e051c5967ce44
1 ;;; ob-ruby.el --- Babel Functions for Ruby -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2009-2016 Free Software Foundation, Inc.
5 ;; Author: Eric Schulte
6 ;; Keywords: literate programming, reproducible research
7 ;; Homepage: http://orgmode.org
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Commentary:
26 ;; Org-Babel support for evaluating ruby source code.
28 ;;; Requirements:
30 ;; - ruby and irb executables :: http://www.ruby-lang.org/
32 ;; - ruby-mode :: Can be installed through ELPA, or from
33 ;; http://github.com/eschulte/rinari/raw/master/util/ruby-mode.el
35 ;; - inf-ruby mode :: Can be installed through ELPA, or from
36 ;; http://github.com/eschulte/rinari/raw/master/util/inf-ruby.el
38 ;;; Code:
39 (require 'ob)
41 (declare-function org-trim "org" (s &optional keep-lead))
42 (declare-function run-ruby "ext:inf-ruby" (&optional command name))
43 (declare-function xmp "ext:rcodetools" (&optional option))
45 (defvar org-babel-tangle-lang-exts)
46 (add-to-list 'org-babel-tangle-lang-exts '("ruby" . "rb"))
48 (defvar org-babel-default-header-args:ruby '())
50 (defvar org-babel-ruby-command "ruby"
51 "Name of command to use for executing ruby code.")
53 (defcustom org-babel-ruby-hline-to "nil"
54 "Replace hlines in incoming tables with this when translating to ruby."
55 :group 'org-babel
56 :version "24.4"
57 :package-version '(Org . "8.0")
58 :type 'string)
60 (defcustom org-babel-ruby-nil-to 'hline
61 "Replace nil in ruby tables with this before returning."
62 :group 'org-babel
63 :version "24.4"
64 :package-version '(Org . "8.0")
65 :type 'symbol)
67 (defun org-babel-execute:ruby (body params)
68 "Execute a block of Ruby code with Babel.
69 This function is called by `org-babel-execute-src-block'."
70 (let* ((session (org-babel-ruby-initiate-session
71 (cdr (assoc :session params))))
72 (result-params (cdr (assoc :result-params params)))
73 (result-type (cdr (assoc :result-type params)))
74 (full-body (org-babel-expand-body:generic
75 body params (org-babel-variable-assignments:ruby params)))
76 (result (if (member "xmp" result-params)
77 (with-temp-buffer
78 (require 'rcodetools)
79 (insert full-body)
80 (xmp (cdr (assoc :xmp-option params)))
81 (buffer-string))
82 (org-babel-ruby-evaluate
83 session full-body result-type result-params))))
84 (org-babel-reassemble-table
85 (org-babel-result-cond result-params
86 result
87 (org-babel-ruby-table-or-string result))
88 (org-babel-pick-name (cdr (assoc :colname-names params))
89 (cdr (assoc :colnames params)))
90 (org-babel-pick-name (cdr (assoc :rowname-names params))
91 (cdr (assoc :rownames params))))))
93 (defun org-babel-prep-session:ruby (session params)
94 "Prepare SESSION according to the header arguments specified in PARAMS."
95 ;; (message "params=%S" params) ;; debugging
96 (let* ((session (org-babel-ruby-initiate-session session))
97 (var-lines (org-babel-variable-assignments:ruby params)))
98 (org-babel-comint-in-buffer session
99 (sit-for .5) (goto-char (point-max))
100 (mapc (lambda (var)
101 (insert var) (comint-send-input nil t)
102 (org-babel-comint-wait-for-output session)
103 (sit-for .1) (goto-char (point-max))) var-lines))
104 session))
106 (defun org-babel-load-session:ruby (session body params)
107 "Load BODY into SESSION."
108 (save-window-excursion
109 (let ((buffer (org-babel-prep-session:ruby session params)))
110 (with-current-buffer buffer
111 (goto-char (process-mark (get-buffer-process (current-buffer))))
112 (insert (org-babel-chomp body)))
113 buffer)))
115 ;; helper functions
117 (defun org-babel-variable-assignments:ruby (params)
118 "Return list of ruby statements assigning the block's variables."
119 (mapcar
120 (lambda (pair)
121 (format "%s=%s"
122 (car pair)
123 (org-babel-ruby-var-to-ruby (cdr pair))))
124 (org-babel--get-vars params)))
126 (defun org-babel-ruby-var-to-ruby (var)
127 "Convert VAR into a ruby variable.
128 Convert an elisp value into a string of ruby source code
129 specifying a variable of the same value."
130 (if (listp var)
131 (concat "[" (mapconcat #'org-babel-ruby-var-to-ruby var ", ") "]")
132 (if (equal var 'hline)
133 org-babel-ruby-hline-to
134 (format "%S" var))))
136 (defun org-babel-ruby-table-or-string (results)
137 "Convert RESULTS into an appropriate elisp value.
138 If RESULTS look like a table, then convert them into an
139 Emacs-lisp table, otherwise return the results as a string."
140 (let ((res (org-babel-script-escape results)))
141 (if (listp res)
142 (mapcar (lambda (el) (if (equal el 'nil)
143 org-babel-ruby-nil-to el))
144 res)
145 res)))
147 (defun org-babel-ruby-initiate-session (&optional session _params)
148 "Initiate a ruby session.
149 If there is not a current inferior-process-buffer in SESSION
150 then create one. Return the initialized session."
151 (unless (string= session "none")
152 (require 'inf-ruby)
153 (let ((session-buffer (save-window-excursion
154 (run-ruby nil session) (current-buffer))))
155 (if (org-babel-comint-buffer-livep session-buffer)
156 (progn (sit-for .25) session-buffer)
157 (sit-for .5)
158 (org-babel-ruby-initiate-session session)))))
160 (defvar org-babel-ruby-eoe-indicator ":org_babel_ruby_eoe"
161 "String to indicate that evaluation has completed.")
162 (defvar org-babel-ruby-f-write
163 "File.open('%s','w'){|f| f.write((_.class == String) ? _ : _.inspect)}")
164 (defvar org-babel-ruby-pp-f-write
165 "File.open('%s','w'){|f| $stdout = f; pp(results); $stdout = orig_out}")
166 (defvar org-babel-ruby-wrapper-method
168 def main()
171 results = main()
172 File.open('%s', 'w'){ |f| f.write((results.class == String) ? results : results.inspect) }
174 (defvar org-babel-ruby-pp-wrapper-method
176 require 'pp'
177 def main()
180 results = main()
181 File.open('%s', 'w') do |f|
182 $stdout = f
183 pp results
187 (defun org-babel-ruby-evaluate
188 (buffer body &optional result-type result-params)
189 "Pass BODY to the Ruby process in BUFFER.
190 If RESULT-TYPE equals `output' then return a list of the outputs
191 of the statements in BODY, if RESULT-TYPE equals `value' then
192 return the value of the last statement in BODY, as elisp."
193 (if (not buffer)
194 ;; external process evaluation
195 (pcase result-type
196 (`output (org-babel-eval org-babel-ruby-command body))
197 (`value (let ((tmp-file (org-babel-temp-file "ruby-")))
198 (org-babel-eval
199 org-babel-ruby-command
200 (format (if (member "pp" result-params)
201 org-babel-ruby-pp-wrapper-method
202 org-babel-ruby-wrapper-method)
203 body (org-babel-process-file-name tmp-file 'noquote)))
204 (org-babel-eval-read-file tmp-file))))
205 ;; comint session evaluation
206 (pcase result-type
207 (`output
208 (let ((eoe-string (format "puts \"%s\"" org-babel-ruby-eoe-indicator)))
209 ;; Force the session to be ready before the actual session
210 ;; code is run. There is some problem in comint that will
211 ;; sometimes show the prompt after the the input has already
212 ;; been inserted and that throws off the extraction of the
213 ;; result for Babel.
214 (org-babel-comint-with-output
215 (buffer org-babel-ruby-eoe-indicator t eoe-string)
216 (insert eoe-string) (comint-send-input nil t))
217 ;; Now we can start the evaluation.
218 (mapconcat
219 #'identity
220 (butlast
221 (split-string
222 (mapconcat
223 #'org-trim
224 (org-babel-comint-with-output
225 (buffer org-babel-ruby-eoe-indicator t body)
226 (mapc
227 (lambda (line)
228 (insert (org-babel-chomp line)) (comint-send-input nil t))
229 (list "conf.echo=false;_org_prompt_mode=conf.prompt_mode;conf.prompt_mode=:NULL"
230 body
231 "conf.prompt_mode=_org_prompt_mode;conf.echo=true"
232 eoe-string)))
233 "\n") "[\r\n]") 4) "\n")))
234 (`value
235 (let* ((tmp-file (org-babel-temp-file "ruby-"))
236 (ppp (or (member "code" result-params)
237 (member "pp" result-params))))
238 (org-babel-comint-with-output
239 (buffer org-babel-ruby-eoe-indicator t body)
240 (when ppp (insert "require 'pp';") (comint-send-input nil t))
241 (mapc
242 (lambda (line)
243 (insert (org-babel-chomp line)) (comint-send-input nil t))
244 (append
245 (list body)
246 (if (not ppp)
247 (list (format org-babel-ruby-f-write
248 (org-babel-process-file-name tmp-file 'noquote)))
249 (list
250 "results=_" "require 'pp'" "orig_out = $stdout"
251 (format org-babel-ruby-pp-f-write
252 (org-babel-process-file-name tmp-file 'noquote))))
253 (list org-babel-ruby-eoe-indicator)))
254 (comint-send-input nil t))
255 (org-babel-eval-read-file tmp-file))))))
257 (defun org-babel-ruby-read-string (string)
258 "Strip \\\"s from around a ruby string."
259 (if (string-match "^\"\\([^\000]+\\)\"$" string)
260 (match-string 1 string)
261 string))
263 (provide 'ob-ruby)
267 ;;; ob-ruby.el ends here