2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-ruby.el --- org-babel functions for ruby evaluation
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; Copyright (C) 2009, 2010 Free Software Foundation
|
2009-06-11 18:15:59 -04:00
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; Version: 0.01
|
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; This file is part of GNU Emacs.
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2010-06-25 12:32:35 -04:00
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2009-06-11 18:15:59 -04:00
|
|
|
;; it under the terms of the GNU General Public License as published by
|
2010-06-25 12:32:35 -04:00
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2009-06-11 18:15:59 -04:00
|
|
|
;; 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.
|
2010-06-25 12:32:35 -04:00
|
|
|
|
2009-06-11 18:15:59 -04:00
|
|
|
;; You should have received a copy of the GNU General Public License
|
2010-06-25 12:32:35 -04:00
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2009-06-11 18:15:59 -04:00
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating ruby source code.
|
|
|
|
|
2009-08-16 12:48:08 -04:00
|
|
|
;;; Requirements:
|
|
|
|
|
|
|
|
;; - ruby and irb executables :: http://www.ruby-lang.org/
|
|
|
|
;;
|
|
|
|
;; - ruby-mode :: Can be installed through ELPA, or from
|
|
|
|
;; http://github.com/eschulte/rinari/raw/master/util/ruby-mode.el
|
|
|
|
;;
|
|
|
|
;; - inf-ruby mode :: Can be installed through ELPA, or from
|
|
|
|
;; http://github.com/eschulte/rinari/raw/master/util/inf-ruby.el
|
|
|
|
|
2009-06-11 18:15:59 -04:00
|
|
|
;;; Code:
|
2010-06-11 19:02:42 -04:00
|
|
|
(require 'ob)
|
2010-07-02 22:21:31 -04:00
|
|
|
(require 'ob-ref)
|
|
|
|
(require 'ob-comint)
|
2010-07-04 17:46:13 -04:00
|
|
|
(require 'ob-eval)
|
|
|
|
(eval-when-compile (require 'cl))
|
2010-07-02 22:21:31 -04:00
|
|
|
|
2010-07-04 11:24:08 -04:00
|
|
|
(declare-function run-ruby "ext:inf-ruby" (&optional command name))
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2010-06-17 13:21:14 -04:00
|
|
|
(add-to-list 'org-babel-tangle-lang-exts '("ruby" . "rb"))
|
|
|
|
|
2010-06-25 13:12:54 -04:00
|
|
|
(defvar org-babel-default-header-args:ruby '())
|
|
|
|
|
2010-07-04 14:31:14 -04:00
|
|
|
(defvar org-babel-ruby-command "ruby"
|
|
|
|
"Name of command to use for executing ruby code.")
|
|
|
|
|
2010-04-16 01:15:47 -04:00
|
|
|
(defun org-babel-expand-body:ruby (body params &optional processed-params)
|
2010-06-11 20:12:15 -04:00
|
|
|
"Expand BODY according to PARAMS, return the expanded body."
|
2010-07-02 22:21:31 -04:00
|
|
|
(require 'inf-ruby)
|
2010-06-25 13:26:48 -04:00
|
|
|
(let ((vars (nth 1 (or processed-params (org-babel-process-params params)))))
|
2010-04-16 01:15:47 -04:00
|
|
|
(concat
|
|
|
|
(mapconcat ;; define any variables
|
|
|
|
(lambda (pair)
|
|
|
|
(format "%s=%s"
|
|
|
|
(car pair)
|
|
|
|
(org-babel-ruby-var-to-ruby (cdr pair))))
|
|
|
|
vars "\n") "\n" body "\n")))
|
|
|
|
|
2009-07-08 00:13:07 -04:00
|
|
|
(defun org-babel-execute:ruby (body params)
|
2009-06-11 18:15:59 -04:00
|
|
|
"Execute a block of Ruby code with org-babel. This function is
|
2009-11-10 15:42:05 -05:00
|
|
|
called by `org-babel-execute-src-block'."
|
2009-06-11 18:15:59 -04:00
|
|
|
(message "executing Ruby source code block")
|
2009-11-10 17:22:25 -05:00
|
|
|
(let* ((processed-params (org-babel-process-params params))
|
|
|
|
(session (org-babel-ruby-initiate-session (first processed-params)))
|
2010-06-25 13:26:48 -04:00
|
|
|
(result-params (nth 2 processed-params))
|
|
|
|
(result-type (nth 3 processed-params))
|
2010-04-16 01:15:47 -04:00
|
|
|
(full-body (org-babel-expand-body:ruby
|
2010-06-07 15:13:37 -04:00
|
|
|
body params processed-params))
|
2010-07-02 22:21:31 -04:00
|
|
|
(result (org-babel-ruby-evaluate
|
|
|
|
session full-body result-type result-params)))
|
2010-04-18 21:06:34 -04:00
|
|
|
(or (cdr (assoc :file params))
|
|
|
|
(org-babel-reassemble-table
|
2010-04-20 01:33:47 -04:00
|
|
|
result
|
2010-06-07 15:13:37 -04:00
|
|
|
(org-babel-pick-name (nth 4 processed-params)
|
|
|
|
(cdr (assoc :colnames params)))
|
|
|
|
(org-babel-pick-name (nth 5 processed-params)
|
|
|
|
(cdr (assoc :rownames params)))))))
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2009-06-14 14:08:12 -04:00
|
|
|
(defun org-babel-prep-session:ruby (session params)
|
|
|
|
"Prepare SESSION according to the header arguments specified in PARAMS."
|
2009-06-14 14:44:29 -04:00
|
|
|
;; (message "params=%S" params) ;; debugging
|
2009-06-14 14:08:12 -04:00
|
|
|
(let* ((session (org-babel-ruby-initiate-session session))
|
|
|
|
(vars (org-babel-ref-variables params))
|
|
|
|
(var-lines (mapcar ;; define any variables
|
|
|
|
(lambda (pair)
|
|
|
|
(format "%s=%s"
|
|
|
|
(car pair)
|
|
|
|
(org-babel-ruby-var-to-ruby (cdr pair))))
|
|
|
|
vars)))
|
|
|
|
(org-babel-comint-in-buffer session
|
2009-06-14 14:44:29 -04:00
|
|
|
(sit-for .5) (goto-char (point-max))
|
2009-06-14 14:08:12 -04:00
|
|
|
(mapc (lambda (var)
|
|
|
|
(insert var) (comint-send-input nil t)
|
2009-06-14 14:44:29 -04:00
|
|
|
(org-babel-comint-wait-for-output session)
|
2010-01-11 12:14:30 -05:00
|
|
|
(sit-for .1) (goto-char (point-max))) var-lines))
|
|
|
|
session))
|
|
|
|
|
|
|
|
(defun org-babel-load-session:ruby (session body params)
|
|
|
|
"Load BODY into SESSION."
|
|
|
|
(save-window-excursion
|
|
|
|
(let ((buffer (org-babel-prep-session:ruby session params)))
|
|
|
|
(with-current-buffer buffer
|
|
|
|
(goto-char (process-mark (get-buffer-process (current-buffer))))
|
|
|
|
(insert (org-babel-chomp body)))
|
|
|
|
buffer)))
|
2009-06-14 14:08:12 -04:00
|
|
|
|
|
|
|
;; helper functions
|
|
|
|
|
2009-06-11 18:15:59 -04:00
|
|
|
(defun org-babel-ruby-var-to-ruby (var)
|
2009-06-12 12:24:03 -04:00
|
|
|
"Convert an elisp var into a string of ruby source code
|
|
|
|
specifying a var of the same value."
|
2009-06-11 18:15:59 -04:00
|
|
|
(if (listp var)
|
|
|
|
(concat "[" (mapconcat #'org-babel-ruby-var-to-ruby var ", ") "]")
|
|
|
|
(format "%S" var)))
|
|
|
|
|
2009-07-05 19:59:24 -04:00
|
|
|
(defun org-babel-ruby-table-or-string (results)
|
2010-06-11 20:12:15 -04:00
|
|
|
"If RESULTS look like a table, then convert them into an
|
2009-06-11 18:15:59 -04:00
|
|
|
Emacs-lisp table, otherwise return the results as a string."
|
|
|
|
(org-babel-read
|
2009-06-14 11:41:52 -04:00
|
|
|
(if (and (stringp results) (string-match "^\\[.+\\]$" results))
|
2009-06-11 18:15:59 -04:00
|
|
|
(org-babel-read
|
2010-04-10 17:14:27 -04:00
|
|
|
(concat "'"
|
|
|
|
(replace-regexp-in-string
|
|
|
|
"\\[" "(" (replace-regexp-in-string
|
|
|
|
"\\]" ")" (replace-regexp-in-string
|
|
|
|
", " " " (replace-regexp-in-string
|
2010-07-04 14:31:14 -04:00
|
|
|
"'" "\"" results))))))
|
2009-06-11 18:15:59 -04:00
|
|
|
results)))
|
|
|
|
|
2010-03-13 12:59:41 -05:00
|
|
|
(defun org-babel-ruby-initiate-session (&optional session params)
|
2009-06-11 18:15:59 -04:00
|
|
|
"If there is not a current inferior-process-buffer in SESSION
|
2010-06-11 20:12:15 -04:00
|
|
|
then create one. Return the initialized session."
|
2010-07-02 22:21:31 -04:00
|
|
|
(require 'inf-ruby)
|
2009-06-15 12:28:01 -04:00
|
|
|
(unless (string= session "none")
|
2010-06-07 15:08:43 -04:00
|
|
|
(let ((session-buffer (save-window-excursion
|
|
|
|
(run-ruby nil session) (current-buffer))))
|
2009-06-15 12:28:01 -04:00
|
|
|
(if (org-babel-comint-buffer-livep session-buffer)
|
2010-06-07 15:08:43 -04:00
|
|
|
(progn (sit-for .25) session-buffer)
|
2009-06-15 12:28:01 -04:00
|
|
|
(sit-for .5)
|
|
|
|
(org-babel-ruby-initiate-session session)))))
|
2009-06-11 18:15:59 -04:00
|
|
|
|
|
|
|
(defvar org-babel-ruby-eoe-indicator ":org_babel_ruby_eoe"
|
|
|
|
"Used to indicate that evaluation is has completed.")
|
2010-07-04 14:31:14 -04:00
|
|
|
(defvar org-babel-ruby-f-write
|
|
|
|
"File.open('%s','w'){|f| f.write((_.class == String) ? _ : _.inspect)}")
|
|
|
|
(defvar org-babel-ruby-pp-f-write
|
|
|
|
"File.open('%s','w'){|f| $stdout = f; pp(results); $stdout = orig_out}")
|
2009-06-15 13:13:48 -04:00
|
|
|
(defvar org-babel-ruby-wrapper-method
|
|
|
|
"
|
|
|
|
def main()
|
|
|
|
%s
|
|
|
|
end
|
|
|
|
results = main()
|
|
|
|
File.open('%s', 'w'){ |f| f.write((results.class == String) ? results : results.inspect) }
|
|
|
|
")
|
2009-10-18 15:14:39 -04:00
|
|
|
(defvar org-babel-ruby-pp-wrapper-method
|
|
|
|
"
|
|
|
|
require 'pp'
|
|
|
|
def main()
|
|
|
|
%s
|
|
|
|
end
|
|
|
|
results = main()
|
|
|
|
File.open('%s', 'w') do |f|
|
|
|
|
$stdout = f
|
|
|
|
pp results
|
|
|
|
end
|
|
|
|
")
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2010-07-02 22:21:31 -04:00
|
|
|
(defun org-babel-ruby-evaluate
|
|
|
|
(buffer body &optional result-type result-params)
|
2009-06-11 19:28:21 -04:00
|
|
|
"Pass BODY to the Ruby process in BUFFER. If RESULT-TYPE equals
|
2009-06-11 18:15:59 -04:00
|
|
|
'output then return a list of the outputs of the statements in
|
2009-06-11 19:28:21 -04:00
|
|
|
BODY, if RESULT-TYPE equals 'value then return the value of the
|
2009-07-05 21:23:17 -04:00
|
|
|
last statement in BODY, as elisp."
|
2010-07-02 22:21:31 -04:00
|
|
|
(if (not buffer)
|
2009-06-15 13:54:14 -04:00
|
|
|
;; external process evaluation
|
2009-06-15 13:13:48 -04:00
|
|
|
(case result-type
|
2010-07-04 14:31:14 -04:00
|
|
|
(output (org-babel-eval org-babel-ruby-command body))
|
|
|
|
(value (let ((tmp-file (make-temp-file "org-babel-ruby-results-")))
|
|
|
|
(org-babel-eval org-babel-ruby-command
|
|
|
|
(format (if (member "pp" result-params)
|
|
|
|
org-babel-ruby-pp-wrapper-method
|
|
|
|
org-babel-ruby-wrapper-method)
|
|
|
|
body tmp-file))
|
|
|
|
((lambda (raw)
|
|
|
|
(if (or (member "code" result-params)
|
|
|
|
(member "pp" result-params))
|
|
|
|
raw
|
|
|
|
(org-babel-ruby-table-or-string raw)))
|
|
|
|
(org-babel-eval-read-file tmp-file)))))
|
|
|
|
;; comint session evaluation
|
|
|
|
(case result-type
|
|
|
|
(output
|
|
|
|
(mapconcat
|
|
|
|
#'identity
|
|
|
|
(butlast
|
|
|
|
(split-string
|
|
|
|
(mapconcat
|
|
|
|
#'org-babel-trim
|
|
|
|
(butlast
|
|
|
|
(org-babel-comint-with-output
|
2010-07-04 17:46:13 -04:00
|
|
|
(buffer org-babel-ruby-eoe-indicator t body)
|
2010-07-04 14:31:14 -04:00
|
|
|
(mapc
|
|
|
|
(lambda (line)
|
|
|
|
(insert (org-babel-chomp line)) (comint-send-input nil t))
|
|
|
|
(list body org-babel-ruby-eoe-indicator))
|
|
|
|
(comint-send-input nil t)) 2)
|
|
|
|
"\n") "[\r\n]")) "\n"))
|
|
|
|
(value
|
|
|
|
((lambda (results)
|
|
|
|
(if (or (member "code" result-params) (member "pp" result-params))
|
|
|
|
results
|
|
|
|
(org-babel-ruby-table-or-string results)))
|
|
|
|
(let* ((tmp-file (make-temp-file "org-babel-ruby-results-"))
|
|
|
|
(ppp (or (member "code" result-params)
|
|
|
|
(member "pp" result-params))))
|
|
|
|
(org-babel-comint-with-output
|
|
|
|
(buffer org-babel-ruby-eoe-indicator t body)
|
|
|
|
(when ppp (insert "require 'pp';") (comint-send-input nil t))
|
|
|
|
(mapc
|
|
|
|
(lambda (line)
|
|
|
|
(insert (org-babel-chomp line)) (comint-send-input nil t))
|
|
|
|
(append
|
|
|
|
(list body)
|
|
|
|
(if (not ppp)
|
|
|
|
(list (format org-babel-ruby-f-write tmp-file))
|
|
|
|
(list
|
|
|
|
"results=_" "require 'pp'" "orig_out = $stdout"
|
|
|
|
(format org-babel-ruby-pp-f-write tmp-file)))
|
|
|
|
(list org-babel-ruby-eoe-indicator)))
|
|
|
|
(comint-send-input nil t))
|
|
|
|
(org-babel-eval-read-file tmp-file)))))))
|
2009-06-11 18:15:59 -04:00
|
|
|
|
2009-06-12 19:08:51 -04:00
|
|
|
(defun org-babel-ruby-read-string (string)
|
2010-06-11 20:12:15 -04:00
|
|
|
"Strip \\\"s from around a ruby string."
|
2010-02-19 11:34:16 -05:00
|
|
|
(if (string-match "^\"\\([^\000]+\\)\"$" string)
|
2009-06-12 19:08:51 -04:00
|
|
|
(match-string 1 string)
|
|
|
|
string))
|
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
(provide 'ob-ruby)
|
2010-06-25 12:32:35 -04:00
|
|
|
|
|
|
|
;; arch-tag: 3e9726db-4520-49e2-b263-e8f571ac88f5
|
|
|
|
|
2010-06-11 19:02:42 -04:00
|
|
|
;;; ob-ruby.el ends here
|