blob: 46bad32fac8085ad41910a5220403d4d4aec95b3 (
plain)
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
|
(require 'ert)
(require 'helpful)
(defun test-foo ()
"Docstring here."
nil)
(defun test-foo-advised ()
"Docstring here too."
nil)
(defadvice test-foo-advised (before test-advice1 activate)
"Placeholder advice 1."
nil)
(defadvice test-foo-advised (after test-advice2 activate)
"Placeholder advice 2."
nil)
(ert-deftest helpful--docstring ()
"Basic docstring fetching."
(should
(equal
(helpful--docstring #'test-foo)
"Docstring here.")))
(ert-deftest helpful--docstring-advice ()
"Get the docstring on advised functions."
(should
(equal
(helpful--docstring #'test-foo-advised)
"Docstring here too.")))
(defun test-foo-no-docstring ()
nil)
(ert-deftest helpful--no-docstring ()
"We should not crash on a function without a docstring."
(should (null (helpful--docstring #'test-foo-no-docstring))))
(defun test-foo-usage-docstring ()
"\n\n(fn &rest ARGS)"
nil)
(ert-deftest helpful--usage-docstring ()
"If a function docstring only has usage, do not return it."
(should (null (helpful--docstring #'test-foo-usage-docstring))))
(defun test-foo-no-properties ()
nil)
(ert-deftest helpful--no-symbol-properties ()
"Helpful should handle functions without any symbol properties."
;; Interactively evaluating this file will set edebug properties on
;; test-foo, so remove all properties.
(setplist #'test-foo-no-properties nil)
(should (helpful-function #'test-foo-no-properties)))
(ert-deftest helpful--split-first-line ()
;; Don't modify a single line string.
(should
(equal (helpful--split-first-line "foo") "foo"))
;; Don't modify a two-line string if we don't end with .
(should
(equal (helpful--split-first-line "foo\nbar") "foo\nbar"))
;; If the second line is already empty, do nothing.
(should
(equal (helpful--split-first-line "foo.\n\nbar") "foo.\n\nbar"))
;; But if we have a single sentence and no empy line, insert one.
(should
(equal (helpful--split-first-line "foo.\nbar") "foo.\n\nbar")))
(ert-deftest helpful--format-reference ()
(should
(equal
(helpful--format-reference '(def foo) 1 123 "/foo/bar.el")
"(def foo ...) ; 1 reference"))
(should
(equal
(helpful--format-reference '(advice-add 'bar) 1 123 "/foo/bar.el")
"(advice-add 'bar ...) ; 1 reference")))
(ert-deftest helpful--format-docstring ()
"Ensure we create links in docstrings."
;; If it's bound, we should link it.
(let* ((formatted (helpful--format-docstring "foo `message'."))
(m-position (s-index-of "m" formatted)))
(should (get-text-property m-position 'button formatted)))
;; If it's not bound, we should not.
(let* ((formatted (helpful--format-docstring "foo `messagexxx'."))
(m-position (s-index-of "m" formatted)))
(should (not (get-text-property m-position 'button formatted)))
;; But we should always remove the backticks.
(should (equal formatted "foo messagexxx."))))
|
