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
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
|
# coding: us-ascii
require 'rdoc/test_case'
class TestRDocComment < RDoc::TestCase
def setup
super
@top_level = @store.add_file 'file.rb'
@comment = RDoc::Comment.new
@comment.location = @top_level
@comment.text = 'this is a comment'
end
def test_empty_eh
refute_empty @comment
@comment = ''
assert_empty @comment
end
def test_equals2
assert_equal @comment, @comment.dup
c2 = @comment.dup
c2.text = nil
refute_equal @comment, c2
c3 = @comment.dup
c3.location = nil
refute_equal @comment, c3
end
def test_extract_call_seq
m = RDoc::AnyMethod.new nil, 'm'
comment = RDoc::Comment.new <<-COMMENT, @top_level
call-seq:
bla => true or false
moar comment
COMMENT
comment.extract_call_seq m
assert_equal "bla => true or false\n", m.call_seq
end
def test_extract_call_seq_blank
m = RDoc::AnyMethod.new nil, 'm'
comment = RDoc::Comment.new <<-COMMENT, @top_level
call-seq:
bla => true or false
COMMENT
comment.extract_call_seq m
assert_equal "bla => true or false\n", m.call_seq
end
def test_extract_call_seq_commented
m = RDoc::AnyMethod.new nil, 'm'
comment = RDoc::Comment.new <<-COMMENT, @top_level
# call-seq:
# bla => true or false
#
# moar comment
COMMENT
comment.extract_call_seq m
assert_equal nil, m.call_seq
end
def test_extract_call_seq_no_blank
m = RDoc::AnyMethod.new nil, 'm'
comment = RDoc::Comment.new <<-COMMENT, @top_level
call-seq:
bla => true or false
COMMENT
comment.extract_call_seq m
assert_equal "bla => true or false\n", m.call_seq
end
def test_extract_call_seq_undent
m = RDoc::AnyMethod.new nil, 'm'
comment = RDoc::Comment.new <<-COMMENT, @top_level
call-seq:
bla => true or false
moar comment
COMMENT
comment.extract_call_seq m
assert_equal "bla => true or false\nmoar comment\n", m.call_seq
end
def test_extract_call_seq_c
comment = RDoc::Comment.new <<-COMMENT
call-seq:
commercial() -> Date <br />
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
If no arguments are given:
* ruby 1.8: returns a +Date+ for 1582-10-15 (the Day of Calendar Reform in
Italy)
* ruby 1.9: returns a +Date+ for julian day 0
Otherwise, returns a +Date+ for the commercial week year, commercial week,
and commercial week day given. Ignores the 4th argument.
COMMENT
method_obj = RDoc::AnyMethod.new nil, 'blah'
comment.extract_call_seq method_obj
expected = <<-CALL_SEQ.chomp
commercial() -> Date <br />
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
CALL_SEQ
assert_equal expected, method_obj.call_seq
end
def test_extract_call_seq_c_no_blank
comment = RDoc::Comment.new <<-COMMENT
call-seq:
commercial() -> Date <br />
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
COMMENT
method_obj = RDoc::AnyMethod.new nil, 'blah'
comment.extract_call_seq method_obj
expected = <<-CALL_SEQ.chomp
commercial() -> Date <br />
commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
CALL_SEQ
assert_equal expected, method_obj.call_seq
end
def test_extract_call_seq_c_separator
comment = RDoc::Comment.new <<-'COMMENT'
call-seq:
ARGF.readlines(sep=$/) -> array
ARGF.readlines(limit) -> array
ARGF.readlines(sep, limit) -> array
ARGF.to_a(sep=$/) -> array
ARGF.to_a(limit) -> array
ARGF.to_a(sep, limit) -> array
Reads +ARGF+'s current file in its entirety, returning an +Array+ of its
lines, one line per element. Lines are assumed to be separated by _sep_.
lines = ARGF.readlines
lines[0] #=> "This is line one\n"
COMMENT
method_obj = RDoc::AnyMethod.new nil, 'blah'
comment.extract_call_seq method_obj
expected = <<-CALL_SEQ
ARGF.readlines(sep=$/) -> array
ARGF.readlines(limit) -> array
ARGF.readlines(sep, limit) -> array
ARGF.to_a(sep=$/) -> array
ARGF.to_a(limit) -> array
ARGF.to_a(sep, limit) -> array
CALL_SEQ
assert_equal expected, method_obj.call_seq
expected = <<-'COMMENT'
Reads +ARGF+'s current file in its entirety, returning an +Array+ of its
lines, one line per element. Lines are assumed to be separated by _sep_.
lines = ARGF.readlines
lines[0] #=> "This is line one\n"
COMMENT
assert_equal expected, comment.text
end
def test_force_encoding
skip "Encoding not implemented" unless Object.const_defined? :Encoding
@comment.force_encoding Encoding::UTF_8
assert_equal Encoding::UTF_8, @comment.text.encoding
end
def test_format
assert_equal 'rdoc', @comment.format
end
def test_format_equals
c = comment 'content'
document = c.parse
c.format = RDoc::RD
assert_equal RDoc::RD, c.format
refute_same document, c.parse
end
def test_initialize_copy
copy = @comment.dup
refute_same @comment.text, copy.text
assert_same @comment.location, copy.location
end
def test_location
assert_equal @top_level, @comment.location
end
def test_normalize
@comment.text = <<-TEXT
# comment
TEXT
assert_same @comment, @comment.normalize
assert_equal 'comment', @comment.text
end
def test_normalize_twice
@comment.text = <<-TEXT
# comment
TEXT
@comment.normalize
text = @comment.text
@comment.normalize
assert_same text, @comment.text, 'normalize not cached'
end
def test_normalize_document
@comment.text = nil
@comment.document = @RM::Document.new
assert_same @comment, @comment.normalize
assert_nil @comment.text
end
def test_normalize_eh
refute @comment.normalized?
@comment.normalize
assert @comment.normalized?
end
def test_text
assert_equal 'this is a comment', @comment.text
end
def test_text_equals
@comment.text = 'other'
assert_equal 'other', @comment.text
refute @comment.normalized?
end
def test_text_equals_no_text
c = RDoc::Comment.new nil, @top_level
c.document = @RM::Document.new
e = assert_raises RDoc::Error do
c.text = 'other'
end
assert_equal 'replacing document-only comment is not allowed', e.message
end
def test_text_equals_parsed
document = @comment.parse
@comment.text = 'other'
refute_equal document, @comment.parse
end
def test_tomdoc_eh
refute @comment.tomdoc?
@comment.format = 'tomdoc'
assert @comment.tomdoc?
end
def test_parse
parsed = @comment.parse
expected = @RM::Document.new(
@RM::Paragraph.new('this is a comment'))
expected.file = @top_level
assert_equal expected, parsed
assert_same parsed, @comment.parse
end
def test_parse_rd
c = comment 'it ((*works*))'
c.format = 'rd'
expected =
@RM::Document.new(
@RM::Paragraph.new('it <em>works</em>'))
expected.file = @top_level
assert_equal expected, c.parse
end
def test_remove_private_encoding
skip "Encoding not implemented" unless Object.const_defined? :Encoding
comment = RDoc::Comment.new <<-EOS, @top_level
# This is text
#--
# this is private
EOS
comment.force_encoding Encoding::IBM437
comment.remove_private
assert_equal Encoding::IBM437, comment.text.encoding
end
def test_remove_private_hash
@comment.text = <<-TEXT
#--
# private
#++
# public
TEXT
@comment.remove_private
assert_equal "# public\n", @comment.text
end
def test_remove_private_hash_trail
comment = RDoc::Comment.new <<-EOS, @top_level
# This is text
#--
# this is private
EOS
expected = RDoc::Comment.new <<-EOS, @top_level
# This is text
EOS
comment.remove_private
assert_equal expected, comment
end
def test_remove_private_long
comment = RDoc::Comment.new <<-EOS, @top_level
#-----
#++
# this is text
#-----
EOS
expected = RDoc::Comment.new <<-EOS, @top_level
# this is text
EOS
comment.remove_private
assert_equal expected, comment
end
def test_remove_private_rule
comment = RDoc::Comment.new <<-EOS, @top_level
# This is text with a rule:
# ---
# this is also text
EOS
expected = comment.dup
comment.remove_private
assert_equal expected, comment
end
def test_remove_private_star
@comment.text = <<-TEXT
/*
*--
* private
*++
* public
*/
TEXT
@comment.remove_private
assert_equal "/*\n * public\n */\n", @comment.text
end
def test_remove_private_star2
@comment.text = <<-TEXT
/*--
* private
*++
* public
*/
TEXT
@comment.remove_private
assert_equal "/*--\n * private\n *++\n * public\n */\n", @comment.text
end
def test_remove_private_toggle
comment = RDoc::Comment.new <<-EOS, @top_level
# This is text
#--
# this is private
#++
# This is text again.
EOS
expected = RDoc::Comment.new <<-EOS, @top_level
# This is text
# This is text again.
EOS
comment.remove_private
assert_equal expected, comment
end
def test_remove_private_toggle_encoding
skip "Encoding not implemented" unless Object.const_defined? :Encoding
comment = RDoc::Comment.new <<-EOS, @top_level
# This is text
#--
# this is private
#++
# This is text again.
EOS
comment.force_encoding Encoding::IBM437
comment.remove_private
assert_equal Encoding::IBM437, comment.text.encoding
end
def test_remove_private_toggle_encoding_ruby_bug?
skip "Encoding not implemented" unless Object.const_defined? :Encoding
comment = RDoc::Comment.new <<-EOS, @top_level
#--
# this is private
#++
# This is text again.
EOS
comment.force_encoding Encoding::IBM437
comment.remove_private
assert_equal Encoding::IBM437, comment.text.encoding
end
end
|
