Merge pull request #104 from smartmobilefactory/bugfix/optionals-generation-for-dictionary-subkeys

Plist2swift: Fix Generation of Sub-Keys in Dictionaries

Author: Tomusm

Plist2swift/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/

Plist2swift/.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata

@@ -0,0 +1,22 @@
+// swift-tools-version:5.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "Plist2swift",
+    dependencies: [
+        // Dependencies declare other packages that this package depends on.
+        // .package(url: /* package url */, from: "1.0.0"),
+    ],
+    targets: [
+        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
+        // Targets can depend on other targets in this package, and on products in packages which this package depends on.
+        .target(
+            name: "Plist2swift",
+            dependencies: []),
+        .testTarget(
+            name: "Plist2swiftTests",
+            dependencies: ["Plist2swift"]),
+    ]
+)

Plist2swift/Package.swift

@@ -1,3 +1,5 @@
+#!/usr/bin/env xcrun --sdk macosx swift
+
 //
 //  main.swift
 //  plist2swift
@@ -620,22 +622,31 @@ for plistPath in plists {
 	}
 
 	for key in allKeys {
-		if (keysAndTypes[key] == nil) {
-			let type = typeForValue(tuples[key]!)
-			keysAndTypes[key] = type
-			// Generate protocols for Dictionary entries
-			if (type == "Dictionary<String, Any>") {
+		guard let tuple = tuples[key] else {
+			continue
+		}
 
-				let dictionary = tuples[key] as? Dictionary<String, Any>
-				let sortedDictionary = dictionary?.sorted { (pairOne, pairTwo) -> Bool in
-					return pairOne.key < pairTwo.key
+		let type = typeForValue(tuple)
+		if (type != "Dictionary<String, Any>") { // Just register the existence of primitive types
+			keysAndTypes[key] = type
+		} else { // Generate protocols for Dictionary entries
+			var dictionary = tuples[key] as? Dictionary<String, Any> ?? [:]
+
+			// Merge sub-keys in dictionaries from current property list with already known sub-keys from dictionaries
+			// with the same name.
+			if let keyValueTuples = allKeyValueTuples[key] {
+				for knownKey in Set<String>(keyValueTuples.keys).subtracting(Set(dictionary.keys)) {
+					for (tupleKey, tupleValue) in keyValueTuples.tuples {
+						if (tupleKey == knownKey) {
+							dictionary[tupleKey] = tupleValue
+						}
+					}
 				}
-
-				allKeyValueTuples[key] = KeyValueTuples(tuples: sortedDictionary ?? [])
-				let name = key.uppercaseFirst()
-				let protocolName = name.appending("Protocol")
-				keysAndTypes[key] = protocolName
 			}
+
+			allKeyValueTuples[key] = KeyValueTuples(tuples: dictionary.sorted { $0.key < $1.key })
+			// Generate protocol name
+			keysAndTypes[key] = key.uppercaseFirst().appending("Protocol")
 		}
 	}
 

Plist2swift/Plist2swift

@@ -0,0 +1,7 @@
+import XCTest
+
+import Plist2swiftTests
+
+var tests = [XCTestCaseEntry]()
+tests += Plist2swiftTests.allTests()
+XCTMain(tests)

Plist2swift/Plist2swift.swift Plist2swift/Sources/Plist2.swiftPlist2swift/Plist2swift.swift renamed to Plist2swift/Sources/Plist2.swift

@@ -0,0 +1,47 @@
+import XCTest
+import class Foundation.Bundle
+
+final class Plist2swiftTests: XCTestCase {
+    func testExample() throws {
+        // This is an example of a functional test case.
+        // Use XCTAssert and related functions to verify your tests produce the correct
+        // results.
+
+        // Some of the APIs that we use below are available in macOS 10.13 and above.
+        guard #available(macOS 10.13, *) else {
+            return
+        }
+
+        let fooBinary = productsDirectory.appendingPathComponent("Plist2swift")
+
+        let process = Process()
+        process.executableURL = fooBinary
+
+        let pipe = Pipe()
+        process.standardOutput = pipe
+
+        try process.run()
+        process.waitUntilExit()
+
+        let data = pipe.fileHandleForReading.readDataToEndOfFile()
+        let output = String(data: data, encoding: .utf8)
+
+        XCTAssertEqual(output, "Hello, world!\n")
+    }
+
+    /// Returns path to the built products directory.
+    var productsDirectory: URL {
+      #if os(macOS)
+        for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(".xctest") {
+            return bundle.bundleURL.deletingLastPathComponent()
+        }
+        fatalError("couldn't find the products directory")
+      #else
+        return Bundle.main.bundleURL
+      #endif
+    }
+
+    static var allTests = [
+        ("testExample", testExample),
+    ]
+}

Plist2swift/Tests/LinuxMain.swift

@@ -0,0 +1,9 @@
+import XCTest
+
+#if !canImport(ObjectiveC)
+public func allTests() -> [XCTestCaseEntry] {
+    return [
+        testCase(Plist2swiftTests.allTests),
+    ]
+}
+#endif