1 ;;; yasnippet-tests.el --- some yasnippet tests -*- lexical-binding: t -*-
3 ;; Copyright (C) 2012, 2013, 2014, 2015 Free Software Foundation, Inc.
5 ;; Author: João Távora <joaot@siscog.pt>
6 ;; Keywords: emulations, convenience
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 ;; Test basic snippet mechanics and the loading system
35 (defun yas--buffer-contents ()
36 (buffer-substring-no-properties (point-min) (point-max)))
38 (ert-deftest field-navigation ()
41 (yas-expand-snippet "${1:brother} from another ${2:mother}")
42 (should (string= (yas--buffer-contents)
43 "brother from another mother"))
45 (should (looking-at "brother"))
46 (ert-simulate-command '(yas-next-field-or-maybe-expand))
47 (should (looking-at "mother"))
48 (ert-simulate-command '(yas-prev-field))
49 (should (looking-at "brother"))))
51 (ert-deftest simple-mirror ()
54 (yas-expand-snippet "${1:brother} from another $1")
55 (should (string= (yas--buffer-contents)
56 "brother from another brother"))
57 (yas-mock-insert "bla")
58 (should (string= (yas--buffer-contents)
59 "bla from another bla"))))
61 (ert-deftest mirror-with-transformation ()
64 (yas-expand-snippet "${1:brother} from another ${1:$(upcase yas-text)}")
65 (should (string= (yas--buffer-contents)
66 "brother from another BROTHER"))
67 (yas-mock-insert "bla")
68 (should (string= (yas--buffer-contents)
69 "bla from another BLA"))))
71 (ert-deftest mirror-with-transformation-and-autofill ()
72 "Test interaction of autofill with mirror transforms"
73 (let ((words "one two three four five")
76 (c-mode) ; In `c-mode' filling comments works by narrowing.
80 (yas-expand-snippet "/* $0\n */")
81 (yas-mock-insert words)
82 (setq filled-words (delete-and-extract-region (point-min) (point-max)))
83 (yas-expand-snippet "/* $1\n */\n$2$2")
84 (should (string= (yas--buffer-contents)
86 (yas-mock-insert words)
87 (should (string= (yas--buffer-contents)
88 (concat filled-words "\n"))))))
91 (ert-deftest primary-field-transformation ()
94 (let ((snippet "${1:$$(upcase yas-text)}${1:$(concat \"bar\" yas-text)}"))
95 (yas-expand-snippet snippet)
96 (should (string= (yas--buffer-contents) "bar"))
97 (yas-mock-insert "foo")
98 (should (string= (yas--buffer-contents) "FOObarFOO")))))
100 (ert-deftest nested-placeholders-kill-superfield ()
103 (yas-expand-snippet "brother from ${2:another ${3:mother}}!")
104 (should (string= (yas--buffer-contents)
105 "brother from another mother!"))
106 (yas-mock-insert "bla")
107 (should (string= (yas--buffer-contents)
108 "brother from bla!"))))
110 (ert-deftest nested-placeholders-use-subfield ()
113 (yas-expand-snippet "brother from ${2:another ${3:mother}}!")
114 (ert-simulate-command '(yas-next-field-or-maybe-expand))
115 (yas-mock-insert "bla")
116 (should (string= (yas--buffer-contents)
117 "brother from another bla!"))))
119 (ert-deftest mirrors-adjacent-to-fields-with-nested-mirrors ()
122 (yas-expand-snippet "<%= f.submit \"${1:Submit}\"${2:$(and (yas-text) \", :disable_with => '\")}${2:$1ing...}${2:$(and (yas-text) \"'\")} %>")
123 (should (string= (yas--buffer-contents)
124 "<%= f.submit \"Submit\", :disable_with => 'Submiting...' %>"))
125 (yas-mock-insert "Send")
126 (should (string= (yas--buffer-contents)
127 "<%= f.submit \"Send\", :disable_with => 'Sending...' %>"))))
129 (ert-deftest deep-nested-mirroring-issue-351 ()
132 (yas-expand-snippet "${1:FOOOOOOO}${2:$1}${3:$2}${4:$3}")
133 (yas-mock-insert "abc")
134 (should (string= (yas--buffer-contents) "abcabcabcabc"))))
136 (ert-deftest delete-numberless-inner-snippet-issue-562 ()
139 (yas-expand-snippet "${3:${test}bla}$0${2:ble}")
140 (ert-simulate-command '(yas-next-field-or-maybe-expand))
141 (should (looking-at "testblable"))
142 (ert-simulate-command '(yas-next-field-or-maybe-expand))
143 (ert-simulate-command '(yas-skip-and-clear-or-delete-char))
144 (should (looking-at "ble"))
145 (should (null (yas--snippets-at-point)))))
147 (ert-deftest ignore-trailing-whitespace ()
150 (insert "# key: foo\n# --\nfoo")
151 (yas--parse-template))
153 (insert "# key: foo \n# --\nfoo")
154 (yas--parse-template)))))
156 ;; (ert-deftest in-snippet-undo ()
158 ;; (yas-minor-mode 1)
159 ;; (yas-expand-snippet "brother from ${2:another ${3:mother}}!")
160 ;; (ert-simulate-command '(yas-next-field-or-maybe-expand))
161 ;; (yas-mock-insert "bla")
162 ;; (ert-simulate-command '(undo))
163 ;; (should (string= (yas--buffer-contents)
164 ;; "brother from another mother!"))))
166 (ert-deftest dont-clear-on-partial-deletion-issue-515 ()
167 "Ensure fields are not cleared when user doesn't really mean to."
170 (yas-expand-snippet "my ${1:kid brother} from another ${2:mother}")
172 (ert-simulate-command '(kill-word 1))
173 (ert-simulate-command '(delete-char 1))
175 (should (string= (yas--buffer-contents)
176 "my brother from another mother"))
177 (should (looking-at "brother"))
179 (ert-simulate-command '(yas-next-field))
180 (should (looking-at "mother"))
181 (ert-simulate-command '(yas-prev-field))
182 (should (looking-at "brother"))))
184 (ert-deftest do-clear-on-yank-issue-515 ()
185 "A yank should clear an unmodified field."
188 (yas-expand-snippet "my ${1:kid brother} from another ${2:mother}")
189 (yas-mock-yank "little sibling")
190 (should (string= (yas--buffer-contents)
191 "my little sibling from another mother"))
192 (ert-simulate-command '(yas-next-field))
193 (ert-simulate-command '(yas-prev-field))
194 (should (looking-at "little sibling"))))
197 ;;; Snippet expansion and character escaping
198 ;;; Thanks to @zw963 (Billy) for the testing
200 (ert-deftest escape-dollar ()
203 (yas-expand-snippet "bla\\${1:bla}ble")
204 (should (string= (yas--buffer-contents) "bla${1:bla}ble"))))
206 (ert-deftest escape-closing-brace ()
209 (yas-expand-snippet "bla${1:bla\\}}ble")
210 (should (string= (yas--buffer-contents) "blabla}ble"))
211 (should (string= (yas-field-value 1) "bla}"))))
213 (ert-deftest escape-backslashes ()
216 (yas-expand-snippet "bla\\ble")
217 (should (string= (yas--buffer-contents) "bla\\ble"))))
219 (ert-deftest escape-backquotes ()
222 (yas-expand-snippet "bla`(upcase \"foo\\`bar\")`ble")
223 (should (string= (yas--buffer-contents) "blaFOO`BARble"))))
225 (ert-deftest escape-some-elisp-with-strings ()
226 "elisp with strings and unbalance parens inside it"
229 ;; The rules here is: to output a literal `"' you need to escape
230 ;; it with one backslash. You don't need to escape them in
232 (yas-expand-snippet "soon \\\"`(concat (upcase \"(my arms\")\"\\\" were all around her\")`")
233 (should (string= (yas--buffer-contents) "soon \"(MY ARMS\" were all around her"))))
235 (ert-deftest escape-some-elisp-with-backslashes ()
238 ;; And the rule here is: to output a literal `\' inside a string
239 ;; inside embedded elisp you need a total of six `\'
240 (yas-expand-snippet "bla`(upcase \"hey\\\\\\yo\")`ble")
241 (should (string= (yas--buffer-contents) "blaHEY\\YOble"))))
243 (ert-deftest be-careful-when-escaping-in-yas-selected-text ()
246 (let ((yas-selected-text "He\\\\o world!"))
247 (yas-expand-snippet "Look ma! `(yas-selected-text)`")
248 (should (string= (yas--buffer-contents) "Look ma! He\\\\o world!")))
249 (yas-exit-all-snippets)
251 (let ((yas-selected-text "He\"o world!"))
252 (yas-expand-snippet "Look ma! `(yas-selected-text)`")
253 (should (string= (yas--buffer-contents) "Look ma! He\"o world!")))
254 (yas-exit-all-snippets)
256 (let ((yas-selected-text "He\"\)\\o world!"))
257 (yas-expand-snippet "Look ma! `(yas-selected-text)`")
258 (should (string= (yas--buffer-contents) "Look ma! He\"\)\\o world!")))
259 (yas-exit-all-snippets)
262 (ert-deftest be-careful-when-escaping-in-yas-selected-text-2 ()
265 (let ((yas-selected-text "He)}o world!"))
266 (yas-expand-snippet "Look ma! ${1:`(yas-selected-text)`} OK?")
267 (should (string= (yas--buffer-contents) "Look ma! He)}o world! OK?")))))
269 (ert-deftest example-for-issue-271 ()
272 (let ((yas-selected-text "aaa")
273 (snippet "if ${1:condition}\n`yas-selected-text`\nelse\n$3\nend"))
274 (yas-expand-snippet snippet)
276 (yas-mock-insert "bbb")
277 (should (string= (yas--buffer-contents) "if condition\naaa\nelse\nbbb\nend")))))
279 (defmacro yas--with-font-locked-temp-buffer (&rest body)
280 "Like `with-temp-buffer', but ensure `font-lock-mode'."
281 (declare (indent 0) (debug t))
282 (let ((temp-buffer (make-symbol "temp-buffer")))
283 ;; NOTE: buffer name must not start with a space, otherwise
284 ;; `font-lock-mode' doesn't turn on.
285 `(let ((,temp-buffer (generate-new-buffer "*yas-temp*")))
286 (with-current-buffer ,temp-buffer
287 ;; pretend we're interactive so `font-lock-mode' turns on
288 (let ((noninteractive nil)
289 ;; turn on font locking after major mode change
290 (change-major-mode-after-body-hook #'font-lock-mode))
292 (progn (require 'font-lock)
293 ;; turn on font locking before major mode change
296 (and (buffer-name ,temp-buffer)
297 (kill-buffer ,temp-buffer))))))))
299 (defmacro yas-saving-variables (&rest body)
300 `(yas-call-with-saving-variables #'(lambda () ,@body)))
302 (defmacro yas-with-snippet-dirs (dirs &rest body)
303 (declare (indent defun))
304 `(yas-call-with-snippet-dirs ,dirs
308 (ert-deftest example-for-issue-474 ()
309 (yas--with-font-locked-temp-buffer
312 (insert "#include <foo>\n")
313 (let ((yas-good-grace nil)) (yas-expand-snippet "`\"TODO: \"`"))
314 (should (string= (yas--buffer-contents) "#include <foo>\nTODO: "))))
316 (ert-deftest example-for-issue-404 ()
317 (yas--with-font-locked-temp-buffer
320 (insert "#include <foo>\n")
321 (let ((yas-good-grace nil)) (yas-expand-snippet "main"))
322 (should (string= (yas--buffer-contents) "#include <foo>\nmain"))))
324 (ert-deftest example-for-issue-404-c-mode ()
325 (yas--with-font-locked-temp-buffer
328 (insert "#include <foo>\n")
329 (let ((yas-good-grace nil)) (yas-expand-snippet "main"))
330 (should (string= (yas--buffer-contents) "#include <foo>\nmain"))))
332 (ert-deftest middle-of-buffer-snippet-insertion ()
336 (save-excursion (insert "end"))
337 (yas-expand-snippet "-middle-")
338 (should (string= (yas--buffer-contents) "beginning-middle-end"))))
340 (ert-deftest another-example-for-issue-271 ()
341 ;; expect this to fail in batch mode since `region-active-p' doesn't
342 ;; used by `yas-expand-snippet' doesn't make sense in that context.
344 :expected-result (if noninteractive
349 (let ((snippet "\\${${1:1}:`yas-selected-text`}"))
353 (yas-expand-snippet snippet)
354 (should (string= (yas--buffer-contents) "aaa${1:bbb}ccc")))))
356 (ert-deftest string-match-with-subregexp-in-embedded-elisp ()
359 ;; the rule here is: To use regexps in embedded `(elisp)` expressions, write
360 ;; it like you would normal elisp, i.e. no need to escape the backslashes.
361 (let ((snippet "`(if (string-match \"foo\\\\(ba+r\\\\)foo\" \"foobaaaaaaaaaarfoo\")
364 (yas-expand-snippet snippet))
365 (should (string= (yas--buffer-contents) "ok"))))
367 (ert-deftest string-match-with-subregexp-in-mirror-transformations ()
370 ;; the rule here is: To use regexps in embedded `(elisp)` expressions,
371 ;; escape backslashes once, i.e. to use \\( \\) constructs, write \\\\( \\\\).
372 (let ((snippet "$1${1:$(if (string-match \"foo\\\\\\\\(ba+r\\\\\\\\)baz\" yas-text)
375 (yas-expand-snippet snippet)
376 (should (string= (yas--buffer-contents) "fail"))
377 (yas-mock-insert "foobaaar")
378 (should (string= (yas--buffer-contents) "foobaaarfail"))
379 (yas-mock-insert "baz")
380 (should (string= (yas--buffer-contents) "foobaaarbazok")))))
385 (ert-deftest protection-overlay-no-cheating ()
386 "Protection overlays at the very end of the buffer are dealt
387 with by cheatingly inserting a newline!
389 TODO: correct this bug!"
390 :expected-result :failed
393 (yas-expand-snippet "${2:brother} from another ${1:mother}")
394 (should (string= (yas--buffer-contents)
395 "brother from another mother") ;; no newline should be here!
399 (defvar yas--foobarbaz)
401 ;; See issue #497. To understand this test, follow the example of the
402 ;; `yas-key-syntaxes' docstring.
404 (ert-deftest complicated-yas-key-syntaxes ()
406 (yas-saving-variables
407 (yas-with-snippet-dirs
408 '((".emacs.d/snippets"
410 ("foo-barbaz" . "# condition: yas--foobarbaz\n# --\nOKfoo-barbazOK")
411 ("barbaz" . "# condition: yas--barbaz\n# --\nOKbarbazOK")
413 ("'quote" . "OKquoteOK"))))
417 (let ((yas-key-syntaxes '("w" "w_")))
418 (let ((yas--barbaz t))
419 (yas-should-expand '(("foo-barbaz" . "foo-OKbarbazOK")
420 ("barbaz" . "OKbarbazOK"))))
421 (let ((yas--foobarbaz t))
422 (yas-should-expand '(("foo-barbaz" . "OKfoo-barbazOK"))))
423 (let ((yas-key-syntaxes
424 (cons #'(lambda (_start-point)
425 (unless (looking-back "-")
430 (yas-should-expand '(("foo-barbaz" . "foo-barOKbazOK")))))
431 (let ((yas-key-syntaxes '(yas-try-key-from-whitespace)))
432 (yas-should-expand '(("xxx\n'quote" . "xxx\nOKquoteOK")
433 ("xxx 'quote" . "xxx OKquoteOK"))))
434 (let ((yas-key-syntaxes '(yas-shortest-key-until-whitespace))
435 (yas--foobarbaz t) (yas--barbaz t))
436 (yas-should-expand '(("foo-barbaz" . "foo-barOKbazOK")))
437 (setq yas-key-syntaxes '(yas-longest-key-from-whitespace))
438 (yas-should-expand '(("foo-barbaz" . "OKfoo-barbazOK")
439 ("foo " . "foo "))))))))
444 (defun yas--call-with-temporary-redefinitions (function
445 &rest function-names-and-overriding-functions)
446 (let* ((overrides (remove-if-not #'(lambda (fdef)
447 (fboundp (first fdef)))
448 function-names-and-overriding-functions))
449 (definition-names (mapcar #'first overrides))
450 (overriding-functions (mapcar #'second overrides))
451 (saved-functions (mapcar #'symbol-function definition-names)))
452 ;; saving all definitions before overriding anything ensures FDEFINITION
453 ;; errors don't cause accidental permanent redefinitions.
455 (cl-labels ((set-fdefinitions (names functions)
456 (loop for name in names
459 (set-fdefinitions definition-names overriding-functions)
460 (unwind-protect (funcall function)
461 (set-fdefinitions definition-names saved-functions)))))
463 (defmacro yas--with-temporary-redefinitions (fdefinitions &rest body)
464 ;; "Temporarily (but globally) redefine each function in FDEFINITIONS.
465 ;; E.g.: (yas--with-temporary-redefinitions ((foo (x) ...)
467 ;; ;; code that eventually calls foo, bar of (setf foo)
469 ;; FIXME: This is hideous! Better use defadvice (or at least letf).
470 `(yas--call-with-temporary-redefinitions
472 ,@(mapcar #'(lambda (thingy)
473 `(list ',(first thingy)
474 (lambda ,@(rest thingy))))
477 (defmacro yas-with-overriden-buffer-list (&rest body)
478 (let ((saved-sym (make-symbol "yas--buffer-list")))
479 `(let ((,saved-sym (symbol-function 'buffer-list)))
480 (yas--with-temporary-redefinitions
482 (remove-if #'(lambda (buf)
483 (with-current-buffer buf
484 (eq major-mode 'lisp-interaction-mode)))
485 (funcall ,saved-sym))))
489 (defmacro yas-with-some-interesting-snippet-dirs (&rest body)
490 `(yas-saving-variables
491 (yas-with-overriden-buffer-list
492 (yas-with-snippet-dirs
493 '((".emacs.d/snippets"
495 (".yas-parents" . "cc-mode")
496 ("printf" . "printf($1);")) ;; notice the overriding for issue #281
497 ("emacs-lisp-mode" ("ert-deftest" . "(ert-deftest ${1:name} () $0)"))
498 ("lisp-interaction-mode" (".yas-parents" . "emacs-lisp-mode")))
501 (".yas-parents" . "c++-mode")
502 ("printf" . "printf"))
503 ("cc-mode" ("def" . "# define"))
504 ("emacs-lisp-mode" ("dolist" . "(dolist)"))
505 ("lisp-interaction-mode" ("sc" . "brother from another mother"))))
508 (ert-deftest snippet-lookup ()
509 "Test `yas-lookup-snippet'."
510 (yas-with-some-interesting-snippet-dirs
511 (yas-reload-all 'no-jit)
512 (should (equal (yas-lookup-snippet "printf" 'c-mode) "printf($1);"))
513 (should (equal (yas-lookup-snippet "def" 'c-mode) "# define"))
514 (should-not (yas-lookup-snippet "no such snippet" nil 'noerror))
515 (should-not (yas-lookup-snippet "printf" 'emacs-lisp-mode 'noerror))))
517 (ert-deftest basic-jit-loading ()
518 "Test basic loading and expansion of snippets"
519 (yas-with-some-interesting-snippet-dirs
521 (yas--basic-jit-loading-1)))
523 (ert-deftest basic-jit-loading-with-compiled-snippets ()
524 "Test basic loading and expansion of compiled snippets"
525 (yas-with-some-interesting-snippet-dirs
528 (yas--with-temporary-redefinitions ((yas--load-directory-2
530 (ert-fail "yas--load-directory-2 shouldn't be called when snippets have been compiled")))
532 (yas--basic-jit-loading-1))))
534 (ert-deftest visiting-compiled-snippets ()
535 "Test snippet visiting for compiled snippets."
536 (yas-with-some-interesting-snippet-dirs
538 (yas-reload-all 'no-jit) ; must be loaded for `yas-lookup-snippet' to work.
539 (yas--with-temporary-redefinitions ((find-file-noselect
541 (throw 'yas-snippet-file filename)))
542 (should (string-suffix-p
544 (catch 'yas-snippet-file
545 (yas--visit-snippet-file-1
546 (yas--lookup-snippet-1 "def" 'cc-mode))))))))
548 (ert-deftest loading-with-cyclic-parenthood ()
549 "Test loading when cyclic parenthood is setup."
550 (yas-saving-variables
551 (yas-with-snippet-dirs '((".emacs.d/snippets"
553 (".yas-parents" . "cc-mode"))
555 (".yas-parents" . "yet-another-c-mode and-that-one"))
556 ("yet-another-c-mode"
557 (".yas-parents" . "c-mode and-also-this-one lisp-interaction-mode"))))
560 (let* ((major-mode 'c-mode)
566 ;; prog-mode doesn't exist in emacs 24.3
567 ,@(if (fboundp 'prog-mode)
570 lisp-interaction-mode))
571 (observed (yas--modes-to-activate)))
572 (should (equal major-mode (car observed)))
573 (should (equal (sort expected #'string<) (sort observed #'string<))))))))
575 (ert-deftest extra-modes-parenthood ()
576 "Test activation of parents of `yas--extra-modes'."
577 (yas-saving-variables
578 (yas-with-snippet-dirs '((".emacs.d/snippets"
580 (".yas-parents" . "cc-mode"))
581 ("yet-another-c-mode"
582 (".yas-parents" . "c-mode and-also-this-one lisp-interaction-mode"))))
585 (yas-activate-extra-mode 'c-mode)
586 (yas-activate-extra-mode 'yet-another-c-mode)
587 (yas-activate-extra-mode 'and-that-one)
588 (let* ((expected-first `(and-that-one
592 (expected-rest `(cc-mode
593 ;; prog-mode doesn't exist in emacs 24.3
594 ,@(if (fboundp 'prog-mode)
598 lisp-interaction-mode))
599 (observed (yas--modes-to-activate)))
600 (should (equal expected-first
601 (cl-subseq observed 0 (length expected-first))))
602 (should (equal (sort expected-rest #'string<)
603 (sort (cl-subseq observed (length expected-first)) #'string<))))))))
605 (defalias 'yas--phony-c-mode 'c-mode)
607 (ert-deftest issue-492-and-494 ()
608 (define-derived-mode yas--test-mode yas--phony-c-mode "Just a test mode")
609 (yas-with-snippet-dirs '((".emacs.d/snippets"
613 (let* ((major-mode 'yas--test-mode)
615 ,@(if (fboundp 'prog-mode)
619 (observed (yas--modes-to-activate)))
620 (should (null (cl-set-exclusive-or expected observed)))
621 (should (= (length expected)
622 (length observed)))))))
624 (define-derived-mode yas--test-mode c-mode "Just a test mode")
625 (define-derived-mode yas--another-test-mode c-mode "Another test mode")
627 (ert-deftest issue-504-tricky-jit ()
628 (yas-with-snippet-dirs
629 '((".emacs.d/snippets"
630 ("yas--another-test-mode"
631 (".yas-parents" . "yas--test-mode"))
633 (let ((b (with-current-buffer (generate-new-buffer "*yas-test*")
634 (yas--another-test-mode)
639 (should (= 0 (hash-table-count yas--scheduled-jit-loads))))
642 (defun yas--basic-jit-loading-1 ()
644 (should (= 4 (hash-table-count yas--scheduled-jit-loads)))
645 (should (= 0 (hash-table-count yas--tables)))
646 (lisp-interaction-mode)
648 (should (= 2 (hash-table-count yas--scheduled-jit-loads)))
649 (should (= 2 (hash-table-count yas--tables)))
650 (should (= 1 (hash-table-count (yas--table-uuidhash (gethash 'lisp-interaction-mode yas--tables)))))
651 (should (= 2 (hash-table-count (yas--table-uuidhash (gethash 'emacs-lisp-mode yas--tables)))))
652 (yas-should-expand '(("sc" . "brother from another mother")
653 ("dolist" . "(dolist)")
654 ("ert-deftest" . "(ert-deftest name () )")))
657 (should (= 0 (hash-table-count yas--scheduled-jit-loads)))
658 (should (= 4 (hash-table-count yas--tables)))
659 (should (= 1 (hash-table-count (yas--table-uuidhash (gethash 'c-mode yas--tables)))))
660 (should (= 1 (hash-table-count (yas--table-uuidhash (gethash 'cc-mode yas--tables)))))
661 (yas-should-expand '(("printf" . "printf();")
662 ("def" . "# define")))
663 (yas-should-not-expand '("sc" "dolist" "ert-deftest"))))
668 (defmacro yas-with-even-more-interesting-snippet-dirs (&rest body)
669 `(yas-saving-variables
670 (yas-with-snippet-dirs
671 `((".emacs.d/snippets"
673 (".yas-make-groups" . "")
674 ("printf" . "printf($1);")
676 ("fnprintf" . "fprintf($1);")
677 ("snprintf" . "snprintf($1);"))
679 ("strcmp" . "strecmp($1);")
680 ("strcasecmp" . "strcasecmp($1);")))
681 ("lisp-interaction-mode"
682 ("ert-deftest" . "# group: barbar\n# --\n(ert-deftest ${1:name} () $0)"))
684 ("a-guy" . "# uuid: 999\n# --\nyo!")
685 ("a-sir" . "# uuid: 12345\n# --\nindeed!")
686 ("a-lady" . "# uuid: 54321\n# --\noh-la-la!")
687 ("a-beggar" . "# uuid: 0101\n# --\narrrgh!")
688 ("an-outcast" . "# uuid: 666\n# --\narrrgh!")
689 (".yas-setup.el" . , (pp-to-string
690 '(yas-define-menu 'fancy-mode
691 '((yas-ignore-item "0101")
694 ((yas-item "12345")))
695 (yas-submenu "ladies"
696 ((yas-item "54321"))))
700 (ert-deftest test-yas-define-menu ()
701 (let ((yas-use-menu t))
702 (yas-with-even-more-interesting-snippet-dirs
703 (yas-reload-all 'no-jit)
704 (let ((menu (cdr (gethash 'fancy-mode yas--menu-table))))
705 (should (eql 4 (length menu)))
706 (dolist (item '("a-guy" "a-beggar"))
707 (should (find item menu :key #'third :test #'string=)))
708 (should-not (find "an-outcast" menu :key #'third :test #'string=))
709 (dolist (submenu '("sirs" "ladies"))
712 (find submenu menu :key #'third :test #'string=)))))
715 (ert-deftest test-group-menus ()
716 "Test group-based menus using .yas-make-groups and the group directive"
717 (let ((yas-use-menu t))
718 (yas-with-even-more-interesting-snippet-dirs
719 (yas-reload-all 'no-jit)
720 ;; first the subdir-based groups
722 (let ((menu (cdr (gethash 'c-mode yas--menu-table))))
723 (should (eql 3 (length menu)))
724 (dolist (item '("printf" "foo-group-a" "foo-group-b"))
725 (should (find item menu :key #'third :test #'string=)))
726 (dolist (submenu '("foo-group-a" "foo-group-b"))
729 (find submenu menu :key #'third :test #'string=))))))
730 ;; now group directives
732 (let ((menu (cdr (gethash 'lisp-interaction-mode yas--menu-table))))
733 (should (eql 1 (length menu)))
734 (should (find "barbar" menu :key #'third :test #'string=))
737 (find "barbar" menu :key #'third :test #'string=))))))))
739 (ert-deftest test-group-menus-twisted ()
740 "Same as similarly named test, but be mean.
743 (let ((yas-use-menu t))
744 (yas-with-even-more-interesting-snippet-dirs
745 ;; add a group directive conflicting with the subdir and watch
748 (insert "# group: foo-group-c\n# --\nstrecmp($1)")
749 (write-region nil nil (concat (first (yas-snippet-dirs))
750 "/c-mode/foo-group-b/strcmp")))
751 (yas-reload-all 'no-jit)
752 (let ((menu (cdr (gethash 'c-mode yas--menu-table))))
753 (should (eql 4 (length menu)))
754 (dolist (item '("printf" "foo-group-a" "foo-group-b" "foo-group-c"))
755 (should (find item menu :key #'third :test #'string=)))
756 (dolist (submenu '("foo-group-a" "foo-group-b" "foo-group-c"))
759 (find submenu menu :key #'third :test #'string=))))))
760 ;; delete the .yas-make-groups file and watch behaviour
762 (delete-file (concat (first (yas-snippet-dirs))
763 "/c-mode/.yas-make-groups"))
764 (yas-reload-all 'no-jit)
765 (let ((menu (cdr (gethash 'c-mode yas--menu-table))))
766 (should (eql 5 (length menu))))
767 ;; Change a group directive and reload
769 (let ((menu (cdr (gethash 'lisp-interaction-mode yas--menu-table))))
770 (should (find "barbar" menu :key #'third :test #'string=)))
773 (insert "# group: foofoo\n# --\n(ert-deftest ${1:name} () $0)")
774 (write-region nil nil (concat (first (yas-snippet-dirs))
775 "/lisp-interaction-mode/ert-deftest")))
776 (yas-reload-all 'no-jit)
777 (let ((menu (cdr (gethash 'lisp-interaction-mode yas--menu-table))))
778 (should (eql 1 (length menu)))
779 (should (find "foofoo" menu :key #'third :test #'string=))
782 (find "foofoo" menu :key #'third :test #'string=))))))))
785 ;;; The infamous and problematic tab keybinding
787 (ert-deftest test-yas-tab-binding ()
790 (should (not (eq (key-binding (yas--read-keybinding "<tab>")) 'yas-expand)))
792 (should (eq (key-binding (yas--read-keybinding "<tab>")) 'yas-expand))
793 (yas-expand-snippet "$1 $2 $3")
794 (should (eq (key-binding [(tab)]) 'yas-next-field-or-maybe-expand))
795 (should (eq (key-binding (kbd "TAB")) 'yas-next-field-or-maybe-expand))
796 (should (eq (key-binding [(shift tab)]) 'yas-prev-field))
797 (should (eq (key-binding [backtab]) 'yas-prev-field))))
799 (ert-deftest test-rebindings ()
802 (define-key yas-minor-mode-map [tab] nil)
803 (define-key yas-minor-mode-map (kbd "TAB") nil)
804 (define-key yas-minor-mode-map (kbd "SPC") 'yas-expand)
807 (should (not (eq (key-binding (yas--read-keybinding "TAB")) 'yas-expand)))
808 (should (eq (key-binding (yas--read-keybinding "SPC")) 'yas-expand))
810 (should (not (eq (key-binding (yas--read-keybinding "TAB")) 'yas-expand)))
811 (should (eq (key-binding (yas--read-keybinding "SPC")) 'yas-expand))))
812 ;; FIXME: actually should restore to whatever saved values where there.
814 (define-key yas-minor-mode-map [tab] 'yas-expand)
815 (define-key yas-minor-mode-map (kbd "TAB") 'yas-expand)
816 (define-key yas-minor-mode-map (kbd "SPC") nil)))
818 (ert-deftest test-yas-in-org ()
822 (should (eq (key-binding [(tab)]) 'yas-expand))
823 (should (eq (key-binding (kbd "TAB")) 'yas-expand))))
825 (ert-deftest test-yas-activate-extra-modes ()
826 "Given a symbol, `yas-activate-extra-mode' should be able to
827 add the snippets associated with the given mode."
829 (yas-saving-variables
830 (yas-with-snippet-dirs
831 '((".emacs.d/snippets"
835 ("car" . "(car )"))))
839 (yas-activate-extra-mode 'markdown-mode)
840 (should (eq 'markdown-mode (car yas--extra-modes)))
841 (yas-should-expand '(("_" . "_Text_ ")))
842 (yas-should-expand '(("car" . "(car )")))
843 (yas-deactivate-extra-mode 'markdown-mode)
844 (should-not (eq 'markdown-mode (car yas--extra-modes)))
845 (yas-should-not-expand '("_"))
846 (yas-should-expand '(("car" . "(car )")))))))
851 (defun yas-should-expand (keys-and-expansions)
852 (dolist (key-and-expansion keys-and-expansions)
853 (yas-exit-all-snippets)
855 (insert (car key-and-expansion))
856 (let ((yas-fallback-behavior nil))
857 (ert-simulate-command '(yas-expand)))
858 (unless (string= (yas--buffer-contents) (cdr key-and-expansion))
859 (ert-fail (format "\"%s\" should have expanded to \"%s\" but got \"%s\""
860 (car key-and-expansion)
861 (cdr key-and-expansion)
862 (yas--buffer-contents)))))
863 (yas-exit-all-snippets))
865 (defun yas-should-not-expand (keys)
867 (yas-exit-all-snippets)
870 (let ((yas-fallback-behavior nil))
871 (ert-simulate-command '(yas-expand)))
872 (unless (string= (yas--buffer-contents) key)
873 (ert-fail (format "\"%s\" should have stayed put, but instead expanded to \"%s\""
875 (yas--buffer-contents))))))
877 (defun yas-mock-insert (string)
878 (dotimes (i (length string))
879 (let ((last-command-event (aref string i)))
880 (ert-simulate-command '(self-insert-command 1)))))
882 (defun yas-mock-yank (string)
883 (let ((interprogram-paste-function (lambda () string)))
884 (ert-simulate-command '(yank nil))))
886 (defun yas-make-file-or-dirs (ass)
887 (let ((file-or-dir-name (car ass))
889 (cond ((listp content)
890 (make-directory file-or-dir-name 'parents)
891 (let ((default-directory (concat default-directory "/" file-or-dir-name)))
892 (mapc #'yas-make-file-or-dirs content)))
896 (write-region nil nil file-or-dir-name nil 'nomessage)))
898 (message "[yas] oops don't know this content")))))
901 (defun yas-variables ()
903 (mapatoms #'(lambda (sym)
904 (if (and (string-match "^yas-[^/]" (symbol-name sym))
909 (defun yas-call-with-saving-variables (fn)
910 (let* ((vars (yas-variables))
911 (saved-values (mapcar #'symbol-value vars)))
914 (loop for var in vars
915 for saved in saved-values
916 do (set var saved)))))
918 (defun yas-call-with-snippet-dirs (dirs fn)
919 (let* ((default-directory (make-temp-file "yasnippet-fixture" t))
920 (yas-snippet-dirs (mapcar #'car dirs)))
921 (with-temp-message ""
924 (mapc #'yas-make-file-or-dirs dirs)
926 (when (>= emacs-major-version 24)
927 (delete-directory default-directory 'recursive))))))
931 (unless (fboundp 'special-mode)
932 ;; FIXME: Why provide this default definition here?!?
933 (defalias 'special-mode 'fundamental))
935 (unless (fboundp 'string-suffix-p)
936 ;; introduced in Emacs 24.4
937 (defun string-suffix-p (suffix string &optional ignore-case)
938 "Return non-nil if SUFFIX is a suffix of STRING.
939 If IGNORE-CASE is non-nil, the comparison is done without paying
940 attention to case differences."
941 (let ((start-pos (- (length string) (length suffix))))
942 (and (>= start-pos 0)
943 (eq t (compare-strings suffix nil nil
944 string start-pos nil ignore-case))))))
946 ;;; btw to test this in emacs22 mac osx:
947 ;;; curl -L -O https://github.com/mirrors/emacs/raw/master/lisp/emacs-lisp/ert.el
948 ;;; curl -L -O https://github.com/mirrors/emacs/raw/master/lisp/emacs-lisp/ert-x.el
949 ;;; /usr/bin/emacs -nw -Q -L . -l yasnippet-tests.el --batch -e ert
952 (put 'yas-saving-variables 'edebug-form-spec t)
953 (put 'yas-with-snippet-dirs 'edebug-form-spec t)
954 (put 'yas-with-overriden-buffer-list 'edebug-form-spec t)
955 (put 'yas-with-some-interesting-snippet-dirs 'edebug-form-spec t)
958 (put 'yas--with-temporary-redefinitions 'lisp-indent-function 1)
959 (put 'yas--with-temporary-redefinitions 'edebug-form-spec '((&rest (defun*)) cl-declarations body))
964 (provide 'yasnippet-tests)
966 ;; indent-tabs-mode: nil
967 ;; byte-compile-warnings: (not cl-functions)
969 ;;; yasnippet-tests.el ends here