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
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
|
# frozen_string_literal: true
require_relative 'xref_test_case'
class RDocMarkupToHtmlCrossrefTest < XrefTestCase
def setup
super
@options.hyperlink_all = true
@options.warn_missing_rdoc_ref = true
@to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1
end
def test_convert_CROSSREF
result = @to.convert 'C1'
assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result
result = @to.convert '+C1+'
assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result
result = @to.convert 'Constant[rdoc-ref:C1]'
assert_equal para("<a href=\"C1.html\">Constant</a>"), result
result = @to.convert 'FOO'
assert_equal para("FOO"), result
result = @to.convert '+FOO+'
assert_equal para("<code>FOO</code>"), result
result = @to.convert '<tt># :stopdoc:</tt>:'
assert_equal para("<code># :stopdoc:</code>:"), result
end
def test_convert_CROSSREF_ignored_excluded_words
@options.autolink_excluded_words = ['C1']
result = @to.convert 'C1'
assert_equal para("C1"), result
result = @to.convert '+C1+'
assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result
# Explicit linking with rdoc-ref is not ignored
result = @to.convert 'Constant[rdoc-ref:C1]'
assert_equal para("<a href=\"C1.html\">Constant</a>"), result
end
def test_convert_CROSSREF_method
result = @to.convert 'C1#m(foo, bar, baz)'
assert_equal para("<a href=\"C1.html#method-i-m\"><code>C1#m(foo, bar, baz)</code></a>"), result
end
def test_convert_CROSSREF_label
result = @to.convert 'C1@foo'
assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>"), result
result = @to.convert 'C1#m@foo'
assert_equal para("<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>"),
result
end
def test_convert_CROSSREF_label_for_md
result = @to.convert 'EXAMPLE@foo'
assert_equal para("<a href=\"EXAMPLE_md.html#label-foo\">foo at <code>EXAMPLE</code></a>"), result
end
def test_convert_CROSSREF_label_period
result = @to.convert 'C1@foo.'
assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>."), result
end
def test_convert_CROSSREF_label_space
result = @to.convert 'C1@foo+bar'
assert_equal para("<a href=\"C1.html#class-C1-label-foo+bar\">foo bar at <code>C1</code></a>"),
result
end
def test_convert_CROSSREF_section
@c1.add_section 'Section'
result = @to.convert 'C1@Section'
assert_equal para("<a href=\"C1.html#Section\">Section at <code>C1</code></a>"), result
end
def test_convert_CROSSREF_constant
result = @to.convert 'C1::CONST'
assert_equal para("<a href=\"C1.html#CONST\"><code>C1::CONST</code></a>"), result
end
def test_convert_RDOCLINK_rdoc_ref
result = @to.convert 'rdoc-ref:C1'
assert_equal para("<a href=\"C1.html\"><code>C1</code></a>"), result
end
def test_convert_RDOCLINK_rdoc_ref_not_found
result = nil
stdout, _ = capture_output do
result = @to.convert 'rdoc-ref:FOO'
end
assert_equal para("FOO"), result
assert_include stdout, "index.html: `rdoc-ref:FOO` can't be resolved for `FOO`"
end
def test_convert_RDOCLINK_rdoc_ref_method
result = @to.convert 'rdoc-ref:C1#m'
assert_equal para("<a href=\"C1.html#method-i-m\"><code>C1#m</code></a>"), result
end
def test_convert_RDOCLINK_rdoc_ref_method_label
result = @to.convert 'rdoc-ref:C1#m@foo'
assert_equal para("<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>"),
result, 'rdoc-ref:C1#m@foo'
end
def test_convert_RDOCLINK_rdoc_ref_method_percent
m = @c1.add_method RDoc::AnyMethod.new nil, '%'
result = @to.convert 'rdoc-ref:C1#%'
assert_equal para("<a href=\"C1.html#method-i-25\"><code>C1#%</code></a>"), result
m.singleton = true
result = @to.convert 'rdoc-ref:C1::%'
assert_equal para("<a href=\"C1.html#method-c-25\"><code>C1::%</code></a>"), result
end
def test_convert_RDOCLINK_rdoc_ref_method_escape_html
m = @c1.add_method RDoc::AnyMethod.new nil, '<<'
result = @to.convert 'rdoc-ref:C1#<<'
assert_equal para("<a href=\"C1.html#method-i-3C-3C\"><code>C1#<<</code></a>"), result
m.singleton = true
result = @to.convert 'rdoc-ref:C1::<<'
assert_equal para("<a href=\"C1.html#method-c-3C-3C\"><code>C1::<<</code></a>"), result
end
def test_convert_RDOCLINK_rdoc_ref_method_percent_label
m = @c1.add_method RDoc::AnyMethod.new nil, '%'
result = @to.convert 'rdoc-ref:C1#%@f'
assert_equal para("<a href=\"C1.html#method-i-25-label-f\">f at <code>C1#%</code></a>"),
result
m.singleton = true
result = @to.convert 'rdoc-ref:C1::%@f'
assert_equal para("<a href=\"C1.html#method-c-25-label-f\">f at <code>C1::%</code></a>"),
result
end
def test_convert_RDOCLINK_rdoc_ref_label
result = @to.convert 'rdoc-ref:C1@foo'
assert_equal para("<a href=\"C1.html#class-C1-label-foo\">foo at <code>C1</code></a>"), result,
'rdoc-ref:C1@foo'
end
def test_convert_RDOCLINK_rdoc_ref_label_in_current_file
result = @to.convert 'rdoc-ref:@foo'
assert_equal para("<a href=\"#label-foo\">foo</a>"), result,
'rdoc-ref:@foo'
result = @to.convert '{Foo}[rdoc-ref:@foo]'
assert_equal para("<a href=\"#label-foo\">Foo</a>"), result,
'{Foo}[rdoc-ref:@foo]'
end
def test_gen_url
assert_equal '<a href="C1.html">Some class</a>',
@to.gen_url('rdoc-ref:C1', 'Some class')
assert_equal '<a href="http://example">HTTP example</a>',
@to.gen_url('http://example', 'HTTP example')
end
def test_gen_url_rdoc_ref_not_found
stdout, _ = capture_output do
@to.gen_url 'rdoc-ref:FOO', 'FOO'
end
assert_include stdout, "index.html: `rdoc-ref:FOO` can't be resolved for `FOO`"
end
def test_handle_regexp_CROSSREF
assert_equal "<a href=\"C2/C3.html\"><code>C2::C3</code></a>", REGEXP_HANDLING('C2::C3')
end
def test_handle_regexp_CROSSREF_label
assert_equal "<a href=\"C1.html#method-i-m-label-foo\">foo at <code>C1#m</code></a>",
REGEXP_HANDLING('C1#m@foo')
end
def test_handle_regexp_CROSSREF_show_hash_false
@to.show_hash = false
assert_equal "<a href=\"C1.html#method-i-m\"><code>m</code></a>",
REGEXP_HANDLING('#m')
end
def test_handle_regexp_CROSSREF_with_arg_looks_like_TIDYLINK
result = @to.convert 'C1.m[:sym]'
assert_equal para("<a href=\"C1.html#method-c-m\"><code>C1.m[:sym]</code></a>"), result,
'C1.m[:sym]'
end
def test_handle_regexp_HYPERLINK_rdoc
readme = @store.add_file 'README.txt'
readme.parser = RDoc::Parser::Simple
@to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2
link = @to.handle_regexp_HYPERLINK hyper 'C2::C3'
assert_equal '<a href="C2/C3.html"><code>C2::C3</code></a>', link
link = @to.handle_regexp_HYPERLINK hyper 'C4'
assert_equal '<a href="C4.html"><code>C4</code></a>', link
link = @to.handle_regexp_HYPERLINK hyper 'README.txt'
assert_equal '<a href="README_txt.html">README.txt</a>', link
end
def test_handle_regexp_TIDYLINK_rdoc
readme = @store.add_file 'README.txt'
readme.parser = RDoc::Parser::Simple
@to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2
link = @to.handle_regexp_TIDYLINK tidy 'C2::C3'
assert_equal '<a href="C2/C3.html">tidy</a>', link
link = @to.handle_regexp_TIDYLINK tidy 'C4'
assert_equal '<a href="C4.html">tidy</a>', link
link = @to.handle_regexp_TIDYLINK tidy 'C1#m'
assert_equal '<a href="C1.html#method-i-m">tidy</a>', link
link = @to.handle_regexp_TIDYLINK tidy 'README.txt'
assert_equal '<a href="README_txt.html">tidy</a>', link
end
def test_handle_regexp_TIDYLINK_label
link = @to.handle_regexp_TIDYLINK tidy 'C1#m@foo'
assert_equal "<a href=\"C1.html#method-i-m-label-foo\">tidy</a>",
link, 'C1#m@foo'
end
def test_to_html_CROSSREF_email
@options.hyperlink_all = false
@to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1
result = @to.to_html 'first.last@example.com'
assert_equal 'first.last@example.com', result
end
def test_to_html_CROSSREF_email_hyperlink_all
result = @to.to_html 'first.last@example.com'
assert_equal 'first.last@example.com', result
end
def test_link
assert_equal 'n', @to.link('n', 'n')
assert_equal '<a href="C1.html#method-c-m"><code>m</code></a>', @to.link('m', 'm')
end
def test_link_for_method_traverse
@to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c9
assert_equal '<a href="C9/A.html#method-i-foo"><code>C9::B#foo</code></a>', @to.link('C9::B#foo', 'C9::B#foo')
end
def test_link_class_method_full
assert_equal '<a href="Parent.html#method-c-m"><code>Parent::m</code></a>',
@to.link('Parent::m', 'Parent::m')
end
def para(text)
"\n<p>#{text}</p>\n"
end
def REGEXP_HANDLING(text)
@to.handle_regexp_CROSSREF regexp_handling text
end
def hyper(reference)
RDoc::Markup::RegexpHandling.new 0, "rdoc-ref:#{reference}"
end
def regexp_handling(text)
RDoc::Markup::RegexpHandling.new 0, text
end
def tidy(reference)
RDoc::Markup::RegexpHandling.new 0, "{tidy}[rdoc-ref:#{reference}]"
end
end
|
