lua-docstring/test.lua at master · rpavlik/lua-docstring · GitHub

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
require("lunatest.lunatest")

function test_loads()
	require("help")
	assert_table(help)
end

function test_concat()
	require("help")
	local a = help.docstring[[This is an example]] .. function()
		return "function return value"
	end
	assert_function(a)
	assert_string(a())
end

function test_concat_lookup()
	require("help")
	local a = help.docstring[[This is an example]] .. function()
		return "function return value"
	end
	assert_string(help.lookup(a))
end

function test_concat_twice()
	require("help")
	local a = help.docstring[[This is an example]] .. help.docstring[[This is another example]] .. function()
		return "function return value"
	end
	assert_function(a)
	assert_string(a())
end

function test_concat_twice_lookup()
	require("help")
	local a = help.docstring[[This is an example]] .. help.docstring[[This is another example]] .. function()
		return "function return value"
	end
	assert_table(help.lookup(a))
	assert_len(2, help.lookup(a))
end

function test_call()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]](a)
	assert_function(a)
	assert_string(a())
end

function test_call_chain()
	require("help")
	local function a()
		return "function return value"
	end
	local function b()
		return 5
	end
	help.docstring[[This is an example]](a)(b)
	assert_function(a)
	assert_string(a())
	assert_string(help.lookup(a))

	assert_function(b)
	assert_number(b())
	assert_string(help.lookup(b))
end

function test_call_lookup()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]](a)
	assert_string(help.lookup(a))
end

function test_call_twice()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]](a)
	help.docstring[[This is another example]](a)
	assert_function(a)
	assert_string(a())
end

function test_call_twice_lookup()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]](a)
	help.docstring[[This is another example]](a)
	assert_table(help.lookup(a))
	assert_len(2, help.lookup(a))
end


function test_applyto()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]].applyTo(a)
	assert_function(a)
	assert_string(a())
end

function test_applyto_chain()
	require("help")
	local function a()
		return "function return value"
	end
	local function b()
		return 5
	end
	help.docstring[[This is an example]].applyTo(a).applyTo(b)
	assert_function(a)
	assert_string(a())
	assert_string(help.lookup(a))

	assert_function(b)
	assert_number(b())
	assert_string(help.lookup(b))
end

function test_applyto_lookup()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]].applyTo(a)
	assert_string(help.lookup(a))
end

function test_applyto_twice()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]].applyTo(a)
	help.docstring[[This is another example]].applyTo(a)
	assert_function(a)
	assert_string(a())
end

function test_applyto_twice_lookup()
	require("help")
	local function a()
		return "function return value"
	end
	help.docstring[[This is an example]].applyTo(a)
	help.docstring[[This is another example]].applyTo(a)
	assert_table(help.lookup(a))
	assert_len(2, help.lookup(a))
end

function test_selfdoc_list_of_functions()
	require("help")
	assert_gt(#help, 1)
	assert_not_nil(help.lookup(help), "The help table has no documentation!")

	local keys = {}
	local foundKeys = {}
	for k,v in pairs(help) do
		table.insert(keys, k)
		foundKeys[k] = false
	end

	for _,v in ipairs(help.lookup(help)["functions"]) do
		assert_not_nil(foundKeys[v], "Function listed in documentation does not exist: " .. v)
		assert_false(foundKeys[v], "Function is listed in documentation more than once: " .. v)
		foundKeys[v] = true
	end

	for _,v in ipairs(help.lookup(help)["additionalFeatures"]) do
		assert_not_nil(foundKeys[v], "additionalFeature listed in documentation does not exist: " .. v)
		assert_false(foundKeys[v], "additionalFeature is listed in documentation more than once: " .. v)
		foundKeys[v] = true
	end

	for k,v in pairs(foundKeys) do
		assert_true(v, "Functions/additionalFeatures not listed in documentation for help: " .. k)
	end
end

function test_selfdoc_complete()
	require("help")
	for k,v in pairs(help) do
		assert_not_nil(help.lookup(v), "Function help." ..k.. " is not documented")
	end
end

function test_selfdoc_gc()
	require("help")
	collectgarbage("collect")
	assert_gt(#help, 1)
	assert_not_nil(help.lookup(help), "The help table has no documentation following garbage collection!")
end

function test_nodoc_builtins()
	require("help")
	assert_nil(help.lookup(1), "Don't document generic numbers!")
	assert_nil(help.lookup({}), "Don't document generic tables!")
	assert_nil(help.lookup(nil), "Don't document nil!")
	assert_nil(help.lookup("blabla"), "Don't document generic strings!")
	assert_nil(help.lookup(function() end), "Don't document generic functions!")
	assert_nil(help.lookup(coroutine.create(function() end)), "Don't document generic coroutines!")
end

lunatest.run()