Class: Rack::Lint::InputWrapper

Inherits:
Object
  • Object
show all
Includes:
Assertion
Defined in:
lib/rack/lint.rb

Instance Method Summary collapse

Methods included from Assertion

#assert

Constructor Details

#initialize(input) ⇒ InputWrapper

Returns a new instance of InputWrapper.



258
259
260
 
# File 'lib/rack/lint.rb', line 258

def initialize(input)
  @input = input
end

Instance Method Details

#close(*args) ⇒ Object

  • close must never be called on the input stream.



347
348
349
 
# File 'lib/rack/lint.rb', line 347

def close(*args)
  assert("rack.input#close must not be called") { false }
end

#each(*args) ⇒ Object

  • each must be called without arguments and only yield Strings.



319
320
321
322
323
324
325
326
327
 
# File 'lib/rack/lint.rb', line 319

def each(*args)
  assert("rack.input#each called with arguments") { args.size == 0 }
  @input.each { |line|
    assert("rack.input#each didn't yield a String") {
      line.instance_of? String
    }
    yield line
  }
end

#gets(*args) ⇒ Object

  • gets must be called without arguments and return a string, or nil on EOF.



268
269
270
271
272
273
274
275
 
# File 'lib/rack/lint.rb', line 268

def gets(*args)
  assert("rack.input#gets called with arguments") { args.size == 0 }
  v = @input.gets
  assert("rack.input#gets didn't return a String") {
    v.nil? or v.instance_of? String
  }
  v
end

#read(*args) ⇒ Object

  • read behaves like IO#read. Its signature is read([length, [buffer]]). If given, length must be an non-negative Integer (>= 0) or nil, and buffer must be a String and may not be nil. If length is given and not nil, then this method reads at most length bytes from the input stream. If length is not given or nil, then this method reads all data until EOF. When EOF is reached, this method returns nil if length is given and not nil, or “” if length is not given or is nil. If buffer is given, then the read data will be placed into buffer instead of a newly created String object.



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
 
# File 'lib/rack/lint.rb', line 286

def read(*args)
  assert("rack.input#read called with too many arguments") {
    args.size <= 2
  }
  if args.size >= 1
    assert("rack.input#read called with non-integer and non-nil length") {
      args.first.kind_of?(Integer) || args.first.nil?
    }
    assert("rack.input#read called with a negative length") {
      args.first.nil? || args.first >= 0
    }
  end
  if args.size >= 2
    assert("rack.input#read called with non-String buffer") {
      args[1].kind_of?(String)
    }
  end
  
  v = @input.read(*args)
  
  assert("rack.input#read didn't return nil or a String") {
    v.nil? or v.instance_of? String
  }
  if args[0].nil?
    assert("rack.input#read(nil) returned nil on EOF") {
      !v.nil?
    }
  end
  
  v
end

#rewind(*args) ⇒ Object

  • rewind must be called without arguments. It rewinds the input stream back to the beginning. It must not raise Errno::ESPIPE: that is, it may not be a pipe or a socket. Therefore, handler developers must buffer the input data into some rewindable object if the underlying input stream is not rewindable.



334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/rack/lint.rb', line 334

def rewind(*args)
  assert("rack.input#rewind called with arguments") { args.size == 0 }
  assert("rack.input#rewind raised Errno::ESPIPE") {
    begin
      @input.rewind
      true
    rescue Errno::ESPIPE
      false
    end
  }
end

#size ⇒ Object 



262
263
264
 
# File 'lib/rack/lint.rb', line 262

def size
  @input.size
end