Refactor Apodini Document Export (#13)

* Add ApodiniDocumentExport dependency to refactor ApodiniMigratorShared

* Update ApodiniDocumentExport dependency

* Move JSONDecoder Equatable conformance extensions to ApodiniMigratorSharedTests

* Remove redundant OutputFormat ExpressibleByArgument extension

* Update APIDocument test in ApodiniMigratorCore to restore test coverage

Author: valentinbootz

Package.swift

@@ -36,7 +36,9 @@ let package = Package(
         .package(url: "https://github.com/apple/swift-collections.git", .upToNextMajor(from: "1.0.0")),
 
         // testing runtime crashes
-        .package(url: "https://github.com/norio-nomura/XCTAssertCrash.git", from: "0.2.0")
+        .package(url: "https://github.com/norio-nomura/XCTAssertCrash.git", from: "0.2.0"),
+        
+        .package(url: "https://github.com/Apodini/ApodiniDocumentExport.git", .upToNextMinor(from: "0.1.0"))
     ],
     targets: [
         // The lowest level ApodiniMigrator package providing common API used across several targets, including
@@ -46,7 +48,8 @@ let package = Package(
             dependencies: [
                 .product(name: "PathKit", package: "PathKit"),
                 .product(name: "FineJSON", package: "FineJSON"),
-                .product(name: "Yams", package: "Yams")
+                .product(name: "Yams", package: "Yams"),
+                .product(name: "ApodiniDocumentExport", package: "ApodiniDocumentExport")
             ]
         ),
 
@@ -97,7 +100,8 @@ let package = Package(
                 .target(name: "ApodiniMigrator"),
                 .target(name: "ApodiniMigratorCompare"),
                 .target(name: "ApodiniMigratorClientSupport"),
-                .product(name: "Logging", package: "swift-log")
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "ApodiniDocumentExport", package: "ApodiniDocumentExport")
             ],
             resources: [
                 .process("Resources")
@@ -112,7 +116,8 @@ let package = Package(
             dependencies: [
                 .target(name: "RESTMigrator"),
                 .product(name: "ArgumentParser", package: "swift-argument-parser"),
-                .product(name: "Logging", package: "swift-log")
+                .product(name: "Logging", package: "swift-log"),
+                .product(name: "ApodiniDocumentExport", package: "ApodiniDocumentExport")
             ]
         ),
 
@@ -124,7 +129,8 @@ let package = Package(
                 "RESTMigrator",
                 "ApodiniMigratorCompare",
                 "ApodiniMigratorClientSupport",
-                .product(name: "XCTAssertCrash", package: "XCTAssertCrash", condition: .when(platforms: [.macOS]))
+                .product(name: "XCTAssertCrash", package: "XCTAssertCrash", condition: .when(platforms: [.macOS])),
+                .product(name: "ApodiniDocumentExport", package: "ApodiniDocumentExport")
             ],
             resources: [
                 .process("Resources")

Sources/ApodiniMigratorCLI/Compare.swift

@@ -9,6 +9,7 @@
 import Foundation
 import ArgumentParser
 import RESTMigrator
+import ApodiniDocumentExport
 
 struct Compare: ParsableCommand {
     static var configuration = CommandConfiguration(
@@ -41,6 +42,3 @@ struct Compare: ParsableCommand {
         }
     }
 }
-
-// MARK: - OutputFormat + ExpressibleByArgument
-extension OutputFormat: ExpressibleByArgument {}

Sources/ApodiniMigratorShared/Extensions/Decodable+Extension.swift

@@ -0,0 +1,16 @@
+//
+// This source file is part of the Apodini open source project
+//
+// SPDX-FileCopyrightText: 2019-2021 Paul Schmiedmayer and the Apodini project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
+//
+// SPDX-License-Identifier: MIT
+//
+
+// MARK: - KeyedDecodingContainerProtocol
+extension KeyedDecodingContainerProtocol {
+    /// Decodes a value of the given collection type for the given key, if present, otherwise initalizes it as empty collection
+    public func decodeIfPresentOrInitEmpty<T: Decodable>(_ type: T.Type, forKey key: Key) throws -> T where T: Collection, T.Element: Decodable {
+        // swiftlint:disable:next force_cast
+        (try decodeIfPresent(T.self, forKey: key)) ?? [] as! T
+    }
+}

Sources/ApodiniMigratorShared/Extensions/Encodable+Extensions.swift

@@ -0,0 +1,17 @@
+//
+// This source file is part of the Apodini open source project
+//
+// SPDX-FileCopyrightText: 2019-2021 Paul Schmiedmayer and the Apodini project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
+//
+// SPDX-License-Identifier: MIT
+//
+
+// MARK: - KeyedEncodingContainerProtocol
+extension KeyedEncodingContainerProtocol {
+    /// Only encodes the value if the collection is not empty
+    public mutating func encodeIfNotEmpty<T: Encodable>(_ value: T, forKey key: Key) throws where T: Collection, T.Element: Encodable {
+        if !value.isEmpty {
+            try encode(value, forKey: key)
+        }
+    }
+}

Sources/ApodiniMigratorShared/Extensions/KeyedDecodingContainerProtocol+Extensions.swift

@@ -0,0 +1,22 @@
+//
+// This source file is part of the Apodini open source project
+//
+// SPDX-FileCopyrightText: 2019-2021 Paul Schmiedmayer and the Apodini project authors (see CONTRIBUTORS.md) <paul.schmiedmayer@tum.de>
+//
+// SPDX-License-Identifier: MIT
+//
+
+import Foundation
+import PathKit
+import ApodiniDocumentExport
+
+public extension Path {
+    
+    /// Returns all swift files in `self` and in subdirectories of `self`
+    func recursiveSwiftFiles() throws -> [Path] {
+        guard isDirectory else {
+            return []
+        }
+        return try recursiveChildren().filter { $0.is(.swift) }
+    }
+}

Sources/ApodiniMigratorShared/Extensions/KeyedEncodingContainerProtocol+Extensions.swift

@@ -7,7 +7,6 @@
 //
 
 import Foundation
-import PathKit
 
 public extension String {
     /// Line break
@@ -48,9 +47,4 @@ public extension String {
         }
         return self
     }
-    
-    /// Returns encoded data of `self`
-    func data(_ encoding: Encoding = .utf8) -> Data {
-        data(using: encoding) ?? .init()
-    }
 }