ob-ruby.el 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. ;;; ob-ruby.el --- org-babel functions for ruby evaluation
  2. ;; Copyright (C) 2009, 2010 Free Software Foundation
  3. ;; Author: Eric Schulte
  4. ;; Keywords: literate programming, reproducible research
  5. ;; Homepage: http://orgmode.org
  6. ;; Version: 0.01
  7. ;; This file is part of GNU Emacs.
  8. ;; GNU Emacs 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 of the License, or
  11. ;; (at your option) any later version.
  12. ;; GNU Emacs is distributed in the hope that it will be useful,
  13. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  14. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15. ;; GNU General Public License for more details.
  16. ;; You should have received a copy of the GNU General Public License
  17. ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
  18. ;;; Commentary:
  19. ;; Org-Babel support for evaluating ruby source code.
  20. ;;; Requirements:
  21. ;; - ruby and irb executables :: http://www.ruby-lang.org/
  22. ;;
  23. ;; - ruby-mode :: Can be installed through ELPA, or from
  24. ;; http://github.com/eschulte/rinari/raw/master/util/ruby-mode.el
  25. ;;
  26. ;; - inf-ruby mode :: Can be installed through ELPA, or from
  27. ;; http://github.com/eschulte/rinari/raw/master/util/inf-ruby.el
  28. ;;; Code:
  29. (require 'ob)
  30. (require 'ob-ref)
  31. (require 'ob-comint)
  32. (require 'ob-eval)
  33. (eval-when-compile (require 'cl))
  34. (declare-function run-ruby "ext:inf-ruby" (&optional command name))
  35. (add-to-list 'org-babel-tangle-lang-exts '("ruby" . "rb"))
  36. (defvar org-babel-default-header-args:ruby '())
  37. (defvar org-babel-ruby-command "ruby"
  38. "Name of command to use for executing ruby code.")
  39. (defun org-babel-expand-body:ruby (body params &optional processed-params)
  40. "Expand BODY according to PARAMS, return the expanded body."
  41. (require 'inf-ruby)
  42. (let ((vars (nth 1 (or processed-params (org-babel-process-params params)))))
  43. (concat
  44. (mapconcat ;; define any variables
  45. (lambda (pair)
  46. (format "%s=%s"
  47. (car pair)
  48. (org-babel-ruby-var-to-ruby (cdr pair))))
  49. vars "\n") "\n" body "\n")))
  50. (defun org-babel-execute:ruby (body params)
  51. "Execute a block of Ruby code with org-babel. This function is
  52. called by `org-babel-execute-src-block'."
  53. (let* ((processed-params (org-babel-process-params params))
  54. (session (org-babel-ruby-initiate-session (first processed-params)))
  55. (result-params (nth 2 processed-params))
  56. (result-type (nth 3 processed-params))
  57. (full-body (org-babel-expand-body:ruby
  58. body params processed-params))
  59. (result (org-babel-ruby-evaluate
  60. session full-body result-type result-params)))
  61. (or (cdr (assoc :file params))
  62. (org-babel-reassemble-table
  63. result
  64. (org-babel-pick-name (nth 4 processed-params)
  65. (cdr (assoc :colnames params)))
  66. (org-babel-pick-name (nth 5 processed-params)
  67. (cdr (assoc :rownames params)))))))
  68. (defun org-babel-prep-session:ruby (session params)
  69. "Prepare SESSION according to the header arguments specified in PARAMS."
  70. ;; (message "params=%S" params) ;; debugging
  71. (let* ((session (org-babel-ruby-initiate-session session))
  72. (vars (org-babel-ref-variables params))
  73. (var-lines (mapcar ;; define any variables
  74. (lambda (pair)
  75. (format "%s=%s"
  76. (car pair)
  77. (org-babel-ruby-var-to-ruby (cdr pair))))
  78. vars)))
  79. (org-babel-comint-in-buffer session
  80. (sit-for .5) (goto-char (point-max))
  81. (mapc (lambda (var)
  82. (insert var) (comint-send-input nil t)
  83. (org-babel-comint-wait-for-output session)
  84. (sit-for .1) (goto-char (point-max))) var-lines))
  85. session))
  86. (defun org-babel-load-session:ruby (session body params)
  87. "Load BODY into SESSION."
  88. (save-window-excursion
  89. (let ((buffer (org-babel-prep-session:ruby session params)))
  90. (with-current-buffer buffer
  91. (goto-char (process-mark (get-buffer-process (current-buffer))))
  92. (insert (org-babel-chomp body)))
  93. buffer)))
  94. ;; helper functions
  95. (defun org-babel-ruby-var-to-ruby (var)
  96. "Convert an elisp var into a string of ruby source code
  97. specifying a var of the same value."
  98. (if (listp var)
  99. (concat "[" (mapconcat #'org-babel-ruby-var-to-ruby var ", ") "]")
  100. (format "%S" var)))
  101. (defun org-babel-ruby-table-or-string (results)
  102. "If RESULTS look like a table, then convert them into an
  103. Emacs-lisp table, otherwise return the results as a string."
  104. (org-babel-read
  105. (if (and (stringp results) (string-match "^\\[.+\\]$" results))
  106. (org-babel-read
  107. (concat "'"
  108. (replace-regexp-in-string
  109. "\\[" "(" (replace-regexp-in-string
  110. "\\]" ")" (replace-regexp-in-string
  111. ", " " " (replace-regexp-in-string
  112. "'" "\"" results))))))
  113. results)))
  114. (defun org-babel-ruby-initiate-session (&optional session params)
  115. "If there is not a current inferior-process-buffer in SESSION
  116. then create one. Return the initialized session."
  117. (require 'inf-ruby)
  118. (unless (string= session "none")
  119. (let ((session-buffer (save-window-excursion
  120. (run-ruby nil session) (current-buffer))))
  121. (if (org-babel-comint-buffer-livep session-buffer)
  122. (progn (sit-for .25) session-buffer)
  123. (sit-for .5)
  124. (org-babel-ruby-initiate-session session)))))
  125. (defvar org-babel-ruby-eoe-indicator ":org_babel_ruby_eoe"
  126. "Used to indicate that evaluation is has completed.")
  127. (defvar org-babel-ruby-f-write
  128. "File.open('%s','w'){|f| f.write((_.class == String) ? _ : _.inspect)}")
  129. (defvar org-babel-ruby-pp-f-write
  130. "File.open('%s','w'){|f| $stdout = f; pp(results); $stdout = orig_out}")
  131. (defvar org-babel-ruby-wrapper-method
  132. "
  133. def main()
  134. %s
  135. end
  136. results = main()
  137. File.open('%s', 'w'){ |f| f.write((results.class == String) ? results : results.inspect) }
  138. ")
  139. (defvar org-babel-ruby-pp-wrapper-method
  140. "
  141. require 'pp'
  142. def main()
  143. %s
  144. end
  145. results = main()
  146. File.open('%s', 'w') do |f|
  147. $stdout = f
  148. pp results
  149. end
  150. ")
  151. (defun org-babel-ruby-evaluate
  152. (buffer body &optional result-type result-params)
  153. "Pass BODY to the Ruby process in BUFFER. If RESULT-TYPE equals
  154. 'output then return a list of the outputs of the statements in
  155. BODY, if RESULT-TYPE equals 'value then return the value of the
  156. last statement in BODY, as elisp."
  157. (if (not buffer)
  158. ;; external process evaluation
  159. (case result-type
  160. (output (org-babel-eval org-babel-ruby-command body))
  161. (value (let ((tmp-file (make-temp-file "org-babel-ruby-results-")))
  162. (org-babel-eval org-babel-ruby-command
  163. (format (if (member "pp" result-params)
  164. org-babel-ruby-pp-wrapper-method
  165. org-babel-ruby-wrapper-method)
  166. body tmp-file))
  167. ((lambda (raw)
  168. (if (or (member "code" result-params)
  169. (member "pp" result-params))
  170. raw
  171. (org-babel-ruby-table-or-string raw)))
  172. (org-babel-eval-read-file tmp-file)))))
  173. ;; comint session evaluation
  174. (case result-type
  175. (output
  176. (mapconcat
  177. #'identity
  178. (butlast
  179. (split-string
  180. (mapconcat
  181. #'org-babel-trim
  182. (butlast
  183. (org-babel-comint-with-output
  184. (buffer org-babel-ruby-eoe-indicator t body)
  185. (mapc
  186. (lambda (line)
  187. (insert (org-babel-chomp line)) (comint-send-input nil t))
  188. (list body org-babel-ruby-eoe-indicator))
  189. (comint-send-input nil t)) 2)
  190. "\n") "[\r\n]")) "\n"))
  191. (value
  192. ((lambda (results)
  193. (if (or (member "code" result-params) (member "pp" result-params))
  194. results
  195. (org-babel-ruby-table-or-string results)))
  196. (let* ((tmp-file (make-temp-file "org-babel-ruby-results-"))
  197. (ppp (or (member "code" result-params)
  198. (member "pp" result-params))))
  199. (org-babel-comint-with-output
  200. (buffer org-babel-ruby-eoe-indicator t body)
  201. (when ppp (insert "require 'pp';") (comint-send-input nil t))
  202. (mapc
  203. (lambda (line)
  204. (insert (org-babel-chomp line)) (comint-send-input nil t))
  205. (append
  206. (list body)
  207. (if (not ppp)
  208. (list (format org-babel-ruby-f-write tmp-file))
  209. (list
  210. "results=_" "require 'pp'" "orig_out = $stdout"
  211. (format org-babel-ruby-pp-f-write tmp-file)))
  212. (list org-babel-ruby-eoe-indicator)))
  213. (comint-send-input nil t))
  214. (org-babel-eval-read-file tmp-file)))))))
  215. (defun org-babel-ruby-read-string (string)
  216. "Strip \\\"s from around a ruby string."
  217. (if (string-match "^\"\\([^\000]+\\)\"$" string)
  218. (match-string 1 string)
  219. string))
  220. (provide 'ob-ruby)
  221. ;; arch-tag: 3e9726db-4520-49e2-b263-e8f571ac88f5
  222. ;;; ob-ruby.el ends here