File: stream.rb

package info (click to toggle)
ruby-protocol-http 0.55.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 840 kB
  • sloc: ruby: 6,904; makefile: 4
file content (335 lines) | stat: -rw-r--r-- 8,940 bytes parent folder | download
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
# frozen_string_literal: true

# Released under the MIT License.
# Copyright, 2022-2025, by Samuel Williams.

require "protocol/http/body/stream"
require "protocol/http/body/buffered"

describe Protocol::HTTP::Body::Stream do
	let(:input) {Protocol::HTTP::Body::Buffered.new(["Hello", "World"])}
	let(:output) {Protocol::HTTP::Body::Buffered.new}
	let(:stream) {subject.new(input, output)}
	
	with "no input" do
		let(:input) {nil}
		
		it "should be empty" do
			expect(stream).to be(:empty?)
		end
		
		it "should read nothing" do
			expect(stream.read).to be == ""
		end
	end
	
	with "#empty?" do
		it "should be empty" do
			expect(stream).to be(:empty?)
		end
	end
	
	with "#read" do
		it "should read from the input" do
			expect(stream.read(5)).to be == "Hello"
		end
		
		it "can handle zero-length read" do
			expect(stream.read(0)).to be == ""
		end
		
		it "can read the entire input" do
			expect(stream.read).to be == "HelloWorld"
		end
		
		it "should read from the input into the given buffer" do
			buffer = String.new
			expect(stream.read(5, buffer)).to be == "Hello"
			expect(buffer).to be == "Hello"
			expect(stream.read(5, buffer)).to be == "World"
			expect(buffer).to be == "World"
			expect(stream.read(5, buffer)).to be == nil
			expect(buffer).to be == ""
		end
		
		it "can read partial input" do
			expect(stream.read(2)).to be == "He"
			expect(stream.read(2)).to be == "ll"
			expect(stream.read(2)).to be == "oW"
			expect(stream.read(2)).to be == "or"
			expect(stream.read(2)).to be == "ld"
			expect(stream.read(2)).to be == nil
		end
		
		it "can read partial input into the given buffer" do
			buffer = String.new
			expect(stream.read(100, buffer)).to be == "HelloWorld"
			expect(buffer).to be == "HelloWorld"
			
			expect(stream.read(2, buffer)).to be == nil
			expect(buffer).to be == ""
		end
	end
	
	with "#read_nonblock" do
		it "should read from the input" do
			expect(stream.read_nonblock(5)).to be == "Hello"
			expect(stream.read_nonblock(5)).to be == "World"
			expect(stream.read_nonblock(5)).to be == nil
		end
		
		it "should read from the input into the given buffer" do
			buffer = String.new
			expect(stream.read_nonblock(5, buffer)).to be == "Hello"
			expect(buffer).to be == "Hello"
			expect(stream.read_nonblock(5, buffer)).to be == "World"
			expect(buffer).to be == "World"
			expect(stream.read_nonblock(5, buffer)).to be == nil
			expect(buffer).to be == ""
		end
		
		it "can read input into the given buffer" do
			buffer = String.new
			expect(stream.read_nonblock(100, buffer)).to be == "Hello"
			expect(buffer).to be == "Hello"
			
			expect(stream.read_nonblock(100, buffer)).to be == "World"
			expect(buffer).to be == "World"
			
			expect(stream.read_nonblock(2, buffer)).to be == nil
			expect(buffer).to be == ""
		end
		
		it "can read partial input" do
			expect(stream.read_nonblock(2)).to be == "He"
			expect(stream.read_nonblock(2)).to be == "ll"
			expect(stream.read_nonblock(2)).to be == "o"
			expect(stream.read_nonblock(2)).to be == "Wo"
			expect(stream.read_nonblock(2)).to be == "rl"
			expect(stream.read_nonblock(2)).to be == "d"
			expect(stream.read_nonblock(2)).to be == nil
		end
	end
	
	with "#read_partial" do
		it "can read partial input" do
			expect(stream.read_partial(2)).to be == "He"
			expect(stream.read_partial(2)).to be == "ll"
			expect(stream.read_partial(2)).to be == "o"
			expect(stream.read_partial(2)).to be == "Wo"
			expect(stream.read_partial(2)).to be == "rl"
			expect(stream.read_partial(2)).to be == "d"
			expect(stream.read_partial(2)).to be == nil
		end
		
		it "can read partial input with buffer" do
			buffer = String.new
			expect(stream.read_partial(2, buffer)).to be == "He"
			expect(buffer).to be == "He"
			expect(stream.read_partial(2, buffer)).to be == "ll"
			expect(buffer).to be == "ll"
			expect(stream.read_partial(2, buffer)).to be == "o"
			expect(buffer).to be == "o"
			expect(stream.read_partial(2, buffer)).to be == "Wo"
			expect(buffer).to be == "Wo"
			expect(stream.read_partial(2, buffer)).to be == "rl"
			expect(buffer).to be == "rl"
			expect(stream.read_partial(2, buffer)).to be == "d"
			expect(buffer).to be == "d"
			expect(stream.read_partial(2, buffer)).to be == nil
			expect(buffer).to be == ""
		end
	end
	
	with "#readpartial" do
		it "can read partial input" do
			expect(stream.readpartial(20)).to be == "Hello"
			expect(stream.readpartial(20)).to be == "World"
			expect{stream.readpartial(20)}.to raise_exception(EOFError)
		end
		
		it "can read partial input with buffer" do
			buffer = String.new
			expect(stream.readpartial(20, buffer)).to be == "Hello"
			expect(buffer).to be == "Hello"
			expect(stream.readpartial(20, buffer)).to be == "World"
			expect(buffer).to be == "World"
			expect{stream.readpartial(20, buffer)}.to raise_exception(EOFError)
			expect(buffer).to be == ""
		end
	end
	
	with "#each" do
		it "can iterate over input" do
			chunks = []
			
			stream.each do |chunk|
				chunks << chunk
			end
			
			expect(chunks).to be == ["Hello", "World"]
		end
		
		it "can iterate over input with buffer" do
			expect(stream.read(2)).to be == "He"
			
			chunks = []
			
			stream.each do |chunk|
				chunks << chunk
			end
			
			expect(chunks).to be == ["llo", "World"]
		end
		
		it "can return an enumerator" do
			expect(stream.each.to_a).to be == ["Hello", "World"]
		end
	end
	
	with "#read_until" do
		it "can read until a pattern is encountered" do
			expect(stream.read_until("o")).to be == "Hello"
			expect(stream.read_until("d")).to be == "World"
		end
		
		it "can read until a pattern which isn't encountered" do
			expect(stream.read_until("X")).to be_nil
		end
	end
	
	with "#gets" do
		let(:input) {Protocol::HTTP::Body::Buffered.new(["Hello\nWorld\n"])}
		
		it "can read lines" do
			expect(stream.gets).to be == "Hello\n"
			expect(stream.gets).to be == "World\n"
			expect(stream.gets).to be == nil
		end
		
		it "can read up until the limit" do
			expect(stream.gets("X", 2)).to be == "He"
		end
		
		it "can read lines with limit" do
			expect(stream.gets(2)).to be == "He"
			expect(stream.gets(6)).to be == "llo\n"
			expect(stream.gets(2)).to be == "Wo"
			expect(stream.gets(6)).to be == "rld\n"
			expect(stream.gets(2)).to be == nil
		end
		
		it "can read lines and chomp separators" do
			expect(stream.gets(chomp: true)).to be == "Hello"
			expect(stream.gets(chomp: true)).to be == "World"
			expect(stream.gets(chomp: true)).to be == nil
		end
		
		it "can read without separator" do
			expect(stream.gets(nil, 4)).to be == "Hell"
			expect(stream.gets(nil, 4)).to be == "o\nWo"
			expect(stream.gets(nil, 4)).to be == "rld\n"
			expect(stream.gets(nil, 4)).to be == nil
		end
		
		with "several chunks" do
			let(:input) {Protocol::HTTP::Body::Buffered.new(["Hello ", "World\n"])}
			
			it "can read lines" do
				expect(stream.gets).to be == "Hello World\n"
				expect(stream.gets).to be == nil
			end
		end
		
		with "incomplete line at the end" do
			let(:input) {Protocol::HTTP::Body::Buffered.new(["Hello\nWorld"])}
			
			it "returns the remaining buffer when there is no more data to read" do
				expect(stream.gets).to be == "Hello\n"
				expect(stream.gets).to be == "World"
				expect(stream.gets).to be == nil
			end
		end
	end
	
	with "#close_read" do
		it "should close the input" do
			stream.read(1)
			stream.close_read
			expect{stream.read(1)}.to raise_exception(IOError)
		end
	end
	
	with "#write" do
		it "should write to the output" do
			expect(stream.write("Hello")).to be == 5
			expect(stream.write("World")).to be == 5
			
			expect(output.chunks).to be == ["Hello", "World"]
		end
	end
	
	with "#<<" do
		it "should write to the output" do
			stream << "Hello"
			stream << "World"
			
			expect(output.chunks).to be == ["Hello", "World"]
		end
	end
	
	with "#write_nonblock" do
		it "should write to the output" do
			stream.write_nonblock("Hello")
			stream.write_nonblock("World")
			
			expect(output.chunks).to be == ["Hello", "World"]
		end
	end
	
	with "#puts" do
		it "should write lines to the output" do
			stream.puts("Hello", "World")
			stream.puts("Goodbye")
			
			expect(output.chunks).to be == ["Hello\nWorld\n", "Goodbye\n"]
		end
	end
	
	with "#close_write" do
		it "should close the input" do
			stream.close_write
			expect{stream.write("X")}.to raise_exception(IOError)
		end
	end
	
	with "#flush" do
		it "can be flushed" do	
			# For streams, this is a no-op since buffering is handled by the output body.
			stream.flush
		end
	end
	
	with "#close" do
		it "can can be closed" do
			stream.close
			expect(stream).to be(:closed?)
		end
		
		it "can be closed multiple times" do
			stream.close
			stream.close
			expect(stream).to be(:closed?)
		end
	end
	
	with "IO.copy_stream" do
		let(:output) {StringIO.new}
		
		it "can copy input to output" do
			::IO.copy_stream(stream, output)
			
			expect(output.string).to be == "HelloWorld"
		end
	end
end