buffer.rb in httpx-1.1.0

- old
+ new

@@ -3,35 +3,41 @@
 require "delegate"
 require "stringio"
 require "tempfile"
 
 module HTTPX
+  # wraps and delegates to an internal buffer, which can be a StringIO or a Tempfile.
   class Response::Buffer < SimpleDelegator
+    # initializes buffer with the +threshold_size+ over which the payload gets buffer to a tempfile,
+    # the initial +bytesize+, and the +encoding+.
     def initialize(threshold_size:, bytesize: 0, encoding: Encoding::BINARY)
       @threshold_size = threshold_size
       @bytesize = bytesize
       @encoding = encoding
-      try_upgrade_buffer
+      @buffer = StringIO.new("".b)
       super(@buffer)
     end
 
     def initialize_dup(other)
       super
 
       @buffer = other.instance_variable_get(:@buffer).dup
     end
 
+    # size in bytes of the buffered content.
     def size
       @bytesize
     end
 
+    # writes the +chunk+ into the buffer.
     def write(chunk)
       @bytesize += chunk.bytesize
       try_upgrade_buffer
       @buffer.write(chunk)
     end
 
+    # returns the buffered content as a string.
     def to_s
       case @buffer
       when StringIO
         begin
           @buffer.string.force_encoding(@encoding)
@@ -47,38 +53,38 @@
           content
         end
       end
     end
 
+    # closes the buffer.
     def close
       @buffer.close
       @buffer.unlink if @buffer.respond_to?(:unlink)
     end
 
     private
 
+    # initializes the buffer into a StringIO, or turns it into a Tempfile when the threshold
+    # has been reached.
     def try_upgrade_buffer
-      if !@buffer.is_a?(Tempfile) && @bytesize > @threshold_size
-        aux = @buffer
+      return unless @bytesize > @threshold_size
 
-        @buffer = Tempfile.new("httpx", encoding: Encoding::BINARY, mode: File::RDWR)
+      return if @buffer.is_a?(Tempfile)
 
-        if aux
-          aux.rewind
-          ::IO.copy_stream(aux, @buffer)
-          aux.close
-        end
+      aux = @buffer
 
-      else
-        return if @buffer
+      @buffer = Tempfile.new("httpx", encoding: Encoding::BINARY, mode: File::RDWR)
 
-        @buffer = StringIO.new("".b)
-
+      if aux
+        aux.rewind
+        ::IO.copy_stream(aux, @buffer)
+        aux.close
       end
+
       __setobj__(@buffer)
     end
 
-    def _with_same_buffer_pos
+    def _with_same_buffer_pos # :nodoc:
       current_pos = @buffer.pos
       @buffer.rewind
       begin
         yield
       ensure