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
|
require 'rubygems'
require 'rubygems/test_case'
require 'rubygems/rdoc'
class TestGemRDoc < Gem::TestCase
Gem::RDoc.load_rdoc
rdoc_4 = Gem::Requirement.new('> 3').satisfied_by?(Gem::RDoc.rdoc_version)
def setup
super
@a = util_spec 'a' do |s|
s.rdoc_options = %w[--main MyTitle]
s.extra_rdoc_files = %w[README]
end
write_file File.join(@tempdir, 'lib', 'a.rb')
write_file File.join(@tempdir, 'README')
install_gem @a
@hook = Gem::RDoc.new @a
begin
Gem::RDoc.load_rdoc
rescue Gem::DocumentError => e
skip e.message
end
Gem.configuration[:rdoc] = nil
end
##
# RDoc 4 ships with its own Gem::RDoc which overrides this one which is
# shipped for backwards compatibility.
def rdoc_4?
Gem::Requirement.new('>= 4.0.0.preview2').satisfied_by? \
@hook.class.rdoc_version
end
def rdoc_3?
Gem::Requirement.new('~> 3.0').satisfied_by? @hook.class.rdoc_version
end
def rdoc_3_8_or_better?
Gem::Requirement.new('>= 3.8').satisfied_by? @hook.class.rdoc_version
end
def test_initialize
if rdoc_4? then
refute @hook.generate_rdoc
else
assert @hook.generate_rdoc
end
assert @hook.generate_ri
rdoc = Gem::RDoc.new @a, false, false
refute rdoc.generate_rdoc
refute rdoc.generate_ri
end
def test_delete_legacy_args
args = %w[
--inline-source
--one-file
--promiscuous
-p
]
@hook.delete_legacy_args args
assert_empty args
end
def test_document
skip 'RDoc 3 required' unless rdoc_3?
options = RDoc::Options.new
options.files = []
rdoc = @hook.new_rdoc
@hook.instance_variable_set :@rdoc, rdoc
@hook.instance_variable_set :@file_info, []
@hook.document 'darkfish', options, @a.doc_dir('rdoc')
assert @hook.rdoc_installed?
end unless rdoc_4
def test_generate
skip 'RDoc 3 required' unless rdoc_3?
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate
assert @hook.rdoc_installed?
assert @hook.ri_installed?
rdoc = @hook.instance_variable_get :@rdoc
refute rdoc.options.hyperlink_all
end unless rdoc_4
def test_generate_configuration_rdoc_array
skip 'RDoc 3 required' unless rdoc_3?
Gem.configuration[:rdoc] = %w[-A]
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate
rdoc = @hook.instance_variable_get :@rdoc
assert rdoc.options.hyperlink_all
end unless rdoc_4
def test_generate_configuration_rdoc_string
skip 'RDoc 3 required' unless rdoc_3?
Gem.configuration[:rdoc] = '-A'
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate
rdoc = @hook.instance_variable_get :@rdoc
assert rdoc.options.hyperlink_all
end unless rdoc_4
def test_generate_disabled
@hook.generate_rdoc = false
@hook.generate_ri = false
@hook.generate
refute @hook.rdoc_installed?
refute @hook.ri_installed?
end
def test_generate_force
skip 'RDoc 3 required' unless rdoc_3?
FileUtils.mkdir_p @a.doc_dir 'ri'
FileUtils.mkdir_p @a.doc_dir 'rdoc'
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.force = true
@hook.generate
assert_path_exists File.join(@a.doc_dir('rdoc'), 'index.html')
assert_path_exists File.join(@a.doc_dir('ri'), 'cache.ri')
end unless rdoc_4
def test_generate_no_overwrite
skip 'RDoc 3 required' unless rdoc_3?
FileUtils.mkdir_p @a.doc_dir 'ri'
FileUtils.mkdir_p @a.doc_dir 'rdoc'
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate
refute_path_exists File.join(@a.doc_dir('rdoc'), 'index.html')
refute_path_exists File.join(@a.doc_dir('ri'), 'cache.ri')
end unless rdoc_4
def test_generate_legacy
skip 'RDoc < 3.8 required' if rdoc_3_8_or_better?
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.generate_legacy
assert @hook.rdoc_installed?
assert @hook.ri_installed?
end unless rdoc_4
def test_legacy_rdoc
skip 'RDoc < 3.8 required' if rdoc_3_8_or_better?
FileUtils.mkdir_p @a.doc_dir
FileUtils.mkdir_p File.join(@a.gem_dir, 'lib')
@hook.legacy_rdoc '--op', @a.doc_dir('rdoc')
assert @hook.rdoc_installed?
end unless rdoc_4
def test_new_rdoc
assert_kind_of RDoc::RDoc, @hook.new_rdoc
end
def test_rdoc_installed?
refute @hook.rdoc_installed?
FileUtils.mkdir_p @a.doc_dir 'rdoc'
assert @hook.rdoc_installed?
end
def test_remove
FileUtils.mkdir_p @a.doc_dir 'rdoc'
FileUtils.mkdir_p @a.doc_dir 'ri'
@hook.remove
refute @hook.rdoc_installed?
refute @hook.ri_installed?
assert_path_exists @a.doc_dir
end
def test_remove_unwritable
skip 'chmod not supported' if Gem.win_platform?
FileUtils.mkdir_p @a.base_dir
FileUtils.chmod 0, @a.base_dir
e = assert_raises Gem::FilePermissionError do
@hook.remove
end
assert_equal @a.base_dir, e.directory
ensure
FileUtils.chmod(0755, @a.base_dir) if File.directory?(@a.base_dir)
end
def test_ri_installed?
refute @hook.ri_installed?
FileUtils.mkdir_p @a.doc_dir 'ri'
assert @hook.ri_installed?
end
def test_setup
@hook.setup
assert_path_exists @a.doc_dir
end
def test_setup_unwritable
skip 'chmod not supported' if Gem.win_platform?
FileUtils.mkdir_p @a.doc_dir
FileUtils.chmod 0, @a.doc_dir
e = assert_raises Gem::FilePermissionError do
@hook.setup
end
assert_equal @a.doc_dir, e.directory
ensure
if File.exist? @a.doc_dir
FileUtils.chmod 0755, @a.doc_dir
FileUtils.rm_r @a.doc_dir
end
end
end
|
