1 ;;; ruby-mode-tests.el --- Test suite for ruby-mode
3 ;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
5 ;; This file is part of GNU Emacs.
7 ;; GNU Emacs is free software: you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (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.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 (defmacro ruby-with-temp-buffer (contents &rest body)
28 (declare (indent 1) (debug t))
34 (defun ruby-should-indent (content column)
35 "Assert indentation COLUMN on the last line of CONTENT."
36 (ruby-with-temp-buffer content
37 (indent-according-to-mode)
38 (should (= (current-indentation) column))))
40 (defun ruby-should-indent-buffer (expected content)
41 "Assert that CONTENT turns into EXPECTED after the buffer is re-indented.
43 The whitespace before and including \"|\" on each line is removed."
44 (ruby-with-temp-buffer (ruby-test-string content)
45 (indent-region (point-min) (point-max))
46 (should (string= (ruby-test-string expected) (buffer-string)))))
48 (defun ruby-test-string (s &rest args)
49 (apply 'format (replace-regexp-in-string "^[ \t]*|" "" s) args))
51 (defun ruby-assert-state (content index value &optional point)
52 "Assert syntax state values at the end of CONTENT.
54 VALUES-PLIST is a list with alternating index and value elements."
55 (ruby-with-temp-buffer content
56 (when point (goto-char point))
57 (syntax-propertize (point))
58 (should (eq (nth index
59 (parse-partial-sexp (point-min) (point)))
62 (defun ruby-assert-face (content pos face)
63 (ruby-with-temp-buffer content
64 (font-lock-ensure nil nil)
65 (should (eq face (get-text-property pos 'face)))))
67 (ert-deftest ruby-indent-after-symbol-made-from-string-interpolation ()
68 "It can indent the line after symbol made using string interpolation."
69 (ruby-should-indent "def foo(suffix)\n :\"bar#{suffix}\"\n"
72 (ert-deftest ruby-indent-after-js-style-symbol-with-block-beg-name ()
73 "JS-style hash symbol can have keyword name."
74 (ruby-should-indent "link_to \"home\", home_path, class: \"foo\"\n" 0))
76 (ert-deftest ruby-discern-singleton-class-from-heredoc ()
77 (ruby-assert-state "foo <<asd\n" 3 ?\n)
78 (ruby-assert-state "class <<asd\n" 3 nil))
80 (ert-deftest ruby-heredoc-font-lock ()
81 (let ((s "foo <<eos.gsub('^ *', '')"))
82 (ruby-assert-face s 9 font-lock-string-face)
83 (ruby-assert-face s 10 nil)))
85 (ert-deftest ruby-singleton-class-no-heredoc-font-lock ()
86 (ruby-assert-face "class<<a" 8 nil))
88 (ert-deftest ruby-heredoc-highlights-interpolations ()
89 (ruby-assert-face "s = <<EOS\n #{foo}\nEOS" 15 font-lock-variable-name-face))
91 (ert-deftest ruby-no-heredoc-inside-quotes ()
92 (ruby-assert-state "\"<<\", \"\",\nfoo" 3 nil))
94 (ert-deftest ruby-exit!-font-lock ()
95 (ruby-assert-face "exit!" 5 font-lock-builtin-face))
97 (ert-deftest ruby-deep-indent ()
98 (let ((ruby-deep-arglist nil)
99 (ruby-deep-indent-paren '(?\( ?\{ ?\[ ?\] t)))
100 (ruby-should-indent "foo = [1,\n2" 7)
101 (ruby-should-indent "foo = {a: b,\nc: d" 7)
102 (ruby-should-indent "foo(a,\nb" 4)))
104 (ert-deftest ruby-deep-indent-disabled ()
105 (let ((ruby-deep-arglist nil)
106 (ruby-deep-indent-paren nil))
107 (ruby-should-indent "foo = [\n1" ruby-indent-level)
108 (ruby-should-indent "foo = {\na: b" ruby-indent-level)
109 (ruby-should-indent "foo(\na" ruby-indent-level)))
111 (ert-deftest ruby-indent-after-keyword-in-a-string ()
112 (ruby-should-indent "a = \"abc\nif\"\n " 0)
113 (ruby-should-indent "a = %w[abc\n def]\n " 0)
114 (ruby-should-indent "a = \"abc\n def\"\n " 0))
116 (ert-deftest ruby-regexp-doesnt-start-in-string ()
117 (ruby-assert-state "'(/', /\d+/" 3 nil))
119 (ert-deftest ruby-regexp-starts-after-string ()
120 (ruby-assert-state "'(/', /\d+/" 3 ?/ 8))
122 (ert-deftest ruby-regexp-interpolation-is-highlighted ()
123 (ruby-assert-face "/#{foobs}/" 4 font-lock-variable-name-face))
125 (ert-deftest ruby-regexp-skips-over-interpolation ()
126 (ruby-assert-state "/#{foobs.join('/')}/" 3 nil))
128 (ert-deftest ruby-regexp-continues-till-end-when-unclosed ()
129 (ruby-assert-state "/bars" 3 ?/))
131 (ert-deftest ruby-regexp-can-be-multiline ()
132 (ruby-assert-state "/bars\ntees # toots \nfoos/" 3 nil))
134 (ert-deftest ruby-slash-symbol-is-not-mistaken-for-regexp ()
135 (ruby-assert-state ":/" 3 nil))
137 (ert-deftest ruby-slash-char-literal-is-not-mistaken-for-regexp ()
138 (ruby-assert-state "?/" 3 nil))
140 (ert-deftest ruby-indent-simple ()
141 (ruby-should-indent-buffer
153 (ert-deftest ruby-indent-keyword-label ()
154 (ruby-should-indent-buffer
166 (ert-deftest ruby-indent-method-with-question-mark ()
167 (ruby-should-indent-buffer
177 (ert-deftest ruby-indent-expr-in-regexp ()
178 (ruby-should-indent-buffer
188 (ert-deftest ruby-indent-singleton-class ()
189 (ruby-should-indent-buffer
199 (ert-deftest ruby-indent-inside-heredoc-after-operator ()
200 (ruby-should-indent-buffer
206 (ert-deftest ruby-indent-inside-heredoc-after-space ()
207 (ruby-should-indent-buffer
208 "foo <<eos.gsub(' ', '*')
210 "foo <<eos.gsub(' ', '*')
213 (ert-deftest ruby-indent-array-literal ()
214 (let ((ruby-deep-indent-paren nil))
215 (ruby-should-indent-buffer
224 (ruby-should-indent-buffer
234 (ert-deftest ruby-indent-begin-end ()
235 (ruby-should-indent-buffer
245 (ert-deftest ruby-indent-array-after-paren-and-space ()
246 (ruby-should-indent-buffer
260 (ert-deftest ruby-indent-after-block-in-continued-expression ()
261 (ruby-should-indent-buffer
273 (ert-deftest ruby-indent-spread-args-in-parens ()
274 (let ((ruby-deep-indent-paren '(?\()))
275 (ruby-should-indent-buffer
285 (ert-deftest ruby-align-to-stmt-keywords-t ()
286 (let ((ruby-align-to-stmt-keywords t))
287 (ruby-should-indent-buffer
320 (ert-deftest ruby-align-to-stmt-keywords-case ()
321 (let ((ruby-align-to-stmt-keywords '(case)))
322 (ruby-should-indent-buffer
336 (ert-deftest ruby-align-chained-calls ()
337 (let ((ruby-align-chained-calls t))
338 (ruby-should-indent-buffer
342 |my_array.select { |str| str.size > 5 }
343 | .map { |str| str.downcase }"
347 |my_array.select { |str| str.size > 5 }
348 | .map { |str| str.downcase }")))
350 (ert-deftest ruby-move-to-block-stops-at-indentation ()
351 (ruby-with-temp-buffer "def f\nend"
353 (ruby-move-to-block -1)
354 (should (looking-at "^def"))))
356 (ert-deftest ruby-toggle-block-to-do-end ()
357 (ruby-with-temp-buffer "foo {|b|\n}"
360 (should (string= "foo do |b|\nend" (buffer-string)))))
362 (ert-deftest ruby-toggle-block-to-brace ()
363 (let ((pairs '((17 . "foo { |b| b + 2 }")
364 (16 . "foo { |b|\n b + 2\n}"))))
367 (let ((fill-column (car pair)))
368 (insert "foo do |b|\n b + 2\nend")
372 (should (string= (cdr pair) (buffer-string))))))))
374 (ert-deftest ruby-toggle-block-to-multiline ()
375 (ruby-with-temp-buffer "foo {|b| b + 1}"
378 (should (string= "foo do |b|\n b + 1\nend" (buffer-string)))))
380 (ert-deftest ruby-toggle-block-with-interpolation ()
381 (ruby-with-temp-buffer "foo do\n \"#{bar}\"\nend"
384 (should (string= "foo { \"#{bar}\" }" (buffer-string)))))
386 (ert-deftest ruby-recognize-symbols-starting-with-at-character ()
387 (ruby-assert-face ":@abc" 3 font-lock-constant-face))
389 (ert-deftest ruby-hash-character-not-interpolation ()
390 (ruby-assert-face "\"This is #{interpolation}\"" 15
391 font-lock-variable-name-face)
392 (ruby-assert-face "\"This is \\#{no interpolation} despite the #\""
393 15 font-lock-string-face)
394 (ruby-assert-face "\n#@comment, not ruby code" 5 font-lock-comment-face)
395 (ruby-assert-state "\n#@comment, not ruby code" 4 t)
396 (ruby-assert-face "# A comment cannot have #{an interpolation} in it"
397 30 font-lock-comment-face)
398 (ruby-assert-face "# #{comment}\n \"#{interpolation}\"" 16
399 font-lock-variable-name-face))
401 (ert-deftest ruby-interpolation-suppresses-quotes-inside ()
402 (let ((s "\"<ul><li>#{@files.join(\"</li><li>\")}</li></ul>\""))
403 (ruby-assert-state s 8 nil)
404 (ruby-assert-face s 9 font-lock-string-face)
405 (ruby-assert-face s 10 font-lock-variable-name-face)
406 (ruby-assert-face s 41 font-lock-string-face)))
408 (ert-deftest ruby-interpolation-suppresses-one-double-quote ()
409 (let ((s "\"foo#{'\"'}\""))
410 (ruby-assert-state s 8 nil)
411 (ruby-assert-face s 8 font-lock-variable-name-face)
412 (ruby-assert-face s 11 font-lock-string-face)))
414 (ert-deftest ruby-interpolation-suppresses-one-backtick ()
415 (let ((s "`as#{'`'}das`"))
416 (ruby-assert-state s 8 nil)))
418 (ert-deftest ruby-interpolation-keeps-non-quote-syntax ()
419 (let ((s "\"foo#{baz.tee}bar\""))
420 (ruby-with-temp-buffer s
421 (goto-char (point-min))
423 (syntax-propertize (point-max))
424 (search-forward "tee")
425 (should (string= (thing-at-point 'symbol) "tee")))))
427 (ert-deftest ruby-interpolation-inside-percent-literal ()
428 (let ((s "%( #{boo} )"))
429 (ruby-assert-face s 1 font-lock-string-face)
430 (ruby-assert-face s 4 font-lock-variable-name-face)
431 (ruby-assert-face s 10 font-lock-string-face)
432 (ruby-assert-state s 8 nil)))
434 (ert-deftest ruby-interpolation-inside-percent-literal-with-paren ()
435 :expected-result :failed
436 (let ((s "%(^#{\")\"}^)"))
437 (ruby-assert-face s 3 font-lock-string-face)
438 (ruby-assert-face s 4 font-lock-variable-name-face)
439 (ruby-assert-face s 10 font-lock-string-face)
440 ;; It's confused by the closing paren in the middle.
441 (ruby-assert-state s 8 nil)))
443 (ert-deftest ruby-interpolation-inside-double-quoted-percent-literals ()
444 (ruby-assert-face "%Q{foo #@bar}" 8 font-lock-variable-name-face)
445 (ruby-assert-face "%W{foo #@bar}" 8 font-lock-variable-name-face)
446 (ruby-assert-face "%r{foo #@bar}" 8 font-lock-variable-name-face)
447 (ruby-assert-face "%x{foo #@bar}" 8 font-lock-variable-name-face))
449 (ert-deftest ruby-no-interpolation-in-single-quoted-literals ()
450 (ruby-assert-face "'foo #@bar'" 7 font-lock-string-face)
451 (ruby-assert-face "%q{foo #@bar}" 8 font-lock-string-face)
452 (ruby-assert-face "%w{foo #@bar}" 8 font-lock-string-face)
453 (ruby-assert-face "%s{foo #@bar}" 8 font-lock-string-face))
455 (ert-deftest ruby-interpolation-after-dollar-sign ()
456 (ruby-assert-face "\"$#{balance}\"" 2 'font-lock-string-face)
457 (ruby-assert-face "\"$#{balance}\"" 3 'font-lock-variable-name-face))
459 (ert-deftest ruby-no-unknown-percent-literals ()
460 ;; No folding of case.
461 (ruby-assert-face "%S{foo}" 4 nil)
462 (ruby-assert-face "%R{foo}" 4 nil))
464 (ert-deftest ruby-add-log-current-method-examples ()
465 (let ((pairs '(("foo" . "#foo")
467 ("self.foo" . ".foo"))))
469 (let ((name (car pair))
471 (ruby-with-temp-buffer (ruby-test-string
480 (search-backward "_")
482 (should (string= (ruby-add-log-current-method)
483 (format "M::C%s" value))))))))
485 (ert-deftest ruby-add-log-current-method-outside-of-method ()
486 (ruby-with-temp-buffer (ruby-test-string
494 (search-backward "_")
495 (should (string= (ruby-add-log-current-method)"M::C"))))
497 (ert-deftest ruby-add-log-current-method-in-singleton-class ()
498 (ruby-with-temp-buffer (ruby-test-string
506 (search-backward "_")
507 (should (string= (ruby-add-log-current-method) "C.foo"))))
509 (ert-deftest ruby-add-log-current-method-namespace-shorthand ()
510 (ruby-with-temp-buffer (ruby-test-string
516 (search-backward "_")
517 (should (string= (ruby-add-log-current-method) "C::D#foo"))))
519 (ert-deftest ruby-add-log-current-method-after-inner-class ()
520 (ruby-with-temp-buffer (ruby-test-string
530 (search-backward "_")
531 (should (string= (ruby-add-log-current-method) "M::C#foo"))))
533 (defvar ruby-block-test-example
551 (defmacro ruby-deftest-move-to-block (name &rest body)
552 (declare (indent defun))
553 `(ert-deftest ,(intern (format "ruby-move-to-block-%s" name)) ()
555 (insert ruby-block-test-example)
557 (goto-char (point-min))
560 (ruby-deftest-move-to-block works-on-do
563 (should (= 13 (line-number-at-pos)))
564 (ruby-beginning-of-block)
565 (should (= 11 (line-number-at-pos))))
567 (ruby-deftest-move-to-block zero-is-noop
569 (ruby-move-to-block 0)
570 (should (= 5 (line-number-at-pos))))
572 (ruby-deftest-move-to-block ok-with-three
574 (ruby-move-to-block 3)
575 (should (= 14 (line-number-at-pos))))
577 (ruby-deftest-move-to-block ok-with-minus-two
579 (ruby-move-to-block -2)
580 (should (= 2 (line-number-at-pos))))
582 (ert-deftest ruby-move-to-block-skips-percent-literal ()
583 (dolist (s (list (ruby-test-string
595 (ruby-with-temp-buffer s
596 (goto-char (point-min))
598 (should (= 5 (line-number-at-pos)))
599 (ruby-beginning-of-block)
600 (should (= 1 (line-number-at-pos))))))
602 (ert-deftest ruby-move-to-block-skips-heredoc ()
603 (ruby-with-temp-buffer
606 | ActiveSupport::Deprecation.warn(<<-eowarn)
611 (goto-char (point-min))
613 (should (= 6 (line-number-at-pos)))
614 (ruby-beginning-of-block)
615 (should (= 1 (line-number-at-pos)))))
617 (ert-deftest ruby-move-to-block-does-not-fold-case ()
618 (ruby-with-temp-buffer
623 (let ((case-fold-search t))
624 (ruby-beginning-of-block))
625 (should (= 1 (line-number-at-pos)))))
627 (ert-deftest ruby-move-to-block-moves-from-else-to-if ()
628 (ruby-with-temp-buffer (ruby-test-string
634 (goto-char (point-min))
636 (ruby-beginning-of-block)
637 (should (= 1 (line-number-at-pos)))))
639 (ert-deftest ruby-beginning-of-defun-does-not-fold-case ()
640 (ruby-with-temp-buffer
647 (goto-char (point-min))
649 (let ((case-fold-search t))
650 (beginning-of-defun))
651 (should (= 2 (line-number-at-pos)))))
653 (ert-deftest ruby-end-of-defun-skips-to-next-line-after-the-method ()
654 (ruby-with-temp-buffer
661 (goto-char (point-min))
664 (should (= 5 (line-number-at-pos)))))
666 (defvar ruby-sexp-test-example
672 | [1, 2, 3].map do |i|
678 (ert-deftest ruby-forward-sexp-skips-method-calls-with-keyword-names ()
679 (ruby-with-temp-buffer ruby-sexp-test-example
682 (should (= 8 (line-number-at-pos)))))
684 (ert-deftest ruby-backward-sexp-skips-method-calls-with-keyword-names ()
685 (ruby-with-temp-buffer ruby-sexp-test-example
689 (should (= 2 (line-number-at-pos)))))
691 (ert-deftest ruby--insert-coding-comment-ruby-style ()
693 (let ((ruby-encoding-magic-comment-style 'ruby))
694 (ruby--insert-coding-comment "utf-8")
695 (should (string= "# coding: utf-8\n" (buffer-string))))))
697 (ert-deftest ruby--insert-coding-comment-emacs-style ()
699 (let ((ruby-encoding-magic-comment-style 'emacs))
700 (ruby--insert-coding-comment "utf-8")
701 (should (string= "# -*- coding: utf-8 -*-\n" (buffer-string))))))
703 (ert-deftest ruby--insert-coding-comment-custom-style ()
705 (let ((ruby-encoding-magic-comment-style 'custom)
706 (ruby-custom-encoding-magic-comment-template "# encoding: %s\n"))
707 (ruby--insert-coding-comment "utf-8")
708 (should (string= "# encoding: utf-8\n\n" (buffer-string))))))
711 (provide 'ruby-mode-tests)
713 ;;; ruby-mode-tests.el ends here