1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
;;; ess-test-literate.el --- ESS literate tests -*- lexical-binding: t; -*-
;;; Commentary:
;; Literate tests
;;; Code:
(require 'ess-r-mode)
(eval-when-compile
(require 'cl-lib))
(require 'etest)
(defvar elt-section-pattern)
(defvar elt-chunk-pattern)
(defvar elt-code-pattern)
(defvar chunk-end)
(defvar elt-code-cont-pattern)
(defvar test-case)
(defvar test-case-state)
(defvar elt-mode-init)
(defmacro elt-deftest (name args file)
`(ert-deftest ,name ,args
(let ((inhibit-message ess-inhibit-message-in-tests)
(path (expand-file-name ,file "literate")))
(elt-do 'test path))))
(defun elt--activate-font-lock-keywords ()
"Activate font-lock keywords for some of ELT's symbols."
(font-lock-add-keywords
nil
'(("(\\(\\<elt-deftest\\)\\>\\s *\\(\\(?:\\sw\\|\\s_\\)+\\)?"
(1 font-lock-keyword-face nil t)
(2 font-lock-function-name-face nil t)))))
(add-hook 'emacs-lisp-mode-hook #'elt--activate-font-lock-keywords)
(defvar elt-ess-r-chunk-pattern "^###[ \t]*\\([0-9]+[a-zA-Z]*\\) \\([^\n]*\\)$")
(defvar elt-ess-r-code-start-pattern "^##!")
(defvar elt-ess-r-code-cont-pattern "^##>")
(defvar elt-ess-r-code-pattern "^##[!>]")
(defvar elt-ess-r-section-pattern "^##### \\([^\n]*\\)$")
(defvar elt-ess-r-mode-init '((mode . R)))
(defun elt-do (action file)
(unless (memq action '(test regenerate))
(error "Invalid literate test action"))
(let ((verb (if (eq action 'test)
"Testing"
"Regenerating")))
(message "---%s %s" verb (file-name-nondirectory file)))
(let* ((src-buffer (if (file-exists-p file)
(find-file-noselect file)
(error "Can't find literate test file")))
(src-string (with-current-buffer src-buffer
(buffer-string)))
(output (elt-buffer-string file src-string)))
(pcase action
(`test (should (string= src-string output)))
(`regenerate (with-current-buffer src-buffer
(erase-buffer)
(insert output)
(save-buffer))))))
(defun elt-buffer-string (file src-string)
(let ((el-file (concat (file-name-sans-extension file) ".el")))
(when (file-exists-p el-file)
(load-file el-file)))
(with-temp-buffer
(insert src-string)
;; Don't check safety of local variables declared in test files
(cl-letf (((symbol-function 'safe-local-variable-p) (lambda (sym val) t)))
(let ((enable-dir-local-variables nil))
(hack-local-variables)))
(let ((elt-chunk-pattern elt-ess-r-chunk-pattern)
(elt-code-cont-pattern elt-ess-r-code-cont-pattern)
(elt-code-pattern elt-ess-r-code-pattern)
(elt-section-pattern elt-ess-r-section-pattern)
(elt-mode-init (append (assq-delete-all 'mode file-local-variables-alist)
elt-ess-r-mode-init)))
(elt-this-buffer)
(buffer-string))))
(defun elt-this-buffer ()
(goto-char 1)
(let ((undo-inhibit-record-point t))
(undo-boundary)
;; Print first section header
(elt-print-section-header)
(when (elt-search-chunk nil t)
(while (looking-at elt-chunk-pattern)
(elt-print-chunk-id)
(elt-process-next-chunk)))
(skip-chars-backward "\n")
(let ((point-max (or (elt-local-variables-pos)
(point-max))))
(delete-region (1+ (point)) point-max)
(insert "\n"))
(when (looking-at (concat "\n" comment-start "+ +Local Variables:"))
(insert "\n"))
(undo-boundary)))
(defun elt-local-variables-pos ()
(save-excursion
(let ((pattern (concat "^" comment-start "+ +Local Variables:")))
(when (re-search-forward pattern nil t)
(match-beginning 0)))))
(defun elt-print-section-header ()
(save-excursion
(skip-chars-forward " \n\t")
(when (looking-at elt-section-pattern)
(message (match-string-no-properties 1)))))
(defun elt-print-chunk-id ()
(let ((number (concat "#" (match-string-no-properties 1)))
(msg (match-string-no-properties 2)))
(setq msg (substring msg 0 (string-match "-+$" msg)))
(message (if (> (length msg) 0)
(concat number " - " msg)
number))))
(defun elt-search-chunk (&optional n skip-section)
(let* ((next-chunk (save-excursion
(cond ((re-search-forward elt-chunk-pattern
nil t (or n 1))
(match-beginning 0))
((elt-local-variables-pos))
(t
(point-max)))))
(next-section (save-excursion
(when (re-search-forward elt-section-pattern
next-chunk t)
(match-beginning 0)))))
(goto-char (if (and (not skip-section) next-section)
next-section
next-chunk))))
(defun elt-process-next-chunk ()
(let* ((chunk-beg (point))
(chunk-end (progn
(forward-line)
(save-excursion
(elt-search-chunk)
(point-marker))))
(orig-chunk (buffer-substring chunk-beg chunk-end)))
(condition-case cnd
(let* ((test-case (progn
(skip-chars-forward " \t\n")
(elt-process-case)))
(test-case-state test-case))
(while (looking-at elt-code-pattern)
(elt-process-next-subchunk chunk-end))
(insert "\n")
(elt-print-section-header)
(when (looking-at elt-section-pattern)
(insert "\n")
(elt-search-chunk nil t)))
(ert-test-skipped
(message (concat " Skipping test: " (cadr cnd)))
(goto-char chunk-beg)
(delete-region chunk-beg chunk-end)
(insert orig-chunk)
nil))))
(defun elt-process-next-subchunk (chunk-end)
(let* ((continuation (looking-at elt-code-cont-pattern))
(test-code (elt-process-code))
(test-result (elt-run-chunk test-code
elt-mode-init
continuation))
(subchunk-end (save-excursion
(if (re-search-forward elt-code-pattern chunk-end t)
(match-beginning 0)
chunk-end))))
(setq test-case-state test-result)
(delete-region (point) subchunk-end)
(insert (concat "\n" test-result "\n\n"))))
(defun elt-process-case ()
(let ((case-start (progn
(skip-chars-forward " \t\n")
(goto-char (line-beginning-position))
(point)))
(code-start (if (re-search-forward elt-code-pattern chunk-end t)
(goto-char (match-beginning 0))
(error "No test code found")))
(case-end (progn
(skip-chars-backward " \t\n")
(point))))
(forward-char 1)
(delete-region (point) code-start)
(insert "\n")
(buffer-substring-no-properties case-start case-end)))
(defun elt-process-code ()
(let* ((test-start (point))
(test-end (if (re-search-forward "^$" chunk-end t)
(1- (match-beginning 0))
(goto-char chunk-end)))
(test-code (buffer-substring-no-properties test-start test-end)))
;; Remove comment prefix
(while (string-match (concat (substring elt-code-pattern 1) "[ \t]?")
test-code)
(setq test-code (replace-match "" t t test-code)))
;; Parse elisp
(setq test-code (concat "(" test-code ")"))
(car (read-from-string test-code))))
(defvar elt--state-buffer nil
"Evaluation buffer of previous test chunk.")
(defun elt-run-chunk (body local-variables &optional keep-state)
(unless keep-state
(when (and elt--state-buffer
(buffer-name elt--state-buffer))
(kill-buffer elt--state-buffer))
(setq elt--state-buffer (etest--new-buffer local-variables)))
(with-current-buffer elt--state-buffer
(delete-region (point-min) (point-max))
(insert (if keep-state test-case-state test-case)))
(etest-run elt--state-buffer body (not keep-state))
(etest--result elt--state-buffer))
(provide 'ess-test-literate)
;;; ess-test-literate.el ends here
|
