1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
;;; completion-preview-tests.el --- tests for completion-preview.el -*- lexical-binding: t -*-
;; Copyright (C) 2023-2025 Free Software Foundation, Inc.
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Code:
(require 'ert)
(require 'completion-preview)
(defun completion-preview-tests--capf (completions &rest props)
(lambda ()
(when-let ((bounds (bounds-of-thing-at-point 'symbol)))
(append (list (car bounds) (cdr bounds) completions) props))))
(defun completion-preview-tests--check-preview
(string &optional beg-face end-face)
"Check that the completion preview is showing STRING.
BEG-FACE and END-FACE say which faces the beginning and end of STRING
should have, respectively. Both BEG-FACE and END-FACE default to
`completion-preview'.
If STRING is nil, check that there is no completion preview
instead."
(if (not string)
(should-not completion-preview--overlay)
(should completion-preview--overlay)
(let ((after-string (completion-preview--get 'after-string)))
(should (string= after-string string))
(should (eq (get-text-property 0 'face after-string)
(or beg-face 'completion-preview)))
(should (eq (get-text-property (1- (length after-string)) 'face after-string)
(or end-face
'completion-preview))))))
(ert-deftest completion-preview ()
"Test Completion Preview mode."
(with-temp-buffer
(setq-local completion-at-point-functions
(list (completion-preview-tests--capf '("foobarbaz"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; Exact match
(completion-preview-tests--check-preview "barbaz"
'completion-preview-exact
'completion-preview-exact)
(insert "v")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; No match, no preview
(completion-preview-tests--check-preview nil)
(delete-char -1)
(let ((this-command 'delete-backward-char))
(completion-preview--post-command))
;; Exact match again
(completion-preview-tests--check-preview "barbaz"
'completion-preview-exact
'completion-preview-exact)))
(ert-deftest completion-preview-multiple-matches ()
"Test Completion Preview mode with multiple matching candidates."
(with-temp-buffer
(setq-local completion-at-point-functions
(list (completion-preview-tests--capf
'("foobar" "foobaz"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; Multiple matches, the preview shows the first one
(completion-preview-tests--check-preview "bar" 'completion-preview-common)
(completion-preview-next-candidate 1)
;; Next match
(completion-preview-tests--check-preview "baz" 'completion-preview-common)))
(ert-deftest completion-preview-exact-match-only ()
"Test `completion-preview-exact-match-only'."
(with-temp-buffer
(setq-local completion-at-point-functions
(list (completion-preview-tests--capf
'("spam" "foobar" "foobaz")))
completion-preview-exact-match-only t)
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; Multiple matches, so no preview
(completion-preview-tests--check-preview nil)
(delete-region (point-min) (point-max))
(insert "spa")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; Exact match
(completion-preview-tests--check-preview "m"
'completion-preview-exact
'completion-preview-exact)))
(ert-deftest completion-preview-function-capfs ()
"Test Completion Preview mode with capfs that return a function."
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(lambda () #'ignore)
(completion-preview-tests--capf
'("foobar" "foobaz"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "bar" 'completion-preview-common)))
(ert-deftest completion-preview-non-exclusive-capfs ()
"Test Completion Preview mode with non-exclusive capfs."
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(completion-preview-tests--capf
'("spam") :exclusive 'no)
(completion-preview-tests--capf
'("foobar" "foobaz") :exclusive 'no)
(completion-preview-tests--capf
'("foobarbaz"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "bar" 'completion-preview-common)
(setq-local completion-preview-exact-match-only t)
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "barbaz"
'completion-preview-exact
'completion-preview-exact)))
(ert-deftest completion-preview-face-updates ()
"Test updating the face in completion preview when match is no longer exact."
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(completion-preview-tests--capf
'("foobarbaz" "food"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "d")
(insert "b")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "arbaz"
'completion-preview-exact
'completion-preview-exact)
(delete-char -1)
(let ((this-command 'delete-backward-char))
(completion-preview--post-command))
(completion-preview-tests--check-preview "d")))
(ert-deftest completion-preview-capf-errors ()
"Test Completion Preview mode with capfs that signal errors.
`dabbrev-capf' is one example of such a capf."
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(lambda () (user-error "Bad"))
(completion-preview-tests--capf
'("foobarbaz"))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "barbaz"
'completion-preview-exact
'completion-preview-exact)))
(ert-deftest completion-preview-mid-symbol-cycle ()
"Test cycling the completion preview with point at the middle of a symbol."
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(completion-preview-tests--capf
'("foobar" "foobaz"))))
(insert "fooba")
(forward-char -2)
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "r")
(completion-preview-next-candidate 1)
(completion-preview-tests--check-preview "z")))
(ert-deftest completion-preview-complete ()
"Test `completion-preview-complete'."
(with-temp-buffer
(let ((exit-fn-called nil)
(exit-fn-args nil)
(message-args nil)
(completion-auto-help nil))
(setq-local completion-at-point-functions
(list
(completion-preview-tests--capf
'("foobar" "foobaz" "foobash" "foobash-mode")
:exit-function
(lambda (&rest args)
(setq exit-fn-called t
exit-fn-args args)))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "bar" 'completion-preview-common)
;; Insert the common prefix, "ba".
(completion-preview-complete)
;; Only "r" should remain.
(completion-preview-tests--check-preview "r")
(cl-letf (((symbol-function #'minibuffer-message)
(lambda (&rest args) (setq message-args args))))
;; With `completion-auto-help' set to nil, a second call to
;; `completion-preview-complete' just displays a message.
(completion-preview-complete)
(setq completion-preview--inhibit-update-p nil)
(should (equal message-args '("Next char not unique"))))
;; The preview should stay put.
(completion-preview-tests--check-preview "r")
;; (completion-preview-active-mode -1)
;; Narrow further.
(insert "s")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
;; The preview should indicate an exact match.
(completion-preview-tests--check-preview "h"
'completion-preview-common
'completion-preview-common)
;; Insert the entire preview content.
(completion-preview-complete)
(setq completion-preview--inhibit-update-p nil)
(let ((this-command 'completion-preview-complete))
(completion-preview--post-command))
;; The preview should update to indicate that there's a further
;; possible completion.
(completion-preview-tests--check-preview "-mode"
'completion-preview-exact
'completion-preview-exact)
(should exit-fn-called)
(should (equal exit-fn-args '("foobash" exact)))
(setq exit-fn-called nil exit-fn-args nil)
;; Insert the extra suffix.
(completion-preview-complete)
;; Nothing more to show, so the preview should now be gone.
(should-not completion-preview--overlay)
(should exit-fn-called)
(should (equal exit-fn-args '("foobash-mode" finished))))))
(ert-deftest completion-preview-insert-calls-exit-function ()
"Test that `completion-preview-insert' calls the completion exit function."
(let ((exit-fn-called nil) (exit-fn-args nil))
(with-temp-buffer
(setq-local completion-at-point-functions
(list
(completion-preview-tests--capf
'("foobar" "foobaz")
:exit-function
(lambda (&rest args)
(setq exit-fn-called t
exit-fn-args args)))))
(insert "foo")
(let ((this-command 'self-insert-command))
(completion-preview--post-command))
(completion-preview-tests--check-preview "bar" 'completion-preview-common)
(completion-preview-insert)
(should (string= (buffer-string) "foobar"))
(should-not completion-preview--overlay)
(should exit-fn-called)
(should (equal exit-fn-args '("foobar" finished))))))
;;; completion-preview-tests.el ends here
|
