2009-06-12 16:24:03 +00:00
|
|
|
;;; org-babel-ruby.el --- org-babel functions for ruby evaluation
|
2009-06-11 22:15:59 +00:00
|
|
|
|
|
|
|
;; Copyright (C) 2009 Eric Schulte
|
|
|
|
|
|
|
|
;; Author: Eric Schulte
|
|
|
|
;; Keywords: literate programming, reproducible research
|
|
|
|
;; Homepage: http://orgmode.org
|
|
|
|
;; Version: 0.01
|
|
|
|
|
|
|
|
;;; License:
|
|
|
|
|
|
|
|
;; 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, 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 GNU Emacs; see the file COPYING. If not, write to the
|
|
|
|
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
|
|
;; Boston, MA 02110-1301, USA.
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
|
;; Org-Babel support for evaluating ruby source code.
|
|
|
|
|
2009-08-16 16:48:08 +00: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 22:15:59 +00:00
|
|
|
;;; Code:
|
|
|
|
(require 'org-babel)
|
|
|
|
(require 'inf-ruby)
|
|
|
|
|
|
|
|
(org-babel-add-interpreter "ruby")
|
|
|
|
|
2009-06-15 22:25:46 +00:00
|
|
|
(add-to-list 'org-babel-tangle-langs '("ruby" "rb" "#!/usr/bin/env ruby"))
|
|
|
|
|
2009-07-08 04:13:07 +00:00
|
|
|
(defun org-babel-execute:ruby (body params)
|
2009-06-11 22:15:59 +00:00
|
|
|
"Execute a block of Ruby code with org-babel. This function is
|
2009-07-16 20:21:07 +00:00
|
|
|
called by `org-babel-execute-src-block' via multiple-value-bind."
|
2009-06-11 22:15:59 +00:00
|
|
|
(message "executing Ruby source code block")
|
2009-11-10 22:22:25 +00:00
|
|
|
(let* ((processed-params (org-babel-process-params params))
|
|
|
|
(session (org-babel-ruby-initiate-session (first processed-params)))
|
|
|
|
(vars (second processed-params))
|
|
|
|
(result-params (third processed-params))
|
|
|
|
(result-type (fourth processed-params))
|
|
|
|
(full-body (concat
|
2009-07-16 20:21:07 +00:00
|
|
|
(mapconcat ;; define any variables
|
|
|
|
(lambda (pair)
|
|
|
|
(format "%s=%s"
|
|
|
|
(car pair)
|
|
|
|
(org-babel-ruby-var-to-ruby (cdr pair))))
|
|
|
|
vars "\n") "\n" body "\n")) ;; then the source block body
|
2009-11-10 22:22:25 +00:00
|
|
|
(result (org-babel-ruby-evaluate session full-body result-type)))
|
2009-11-05 17:04:27 +00:00
|
|
|
(or (cdr (assoc :file params)) result)))
|
2009-06-11 22:15:59 +00:00
|
|
|
|
2009-06-14 18:08:12 +00:00
|
|
|
(defun org-babel-prep-session:ruby (session params)
|
|
|
|
"Prepare SESSION according to the header arguments specified in PARAMS."
|
2009-06-14 18:44:29 +00:00
|
|
|
;; (message "params=%S" params) ;; debugging
|
2009-06-14 18:08:12 +00: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)))
|
2009-06-14 18:44:29 +00:00
|
|
|
;; (message "vars=%S" vars) ;; debugging
|
2009-06-14 18:08:12 +00:00
|
|
|
(org-babel-comint-in-buffer session
|
2009-06-14 18:44:29 +00:00
|
|
|
(sit-for .5) (goto-char (point-max))
|
2009-06-14 18:08:12 +00:00
|
|
|
(mapc (lambda (var)
|
|
|
|
(insert var) (comint-send-input nil t)
|
2009-06-14 18:44:29 +00:00
|
|
|
(org-babel-comint-wait-for-output session)
|
|
|
|
(sit-for .1) (goto-char (point-max))) var-lines))))
|
2009-06-14 18:08:12 +00:00
|
|
|
|
|
|
|
;; helper functions
|
|
|
|
|
2009-06-11 22:15:59 +00:00
|
|
|
(defun org-babel-ruby-var-to-ruby (var)
|
2009-06-12 16:24:03 +00:00
|
|
|
"Convert an elisp var into a string of ruby source code
|
|
|
|
specifying a var of the same value."
|
2009-06-11 22:15:59 +00:00
|
|
|
(if (listp var)
|
|
|
|
(concat "[" (mapconcat #'org-babel-ruby-var-to-ruby var ", ") "]")
|
|
|
|
(format "%S" var)))
|
|
|
|
|
2009-07-05 23:59:24 +00:00
|
|
|
(defun org-babel-ruby-table-or-string (results)
|
2009-06-11 22:15:59 +00:00
|
|
|
"If the results look like a table, then convert them into an
|
|
|
|
Emacs-lisp table, otherwise return the results as a string."
|
|
|
|
(org-babel-read
|
2009-06-14 15:41:52 +00:00
|
|
|
(if (and (stringp results) (string-match "^\\[.+\\]$" results))
|
2009-06-11 22:15:59 +00:00
|
|
|
(org-babel-read
|
|
|
|
(replace-regexp-in-string
|
|
|
|
"\\[" "(" (replace-regexp-in-string
|
|
|
|
"\\]" ")" (replace-regexp-in-string
|
|
|
|
", " " " (replace-regexp-in-string
|
|
|
|
"'" "\"" results)))))
|
|
|
|
results)))
|
|
|
|
|
2009-06-11 22:34:34 +00:00
|
|
|
(defun org-babel-ruby-initiate-session (&optional session)
|
2009-06-11 22:15:59 +00:00
|
|
|
"If there is not a current inferior-process-buffer in SESSION
|
|
|
|
then create. Return the initialized session."
|
2009-06-15 16:28:01 +00:00
|
|
|
(unless (string= session "none")
|
|
|
|
(let ((session-buffer (save-window-excursion (run-ruby nil session) (current-buffer))))
|
|
|
|
(if (org-babel-comint-buffer-livep session-buffer)
|
|
|
|
session-buffer
|
|
|
|
(sit-for .5)
|
|
|
|
(org-babel-ruby-initiate-session session)))))
|
2009-06-11 22:15:59 +00:00
|
|
|
|
|
|
|
(defvar org-babel-ruby-last-value-eval "_"
|
|
|
|
"When evaluated by Ruby this returns the return value of the last statement.")
|
2009-10-18 19:14:39 +00:00
|
|
|
(defvar org-babel-ruby-pp-last-value-eval "require 'pp'; pp(_)"
|
|
|
|
"When evaluated by Ruby this pretty prints value of the last statement.")
|
2009-06-11 22:15:59 +00:00
|
|
|
(defvar org-babel-ruby-eoe-indicator ":org_babel_ruby_eoe"
|
|
|
|
"Used to indicate that evaluation is has completed.")
|
2009-06-15 17:13:48 +00: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 19:14:39 +00: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 22:15:59 +00:00
|
|
|
|
2009-06-11 23:28:21 +00:00
|
|
|
(defun org-babel-ruby-evaluate (buffer body &optional result-type)
|
|
|
|
"Pass BODY to the Ruby process in BUFFER. If RESULT-TYPE equals
|
2009-06-11 22:15:59 +00:00
|
|
|
'output then return a list of the outputs of the statements in
|
2009-06-11 23:28:21 +00:00
|
|
|
BODY, if RESULT-TYPE equals 'value then return the value of the
|
2009-07-06 01:23:17 +00:00
|
|
|
last statement in BODY, as elisp."
|
2009-06-15 17:54:14 +00:00
|
|
|
(if (not session)
|
|
|
|
;; external process evaluation
|
|
|
|
(save-window-excursion
|
|
|
|
(case result-type
|
|
|
|
(output
|
|
|
|
(with-temp-buffer
|
|
|
|
(insert body)
|
|
|
|
;; (message "buffer=%s" (buffer-string)) ;; debugging
|
|
|
|
(shell-command-on-region (point-min) (point-max) "ruby" 'replace)
|
|
|
|
(buffer-string)))
|
|
|
|
(value
|
|
|
|
(let ((tmp-file (make-temp-file "ruby-functional-results")))
|
|
|
|
(with-temp-buffer
|
2009-10-18 19:14:39 +00:00
|
|
|
(insert (format (if (member "pp" result-params)
|
|
|
|
org-babel-ruby-pp-wrapper-method
|
|
|
|
org-babel-ruby-wrapper-method) body tmp-file))
|
2009-06-15 17:13:48 +00:00
|
|
|
;; (message "buffer=%s" (buffer-string)) ;; debugging
|
2009-06-15 17:54:14 +00:00
|
|
|
(shell-command-on-region (point-min) (point-max) "ruby"))
|
2009-10-16 18:20:35 +00:00
|
|
|
(let ((raw (with-temp-buffer (insert-file-contents tmp-file)
|
|
|
|
(buffer-string))))
|
2009-10-18 19:14:39 +00:00
|
|
|
(if (or (member "code" result-params) (member "pp" result-params))
|
2009-10-16 18:20:35 +00:00
|
|
|
raw
|
|
|
|
(org-babel-ruby-table-or-string raw)))))))
|
2009-06-15 17:54:14 +00:00
|
|
|
;; comint session evaluation
|
2009-07-08 04:13:07 +00:00
|
|
|
(let* ((full-body
|
2009-07-05 20:08:07 +00:00
|
|
|
(mapconcat
|
|
|
|
#'org-babel-chomp
|
2009-10-18 19:14:39 +00:00
|
|
|
(list body (if (member "pp" result-params)
|
|
|
|
org-babel-ruby-pp-last-value-eval
|
|
|
|
org-babel-ruby-last-value-eval)
|
|
|
|
org-babel-ruby-eoe-indicator) "\n"))
|
2009-06-15 19:30:36 +00:00
|
|
|
(raw (org-babel-comint-with-output buffer org-babel-ruby-eoe-indicator t
|
2009-07-08 04:13:07 +00:00
|
|
|
(insert full-body) (comint-send-input nil t)))
|
2009-06-15 19:30:36 +00:00
|
|
|
(results (cdr (member org-babel-ruby-eoe-indicator
|
|
|
|
(reverse (mapcar #'org-babel-ruby-read-string
|
|
|
|
(mapcar #'org-babel-trim raw)))))))
|
2009-06-15 17:13:48 +00:00
|
|
|
(case result-type
|
|
|
|
(output (mapconcat #'identity (reverse (cdr results)) "\n"))
|
2009-10-16 18:20:35 +00:00
|
|
|
(value
|
2009-10-18 19:14:39 +00:00
|
|
|
(if (or (member "code" result-params) (member "pp" result-params))
|
2009-10-16 18:20:35 +00:00
|
|
|
(car results)
|
|
|
|
(org-babel-ruby-table-or-string (car results))))))))
|
2009-06-11 22:15:59 +00:00
|
|
|
|
2009-06-12 23:08:51 +00:00
|
|
|
(defun org-babel-ruby-read-string (string)
|
|
|
|
"Strip \\\"s from around ruby string"
|
|
|
|
(if (string-match "\"\\([^\000]+\\)\"" string)
|
|
|
|
(match-string 1 string)
|
|
|
|
string))
|
|
|
|
|
2009-06-11 22:15:59 +00:00
|
|
|
(provide 'org-babel-ruby)
|
|
|
|
;;; org-babel-ruby.el ends here
|