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
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
|
# frozen_string_literal: true
require_relative 'helper'
class TestRDocGeneratorDarkfish < RDoc::TestCase
def setup
super
@lib_dir = "#{@pwd}/lib"
$LOAD_PATH.unshift @lib_dir # ensure we load from this RDoc
@options = RDoc::Options.new
@options.option_parser = OptionParser.new
@tmpdir = File.join Dir.tmpdir, "test_rdoc_generator_darkfish_#{$$}"
FileUtils.mkdir_p @tmpdir
Dir.chdir @tmpdir
@options.op_dir = @tmpdir
@options.generator = RDoc::Generator::Darkfish
$LOAD_PATH.each do |path|
darkfish_dir = File.join path, 'rdoc/generator/template/darkfish/'
next unless File.directory? darkfish_dir
@options.template_dir = darkfish_dir
break
end
@rdoc.options = @options
@g = @options.generator.new @store, @options
@rdoc.generator = @g
@top_level = @store.add_file 'file.rb'
@top_level.parser = RDoc::Parser::Ruby
@klass = @top_level.add_class RDoc::NormalClass, 'Klass'
@alias_constant = RDoc::Constant.new 'A', nil, ''
@alias_constant.record_location @top_level
@top_level.add_constant @alias_constant
@klass.add_module_alias @klass, @klass.name, @alias_constant, @top_level
@meth = RDoc::AnyMethod.new nil, 'method'
@meth_bang = RDoc::AnyMethod.new nil, 'method!'
@meth_with_html_tag_yield = RDoc::AnyMethod.new nil, 'method_with_html_tag_yield'
@meth_with_html_tag_yield.block_params = '%<<script>alert("atui")</script>>, yield_arg'
@attr = RDoc::Attr.new nil, 'attr', 'RW', ''
@klass.add_method @meth
@klass.add_method @meth_bang
@klass.add_method @meth_with_html_tag_yield
@klass.add_attribute @attr
@ignored = @top_level.add_class RDoc::NormalClass, 'Ignored'
@ignored.ignore
@store.complete :private
@object = @store.find_class_or_module 'Object'
@klass_alias = @store.find_class_or_module 'Klass::A'
end
def teardown
super
$LOAD_PATH.shift
Dir.chdir @pwd
FileUtils.rm_rf @tmpdir
end
def test_generate
top_level = @store.add_file 'file.rb'
top_level.add_class @klass.class, @klass.name
@klass.add_class RDoc::NormalClass, 'Inner'
@klass.add_comment <<~RDOC, top_level
= Heading 1
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
== Heading 1.1
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
=== Heading 1.1.1
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
==== Heading 1.1.1.1
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
== Heading 1.2
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat
== Heading 1.3
non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
=== Heading 1.3.1
etc etc...
RDOC
@g.generate
assert_file 'index.html'
assert_file 'Object.html'
assert_file 'Klass.html'
assert_file 'Klass/Inner.html'
assert_file 'table_of_contents.html'
assert_file 'js/search_index.js'
assert_hard_link 'css/rdoc.css'
assert_hard_link 'css/fonts.css'
assert_hard_link 'fonts/SourceCodePro-Bold.ttf'
assert_hard_link 'fonts/SourceCodePro-Regular.ttf'
encoding = Regexp.escape Encoding::UTF_8.name
assert_match %r%<meta charset="#{encoding}">%, File.binread('index.html')
assert_match %r%<meta charset="#{encoding}">%, File.binread('Object.html')
refute_match(/Ignored/, File.binread('index.html'))
summary = File.binread('index.html')[%r[<summary.*Klass\.html.*</summary>.*</details>]m]
assert_match(%r[Klass/Inner\.html".*>Inner<], summary)
klass = File.binread('Klass.html')
klassnav = klass[%r[<div class="nav-section">.*<div id="class-metadata">]m]
assert_match(
%r[<li>\s*<details open>\s*<summary>\s*<a href=\S+>Heading 1</a>\s*</summary>\s*<ul]m,
klassnav
)
assert_match(
%r[<li>\s*<a href=\S+>Heading 1.1.1.1</a>\s*</ul>\s*</details>\s*</li>]m,
klassnav
)
assert_match(/<h1 id="class-Klass-label-Heading\+1">Heading 1(?!\.)/,
klass[%r[<section class=\"description\">.*</section>]m])
toc = File.binread('table_of_contents.html')
assert_match(
%r[<a\s+href="Klass\.html#class-Klass-label-Heading\+1">Heading 1</a>]m,
toc[%r[<h2\s+id=\"classes\">.*(?=<h2\b)]m][%r[<a\s+href="Klass\.html".*(?=</li\b)]m]
)
end
def test_generate_page
@store.add_file 'outer.rdoc', parser: RDoc::Parser::Simple
@store.add_file 'outer/inner.rdoc', parser: RDoc::Parser::Simple
@g.generate
assert_file 'outer_rdoc.html'
assert_file 'outer/inner_rdoc.html'
index = File.binread('index.html')
re = %r[<summary><a href="\./outer_rdoc\.html">outer</a></summary>.*?</details>]m
assert_match(re, index)
summary = index[re]
assert_match %r[<a href="\./outer/inner_rdoc.html">inner</a>], summary
re = %r[<details open><summary><a href="\./outer_rdoc\.html">outer</a></summary>.*?</details>]m
assert_match(re, File.binread('outer_rdoc.html'))
re = %r[<details open><summary><a href="\.\./outer_rdoc\.html">outer</a></summary>.*?</details>]m
assert_match(re, File.binread('outer/inner_rdoc.html'))
end
def test_generate_dry_run
@g.dry_run = true
top_level = @store.add_file 'file.rb'
top_level.add_class @klass.class, @klass.name
@g.generate
refute_file 'index.html'
refute_file 'Object.html'
end
def test_generate_static
FileUtils.mkdir_p 'dir/images'
FileUtils.touch 'dir/images/image.png'
FileUtils.mkdir_p 'file'
FileUtils.touch 'file/file.txt'
@options.static_path = [
File.expand_path('dir'),
File.expand_path('file/file.txt'),
]
@g.generate
assert_file 'images/image.png'
assert_file 'file.txt'
end
def test_generate_static_dry_run
FileUtils.mkdir 'static'
FileUtils.touch 'static/image.png'
@options.static_path = [File.expand_path('static')]
@g.dry_run = true
@g.generate
refute_file 'image.png'
end
def test_install_rdoc_static_file
src = Pathname File.expand_path(__FILE__, @pwd)
dst = File.join @tmpdir, File.basename(src)
options = {}
@g.install_rdoc_static_file src, dst, options
assert_file dst
assert_hard_link dst
end
def test_install_rdoc_static_file_missing
src = Pathname(__FILE__) + 'nonexistent'
dst = File.join @tmpdir, File.basename(src)
options = {}
@g.install_rdoc_static_file src, dst, options
refute_file dst
end
def test_setup
@g.setup
assert_equal [@klass_alias, @ignored, @klass, @object],
@g.classes.sort_by { |klass| klass.full_name }
assert_equal [@top_level], @g.files
assert_equal [@meth, @meth, @meth_bang, @meth_bang, @meth_with_html_tag_yield, @meth_with_html_tag_yield], @g.methods
assert_equal [@klass_alias, @klass, @object], @g.modsort
end
def test_template_for
classpage = Pathname.new @options.template_dir + 'class.rhtml'
template = @g.send(:template_for, classpage, true, RDoc::ERBIO)
assert_kind_of RDoc::ERBIO, template
assert_same template, @g.send(:template_for, classpage)
end
def test_template_for_dry_run
classpage = Pathname.new @options.template_dir + 'class.rhtml'
template = @g.send(:template_for, classpage, true, ERB)
assert_kind_of ERB, template
assert_same template, @g.send(:template_for, classpage)
end
def test_template_for_partial
partial = Pathname.new @options.template_dir + '_sidebar_classes.rhtml'
template = @g.send(:template_for, partial, false, RDoc::ERBPartial)
assert_kind_of RDoc::ERBPartial, template
assert_same template, @g.send(:template_for, partial)
end
def test_generated_method_with_html_tag_yield
top_level = @store.add_file 'file.rb'
top_level.add_class @klass.class, @klass.name
@g.generate
path = File.join @tmpdir, 'A.html'
f = open(path)
internal_file = f.read
method_name_index = internal_file.index('<span class="method-name">method_with_html_tag_yield</span>')
last_of_method_name_index = method_name_index + internal_file[method_name_index..-1].index('<div class="method-description">') - 1
method_name = internal_file[method_name_index..last_of_method_name_index]
f.close
assert_includes method_name, '{ |%<<script>alert("atui")</script>>, yield_arg| ... }'
end
def test_generated_filename_with_html_tag
filename = '"><em>should be escaped'
begin # in @tmpdir
File.write(filename, '')
rescue SystemCallError
# ", <, > chars are prohibited as filename
return
else
File.unlink(filename)
end
@store.add_file filename
doc = @store.all_files.last
doc.parser = RDoc::Parser::Simple
@g.generate
Dir.glob("*.html", base: @tmpdir) do |html|
File.binread(File.join(@tmpdir, html)).scan(/.*should be escaped.*/) do |line|
assert_not_include line, "<em>", html
end
end
end
def test_template_stylesheets
css = Tempfile.create(%W'hoge .css', Dir.mktmpdir('tmp', '.'))
File.write(css, '')
css.close
base = File.basename(css)
refute_file(base)
@options.template_stylesheets << css
@g.generate
assert_file base
assert_include File.binread('index.html'), %Q[href="./#{base}"]
end
def test_title
title = "RDoc Test".freeze
@options.title = title
@g.generate
assert_main_title(File.binread('index.html'), title)
end
def test_title_escape
title = %[<script>alert("RDoc")</script>].freeze
@options.title = title
@g.generate
assert_main_title(File.binread('index.html'), title)
end
##
# Asserts that +filename+ has a link count greater than 1 if hard links to
# @tmpdir are supported.
def assert_hard_link filename
assert_file filename
src = @g.template_dir + '_head.rhtml'
dst = File.join @tmpdir, 'hardlinktest'
begin
FileUtils.ln src, dst
nlink = File.stat(dst).nlink if File.identical? src, dst
FileUtils.rm dst
return if nlink == 1
rescue SystemCallError
return
end
assert_operator File.stat(filename).nlink, :>, 1,
"#{filename} is not hard-linked"
end
def assert_main_title(content, title)
title = CGI.escapeHTML(title)
assert_equal(title, content[%r[<title>(.*?)<\/title>]im, 1])
assert_include(content[%r[<main\s[^<>]*+>\s*(.*?)</main>]im, 1], title)
end
end
|