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
| | ;;; find-definition-test.el --- Test suite for find-definition.el -*- lexical-binding: t -*-
;; Copyright (C) 2014 Jorgen Schaefer <contact@jorgenschaefer.de>
;; This program 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.
;; This program 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 this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'ert)
(require 'find-definition)
(defmacro find-definition-with-temp-file (variable &rest body)
"Create a temporary file, bind it to VARIABLE, and evaluated BODY.
Delete the file after BODY finishes."
(declare (indent 1))
`(let ((,variable (make-temp-file "find-definition-test-")))
(unwind-protect
(progn ,@body)
(delete-file ,variable))))
;;;;;;;;;;;;;;;;;;;
;;; find-definition
(ert-deftest find-definition ()
;; It should go to the definition if there is exactly one.
(find-definition-with-temp-file filename
(with-temp-file filename
(insert "Hello\n"
"World\n"))
(let ((find-definition-function (lambda ()
(list (list filename 2 3)))))
(find-definition)
(should (equal (buffer-file-name) filename))
(should (looking-at "ld")))
(kill-buffer))
;; If the backend function can't find a definition for the thing at
;; point, find-definition should prompt the user for a symbol
;; completed by a backend-provided completion table. This symbol
;; then is passed to a backend function to get the location.
(find-definition-with-temp-file filename
(cl-letf* ( ;; User function definitions
(find-definition-function (lambda ()
nil))
(find-definition-identifier-completion-table 'test-table)
(fdsf-identifier nil)
(find-definition-identifier-function
(lambda (sym)
(setq fdsf-identifier sym)
(list (list filename 1 0))))
;; Mocking
(cr-collection nil)
((symbol-function 'completing-read)
(lambda (prompt collection &rest args)
(setq cr-collection collection)
"test-symbol")))
(find-definition)
(should (equal cr-collection 'test-table))
(should (equal fdsf-identifier "test-symbol"))
(should (equal (buffer-file-name) filename))))
;; Do the same with a prefix argument.
(find-definition-with-temp-file filename
(cl-letf* ( ;; User function definitions
(find-definition-function (lambda ()
(error "Should not be called")))
(find-definition-identifier-completion-table 'test-table)
(find-definition-identifier-function
(lambda (sym)
(list (list filename 1 0))))
;; Mocking
(cr-collection nil)
((symbol-function 'completing-read)
(lambda (prompt collection &rest args)
(setq cr-collection collection)
"test-symbol")))
(find-definition '(4))
(should (equal cr-collection 'test-table))))
;; Without a completion table and no identifier at point, the
;; function should throw an error.
(cl-letf* ((find-definition-function (lambda ()
nil))
(find-definition-identifier-completion-table nil)
(find-definition-identifier-function nil))
(should-error
(find-definition)))
;; Without a completion table and a prefix argument, the function
;; should throw an error as well
(cl-letf* ((find-definition-function (lambda ()
(error "Should not be called")))
(find-definition-identifier-completion-table nil)
(find-definition-identifier-function nil))
(should-error
(find-definition '(4))))
;; It should pop up a selection dialog if there is more than one
;; definition.
(find-definition-with-temp-file filename
(with-temp-file filename
(insert "Hello\n"
"World\n"))
(let ((find-definition-function (lambda ()
(list (list filename 1)
(list filename 2)))))
(find-definition)
(should (equal (buffer-name) "*Definitions*"))
(should (eq major-mode 'compilation-mode))))
)
;;;;;;;;;;;;;;;;;;;;;;;;
;;; find-definition-uses
;; - find-definition-uses should go the use if there is exactly one.
;; - find-definition-uses should pop up a selection dialog if there is
;; more than one use.
;; - find-definition-uses should prompt for name if there is no definition.
;; - find-definition-uses should prompt for name with prefix argument.
;; - Provide a new function, etags-find-definition
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;; find-definition-goto-last-position
(ert-deftest find-definition-goto-last-position ()
;; It should move to the last position in the same buffer
(with-temp-buffer
(let* ((find-definition-marker-ring (make-ring 5))
(start (point))
(marker (make-marker)))
(set-marker marker start)
(ring-insert find-definition-marker-ring marker)
(insert "Bla bla\n")
(should (not (= (point) start)))
(find-definition-goto-last-position)
(should (= (point) start))))
;; It should move to the last position in another buffer
(with-temp-buffer
(let* ((find-definition-marker-ring (make-ring 5))
(start (point))
(start-buffer (current-buffer))
(marker (make-marker)))
(set-marker marker start start-buffer)
(ring-insert find-definition-marker-ring marker)
(with-temp-buffer
(find-definition-goto-last-position)
(should (equal (current-buffer) start-buffer))
(should (= (point) start)))))
;; It should should be interactive
(should (interactive-form 'find-definition-goto-last-position))
;; It should raise an error when the marker ring is empty
(let ((find-definition-marker-ring (make-ring 1)))
(should-error (find-definition-goto-last-position)))
;; It should raise an error if the original buffer is deleted
(let* ((find-definition-marker-ring (make-ring 5))
(marker (make-marker)))
(with-temp-buffer
(set-marker marker (point))
(ring-insert find-definition-marker-ring marker))
(should-error
(find-definition-goto-last-position)))
;; It should reset the marker
;;
;; Why? This is copied from pop-to-mark, but why would this be
;; needed?
(let* ((find-definition-marker-ring (make-ring 5))
(marker (make-marker)))
(with-temp-buffer
(set-marker marker (point))
(ring-insert find-definition-marker-ring marker)
(find-definition-goto-last-position)
(should (null (marker-position marker)))
(should (null (marker-buffer marker)))))
)
(provide 'find-definition-test)
;;; find-definition-test.el ends here
|