1 ;;; electric-tests.el --- tests for electric.el
3 ;; Copyright (C) 2013 João Távora
5 ;; Author: João Távora <joaotavora@gmail.com>
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 of the License, or
11 ;; (at your option) any later version.
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.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
21 ;;; Commentary: Tests for Electric Pair mode.
22 ;;; TODO: Add tests for other Electric-* functionality
32 (defun call-with-saved-electric-modes (fn)
33 (let ((saved-electric (if electric-pair-mode 1 -1))
34 (saved-layout (if electric-layout-mode 1 -1))
35 (saved-indent (if electric-indent-mode 1 -1)))
36 (electric-pair-mode -1)
37 (electric-layout-mode -1)
38 (electric-indent-mode -1)
41 (electric-pair-mode saved-electric)
42 (electric-indent-mode saved-indent)
43 (electric-layout-mode saved-layout))))
45 (defmacro save-electric-modes (&rest body)
46 (declare (indent defun) (debug t))
47 `(call-with-saved-electric-modes #'(lambda () ,@body)))
49 (defun electric-pair-test-for (fixture where char expected-string
50 expected-point mode bindings fixture-fn)
55 (let ((last-command-event char))
59 (mapcar #'car bindings)
60 (mapcar #'cdr bindings)
61 (self-insert-command 1))))
62 (should (equal (buffer-substring-no-properties (point-min) (point-max))
64 (should (equal (point)
68 (defun electric-pair-define-test-form (name fixture
80 (let* ((expected-string-and-point
84 ;; FIXME: avoid `eval'
85 (mapcar #'car (eval bindings))
86 (mapcar #'cdr (eval bindings))
91 (cond ((eq (aref skip-pair-string pos)
93 (insert (cadr (electric-pair-syntax-info char)))
95 ((eq (aref skip-pair-string pos)
100 (buffer-substring-no-properties (point-min) (point-max))
102 (list expected-string expected-point)))
103 (expected-string (car expected-string-and-point))
104 (expected-point (cadr expected-string-and-point))
105 (fixture (format "%s%s%s" prefix fixture suffix))
106 (expected-string (format "%s%s%s" prefix expected-string suffix))
107 (expected-point (+ (length prefix) expected-point))
108 (pos (+ (length prefix) pos)))
109 `(ert-deftest ,(intern (format "electric-pair-%s-at-point-%s-in-%s%s"
115 ,(format "With \"%s\", try input %c at point %d. \
116 Should %s \"%s\" and point at %d"
120 (if (string= fixture expected-string)
123 (replace-regexp-in-string "\n" "\\\\n" expected-string)
125 (electric-pair-test-for ,fixture
134 (cl-defmacro define-electric-pair-test
142 (modes '(quote (emacs-lisp-mode ruby-mode c++-mode)))
146 (fixture-fn #'(lambda ()
147 (electric-pair-mode 1))))
150 for mode in (eval modes) ;FIXME: avoid `eval'
153 for (prefix suffix extra-desc) in
154 (append (if test-in-comments
155 `((,(with-temp-buffer
158 (comment-region (point-min) (point-max))
159 (buffer-substring-no-properties (point-min)
164 `(("\"" "\"" "-in-strings")))
169 for char across input
172 collect (electric-pair-define-test-form
187 ;;; Basic pairings and skippings
189 (define-electric-pair-test balanced-situation
190 " (()) " "(((((((" :skip-pair-string "ppppppp"
193 (define-electric-pair-test too-many-openings
194 " ((()) " "(((((((" :skip-pair-string "ppppppp")
196 (define-electric-pair-test too-many-closings
197 " (())) " "(((((((" :skip-pair-string "------p")
199 (define-electric-pair-test too-many-closings-2
200 "() ) " "---(---" :skip-pair-string "-------")
202 (define-electric-pair-test too-many-closings-3
203 ")() " "(------" :skip-pair-string "-------")
205 (define-electric-pair-test balanced-autoskipping
206 " (()) " "---))--" :skip-pair-string "---ss--")
208 (define-electric-pair-test too-many-openings-autoskipping
209 " ((()) " "----))-" :skip-pair-string "-------")
211 (define-electric-pair-test too-many-closings-autoskipping
212 " (())) " "---)))-" :skip-pair-string "---sss-")
217 (define-electric-pair-test mixed-paren-1
218 " ()] " "-(-(---" :skip-pair-string "-p-p---")
220 (define-electric-pair-test mixed-paren-2
221 " [() " "-(-()--" :skip-pair-string "-p-ps--")
223 (define-electric-pair-test mixed-paren-3
224 " (]) " "-(-()--" :skip-pair-string "---ps--")
226 (define-electric-pair-test mixed-paren-4
227 " ()] " "---)]--" :skip-pair-string "---ss--")
229 (define-electric-pair-test mixed-paren-5
230 " [() " "----(--" :skip-pair-string "----p--")
232 (define-electric-pair-test find-matching-different-paren-type
233 " ()] " "-[-----" :skip-pair-string "-------")
235 (define-electric-pair-test find-matching-different-paren-type-inside-list
236 "( ()]) " "-[-----" :skip-pair-string "-------")
238 (define-electric-pair-test ignore-different-unmatching-paren-type
239 "( ()]) " "-(-----" :skip-pair-string "-p-----")
241 (define-electric-pair-test autopair-keep-least-amount-of-mixed-unbalance
242 "( ()] " "-(-----" :skip-pair-string "-p-----")
244 (define-electric-pair-test dont-autopair-to-resolve-mixed-unbalance
245 "( ()] " "-[-----" :skip-pair-string "-------")
247 (define-electric-pair-test autopair-so-as-not-to-worsen-unbalance-situation
248 "( (]) " "-[-----" :skip-pair-string "-p-----")
250 (define-electric-pair-test skip-over-partially-balanced
251 " [([]) " "-----)---" :skip-pair-string "-----s---")
253 (define-electric-pair-test only-skip-over-at-least-partially-balanced-stuff
254 " [([()) " "-----))--" :skip-pair-string "-----s---")
261 (define-electric-pair-test pair-some-quotes-skip-others
262 " \"\" " "-\"\"-----" :skip-pair-string "-ps------"
264 :bindings `((electric-pair-text-syntax-table
265 . ,prog-mode-syntax-table)))
267 (define-electric-pair-test skip-single-quotes-in-ruby-mode
268 " '' " "--'-" :skip-pair-string "--s-"
270 :test-in-comments nil
272 :bindings `((electric-pair-text-syntax-table
273 . ,prog-mode-syntax-table)))
275 (define-electric-pair-test leave-unbalanced-quotes-alone
276 " \"' " "-\"'-" :skip-pair-string "----"
279 :bindings `((electric-pair-text-syntax-table
280 . ,prog-mode-syntax-table)))
282 (define-electric-pair-test leave-unbalanced-quotes-alone-2
283 " \"\\\"' " "-\"--'-" :skip-pair-string "------"
286 :bindings `((electric-pair-text-syntax-table
287 . ,prog-mode-syntax-table)))
289 (define-electric-pair-test leave-unbalanced-quotes-alone-3
290 " foo\\''" "'------" :skip-pair-string "-------"
293 :bindings `((electric-pair-text-syntax-table
294 . ,prog-mode-syntax-table)))
296 (define-electric-pair-test inhibit-only-if-next-is-mismatched
298 :expected-string "\"\"\"foo\"\"bar"
301 :bindings `((electric-pair-text-syntax-table
302 . ,prog-mode-syntax-table)))
305 ;;; More quotes, but now don't bind `electric-pair-text-syntax-table'
306 ;;; to `prog-mode-syntax-table'. Use the defaults for
307 ;;; `electric-pair-pairs' and `electric-pair-text-pairs'.
309 (define-electric-pair-test pairing-skipping-quotes-in-code
310 " \"\" " "-\"\"-----" :skip-pair-string "-ps------"
312 :test-in-comments nil)
314 (define-electric-pair-test skipping-quotes-in-comments
315 " \"\" " "--\"-----" :skip-pair-string "--s------"
316 :test-in-strings nil)
319 ;;; Skipping over whitespace
321 (define-electric-pair-test whitespace-jumping
322 " ( ) " "--))))---" :expected-string " ( ) " :expected-point 8
323 :bindings '((electric-pair-skip-whitespace . t)))
325 (define-electric-pair-test whitespace-chomping
326 " ( ) " "--)------" :expected-string " () " :expected-point 4
327 :bindings '((electric-pair-skip-whitespace . chomp)))
329 (define-electric-pair-test whitespace-chomping-2
330 " ( \n\t\t\n ) " "--)------" :expected-string " () " :expected-point 4
331 :bindings '((electric-pair-skip-whitespace . chomp))
332 :test-in-comments nil)
334 (define-electric-pair-test whitespace-chomping-dont-cross-comments
335 " ( \n\t\t\n ) " "--)------" :expected-string " () \n\t\t\n ) "
337 :bindings '((electric-pair-skip-whitespace . chomp))
343 ;;; Pairing arbitrary characters
345 (define-electric-pair-test angle-brackets-everywhere
346 "<>" "<>" :skip-pair-string "ps"
347 :bindings '((electric-pair-pairs . ((?\< . ?\>)))))
349 (define-electric-pair-test angle-brackets-everywhere-2
350 "(<>" "-<>" :skip-pair-string "-ps"
351 :bindings '((electric-pair-pairs . ((?\< . ?\>)))))
353 (defvar electric-pair-test-angle-brackets-table
354 (let ((table (make-syntax-table prog-mode-syntax-table)))
355 (modify-syntax-entry ?\< "(>" table)
356 (modify-syntax-entry ?\> ")<`" table)
359 (define-electric-pair-test angle-brackets-pair
360 "<>" "<" :expected-string "<><>" :expected-point 2
362 :bindings `((electric-pair-text-syntax-table
363 . ,electric-pair-test-angle-brackets-table)))
365 (define-electric-pair-test angle-brackets-skip
366 "<>" "->" :expected-string "<>" :expected-point 3
368 :bindings `((electric-pair-text-syntax-table
369 . ,electric-pair-test-angle-brackets-table)))
371 (define-electric-pair-test pair-backtick-and-quote-in-comments
372 ";; " "---`" :expected-string ";; `'" :expected-point 5
373 :test-in-comments nil
375 :modes '(emacs-lisp-mode)
376 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
378 (define-electric-pair-test skip-backtick-and-quote-in-comments
379 ";; `foo'" "-------'" :expected-string ";; `foo'" :expected-point 9
380 :test-in-comments nil
382 :modes '(emacs-lisp-mode)
383 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
385 (define-electric-pair-test pair-backtick-and-quote-in-strings
386 "\"\"" "-`" :expected-string "\"`'\"" :expected-point 3
387 :test-in-comments nil
389 :modes '(emacs-lisp-mode)
390 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
392 (define-electric-pair-test skip-backtick-and-quote-in-strings
393 "\"`'\"" "--'" :expected-string "\"`'\"" :expected-point 4
394 :test-in-comments nil
396 :modes '(emacs-lisp-mode)
397 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
399 (define-electric-pair-test skip-backtick-and-quote-in-strings-2
400 " \"`'\"" "----'" :expected-string " \"`'\"" :expected-point 6
401 :test-in-comments nil
403 :modes '(emacs-lisp-mode)
404 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
407 ;;; `js-mode' has `electric-layout-rules' for '{ and '}
409 (define-electric-pair-test js-mode-braces
410 "" "{" :expected-string "{}" :expected-point 2
412 :fixture-fn #'(lambda ()
413 (electric-pair-mode 1)))
415 (define-electric-pair-test js-mode-braces-with-layout
416 "" "{" :expected-string "{\n\n}" :expected-point 3
418 :test-in-comments nil
420 :fixture-fn #'(lambda ()
421 (electric-layout-mode 1)
422 (electric-pair-mode 1)))
424 (define-electric-pair-test js-mode-braces-with-layout-and-indent
425 "" "{" :expected-string "{\n \n}" :expected-point 7
427 :test-in-comments nil
429 :fixture-fn #'(lambda ()
430 (electric-pair-mode 1)
431 (electric-indent-mode 1)
432 (electric-layout-mode 1)))
436 ;;; TODO: better tests
438 (ert-deftest electric-pair-backspace-1 ()
443 (electric-pair-backward-delete-char 1)
444 (should (equal "" (buffer-string))))))
447 ;;; Electric newlines between pairs
448 ;;; TODO: better tests
449 (ert-deftest electric-pair-open-extra-newline ()
453 (electric-pair-mode 1)
454 (electric-indent-mode 1)
455 (insert "int main {}")
457 (let ((c-basic-offset 4))
459 (should (equal "int main {\n \n}"
461 (should (equal (point) (- (point-max) 2)))))))
467 (define-electric-pair-test autowrapping-1
468 "foo" "(" :expected-string "(foo)" :expected-point 2
469 :fixture-fn #'(lambda ()
470 (electric-pair-mode 1)
473 (define-electric-pair-test autowrapping-2
474 "foo" ")" :expected-string "(foo)" :expected-point 6
475 :fixture-fn #'(lambda ()
476 (electric-pair-mode 1)
479 (define-electric-pair-test autowrapping-3
480 "foo" ")" :expected-string "(foo)" :expected-point 6
481 :fixture-fn #'(lambda ()
482 (electric-pair-mode 1)
483 (goto-char (point-max))
484 (skip-chars-backward "\"")
487 (define-electric-pair-test autowrapping-4
488 "foo" "(" :expected-string "(foo)" :expected-point 2
489 :fixture-fn #'(lambda ()
490 (electric-pair-mode 1)
491 (goto-char (point-max))
492 (skip-chars-backward "\"")
495 (define-electric-pair-test autowrapping-5
496 "foo" "\"" :expected-string "\"foo\"" :expected-point 2
497 :fixture-fn #'(lambda ()
498 (electric-pair-mode 1)
501 (define-electric-pair-test autowrapping-6
502 "foo" "\"" :expected-string "\"foo\"" :expected-point 6
503 :fixture-fn #'(lambda ()
504 (electric-pair-mode 1)
505 (goto-char (point-max))
506 (skip-chars-backward "\"")
509 (provide 'electric-tests)
510 ;;; electric-tests.el ends here