org-babel-ruby.el 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  1. ;;; org-babel-ruby.el --- org-babel functions for ruby evaluation
  2. ;; Copyright (C) 2009 Eric Schulte
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: http://orgmode.org
  6. ;; Version: 0.01
  7. ;;; License:
  8. ;; This program is free software; you can redistribute it and/or modify
  9. ;; it under the terms of the GNU General Public License as published by
  10. ;; the Free Software Foundation; either version 3, or (at your option)
  11. ;; any later version.
  12. ;;
  13. ;; This program is distributed in the hope that it will be useful,
  14. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. ;; GNU General Public License for more details.
  17. ;;
  18. ;; You should have received a copy of the GNU General Public License
  19. ;; along with GNU Emacs; see the file COPYING. If not, write to the
  20. ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21. ;; Boston, MA 02110-1301, USA.
  22. ;;; Commentary:
  23. ;; Org-Babel support for evaluating ruby source code.
  24. ;;; Code:
  25. (require 'org-babel)
  26. (require 'inf-ruby)
  27. (org-babel-add-interpreter "ruby")
  28. (defun org-babel-execute:ruby (body params)
  29. "Execute a block of Ruby code with org-babel. This function is
  30. called by `org-babel-execute-src-block'."
  31. (message "executing Ruby source code block")
  32. (let* ((vars (org-babel-ref-variables params))
  33. (result-params (split-string (or (cdr (assoc :results params)) "")))
  34. (result-type (cond ((member "output" result-params) 'output)
  35. ((member "value" result-params) 'value)
  36. (t 'value)))
  37. (full-body (concat
  38. (mapconcat ;; define any variables
  39. (lambda (pair)
  40. (format "%s=%s"
  41. (car pair)
  42. (org-babel-ruby-var-to-ruby (cdr pair))))
  43. vars "\n") "\n" body "\n")) ;; then the source block body
  44. (session (org-babel-ruby-initiate-session (cdr (assoc :session params))))
  45. (results (org-babel-ruby-evaluate session full-body result-type)))
  46. (if (member "scalar" result-params)
  47. results
  48. (case result-type ;; process results based on the result-type
  49. ('output (let ((tmp-file (make-temp-file "org-babel-ruby")))
  50. (with-temp-file tmp-file (insert results))
  51. (org-babel-import-elisp-from-file tmp-file)))
  52. ('value (org-babel-ruby-table-or-results results))))))
  53. (defun org-babel-prep-session:ruby (session params)
  54. "Prepare SESSION according to the header arguments specified in PARAMS."
  55. ;; (message "params=%S" params) ;; debugging
  56. (let* ((session (org-babel-ruby-initiate-session session))
  57. (vars (org-babel-ref-variables params))
  58. (var-lines (mapcar ;; define any variables
  59. (lambda (pair)
  60. (format "%s=%s"
  61. (car pair)
  62. (org-babel-ruby-var-to-ruby (cdr pair))))
  63. vars)))
  64. ;; (message "vars=%S" vars) ;; debugging
  65. (org-babel-comint-in-buffer session
  66. (sit-for .5) (goto-char (point-max))
  67. (mapc (lambda (var)
  68. (insert var) (comint-send-input nil t)
  69. (org-babel-comint-wait-for-output session)
  70. (sit-for .1) (goto-char (point-max))) var-lines))))
  71. ;; helper functions
  72. (defun org-babel-ruby-var-to-ruby (var)
  73. "Convert an elisp var into a string of ruby source code
  74. specifying a var of the same value."
  75. (if (listp var)
  76. (concat "[" (mapconcat #'org-babel-ruby-var-to-ruby var ", ") "]")
  77. (format "%S" var)))
  78. (defun org-babel-ruby-table-or-results (results)
  79. "If the results look like a table, then convert them into an
  80. Emacs-lisp table, otherwise return the results as a string."
  81. (org-babel-read
  82. (if (and (stringp results) (string-match "^\\[.+\\]$" results))
  83. (org-babel-read
  84. (replace-regexp-in-string
  85. "\\[" "(" (replace-regexp-in-string
  86. "\\]" ")" (replace-regexp-in-string
  87. ", " " " (replace-regexp-in-string
  88. "'" "\"" results)))))
  89. results)))
  90. (defun org-babel-ruby-initiate-session (&optional session)
  91. "If there is not a current inferior-process-buffer in SESSION
  92. then create. Return the initialized session."
  93. (let ((session-buffer (save-window-excursion (run-ruby nil session) (current-buffer))))
  94. (if (org-babel-comint-buffer-livep session-buffer)
  95. session-buffer
  96. (sit-for .5)
  97. (org-babel-ruby-initiate-session session))))
  98. (defvar org-babel-ruby-last-value-eval "_"
  99. "When evaluated by Ruby this returns the return value of the last statement.")
  100. (defvar org-babel-ruby-eoe-indicator ":org_babel_ruby_eoe"
  101. "Used to indicate that evaluation is has completed.")
  102. (defun org-babel-ruby-evaluate (buffer body &optional result-type)
  103. "Pass BODY to the Ruby process in BUFFER. If RESULT-TYPE equals
  104. 'output then return a list of the outputs of the statements in
  105. BODY, if RESULT-TYPE equals 'value then return the value of the
  106. last statement in BODY."
  107. (let* ((full-body (mapconcat #'org-babel-chomp
  108. (list body org-babel-ruby-last-value-eval org-babel-ruby-eoe-indicator) "\n"))
  109. (raw (org-babel-comint-with-output buffer org-babel-ruby-eoe-indicator t
  110. (insert full-body) (comint-send-input nil t)))
  111. (results (cdr (member org-babel-ruby-eoe-indicator
  112. (reverse (mapcar #'org-babel-ruby-read-string
  113. (mapcar #'org-babel-trim raw)))))))
  114. (case result-type
  115. (output (mapconcat #'identity (reverse (cdr results)) "\n"))
  116. (value (car results))
  117. (t (reverse results)))))
  118. (defun org-babel-ruby-read-string (string)
  119. "Strip \\\"s from around ruby string"
  120. (if (string-match "\"\\([^\000]+\\)\"" string)
  121. (match-string 1 string)
  122. string))
  123. (provide 'org-babel-ruby)
  124. ;;; org-babel-ruby.el ends here