Class: Rack::RewindableInput

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/rewindable_input.rb

Overview

Class which can make any IO object rewindable, including non-rewindable ones. It does this by buffering the data into a tempfile, which is rewindable.

rack.input is required to be rewindable, so if your input stream IO is non-rewindable by nature (e.g. a pipe or a socket) then you can wrap it in an object of this class to easily make it rewindable.

Don’t forget to call #close when you’re done. This frees up temporary resources that RewindableInput uses, though it does not close the original IO object.

Defined Under Namespace

Classes: Tempfile

Instance Method Summary collapse

Constructor Details

#initialize(io) ⇒ RewindableInput

Returns a new instance of RewindableInput.



14
15
16
17
18
 
# File 'lib/rack/rewindable_input.rb', line 14

def initialize(io)
  @io = io
  @rewindable_io = nil
  @unlinked = false
end

Instance Method Details

#close ⇒ Object

Closes this RewindableInput object without closing the originally wrapped IO oject. Cleans up any temporary resources that this RewindableInput has created.

This method may be called multiple times. It does nothing on subsequent calls.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rack/rewindable_input.rb', line 45

def close
  if @rewindable_io
    if @unlinked
      @rewindable_io.close
    else
      @rewindable_io.close!
    end
    @rewindable_io = nil
  end
end

#each(&block) ⇒ Object 



30
31
32
33
 
# File 'lib/rack/rewindable_input.rb', line 30

def each(&block)
  make_rewindable unless @rewindable_io
  @rewindable_io.each(&block)
end

#gets ⇒ Object 



20
21
22
23
 
# File 'lib/rack/rewindable_input.rb', line 20

def gets
  make_rewindable unless @rewindable_io
  @rewindable_io.gets
end

#read(*args) ⇒ Object 



25
26
27
28
 
# File 'lib/rack/rewindable_input.rb', line 25

def read(*args)
  make_rewindable unless @rewindable_io
  @rewindable_io.read(*args)
end

#rewind ⇒ Object 



35
36
37
38
 
# File 'lib/rack/rewindable_input.rb', line 35

def rewind
  make_rewindable unless @rewindable_io
  @rewindable_io.rewind
end