Skip to content

Make Attachment conform to CustomStringConvertible. #849

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 10, 2024
Merged

Make Attachment conform to CustomStringConvertible. #849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions Sources/Testing/Attachments/Attachment.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,21 @@ public struct AnyAttachable: AttachableContainer, Copyable, Sendable {
}
}

// MARK: - Describing an attachment

extension Attachment where AttachableValue: ~Copyable {
public var description: String {
let typeInfo = TypeInfo(describing: AttachableValue.self)
return #""\#(preferredName)": instance of '\#(typeInfo.unqualifiedName)'"#
}
}

extension Attachment: CustomStringConvertible {
public var description: String {
#""\#(preferredName)": \#(String(describingForTest: attachableValue))"#
}
}

// MARK: - Getting an attachable value from an attachment

@_spi(Experimental)
Expand Down
14 changes: 14 additions & 0 deletions Tests/TestingTests/AttachmentTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,20 @@ struct AttachmentTests {
attachment.attach()
}

@Test func description() {
let attachableValue = MySendableAttachable(string: "<!doctype html>")
let attachment = Attachment(attachableValue, named: "AttachmentTests.saveValue.html")
#expect(String(describing: attachment).contains(#""\#(attachment.preferredName)""#))
#expect(attachment.description.contains("MySendableAttachable("))
}

@Test func moveOnlyDescription() {
let attachableValue = MyAttachable(string: "<!doctype html>")
let attachment = Attachment(attachableValue, named: "AttachmentTests.saveValue.html")
#expect(attachment.description.contains(#""\#(attachment.preferredName)""#))
#expect(attachment.description.contains("'MyAttachable'"))
}

#if !SWT_NO_FILE_IO
func compare(_ attachableValue: borrowing MySendableAttachable, toContentsOfFileAtPath filePath: String) throws {
let file = try FileHandle(forReadingAtPath: filePath)
Expand Down