Add better debug descriptions for request/response objects

MockDuck/Sources/MockRequest.swift

@@ -10,7 +10,7 @@ import Foundation
 
 /// A very basic wrapper around URLRequest that allows us to read and write this data to disk
 /// using Codable without having to make URLRequest itself conform to Codable.
-final class MockRequest {
+final class MockRequest: CustomDebugStringConvertible {
     var request: URLRequest
 
     private(set) lazy var normalizedRequest: URLRequest = {
@@ -20,6 +20,10 @@ final class MockRequest {
     init(request: URLRequest) {
         self.request = request
     }
+
+    public var debugDescription: String {
+        return "\(request.httpMethod ?? "GET") \(request.url?.absoluteString ?? "")"
+    }
 }
 
 extension MockRequest: Codable {

MockDuck/Sources/MockRequestResponse.swift

@@ -9,7 +9,7 @@
 import Foundation
 
 /// A basic container for holding a request, a response, and any associated data.
-final class MockRequestResponse: Codable {
+final class MockRequestResponse: Codable, CustomDebugStringConvertible {
 
     enum MockFileTarget {
         case request
@@ -141,4 +141,27 @@ final class MockRequestResponse: Codable {
         requestWrapper = try container.decode(MockRequest.self, forKey: .requestWrapper)
         responseWrapper = try container.decodeIfPresent(MockResponse.self, forKey: .responseWrapper)
     }
+
+    // MARK: Debug
+
+    public var debugDescription: String {
+        var result = "\n"
+
+        if let request = fileName(for: .request) {
+            result.append("Request: \(request)\n")
+            result.append("\t\(requestWrapper)\n")
+        }
+        if let requestBody = fileName(for: .requestBody) {
+            result.append("Request Body: \(requestBody)\n")
+        }
+        if let responseData = fileName(for: .responseData) {
+            result.append("Response Data: \(responseData)\n")
+
+            if let response = responseWrapper {
+                result.append("\t\(response)\n")
+            }
+        }
+
+        return result
+    }
 }

MockDuck/Sources/MockResponse.swift

@@ -9,7 +9,7 @@
 import Foundation
 
 /// A basic class that holds onto a URLResponse and its associated data.
-public final class MockResponse {
+public final class MockResponse: CustomDebugStringConvertible {
 
     var response: URLResponse
     var responseData: Data?
@@ -82,6 +82,17 @@ public final class MockResponse {
         let data = try JSONSerialization.data(withJSONObject: json, options: [])
         try self.init(for: request, data: data, statusCode: statusCode, headers: headers)
     }
+
+    public var debugDescription: String {
+        var result = ""
+        if let httpResponse = response as? HTTPURLResponse
+        {
+            result.append("\(httpResponse.statusCode) ")
+        }
+        result.append("\(response.url?.absoluteString ?? "")")
+        result.append(" (\(response.expectedContentLength) bytes)")
+        return result
+    }
 }
 
 // MARK: - Codable