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
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
|
# -*- encoding: utf-8 -*-
require_relative '../../spec_helper'
require_relative 'fixtures/classes'
describe "IO.read" do
before :each do
@fname = tmp("io_read.txt")
@contents = "1234567890"
touch(@fname) { |f| f.write @contents }
end
after :each do
rm_r @fname
end
it "reads the contents of a file" do
IO.read(@fname).should == @contents
end
it "calls #to_path on non-String arguments" do
p = mock('path')
p.should_receive(:to_path).and_return(@fname)
IO.read(p)
end
it "accepts an empty options Hash" do
IO.read(@fname, {}).should == @contents
end
it "accepts a length, and empty options Hash" do
IO.read(@fname, 3, {}).should == @contents[0, 3]
end
it "accepts a length, offset, and empty options Hash" do
IO.read(@fname, 3, 0, {}).should == @contents[0, 3]
end
it "raises an IOError if the options Hash specifies write mode" do
lambda { IO.read(@fname, 3, 0, {mode: "w"}) }.should raise_error(IOError)
end
it "raises an IOError if the options Hash specifies append only mode" do
lambda { IO.read(@fname, {mode: "a"}) }.should raise_error(IOError)
end
it "reads the file if the options Hash includes read mode" do
IO.read(@fname, {mode: "r"}).should == @contents
end
it "reads the file if the options Hash includes read/write mode" do
IO.read(@fname, {mode: "r+"}).should == @contents
end
it "reads the file if the options Hash includes read/write append mode" do
IO.read(@fname, {mode: "a+"}).should == @contents
end
it "treats second nil argument as no length limit" do
IO.read(@fname, nil).should == @contents
IO.read(@fname, nil, 5).should == IO.read(@fname, @contents.length, 5)
end
it "treats third nil argument as 0" do
IO.read(@fname, nil, nil).should == @contents
IO.read(@fname, 5, nil).should == IO.read(@fname, 5, 0)
end
it "reads the contents of a file up to a certain size when specified" do
IO.read(@fname, 5).should == @contents.slice(0..4)
end
it "reads the contents of a file from an offset of a specific size when specified" do
IO.read(@fname, 5, 3).should == @contents.slice(3, 5)
end
it "returns nil at end-of-file when length is passed" do
IO.read(@fname, 1, 10).should == nil
end
it "raises an Errno::ENOENT when the requested file does not exist" do
rm_r @fname
lambda { IO.read @fname }.should raise_error(Errno::ENOENT)
end
it "raises a TypeError when not passed a String type" do
lambda { IO.read nil }.should raise_error(TypeError)
end
it "raises an ArgumentError when not passed a valid length" do
lambda { IO.read @fname, -1 }.should raise_error(ArgumentError)
end
it "raises an Errno::EINVAL when not passed a valid offset" do
lambda { IO.read @fname, 0, -1 }.should raise_error(Errno::EINVAL)
lambda { IO.read @fname, -1, -1 }.should raise_error(Errno::EINVAL)
end
with_feature :encoding do
it "uses the external encoding specified via the :external_encoding option" do
str = IO.read(@fname, external_encoding: Encoding::ISO_8859_1)
str.encoding.should == Encoding::ISO_8859_1
end
it "uses the external encoding specified via the :encoding option" do
str = IO.read(@fname, encoding: Encoding::ISO_8859_1)
str.encoding.should == Encoding::ISO_8859_1
end
end
end
describe "IO.read from a pipe" do
it "runs the rest as a subprocess and returns the standard output" do
cmd = "|sh -c 'echo hello'"
platform_is :windows do
cmd = "|cmd.exe /C echo hello"
end
IO.read(cmd).should == "hello\n"
end
with_feature :fork do
it "opens a pipe to a fork if the rest is -" do
str = IO.read("|-")
if str # parent
str.should == "hello from child\n"
else #child
puts "hello from child"
exit!
end
end
end
it "reads only the specified number of bytes requested" do
cmd = "|sh -c 'echo hello'"
platform_is :windows do
cmd = "|cmd.exe /C echo hello"
end
IO.read(cmd, 1).should == "h"
end
platform_is_not :windows do
it "raises Errno::ESPIPE if passed an offset" do
lambda {
IO.read("|sh -c 'echo hello'", 1, 1)
}.should raise_error(Errno::ESPIPE)
end
end
quarantine! do # The process tried to write to a nonexistent pipe.
platform_is :windows do
# TODO: It should raise Errno::ESPIPE on Windows as well
# once https://bugs.ruby-lang.org/issues/12230 is fixed.
it "raises Errno::EINVAL if passed an offset" do
lambda {
IO.read("|cmd.exe /C echo hello", 1, 1)
}.should raise_error(Errno::EINVAL)
end
end
end
end
describe "IO.read on an empty file" do
before :each do
@fname = tmp("io_read_empty.txt")
touch(@fname)
end
after :each do
rm_r @fname
end
it "returns nil when length is passed" do
IO.read(@fname, 1).should == nil
end
it "returns an empty string when no length is passed" do
IO.read(@fname).should == ""
end
end
describe "IO#read" do
before :each do
@fname = tmp("io_read.txt")
@contents = "1234567890"
touch(@fname) { |f| f.write @contents }
@io = open @fname, "r+"
end
after :each do
@io.close
rm_r @fname
end
it "can be read from consecutively" do
@io.read(1).should == '1'
@io.read(2).should == '23'
@io.read(3).should == '456'
@io.read(4).should == '7890'
end
it "clears the output buffer if there is nothing to read" do
@io.pos = 10
buf = 'non-empty string'
@io.read(10, buf).should == nil
buf.should == ''
end
it "consumes zero bytes when reading zero bytes" do
@io.read(0).should == ''
@io.pos.should == 0
@io.getc.chr.should == '1'
end
it "is at end-of-file when everything has been read" do
@io.read
@io.eof?.should == true
end
it "reads the contents of a file" do
@io.read.should == @contents
end
it "places the specified number of bytes in the buffer" do
buf = ""
@io.read 5, buf
buf.should == "12345"
end
it "expands the buffer when too small" do
buf = "ABCDE"
@io.read nil, buf
buf.should == @contents
end
it "overwrites the buffer" do
buf = "ABCDEFGHIJ"
@io.read nil, buf
buf.should == @contents
end
it "truncates the buffer when too big" do
buf = "ABCDEFGHIJKLMNO"
@io.read nil, buf
buf.should == @contents
@io.rewind
buf = "ABCDEFGHIJKLMNO"
@io.read 5, buf
buf.should == @contents[0..4]
end
it "returns the given buffer" do
buf = ""
@io.read(nil, buf).should equal buf
end
it "coerces the second argument to string and uses it as a buffer" do
buf = "ABCDE"
obj = mock("buff")
obj.should_receive(:to_str).any_number_of_times.and_return(buf)
@io.read(15, obj).should_not equal obj
buf.should == @contents
end
it "returns an empty string at end-of-file" do
@io.read
@io.read.should == ''
end
it "reads the contents of a file when more bytes are specified" do
@io.read(@contents.length + 1).should == @contents
end
it "returns an empty string at end-of-file" do
@io.read
@io.read.should == ''
end
it "returns an empty string when the current pos is bigger than the content size" do
@io.pos = 1000
@io.read.should == ''
end
it "returns nil at end-of-file with a length" do
@io.read
@io.read(1).should == nil
end
it "with length argument returns nil when the current pos is bigger than the content size" do
@io.pos = 1000
@io.read(1).should == nil
end
it "raises IOError on closed stream" do
lambda { IOSpecs.closed_io.read }.should raise_error(IOError)
end
platform_is_not :windows do
it "raises IOError when stream is closed by another thread" do
r, w = IO.pipe
t = Thread.new do
begin
r.read(1)
rescue => e
e
end
end
Thread.pass until t.stop?
r.close
t.join
t.value.should be_kind_of(IOError)
w.close
end
end
end
platform_is :windows do
describe "IO#read on Windows" do
before :each do
@fname = tmp("io_read.txt")
touch(@fname, "wb") { |f| f.write "a\r\nb\r\nc" }
end
after :each do
@io.close if @io
rm_r @fname
end
it "normalizes line endings in text mode" do
@io = new_io(@fname, "r")
@io.read.should == "a\nb\nc"
end
it "does not normalize line endings in binary mode" do
@io = new_io(@fname, "rb")
@io.read.should == "a\r\nb\r\nc"
end
end
end
describe "IO#read" do
before :each do
@io = IOSpecs.io_fixture "lines.txt"
end
after :each do
@io.close if @io
end
it "ignores unicode encoding" do
@io.readline.should == "Voici la ligne une.\n"
# read "Qui è"
@io.read(5).should == "Qui " + [195].pack('C*')
end
end
describe "IO#read in binary mode" do
before :each do
@internal = Encoding.default_internal
@name = fixture __FILE__, "read_binary.txt"
end
after :each do
Encoding.default_internal = @internal
end
it "does not transcode file contents when Encoding.default_internal is set" do
Encoding.default_internal = "utf-8"
result = File.open(@name, "rb") { |f| f.read }.chomp
result.encoding.should == Encoding::ASCII_8BIT
xE2 = [226].pack('C*')
result.should == ("abc" + xE2 + "def").force_encoding(Encoding::ASCII_8BIT)
end
it "does not transcode file contents when an internal encoding is specified" do
result = File.open(@name, "r:binary:utf-8") { |f| f.read }.chomp
result.encoding.should == Encoding::ASCII_8BIT
xE2 = [226].pack('C*')
result.should == ("abc" + xE2 + "def").force_encoding(Encoding::ASCII_8BIT)
end
end
describe "IO#read in text mode" do
before :each do
@external = Encoding.default_external
@internal = Encoding.default_internal
@name = fixture __FILE__, "read_text.txt"
end
after :each do
Encoding.default_external = @external
Encoding.default_internal = @internal
end
it "reads data according to the internal encoding" do
Encoding.default_internal = "utf-8"
Encoding.default_external = "utf-8"
result = File.open(@name, "rt") { |f| f.read }.chomp
result.encoding.should == Encoding::UTF_8
result.should == "abcâdef"
end
end
describe "IO.read with BOM" do
it "reads a file without a bom" do
name = fixture __FILE__, "no_bom_UTF-8.txt"
result = File.read(name, mode: "rb:BOM|utf-8")
result.force_encoding("ascii-8bit").should == "UTF-8\n"
end
it "reads a file with a utf-8 bom" do
name = fixture __FILE__, "bom_UTF-8.txt"
result = File.read(name, mode: "rb:BOM|utf-16le")
result.force_encoding("ascii-8bit").should == "UTF-8\n"
end
it "reads a file with a utf-16le bom" do
name = fixture __FILE__, "bom_UTF-16LE.txt"
result = File.read(name, mode: "rb:BOM|utf-8")
result.force_encoding("ascii-8bit").should == "U\x00T\x00F\x00-\x001\x006\x00L\x00E\x00\n\x00"
end
it "reads a file with a utf-16be bom" do
name = fixture __FILE__, "bom_UTF-16BE.txt"
result = File.read(name, mode: "rb:BOM|utf-8")
result.force_encoding("ascii-8bit").should == "\x00U\x00T\x00F\x00-\x001\x006\x00B\x00E\x00\n"
end
it "reads a file with a utf-32le bom" do
name = fixture __FILE__, "bom_UTF-32LE.txt"
result = File.read(name, mode: "rb:BOM|utf-8")
result.force_encoding("ascii-8bit").should == "U\x00\x00\x00T\x00\x00\x00F\x00\x00\x00-\x00\x00\x003\x00\x00\x002\x00\x00\x00L\x00\x00\x00E\x00\x00\x00\n\x00\x00\x00"
end
it "reads a file with a utf-32be bom" do
name = fixture __FILE__, "bom_UTF-32BE.txt"
result = File.read(name, mode: "rb:BOM|utf-8")
result.force_encoding("ascii-8bit").should == "\x00\x00\x00U\x00\x00\x00T\x00\x00\x00F\x00\x00\x00-\x00\x00\x003\x00\x00\x002\x00\x00\x00B\x00\x00\x00E\x00\x00\x00\n"
end
end
with_feature :encoding do
describe :io_read_internal_encoding, shared: true do
it "returns a transcoded String" do
@io.read.should == "ありがとう\n"
end
it "sets the String encoding to the internal encoding" do
@io.read.encoding.should equal(Encoding::UTF_8)
end
describe "when passed nil for limit" do
it "sets the buffer to a transcoded String" do
result = @io.read(nil, buf = "")
buf.should equal(result)
buf.should == "ありがとう\n"
end
it "sets the buffer's encoding to the internal encoding" do
buf = "".force_encoding Encoding::ISO_8859_1
@io.read(nil, buf)
buf.encoding.should equal(Encoding::UTF_8)
end
end
end
describe :io_read_size_internal_encoding, shared: true do
it "reads bytes when passed a size" do
@io.read(2).should == [164, 162].pack('C*').force_encoding(Encoding::ASCII_8BIT)
end
it "returns a String in ASCII-8BIT when passed a size" do
@io.read(4).encoding.should equal(Encoding::ASCII_8BIT)
end
it "does not change the buffer's encoding when passed a limit" do
buf = "".force_encoding Encoding::ISO_8859_1
@io.read(4, buf)
buf.should == [164, 162, 164, 234].pack('C*').force_encoding(Encoding::ISO_8859_1)
buf.encoding.should equal(Encoding::ISO_8859_1)
end
it "truncates the buffer but does not change the buffer's encoding when no data remains" do
buf = "abc".force_encoding Encoding::ISO_8859_1
@io.read
@io.read(1, buf).should be_nil
buf.size.should == 0
buf.encoding.should equal(Encoding::ISO_8859_1)
end
end
describe "IO#read" do
describe "when IO#external_encoding and IO#internal_encoding are nil" do
before :each do
@name = tmp("io_read.txt")
touch(@name) { |f| f.write "\x00\x01\x02" }
@io = new_io @name, "r+"
end
after :each do
@io.close if @io
rm_r @name
end
it "sets the String encoding to Encoding.default_external" do
@io.read.encoding.should equal(Encoding.default_external)
end
end
describe "with internal encoding" do
after :each do
@io.close if @io
end
describe "not specified" do
before :each do
@io = IOSpecs.io_fixture "read_euc_jp.txt", "r:euc-jp"
end
it "does not transcode the String" do
@io.read.should == ("ありがとう\n").encode(Encoding::EUC_JP)
end
it "sets the String encoding to the external encoding" do
@io.read.encoding.should equal(Encoding::EUC_JP)
end
it_behaves_like :io_read_size_internal_encoding, nil
end
describe "specified by open mode" do
before :each do
@io = IOSpecs.io_fixture "read_euc_jp.txt", "r:euc-jp:utf-8"
end
it_behaves_like :io_read_internal_encoding, nil
it_behaves_like :io_read_size_internal_encoding, nil
end
describe "specified by mode: option" do
before :each do
@io = IOSpecs.io_fixture "read_euc_jp.txt", mode: "r:euc-jp:utf-8"
end
it_behaves_like :io_read_internal_encoding, nil
it_behaves_like :io_read_size_internal_encoding, nil
end
describe "specified by internal_encoding: option" do
before :each do
options = { mode: "r",
internal_encoding: "utf-8",
external_encoding: "euc-jp" }
@io = IOSpecs.io_fixture "read_euc_jp.txt", options
end
it_behaves_like :io_read_internal_encoding, nil
it_behaves_like :io_read_size_internal_encoding, nil
end
describe "specified by encoding: option" do
before :each do
options = { mode: "r", encoding: "euc-jp:utf-8" }
@io = IOSpecs.io_fixture "read_euc_jp.txt", options
end
it_behaves_like :io_read_internal_encoding, nil
it_behaves_like :io_read_size_internal_encoding, nil
end
end
end
end
describe "IO#read with large data" do
before :each do
# TODO: what is the significance of this mystery math?
@data_size = 8096 * 2 + 1024
@data = "*" * @data_size
@fname = tmp("io_read.txt")
touch(@fname) { |f| f.write @data }
end
after :each do
rm_r @fname
end
it "reads all the data at once" do
File.open(@fname, 'r') { |io| ScratchPad.record io.read }
ScratchPad.recorded.size.should == @data_size
ScratchPad.recorded.should == @data
end
it "reads only the requested number of bytes" do
read_size = @data_size / 2
File.open(@fname, 'r') { |io| ScratchPad.record io.read(read_size) }
ScratchPad.recorded.size.should == read_size
ScratchPad.recorded.should == @data[0, read_size]
end
end
|