Improve consistency of Body #inspect.

Author: samuel-williams-shopify

lib/protocol/http/body/buffered.rb

@@ -153,8 +153,10 @@ def rewind
 				#
 				# @returns [String] a string representation of the buffered body.
 				def inspect
-					if @chunks
-						"\#<#{self.class} #{@chunks.size} chunks, #{self.length} bytes>"
+					if @chunks and @chunks.size > 0
+						"#<#{self.class} #{@index}/#{@chunks.size} chunks, #{self.length} bytes>"
+					else
+						"#<#{self.class} empty>"
 					end
 				end
 			end

lib/protocol/http/body/completable.rb

@@ -53,6 +53,14 @@ def close(error = nil)
 
 					super
 				end
+				
+				# Inspect the completable body.
+				#
+				# @returns [String] a string representation of the completable body.
+				def inspect
+					callback_status = @callback ? "callback pending" : "callback completed"
+					return "#{super} | #<#{self.class} #{callback_status}>"
+				end
 			end
 		end
 	end

lib/protocol/http/body/deflate.rb

@@ -79,7 +79,7 @@ def ratio
 				#
 				# @returns [String] a string representation of the body.
 				def inspect
-					"#{super} | \#<#{self.class} #{(ratio*100).round(2)}%>"
+					"#{super} | #<#{self.class} #{(ratio*100).round(2)}%>"
 				end
 			end
 

lib/protocol/http/body/file.rb

@@ -135,7 +135,11 @@ def join
 				#
 				# @returns [String] a string representation of the file body.
 				def inspect
-					"\#<#{self.class} file=#{@file.inspect} offset=#{@offset} remaining=#{@remaining}>"
+					if @offset > 0
+						"#<#{self.class} #{@file.inspect} +#{@offset}, #{@remaining} bytes remaining>"
+					else
+						"#<#{self.class} #{@file.inspect}, #{@remaining} bytes remaining>"
+					end
 				end
 			end
 		end

lib/protocol/http/body/head.rb

@@ -53,6 +53,13 @@ def ready?
 				def length
 					@length
 				end
+				
+				# Inspect the head body.
+				#
+				# @returns [String] a string representation of the head body.
+				def inspect
+					"#<#{self.class} #{@length} bytes (empty)>"
+				end
 			end
 		end
 	end

lib/protocol/http/body/rewindable.rb

@@ -86,7 +86,7 @@ def rewindable?
 				#
 				# @returns [String] a string representation of the body.
 				def inspect
-					"\#<#{self.class} #{@index}/#{@chunks.size} chunks read>"
+					"#{super} | #<#{self.class} #{@index}/#{@chunks.size} chunks read>"
 				end
 			end
 		end

lib/protocol/http/body/stream.rb

@@ -386,6 +386,21 @@ def closed?
 					@closed
 				end
 
+				# Inspect the stream.
+				#
+				# @returns [String] a string representation of the stream.
+				def inspect
+					buffer_info = @buffer ? "#{@buffer.bytesize} bytes buffered" : "no buffer"
+					
+					status = []
+					status << "closed" if @closed
+					status << "read-closed" if @closed_read
+					
+					status_info = status.empty? ? "open" : status.join(", ")
+					
+					return "#<#{self.class} #{buffer_info}, #{status_info}>"
+				end
+				
 				# @returns [Boolean] Whether there are any output chunks remaining.
 				def empty?
 					@output.empty?

lib/protocol/http/body/streamable.rb

@@ -147,7 +147,23 @@ def close_input(error = nil)
 					#
 					# @parameter error [Exception | Nil] The error that caused this stream to be closed, if any.
 					def close_output(error = nil)
-						@output&.close(error)
+						if output = @output
+							@output = nil
+							output.close(error)
+						end
+					end
+					
+					# Inspect the streaming body.
+					#
+					# @returns [String] a string representation of the streaming body.
+					def inspect
+						if @block
+							"#<#{self.class} block available, not consumed>"
+						elsif @output
+							"#<#{self.class} block consumed, output active>"
+						else
+							"#<#{self.class} block consumed, output closed>"
+						end
 					end
 				end
 

lib/protocol/http/body/writable.rb

@@ -166,9 +166,9 @@ def output
 				# @returns [String] A string representation of the body.
 				def inspect
 					if @error
-						"\#<#{self.class} #{@count} chunks written, #{status}, error=#{@error}>"
+						"#<#{self.class} #{@count} chunks written, #{status}, error=#{@error}>"
 					else
-						"\#<#{self.class} #{@count} chunks written, #{status}>"
+						"#<#{self.class} #{@count} chunks written, #{status}>"
 					end
 				end
 

test/protocol/http/body/buffered.rb

@@ -148,6 +148,14 @@
 		end
 	end
 
+	with "#inspect" do
+		let(:body) {subject.new}
+
+		it "generates string representation for empty body" do
+			expect(body.inspect).to be == "#<Protocol::HTTP::Body::Buffered empty>"
+		end
+	end
+	
 	with "#each" do
 		with "a block" do
 			it "iterates over chunks" do