Class: Rack::BodyProxy

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

Overview

Proxy for response bodies allowing calling a block when the response body is closed (after the response has been fully sent to the client).

Direct Known Subclasses

Events::EventedBodyProxy

Instance Method Summary collapse

Constructor Details

#initialize(body, &block) ⇒ BodyProxy

Set the response body to wrap, and the block to call when the response has been fully sent.



10
11
12
13
14
 
# File 'lib/rack/body_proxy.rb', line 10

def initialize(body, &block)
  @body = body
  @block = block
  @closed = false
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object

Delegate missing methods to the wrapped body.



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/rack/body_proxy.rb', line 45

def method_missing(method_name, *args, &block)
  case method_name
  when :to_str
    super
  when :to_ary
    begin
      @body.__send__(method_name, *args, &block)
    ensure
      close
    end
  else
    @body.__send__(method_name, *args, &block)
  end
end

Instance Method Details

#close ⇒ Object

If not already closed, close the wrapped body and then call the block the proxy was initialized with.



28
29
30
31
32
33
34
35
36
 
# File 'lib/rack/body_proxy.rb', line 28

def close
  return if @closed
  @closed = true
  begin
    @body.close if @body.respond_to?(:close)
  ensure
    @block.call
  end
end

#closed? ⇒ Boolean

Whether the proxy is closed. The proxy starts as not closed, and becomes closed on the first call to close.

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/rack/body_proxy.rb', line 40

def closed?
  @closed
end

#respond_to_missing?(method_name, include_all = false) ⇒ Boolean

Return whether the wrapped body responds to the method.

Returns:

  • (Boolean) 


17
18
19
20
21
22
23
24
 
# File 'lib/rack/body_proxy.rb', line 17

def respond_to_missing?(method_name, include_all = false)
  case method_name
  when :to_str
    false
  else
    super or @body.respond_to?(method_name, include_all)
  end
end