1 ;;; electric-tests.el --- tests for electric.el
3 ;; Copyright (C) 2013-2014 Free Software Foundation, Inc.
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/>.
23 ;; Tests for Electric Pair mode.
24 ;; TODO: Add tests for other Electric-* functionality
33 (defun call-with-saved-electric-modes (fn)
34 (let ((saved-electric (if electric-pair-mode 1 -1))
35 (saved-layout (if electric-layout-mode 1 -1))
36 (saved-indent (if electric-indent-mode 1 -1)))
37 (electric-pair-mode -1)
38 (electric-layout-mode -1)
39 (electric-indent-mode -1)
42 (electric-pair-mode saved-electric)
43 (electric-indent-mode saved-indent)
44 (electric-layout-mode saved-layout))))
46 (defmacro save-electric-modes (&rest body)
47 (declare (indent defun) (debug t))
48 `(call-with-saved-electric-modes #'(lambda () ,@body)))
50 (defun electric-pair-test-for (fixture where char expected-string
51 expected-point mode bindings fixture-fn)
56 (let ((last-command-event char)
57 (transient-mark-mode 'lambda))
61 (mapcar #'car bindings)
62 (mapcar #'cdr bindings)
63 (self-insert-command 1))))
64 (should (equal (buffer-substring-no-properties (point-min) (point-max))
66 (should (equal (point)
70 (defun electric-pair-define-test-form (name fixture
82 (let* ((expected-string-and-point
86 ;; FIXME: avoid `eval'
87 (mapcar #'car (eval bindings))
88 (mapcar #'cdr (eval bindings))
93 (cond ((eq (aref skip-pair-string pos)
95 (insert (cadr (electric-pair-syntax-info char)))
97 ((eq (aref skip-pair-string pos)
102 (buffer-substring-no-properties (point-min) (point-max))
104 (list expected-string expected-point)))
105 (expected-string (car expected-string-and-point))
106 (expected-point (cadr expected-string-and-point))
107 (fixture (format "%s%s%s" prefix fixture suffix))
108 (expected-string (format "%s%s%s" prefix expected-string suffix))
109 (expected-point (+ (length prefix) expected-point))
110 (pos (+ (length prefix) pos)))
111 `(ert-deftest ,(intern (format "electric-pair-%s-at-point-%s-in-%s%s"
117 ,(format "With \"%s\", try input %c at point %d. \
118 Should %s \"%s\" and point at %d"
122 (if (string= fixture expected-string)
125 (replace-regexp-in-string "\n" "\\\\n" expected-string)
127 (electric-pair-test-for ,fixture
136 (cl-defmacro define-electric-pair-test
144 (modes '(quote (ruby-mode c++-mode)))
148 (fixture-fn #'(lambda ()
149 (electric-pair-mode 1))))
152 for mode in (eval modes) ;FIXME: avoid `eval'
155 for (prefix suffix extra-desc) in
156 (append (if test-in-comments
157 `((,(with-temp-buffer
160 (comment-region (point-min) (point-max))
161 (buffer-substring-no-properties (point-min)
166 `(("\"" "\"" "-in-strings")))
171 for char across input
174 collect (electric-pair-define-test-form
189 ;;; Basic pairs and skips
191 (define-electric-pair-test balanced-situation
192 " (()) " "(((((((" :skip-pair-string "ppppppp"
195 (define-electric-pair-test too-many-openings
196 " ((()) " "(((((((" :skip-pair-string "ppppppp")
198 (define-electric-pair-test too-many-closings
199 " (())) " "(((((((" :skip-pair-string "------p")
201 (define-electric-pair-test too-many-closings-2
202 "() ) " "---(---" :skip-pair-string "-------")
204 (define-electric-pair-test too-many-closings-3
205 ")() " "(------" :skip-pair-string "-------")
207 (define-electric-pair-test balanced-autoskipping
208 " (()) " "---))--" :skip-pair-string "---ss--")
210 (define-electric-pair-test too-many-openings-autoskipping
211 " ((()) " "----))-" :skip-pair-string "-------")
213 (define-electric-pair-test too-many-closings-autoskipping
214 " (())) " "---)))-" :skip-pair-string "---sss-")
219 (define-electric-pair-test mixed-paren-1
220 " ()] " "-(-(---" :skip-pair-string "-p-p---")
222 (define-electric-pair-test mixed-paren-2
223 " [() " "-(-()--" :skip-pair-string "-p-ps--")
225 (define-electric-pair-test mixed-paren-3
226 " (]) " "-(-()--" :skip-pair-string "---ps--")
228 (define-electric-pair-test mixed-paren-4
229 " ()] " "---)]--" :skip-pair-string "---ss--")
231 (define-electric-pair-test mixed-paren-5
232 " [() " "----(--" :skip-pair-string "----p--")
234 (define-electric-pair-test find-matching-different-paren-type
235 " ()] " "-[-----" :skip-pair-string "-------")
237 (define-electric-pair-test find-matching-different-paren-type-inside-list
238 "( ()]) " "-[-----" :skip-pair-string "-------")
240 (define-electric-pair-test ignore-different-nonmatching-paren-type
241 "( ()]) " "-(-----" :skip-pair-string "-p-----")
243 (define-electric-pair-test autopair-keep-least-amount-of-mixed-unbalance
244 "( ()] " "-(-----" :skip-pair-string "-p-----")
246 (define-electric-pair-test dont-autopair-to-resolve-mixed-unbalance
247 "( ()] " "-[-----" :skip-pair-string "-------")
249 (define-electric-pair-test autopair-so-as-not-to-worsen-unbalance-situation
250 "( (]) " "-[-----" :skip-pair-string "-p-----")
252 (define-electric-pair-test skip-over-partially-balanced
253 " [([]) " "-----)---" :skip-pair-string "-----s---")
255 (define-electric-pair-test only-skip-over-at-least-partially-balanced-stuff
256 " [([()) " "-----))--" :skip-pair-string "-----s---")
263 (define-electric-pair-test pair-some-quotes-skip-others
264 " \"\" " "-\"\"-----" :skip-pair-string "-ps------"
266 :bindings `((electric-pair-text-syntax-table
267 . ,prog-mode-syntax-table)))
269 (define-electric-pair-test skip-single-quotes-in-ruby-mode
270 " '' " "--'-" :skip-pair-string "--s-"
272 :test-in-comments nil
274 :bindings `((electric-pair-text-syntax-table
275 . ,prog-mode-syntax-table)))
277 (define-electric-pair-test leave-unbalanced-quotes-alone
278 " \"' " "-\"'-" :skip-pair-string "----"
281 :bindings `((electric-pair-text-syntax-table
282 . ,prog-mode-syntax-table)))
284 (define-electric-pair-test leave-unbalanced-quotes-alone-2
285 " \"\\\"' " "-\"--'-" :skip-pair-string "------"
288 :bindings `((electric-pair-text-syntax-table
289 . ,prog-mode-syntax-table)))
291 (define-electric-pair-test leave-unbalanced-quotes-alone-3
292 " foo\\''" "'------" :skip-pair-string "-------"
295 :bindings `((electric-pair-text-syntax-table
296 . ,prog-mode-syntax-table)))
298 (define-electric-pair-test inhibit-if-strings-mismatched
300 :expected-string "\"\"foo\"\"bar"
303 :bindings `((electric-pair-text-syntax-table
304 . ,prog-mode-syntax-table)))
306 (define-electric-pair-test inhibit-in-mismatched-string-inside-ruby-comments
317 :test-in-comments nil
327 :fixture-fn #'(lambda () (goto-char (point-min)) (search-forward "bar")))
329 (define-electric-pair-test inhibit-in-mismatched-string-inside-c-comments
338 :test-in-comments nil
346 :fixture-fn #'(lambda () (goto-char (point-min)) (search-forward "bar")))
349 ;;; More quotes, but now don't bind `electric-pair-text-syntax-table'
350 ;;; to `prog-mode-syntax-table'. Use the defaults for
351 ;;; `electric-pair-pairs' and `electric-pair-text-pairs'.
353 (define-electric-pair-test pairing-skipping-quotes-in-code
354 " \"\" " "-\"\"-----" :skip-pair-string "-ps------"
356 :test-in-comments nil)
358 (define-electric-pair-test skipping-quotes-in-comments
359 " \"\" " "--\"-----" :skip-pair-string "--s------"
360 :test-in-strings nil)
363 ;;; Skipping over whitespace
365 (define-electric-pair-test whitespace-jumping
366 " ( ) " "--))))---" :expected-string " ( ) " :expected-point 8
367 :bindings '((electric-pair-skip-whitespace . t)))
369 (define-electric-pair-test whitespace-chomping
370 " ( ) " "--)------" :expected-string " () " :expected-point 4
371 :bindings '((electric-pair-skip-whitespace . chomp)))
373 (define-electric-pair-test whitespace-chomping-2
374 " ( \n\t\t\n ) " "--)------" :expected-string " () " :expected-point 4
375 :bindings '((electric-pair-skip-whitespace . chomp))
376 :test-in-comments nil)
378 (define-electric-pair-test whitespace-chomping-dont-cross-comments
379 " ( \n\t\t\n ) " "--)------" :expected-string " () \n\t\t\n ) "
381 :bindings '((electric-pair-skip-whitespace . chomp))
387 ;;; Pairing arbitrary characters
389 (define-electric-pair-test angle-brackets-everywhere
390 "<>" "<>" :skip-pair-string "ps"
391 :bindings '((electric-pair-pairs . ((?\< . ?\>)))))
393 (define-electric-pair-test angle-brackets-everywhere-2
394 "(<>" "-<>" :skip-pair-string "-ps"
395 :bindings '((electric-pair-pairs . ((?\< . ?\>)))))
397 (defvar electric-pair-test-angle-brackets-table
398 (let ((table (make-syntax-table prog-mode-syntax-table)))
399 (modify-syntax-entry ?\< "(>" table)
400 (modify-syntax-entry ?\> ")<`" table)
403 (define-electric-pair-test angle-brackets-pair
404 "<>" "<" :expected-string "<><>" :expected-point 2
406 :bindings `((electric-pair-text-syntax-table
407 . ,electric-pair-test-angle-brackets-table)))
409 (define-electric-pair-test angle-brackets-skip
410 "<>" "->" :expected-string "<>" :expected-point 3
412 :bindings `((electric-pair-text-syntax-table
413 . ,electric-pair-test-angle-brackets-table)))
415 (define-electric-pair-test pair-backtick-and-quote-in-comments
416 ";; " "---`" :expected-string ";; `'" :expected-point 5
417 :test-in-comments nil
419 :modes '(emacs-lisp-mode)
420 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
422 (define-electric-pair-test skip-backtick-and-quote-in-comments
423 ";; `foo'" "-------'" :expected-string ";; `foo'" :expected-point 9
424 :test-in-comments nil
426 :modes '(emacs-lisp-mode)
427 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
429 (define-electric-pair-test pair-backtick-and-quote-in-strings
430 "\"\"" "-`" :expected-string "\"`'\"" :expected-point 3
431 :test-in-comments nil
433 :modes '(emacs-lisp-mode)
434 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
436 (define-electric-pair-test skip-backtick-and-quote-in-strings
437 "\"`'\"" "--'" :expected-string "\"`'\"" :expected-point 4
438 :test-in-comments nil
440 :modes '(emacs-lisp-mode)
441 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
443 (define-electric-pair-test skip-backtick-and-quote-in-strings-2
444 " \"`'\"" "----'" :expected-string " \"`'\"" :expected-point 6
445 :test-in-comments nil
447 :modes '(emacs-lisp-mode)
448 :bindings '((electric-pair-text-pairs . ((?\` . ?\')))))
451 ;;; `js-mode' has `electric-layout-rules' for '{ and '}
453 (define-electric-pair-test js-mode-braces
454 "" "{" :expected-string "{}" :expected-point 2
456 :fixture-fn #'(lambda ()
457 (electric-pair-mode 1)))
459 (define-electric-pair-test js-mode-braces-with-layout
460 "" "{" :expected-string "{\n\n}" :expected-point 3
462 :test-in-comments nil
464 :fixture-fn #'(lambda ()
465 (electric-layout-mode 1)
466 (electric-pair-mode 1)))
468 (define-electric-pair-test js-mode-braces-with-layout-and-indent
469 "" "{" :expected-string "{\n \n}" :expected-point 7
471 :test-in-comments nil
473 :fixture-fn #'(lambda ()
474 (electric-pair-mode 1)
475 (electric-indent-mode 1)
476 (electric-layout-mode 1)))
480 ;;; TODO: better tests
482 (ert-deftest electric-pair-backspace-1 ()
487 (electric-pair-backward-delete-char 1)
488 (should (equal "" (buffer-string))))))
491 ;;; Electric newlines between pairs
492 ;;; TODO: better tests
493 (ert-deftest electric-pair-open-extra-newline ()
497 (electric-pair-mode 1)
498 (electric-indent-mode 1)
499 (insert "int main {}")
501 (let ((c-basic-offset 4))
503 (should (equal "int main {\n \n}"
505 (should (equal (point) (- (point-max) 2)))))))
511 (define-electric-pair-test autowrapping-1
512 "foo" "(" :expected-string "(foo)" :expected-point 2
513 :fixture-fn #'(lambda ()
514 (electric-pair-mode 1)
517 (define-electric-pair-test autowrapping-2
518 "foo" ")" :expected-string "(foo)" :expected-point 6
519 :fixture-fn #'(lambda ()
520 (electric-pair-mode 1)
523 (define-electric-pair-test autowrapping-3
524 "foo" ")" :expected-string "(foo)" :expected-point 6
525 :fixture-fn #'(lambda ()
526 (electric-pair-mode 1)
527 (goto-char (point-max))
528 (skip-chars-backward "\"")
531 (define-electric-pair-test autowrapping-4
532 "foo" "(" :expected-string "(foo)" :expected-point 2
533 :fixture-fn #'(lambda ()
534 (electric-pair-mode 1)
535 (goto-char (point-max))
536 (skip-chars-backward "\"")
539 (define-electric-pair-test autowrapping-5
540 "foo" "\"" :expected-string "\"foo\"" :expected-point 2
541 :fixture-fn #'(lambda ()
542 (electric-pair-mode 1)
545 (define-electric-pair-test autowrapping-6
546 "foo" "\"" :expected-string "\"foo\"" :expected-point 6
547 :fixture-fn #'(lambda ()
548 (electric-pair-mode 1)
549 (goto-char (point-max))
550 (skip-chars-backward "\"")
553 (provide 'electric-tests)
554 ;;; electric-tests.el ends here