Move Files and Folder types into test utility target

Author: d-ronnqvist

Sources/SwiftDocC/Utility/DataStructures/File.swift renamed to Sources/SwiftDocCTestUtilities/FilesAndFolders.swift

@@ -16,15 +16,15 @@ import Foundation
 */
 
 /// An abstract representation of a file (or folder).
-protocol File {
+public protocol File {
     /// The name of the file.
     var name: String { get }
 
     /// Writes the file to a given URL.
     func write(to url: URL) throws
 }
 
-extension File {
+public extension File {
     /// Writes the file inside of a folder and returns the URL that it was written to.
     @discardableResult
     func write(inside url: URL) throws -> URL {
@@ -35,12 +35,12 @@ extension File {
 }
 
 /// An item which provides data.
-protocol DataRepresentable {
+public protocol DataRepresentable {
     func data() throws -> Data
 }
 
 /// `DataRepresentable` can automatically write itself to disk via `Data.write(to:)`
-extension DataRepresentable {
+public extension DataRepresentable {
     func write(to url: URL) throws {
         try data().write(to: url)
     }
@@ -49,17 +49,22 @@ extension DataRepresentable {
 // MARK: -
 
 /// An abstract representation of a folder, containing some files or folders.
-struct Folder: File {
-    let name: String
+public struct Folder: File {
+    public init(name: String, content: [File]) {
+        self.name = name
+        self.content = content
+    }
+    
+    public let name: String
 
     /// The files and sub folders that this folder contains.
-    let content: [File]
+    public let content: [File]
 
-    func appendingFile(_ newFile: File) -> Folder {
+    public func appendingFile(_ newFile: File) -> Folder {
         return Folder(name: name, content: content + [newFile])
     }
 
-    func write(to url: URL) throws {
+    public func write(to url: URL) throws {
         try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false, attributes: nil)
         for file in content {
             try file.write(inside: url)
@@ -69,7 +74,7 @@ struct Folder: File {
 
 extension Folder {
     /// Returns a flat list of a folder's recursive listing for testing purposes.
-    var recursiveContent: [File] {
+    public var recursiveContent: [File] {
         var result = content
         for file in content {
             if let content = (file as? Folder)?.recursiveContent {
@@ -81,13 +86,13 @@ extension Folder {
 }
 
 /// A representation of an Info.plist file.
-struct InfoPlist: File, DataRepresentable {
-    let name = "Info.plist"
+public struct InfoPlist: File, DataRepresentable {
+    public let name = "Info.plist"
 
     /// The information that the Into.plist file contains.
-    let content: Content
+    public let content: Content
 
-    init(displayName: String, identifier: String, versionString: String = "1.0", developmentRegion: String = "en") {
+    public init(displayName: String, identifier: String, versionString: String = "1.0", developmentRegion: String = "en") {
         self.content = Content(
             displayName: displayName,
             identifier: identifier,
@@ -96,11 +101,11 @@ struct InfoPlist: File, DataRepresentable {
         )
     }
 
-    struct Content: Codable, Equatable {
-        let displayName: String
-        let identifier: String
-        let versionString: String
-        let developmentRegion: String
+    public struct Content: Codable, Equatable {
+        public let displayName: String
+        public let identifier: String
+        public let versionString: String
+        public let developmentRegion: String
 
         fileprivate init(displayName: String, identifier: String, versionString: String, developmentRegion: String) {
             self.displayName = displayName
@@ -117,7 +122,7 @@ struct InfoPlist: File, DataRepresentable {
         }
     }
 
-    func data() throws -> Data {
+    public func data() throws -> Data {
         // TODO: Replace this with PropertListEncoder (see below) when it's available in swift-corelibs-foundation
         // https://github.com/apple/swift-corelibs-foundation/commit/d2d72f88d93f7645b94c21af88a7c9f69c979e4f
         let infoPlist = [
@@ -136,74 +141,85 @@ struct InfoPlist: File, DataRepresentable {
 }
 
 /// A representation of a text file with some UTF-8 content.
-struct TextFile: File, DataRepresentable {
-    let name: String
+public struct TextFile: File, DataRepresentable {
+    public init(name: String, utf8Content: String) {
+        self.name = name
+        self.utf8Content = utf8Content
+    }
+    
+    public let name: String
 
     /// The UTF8 content of the file.
-    let utf8Content: String
+    public let utf8Content: String
 
-    func data() throws -> Data {
+    public func data() throws -> Data {
         return utf8Content.data(using: .utf8)!
     }
 }
 
 /// A representation of a text file with some UTF-8 content.
-struct JSONFile<Content: Codable>: File, DataRepresentable {
-    let name: String
+public struct JSONFile<Content: Codable>: File, DataRepresentable {
+    public init(name: String, content: Content) {
+        self.name = name
+        self.content = content
+    }
+    
+    public let name: String
 
     /// The UTF8 content of the file.
-    let content: Content
+    public let content: Content
 
-    func data() throws -> Data {
+    public func data() throws -> Data {
         return try JSONEncoder().encode(content)
     }
 }
 
 /// A copy of another file on disk somewhere.
-struct CopyOfFile: File, DataRepresentable {
-    enum Error: DescribedError {
+public struct CopyOfFile: File, DataRepresentable {
+    enum Error: LocalizedError {
         case notAFile(URL)
         var errorDescription: String {
             switch self {
-                case .notAFile(let url): return "Original url is not a file: \(url.path.singleQuoted)"
+                case .notAFile(let url): return "Original url is not a file: '\(url.path)'"
             }
         }
     }
 
     /// The original file.
-    let original: URL
-    let name: String
+    public let original: URL
+    public let name: String
 
-    init(original: URL, newName: String? = nil) {
+    public init(original: URL, newName: String? = nil) {
         self.original = original
         self.name = newName ?? original.lastPathComponent
     }
 
-    func data() throws -> Data {
+    public func data() throws -> Data {
         // Note that `CopyOfFile` always reads a file from disk and so it's okay
         // to use `FileManager.default` directly here instead of `FileManagerProtocol`.
-        guard !FileManager.default.directoryExists(atPath: original.path) else { throw Error.notAFile(original) }
+        var isDirectory: ObjCBool = false
+        guard FileManager.default.fileExists(atPath: original.path, isDirectory: &isDirectory), !isDirectory.boolValue else { throw Error.notAFile(original) }
         return try Data(contentsOf: original)
     }
 
-    func write(to url: URL) throws {
+    public func write(to url: URL) throws {
         try FileManager.default.copyItem(at: original, to: url)
     }
 }
 
-struct CopyOfFolder: File {
+public struct CopyOfFolder: File {
     /// The original file.
     let original: URL
-    let name: String
+    public let name: String
     let shouldCopyFile: (URL) -> Bool
 
-    init(original: URL, newName: String? = nil, filter shouldCopyFile: @escaping (URL) -> Bool = { _ in true }) {
+    public init(original: URL, newName: String? = nil, filter shouldCopyFile: @escaping (URL) -> Bool = { _ in true }) {
         self.original = original
         self.name = newName ?? original.lastPathComponent
         self.shouldCopyFile = shouldCopyFile
     }
 
-    func write(to url: URL) throws {
+    public func write(to url: URL) throws {
         try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false, attributes: nil)
         for filePath in try FileManager.default.contentsOfDirectory(atPath: original.path) {
             // `contentsOfDirectory(atPath)` includes hidden files, skipHiddenFiles option doesn't help on Linux.
@@ -217,37 +233,37 @@ struct CopyOfFolder: File {
 }
 
 /// A file backed by `Data`.
-struct DataFile: File, DataRepresentable {
-    var name: String
+public struct DataFile: File, DataRepresentable {
+    public var name: String
     var _data: Data
 
-    init(name: String, data: Data) {
+    public init(name: String, data: Data) {
         self.name = name
         self._data = data
     }
 
-    func data() throws -> Data {
+    public func data() throws -> Data {
         return _data
     }
 }
 
 /// A temporary folder which can write files to a temporary location on disk and
 /// will delete itself when its instance is released from memory.
-class TempFolder: File {
-    let name: String
-    let url: URL
+public class TempFolder: File {
+    public let name: String
+    public let url: URL
 
     /// The files and sub folders that this folder contains.
     let content: [File]
 
-    func write(to url: URL) throws {
+    public func write(to url: URL) throws {
         try FileManager.default.createDirectory(at: url, withIntermediateDirectories: false, attributes: nil)
         for file in content {
             try file.write(inside: url)
         }
     }
 
-    init(content: [File], atRoot root: URL) throws {
+    public init(content: [File], atRoot root: URL) throws {
         self.content = content
 
         url = root

Tests/SwiftDocCTests/Infrastructure/BundleDiscoveryTests.swift

@@ -10,6 +10,7 @@
 
 import XCTest
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 class BundleDiscoveryTests: XCTestCase {
 

Tests/SwiftDocCTests/Infrastructure/DocumentationContext+RootPageTests.swift

@@ -11,6 +11,7 @@
 import XCTest
 import SymbolKit
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 class DocumentationContext_RootPageTests: XCTestCase {
     func testNoSGFBundle() throws {

Tests/SwiftDocCTests/Infrastructure/DocumentationContextTests.swift

@@ -12,6 +12,7 @@ import XCTest
 import SymbolKit
 @testable import SwiftDocC
 import Markdown
+import SwiftDocCTestUtilities
 
 func diffDescription(lhs: String, rhs: String) -> String {
     let leftLines = lhs.components(separatedBy: .newlines)

Tests/SwiftDocCTests/Infrastructure/NodeTagsTests.swift

@@ -10,6 +10,7 @@
 
 import XCTest
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 class NodeTagsTests: XCTestCase {
     func testSPIMetadata() throws {

Tests/SwiftDocCTests/LinkTargets/LinkDestinationSummaryTests.swift

@@ -10,6 +10,7 @@
 
 import XCTest
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 class ExternalLinkableTests: XCTestCase {
 

Tests/SwiftDocCTests/Semantics/SymbolTests.swift

@@ -12,6 +12,7 @@ import XCTest
 @testable import SymbolKit
 @testable import SwiftDocC
 import Markdown
+import SwiftDocCTestUtilities
 
 class SymbolTests: XCTestCase {
 

Tests/SwiftDocCUtilitiesTests/ConvertActionStaticHostableTests.swift

@@ -12,6 +12,7 @@ import XCTest
 import Foundation
 @testable import SwiftDocC
 @testable import SwiftDocCUtilities
+import SwiftDocCTestUtilities
 
 class ConvertActionStaticHostableTests: StaticHostingBaseTests {
     /// Creates a DocC archive and then archives it with options  to produce static content which is then validated.

Tests/SwiftDocCUtilitiesTests/ConvertActionTests.swift

@@ -2467,8 +2467,8 @@ extension Folder {
                     if fileURL.lastPathComponent == "Info.plist",
                        let infoPlistData = FileManager.default.contents(atPath: fileURL.path),
                        let infoPlist = try? PropertyListSerialization.propertyList(from: infoPlistData, options: [], format: nil) as? [String: Any],
-                       let displayName = infoPlist[InfoPlist.Content.CodingKeys.displayName.rawValue] as? String,
-                       let identifier = infoPlist[InfoPlist.Content.CodingKeys.identifier.rawValue] as? String {
+                       let displayName = infoPlist["CFBundleDisplayName"] as? String,
+                       let identifier = infoPlist["CFBundleIdentifier"] as? String {
                         content.append(InfoPlist(displayName: displayName, identifier: identifier))
                     } else {
                         content.append(CopyOfFile(original: fileURL, newName: fileURL.lastPathComponent))

Tests/SwiftDocCUtilitiesTests/FolderStructure.swift

@@ -11,6 +11,7 @@
 @testable import SwiftDocC
 @testable import SwiftDocCUtilities
 import XCTest
+import SwiftDocCTestUtilities
 
 /*
  This file contains a test helper API for working with folder hierarchies, with the ability to:
@@ -69,10 +70,10 @@ extension InfoPlist: AssertableFile {
             }
             let infoPlist = try PropertyListSerialization.propertyList(from: infoPlistData, options: [], format: nil) as? [String: String]
 
-            let displayName = infoPlist?[Content.CodingKeys.displayName.rawValue]
-            let identifier = infoPlist?[Content.CodingKeys.identifier.rawValue]
-            let versionString = infoPlist?[Content.CodingKeys.versionString.rawValue]
-            let developmentRegion = infoPlist?[Content.CodingKeys.developmentRegion.rawValue]
+            let displayName = infoPlist?["CFBundleIdentifier"]
+            let identifier = infoPlist?["CFBundleVersion"]
+            let versionString = infoPlist?["CFBundleDevelopmentRegion"]
+            let developmentRegion = infoPlist?["CFBundleDisplayName"]
 
             XCTAssert(displayName == content.displayName && identifier == content.identifier && versionString == content.versionString && developmentRegion == content.developmentRegion,
                       "File '\(name)' should contain the correct information.", file: (file), line: line)

Tests/SwiftDocCUtilitiesTests/FolderStructureTests.swift

@@ -10,6 +10,7 @@
 
 import XCTest
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 class FolderStructureTests: XCTestCase {
 

Tests/SwiftDocCUtilitiesTests/HTMLTemplateDirectory.swift

@@ -10,6 +10,7 @@
 
 import Foundation
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 /// A folder that represents a fake html-build directory for testing.
 extension Folder {

Tests/SwiftDocCUtilitiesTests/PreviewActionIntegrationTests.swift

@@ -11,6 +11,7 @@
 import XCTest
 @testable import SwiftDocC
 @testable import SwiftDocCUtilities
+import SwiftDocCTestUtilities
 
 class PreviewActionIntegrationTests: XCTestCase {
     func json(contentsOf url: URL) throws -> [String: Any] {

Tests/SwiftDocCUtilitiesTests/PreviewServer/PreviewHTTPHandlerTests.swift

@@ -12,6 +12,7 @@ import Foundation
 import XCTest
 @testable import SwiftDocC
 @testable import SwiftDocCUtilities
+import SwiftDocCTestUtilities
 
 import NIO
 import NIOHTTP1

Tests/SwiftDocCUtilitiesTests/PreviewServer/PreviewServerTests.swift

@@ -13,6 +13,7 @@ import Foundation
 
 @testable import SwiftDocCUtilities
 @testable import SwiftDocC
+import SwiftDocCTestUtilities
 
 @testable import NIO
 @testable import NIOHTTP1