File: EncodingFormat.swift

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (84 lines) | stat: -rw-r--r-- 3,323 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2024 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for Swift project authors
//

#if canImport(Foundation)
@_spi(Experimental) import Testing
import Foundation

#if SWT_TARGET_OS_APPLE && canImport(UniformTypeIdentifiers)
private import UniformTypeIdentifiers
#endif

/// An enumeration describing the encoding formats we support for `Encodable`
/// and `NSSecureCoding` types that conform to `Attachable`.
enum EncodingFormat {
  /// The encoding format to use by default.
  ///
  /// The specific format this case corresponds to depends on if we are encoding
  /// an `Encodable` value or an `NSSecureCoding` value.
  case `default`

  /// A property list format.
  ///
  /// - Parameters:
  ///   - format: The corresponding property list format.
  case propertyListFormat(_ format: PropertyListSerialization.PropertyListFormat)

  /// The JSON format.
  case json

  /// Initialize an instance of this type representing the content type or media
  /// type of the specified attachment.
  ///
  /// - Parameters:
  ///   - attachment: The attachment that will be encoded.
  ///
  /// - Throws: If the attachment's content type or media type is unsupported.
  init(for attachment: borrowing Attachment<some Attachable>) throws {
    let ext = (attachment.preferredName as NSString).pathExtension

#if SWT_TARGET_OS_APPLE && canImport(UniformTypeIdentifiers)
    // If the caller explicitly wants to encode their data as either XML or as a
    // property list, use PropertyListEncoder. Otherwise, we'll fall back to
    // JSONEncoder below.
    if #available(_uttypesAPI, *), let contentType = UTType(filenameExtension: ext) {
      if contentType == .data {
        self = .default
      } else if contentType.conforms(to: .json) {
        self = .json
      } else if contentType.conforms(to: .xml) {
        self = .propertyListFormat(.xml)
      } else if contentType.conforms(to: .binaryPropertyList) || contentType == .propertyList {
        self = .propertyListFormat(.binary)
      } else if contentType.conforms(to: .propertyList) {
        self = .propertyListFormat(.openStep)
      } else {
        let contentTypeDescription = contentType.localizedDescription ?? contentType.identifier
        throw CocoaError(.propertyListWriteInvalid, userInfo: [NSLocalizedDescriptionKey: "The content type '\(contentTypeDescription)' cannot be used to attach an instance of \(type(of: self)) to a test."])
      }
      return
    }
#endif

    if ext.isEmpty {
      // No path extension? No problem! Default data.
      self = .default
    } else if ext.caseInsensitiveCompare("plist") == .orderedSame {
      self = .propertyListFormat(.binary)
    } else if ext.caseInsensitiveCompare("xml") == .orderedSame {
      self = .propertyListFormat(.xml)
    } else if ext.caseInsensitiveCompare("json") == .orderedSame {
      self = .json
    } else {
      throw CocoaError(.propertyListWriteInvalid, userInfo: [NSLocalizedDescriptionKey: "The path extension '.\(ext)' cannot be used to attach an instance of \(type(of: self)) to a test."])
    }
  }
}
#endif