;;; company-tests.el --- company-mode tests
-;; Copyright (C) 2011 Free Software Foundation, Inc.
+;; Copyright (C) 2011, 2013 Free Software Foundation, Inc.
;; Author: Nikolaj Schumacher
;;; Code:
+(eval-when-compile (require 'cl))
(require 'ert)
(require 'company)
(require 'company-keywords)
+(require 'company-elisp)
+(require 'company-clang)
-(ert-deftest sorted-keywords ()
+;;; Core
+
+(ert-deftest company-sorted-keywords ()
"Test that keywords in `company-keywords-alist' are in alphabetical order."
(dolist (pair company-keywords-alist)
(when (consp (cdr pair))
(should (not (equal prev next)))
(should (string< prev next))
(setq prev next))))))
+
+(ert-deftest company-good-prefix ()
+ (let ((company-minimum-prefix-length 5)
+ company--explicit-action)
+ (should (eq t (company--good-prefix-p "!@#$%")))
+ (should (eq nil (company--good-prefix-p "abcd")))
+ (should (eq nil (company--good-prefix-p 'stop)))
+ (should (eq t (company--good-prefix-p '("foo" . 5))))
+ (should (eq nil (company--good-prefix-p '("foo" . 4))))))
+
+(ert-deftest company-multi-backend-with-lambdas ()
+ (let ((company-backend
+ (list (lambda (command &optional arg &rest ignore)
+ (case command
+ (prefix "z")
+ (candidates '("a" "b"))))
+ (lambda (command &optional arg &rest ignore)
+ (case command
+ (prefix "z")
+ (candidates '("c" "d")))))))
+ (should (equal (company-call-backend 'candidates "z") '("a" "b" "c" "d")))))
+
+(ert-deftest company-begin-backend-failure-doesnt-break-company-backends ()
+ (with-temp-buffer
+ (insert "a")
+ (company-mode)
+ (should-error
+ (company-begin-backend (lambda (command &rest ignore))))
+ (let (company-frontends
+ (company-backends
+ (list (lambda (command &optional arg)
+ (case command
+ (prefix "a")
+ (candidates '("a" "ab" "ac")))))))
+ (let (this-command)
+ (company-call 'complete))
+ (should (eq 3 company-candidates-length)))))
+
+(ert-deftest company-require-match-explicit ()
+ (with-temp-buffer
+ (insert "ab")
+ (company-mode)
+ (let (company-frontends
+ (company-require-match 'company-explicit-action-p)
+ (company-backends
+ (list (lambda (command &optional arg)
+ (case command
+ (prefix (buffer-substring (point-min) (point)))
+ (candidates '("abc" "abd")))))))
+ (let (this-command)
+ (company-complete))
+ (let ((last-command-event ?e))
+ (company-call 'self-insert-command 1))
+ (should (eq 2 company-candidates-length))
+ (should (eq 3 (point))))))
+
+(ert-deftest company-dont-require-match-when-idle ()
+ (with-temp-buffer
+ (insert "ab")
+ (company-mode)
+ (let (company-frontends
+ (company-require-match 'company-explicit-action-p)
+ (company-backends
+ (list (lambda (command &optional arg)
+ (case command
+ (prefix (buffer-substring (point-min) (point)))
+ (candidates '("abc" "abd")))))))
+ (company-idle-begin (current-buffer) (selected-window)
+ (buffer-chars-modified-tick) (point))
+ (let ((last-command-event ?e))
+ (company-call 'self-insert-command 1))
+ (should (eq nil company-candidates-length))
+ (should (eq 4 (point))))))
+
+(ert-deftest company-auto-complete-explicit ()
+ (with-temp-buffer
+ (insert "ab")
+ (company-mode)
+ (let (company-frontends
+ (company-auto-complete 'company-explicit-action-p)
+ (company-auto-complete-chars '(? ))
+ (company-backends
+ (list (lambda (command &optional arg)
+ (case command
+ (prefix (buffer-substring (point-min) (point)))
+ (candidates '("abcd" "abef")))))))
+ (let (this-command)
+ (company-complete))
+ (let ((last-command-event ? ))
+ (company-call 'self-insert-command 1))
+ (should (string= "abcd " (buffer-string))))))
+
+(ert-deftest company-no-auto-complete-when-idle ()
+ (with-temp-buffer
+ (insert "ab")
+ (company-mode)
+ (let (company-frontends
+ (company-auto-complete 'company-explicit-action-p)
+ (company-auto-complete-chars '(? ))
+ (company-backends
+ (list (lambda (command &optional arg)
+ (case command
+ (prefix (buffer-substring (point-min) (point)))
+ (candidates '("abcd" "abef")))))))
+ (company-idle-begin (current-buffer) (selected-window)
+ (buffer-chars-modified-tick) (point))
+ (let ((last-command-event ? ))
+ (company-call 'self-insert-command 1))
+ (should (string= "ab " (buffer-string))))))
+
+(ert-deftest company-clears-explicit-action-when-no-matches ()
+ (with-temp-buffer
+ (company-mode)
+ (let (company-frontends
+ company-backends)
+ (company-call 'manual-begin) ;; fails
+ (should (null company-candidates))
+ (should (null (company-explicit-action-p))))))
+
+(ert-deftest company-pseudo-tooltip-does-not-get-displaced ()
+ :tags '(interactive)
+ (with-temp-buffer
+ (save-window-excursion
+ (set-window-buffer nil (current-buffer))
+ (save-excursion (insert " ff"))
+ (company-mode)
+ (let ((company-frontends '(company-pseudo-tooltip-frontend))
+ (company-begin-commands '(self-insert-command))
+ (company-backends
+ (list (lambda (c &optional arg)
+ (case c (prefix "") (candidates '("a" "b" "c")))))))
+ (let (this-command)
+ (company-call 'complete))
+ (company-call 'open-line 1)
+ (should (eq 2 (overlay-start company-pseudo-tooltip-overlay)))))))
+
+(ert-deftest company-pseudo-tooltip-overlay-show ()
+ :tags '(interactive)
+ (with-temp-buffer
+ (save-window-excursion
+ (set-window-buffer nil (current-buffer))
+ (insert "aaaa\n bb\nccccc\nddd")
+ (search-backward "bb")
+ (let ((col (company--column))
+ (company-candidates-length 2)
+ (company-candidates '("123" "45")))
+ (company-pseudo-tooltip-show (company--row) col 0)
+ (let ((ov company-pseudo-tooltip-overlay))
+ (should (eq (overlay-get ov 'company-width) 3))
+ ;; FIXME: Make it 2?
+ (should (eq (overlay-get ov 'company-height) company-tooltip-limit))
+ (should (eq (overlay-get ov 'company-column) col))
+ (should (string= (overlay-get ov 'company-after)
+ " 123\nc45 c\nddd\n")))))))
+
+(ert-deftest company-column-with-composition ()
+ (with-temp-buffer
+ (insert "lambda ()")
+ (compose-region 1 (1+ (length "lambda")) "\\")
+ (should (= (company--column) 4))))
+
+(ert-deftest company-column-with-line-prefix ()
+ (with-temp-buffer
+ (insert "foo")
+ (put-text-property (point-min) (point) 'line-prefix " ")
+ (should (= (company--column) 5))))
+
+(ert-deftest company-column-wth-line-prefix-on-empty-line ()
+ (with-temp-buffer
+ (insert "\n")
+ (forward-char -1)
+ (put-text-property (point-min) (point-max) 'line-prefix " ")
+ (should (= (company--column) 2))))
+
+(ert-deftest company-plainify ()
+ (let ((tab-width 8))
+ (should (equal-including-properties
+ (company-plainify "\tabc\td\t")
+ (concat " "
+ "abc "
+ "d "))))
+ (should (equal-including-properties
+ (company-plainify (propertize "foobar" 'line-prefix "-*-"))
+ "-*-foobar")))
+
+(ert-deftest company-modify-line ()
+ (let ((str "-*-foobar"))
+ (should (equal-including-properties
+ (company-modify-line str "zz" 4)
+ "-*-fzzbar"))
+ (should (equal-including-properties
+ (company-modify-line str "xx" 0)
+ "xx-foobar"))
+ (should (equal-including-properties
+ (company-modify-line str "zz" 10)
+ "-*-foobar zz"))))
+
+;;; Template
+
+(ert-deftest company-template-removed-after-the-last-jump ()
+ (with-temp-buffer
+ (insert "{ }")
+ (goto-char 2)
+ (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
+ (save-excursion
+ (dotimes (i 2)
+ (insert " ")
+ (company-template-add-field tpl (point) "foo")))
+ (company-call 'template-forward-field)
+ (should (= 3 (point)))
+ (company-call 'template-forward-field)
+ (should (= 7 (point)))
+ (company-call 'template-forward-field)
+ (should (= 11 (point)))
+ (should (zerop (length (overlay-get tpl 'company-template-fields))))
+ (should (null (overlay-buffer tpl))))))
+
+(ert-deftest company-template-removed-after-input-and-jump ()
+ (with-temp-buffer
+ (insert "{ }")
+ (goto-char 2)
+ (let ((tpl (company-template-declare-template (point) (1- (point-max)))))
+ (save-excursion
+ (insert " ")
+ (company-template-add-field tpl (point) "bar"))
+ (company-call 'template-move-to-first tpl)
+ (should (= 3 (point)))
+ (dolist (c (string-to-list "tee"))
+ (let ((last-command-event c))
+ (company-call 'self-insert-command 1)))
+ (should (string= "{ tee }" (buffer-string)))
+ (should (overlay-buffer tpl))
+ (company-call 'template-forward-field)
+ (should (= 7 (point)))
+ (should (null (overlay-buffer tpl))))))
+
+(defun company-call (name &rest args)
+ (let* ((maybe (intern (format "company-%s" name)))
+ (command (if (fboundp maybe) maybe name)))
+ (apply command args)
+ (let ((this-command command))
+ (run-hooks 'post-command-hook))))
+
+(ert-deftest company-template-c-like-templatify ()
+ (with-temp-buffer
+ (let ((text "foo(int a, short b)"))
+ (insert text)
+ (company-template-c-like-templatify text)
+ (should (equal "foo(arg0, arg1)" (buffer-string)))
+ (should (looking-at "arg0"))
+ (should (equal "int a"
+ (overlay-get (company-template-field-at) 'display))))))
+
+(ert-deftest company-template-c-like-templatify-trims-after-closing-paren ()
+ (with-temp-buffer
+ (let ((text "foo(int a, short b)!@ #1334 a"))
+ (insert text)
+ (company-template-c-like-templatify text)
+ (should (equal "foo(arg0, arg1)" (buffer-string)))
+ (should (looking-at "arg0")))))
+
+;;; Elisp
+
+(defmacro company-elisp-with-buffer (contents &rest body)
+ (declare (indent 0))
+ `(with-temp-buffer
+ (insert ,contents)
+ (setq major-mode 'emacs-lisp-mode)
+ (re-search-backward "|")
+ (replace-match "")
+ (let ((company-elisp-detect-function-context t))
+ ,@body)))
+
+(ert-deftest company-elisp-candidates-predicate ()
+ (company-elisp-with-buffer
+ "(foo ba|)"
+ (should (eq (company-elisp--candidates-predicate "ba")
+ 'boundp))
+ (should (eq (let (company-elisp-detect-function-context)
+ (company-elisp--candidates-predicate "ba"))
+ 'company-elisp--predicate)))
+ (company-elisp-with-buffer
+ "(foo| )"
+ (should (eq (company-elisp--candidates-predicate "foo")
+ 'fboundp))
+ (should (eq (let (company-elisp-detect-function-context)
+ (company-elisp--candidates-predicate "foo"))
+ 'company-elisp--predicate)))
+ (company-elisp-with-buffer
+ "(foo 'b|)"
+ (should (eq (company-elisp--candidates-predicate "b")
+ 'company-elisp--predicate))))
+
+(ert-deftest company-elisp-candidates-predicate-in-docstring ()
+ (company-elisp-with-buffer
+ "(def foo () \"Doo be doo `ide|"
+ (should (eq 'company-elisp--predicate
+ (company-elisp--candidates-predicate "ide")))))
+
+;; This one's also an integration test.
+(ert-deftest company-elisp-candidates-recognizes-binding-form ()
+ (let ((company-elisp-detect-function-context t)
+ (obarray [when what whelp])
+ (what 1)
+ (whelp 2)
+ (wisp 3))
+ (company-elisp-with-buffer
+ "(let ((foo 7) (wh| )))"
+ (should (equal '("what" "whelp")
+ (company-elisp-candidates "wh"))))
+ (company-elisp-with-buffer
+ "(cond ((null nil) (wh| )))"
+ (should (equal '("when")
+ (company-elisp-candidates "wh"))))))
+
+(ert-deftest company-elisp-candidates-predicate-binding-without-value ()
+ (loop for (text prefix predicate) in '(("(let (foo|" "foo" boundp)
+ ("(let (foo (bar|" "bar" boundp)
+ ("(let (foo) (bar|" "bar" fboundp))
+ do
+ (eval `(company-elisp-with-buffer
+ ,text
+ (should (eq ',predicate
+ (company-elisp--candidates-predicate ,prefix)))))))
+
+(ert-deftest company-elisp-finds-vars ()
+ (let ((obarray [boo bar baz backquote])
+ (boo t)
+ (bar t)
+ (baz t))
+ (should (equal '("bar" "baz")
+ (company-elisp--globals "ba" 'boundp)))))
+
+(ert-deftest company-elisp-finds-functions ()
+ (let ((obarray [when what whelp])
+ (what t)
+ (whelp t))
+ (should (equal '("when")
+ (company-elisp--globals "wh" 'fboundp)))))
+
+(ert-deftest company-elisp-finds-things ()
+ (let ((obarray [when what whelp])
+ (what t)
+ (whelp t))
+ (should (equal '("what" "whelp" "when")
+ (sort (company-elisp--globals "wh" 'company-elisp--predicate)
+ 'string<)))))
+
+(ert-deftest company-elisp-locals-vars ()
+ (company-elisp-with-buffer
+ "(let ((foo 5) (bar 6))
+ (cl-labels ((borg ()))
+ (lambda (boo baz)
+ b|)))"
+ (should (equal '("bar" "baz" "boo")
+ (company-elisp--locals "b" nil)))))
+
+(ert-deftest company-elisp-locals-single-var ()
+ (company-elisp-with-buffer
+ "(dotimes (itk 100)
+ (dolist (item items)
+ it|))"
+ (should (equal '("itk" "item")
+ (company-elisp--locals "it" nil)))))
+
+(ert-deftest company-elisp-locals-funs ()
+ (company-elisp-with-buffer
+ "(cl-labels ((foo ())
+ (fee ()))
+ (let ((fun 4))
+ (f| )))"
+ (should (equal '("fee" "foo")
+ (sort (company-elisp--locals "f" t) 'string<)))))
+
+(ert-deftest company-elisp-locals-skips-current-varlist ()
+ (company-elisp-with-buffer
+ "(let ((foo 1)
+ (f| )))"
+ (should (null (company-elisp--locals "f" nil)))))
+
+(ert-deftest company-elisp-show-locals-first ()
+ (company-elisp-with-buffer
+ "(let ((floo 1)
+ (flop 2)
+ (flee 3))
+ fl|)"
+ (let ((obarray [float-pi]))
+ (let (company-elisp-show-locals-first)
+ (should (eq nil (company-elisp 'sorted))))
+ (let ((company-elisp-show-locals-first t))
+ (should (eq t (company-elisp 'sorted)))
+ (should (equal '("flee" "floo" "flop" "float-pi")
+ (company-elisp-candidates "fl")))))))
+
+(ert-deftest company-elisp-candidates-no-duplicates ()
+ (company-elisp-with-buffer
+ "(let ((float-pi 4))
+ f|)"
+ (let ((obarray [float-pi])
+ (company-elisp-show-locals-first t))
+ (should (equal '("float-pi") (company-elisp-candidates "f"))))))
+
+(ert-deftest company-elisp-shouldnt-complete-defun-name ()
+ (company-elisp-with-buffer
+ "(defun foob|)"
+ (should (null (company-elisp 'prefix)))))
+
+(ert-deftest company-elisp-should-complete-def-call ()
+ (company-elisp-with-buffer
+ "(defu|"
+ (should (equal "defu" (company-elisp 'prefix)))))
+
+(ert-deftest company-elisp-should-complete-in-defvar ()
+ ;; It will also complete the var name, at least for now.
+ (company-elisp-with-buffer
+ "(defvar abc de|"
+ (should (equal "de" (company-elisp 'prefix)))))
+
+(ert-deftest company-elisp-shouldnt-complete-in-defun-arglist ()
+ (company-elisp-with-buffer
+ "(defsubst foobar (ba|"
+ (should (null (company-elisp 'prefix)))))
+
+(ert-deftest company-elisp-prefix-in-defun-body ()
+ (company-elisp-with-buffer
+ "(defun foob ()|)"
+ (should (equal "" (company-elisp 'prefix)))))
+
+;;; Clang
+
+(ert-deftest company-clang-objc-templatify ()
+ (with-temp-buffer
+ (let ((text "createBookWithTitle:andAuthor:"))
+ (insert text)
+ (company-clang-objc-templatify text)
+ (should (equal "createBookWithTitle:arg0 andAuthor:arg1" (buffer-string)))
+ (should (looking-at "arg0"))
+ (should (null (overlay-get (company-template-field-at) 'display))))))