Replace JSONLoader with static functions

crazytonyli · crazytonyli · commit c9cdcb2cd08d · 2022-05-03T22:21:05.000+12:00
Currently fatalError is used to "handle errors", but they'll be replaced
with throwing errors later.
diff --git a/WordPress/WordPressTest/ActivityContentFactoryTests.swift b/WordPress/WordPressTest/ActivityContentFactoryTests.swift
@@ -15,6 +15,6 @@ final class ActivityContentFactoryTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 }
diff --git a/WordPress/WordPressTest/ActivityLogTestData.swift b/WordPress/WordPressTest/ActivityLogTestData.swift
@@ -28,7 +28,7 @@ class ActivityLogTestData {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 
     func getCommentEventDictionary() -> [String: AnyObject] {
diff --git a/WordPress/WordPressTest/FormattableCommentContentTests.swift b/WordPress/WordPressTest/FormattableCommentContentTests.swift
@@ -138,7 +138,7 @@ final class FormattableCommentContentTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 
     private func loadLikeNotification() -> WordPress.Notification {
diff --git a/WordPress/WordPressTest/FormattableContentGroupTests.swift b/WordPress/WordPressTest/FormattableContentGroupTests.swift
@@ -64,6 +64,6 @@ final class FormattableContentGroupTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 }
diff --git a/WordPress/WordPressTest/FormattableUserContentTests.swift b/WordPress/WordPressTest/FormattableUserContentTests.swift
@@ -134,7 +134,7 @@ final class FormattableUserContentTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 
     private func loadLikeNotification() -> WordPress.Notification {
diff --git a/WordPress/WordPressTest/NSManagedObject+Fixture.swift b/WordPress/WordPressTest/NSManagedObject+Fixture.swift
@@ -9,9 +9,7 @@ extension NSManagedObject {
     ///   - context: The managed object context to use
     /// - Returns: A new instance with property values of the given JSON file.
     static func fixture(fromFile fileName: String, insertInto context: NSManagedObjectContext) -> Self {
-        guard let jsonObject = JSONLoader().loadFile(named: fileName) else {
-            fatalError("Mockup data could not be parsed, the filename is \(fileName)")
-        }
+        let jsonObject = JSONObject.loadFile(named: fileName)
         let model = Self.init(context: context)
         for (key, value) in jsonObject {
             model.setValue(value, forKey: key)
diff --git a/WordPress/WordPressTest/NotificationContentRangeFactoryTests.swift b/WordPress/WordPressTest/NotificationContentRangeFactoryTests.swift
@@ -65,6 +65,6 @@ final class NotificationContentRangeFactoryTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 }
diff --git a/WordPress/WordPressTest/NotificationTextContentTests.swift b/WordPress/WordPressTest/NotificationTextContentTests.swift
@@ -96,7 +96,7 @@ final class NotificationTextContentTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 
     private func loadLikeNotification() -> WordPress.Notification {
diff --git a/WordPress/WordPressTest/NotificationUtility.swift b/WordPress/WordPressTest/NotificationUtility.swift
@@ -45,7 +45,7 @@ class NotificationUtility {
     }
 
     func mockCommentContent() -> FormattableCommentContent {
-        let dictionary = JSONLoader().loadFile(named: "notifications-replied-comment.json") ?? [:]
+        let dictionary = JSONObject.loadFile(named: "notifications-replied-comment.json")
         let body = dictionary["body"]
         let blocks = NotificationContentFactory.content(from: body as! [[String: AnyObject]], actionsParser: NotificationActionParser(), parent: WordPress.Notification(context: contextManager.mainContext))
         return blocks.filter { $0.kind == .comment }.first! as! FormattableCommentContent
diff --git a/WordPress/WordPressTest/NotificationsContentFactoryTests.swift b/WordPress/WordPressTest/NotificationsContentFactoryTests.swift
@@ -36,7 +36,7 @@ final class NotificationsContentFactoryTests: XCTestCase {
     }
 
     private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {
-        return JSONLoader().loadFile(named: fileName) ?? [:]
+        return JSONObject.loadFile(named: fileName)
     }
 
     func loadLikeNotification() -> WordPress.Notification {
diff --git a/WordPress/WordPressTest/PinghubTests.swift b/WordPress/WordPressTest/PinghubTests.swift
@@ -106,7 +106,7 @@ class PingHubTests: XCTestCase {
 
 private extension PingHubTests {
     func loadJSONMessage(name: String) -> [String: AnyObject]? {
-        return JSONLoader().loadFile(name, type: "json")
+        return JSONObject.loadFile(name, type: "json")
     }
 }
 
diff --git a/WordPress/WordPressTest/TestUtilities/JSONLoader.swift b/WordPress/WordPressTest/TestUtilities/JSONLoader.swift
@@ -1,58 +1,46 @@
 
 import Foundation
 
-@objc open class JSONLoader: NSObject {
-    public typealias JSONDictionary = Dictionary<String, AnyObject>
+typealias JSONObject = Dictionary<String, AnyObject>
+
+extension JSONObject {
+
+    /// Loads the specified json file and returns a dictionary representing it.
+    ///
+    /// - Parameter fileName: The full name of the json file to load.
+    /// - Returns: A dictionary representing the contents of the json file.
+    static func loadFile(named fileName: String) -> JSONObject {
+        return loadFile(
+            (fileName as NSString).deletingPathExtension,
+            type: (fileName as NSString).pathExtension
+        )
+    }
 
     /// Loads the specified JSON file and returns a dictionary representing it.
     ///
     /// - Parameters:
     ///   - name: The name of the file
     ///   - type: The extension of the file
     /// - Returns: A dictionary representing the contents of the JSON file.
-    open func loadFile(_ name: String, type: String) -> JSONDictionary? {
-
-        let path = Bundle(for: Swift.type(of: self)).path(forResource: name, ofType: type)
-
-        if let unwrappedPath = path {
-            return loadFile(unwrappedPath)
-        } else {
-            return nil
+    static func loadFile(_ name: String, type: String) -> JSONObject {
+        guard let url = Bundle(for: BundlerFinder.self).url(forResource: name, withExtension: type) else {
+            fatalError("File not found in the test bundle: \(name).\(type)")
         }
-    }
-
-    /// Loads the specified json file and returns a dictionary representing it.
-    ///
-    /// - Parameter path: The path of the json file to load.
-    /// - Returns: A dictionary representing the contents of the json file.
-    open func loadFile(_ path: String) -> JSONDictionary? {
-
-        if let contents = try? Data(contentsOf: URL(fileURLWithPath: path)) {
-            return parseData(contents)
+        guard let data = try? Data(contentsOf: url) else {
+            fatalError("Can't read content of file: \(name).\(type)")
         }
-
-        return nil
-    }
-
-    /// Loads the specified json file and returns a dictionary representing it.
-    ///
-    /// - Parameter filename: The full name of the json file to load.
-    /// - Returns: A dictionary representing the contents of the json file.
-    open func loadFile(named filename: String) -> JSONDictionary? {
-        return loadFile(
-            (filename as NSString).deletingPathExtension,
-            type: (filename as NSString).pathExtension
-        )
+        guard let parseResult = try? JSONSerialization.jsonObject(with: data, options: [.mutableContainers, .mutableLeaves]) else {
+            fatalError("Can't parse file as JSON: \(name).\(type)")
+        }
+        guard let result = parseResult as? JSONObject else {
+            fatalError("File content isn't a JSON object: \(name).\(type)")
+        }
+        return result
     }
 
-    fileprivate func parseData(_ data: Data) -> JSONDictionary? {
-        let options: JSONSerialization.ReadingOptions = [.mutableContainers, .mutableLeaves]
+}
 
-        do {
-            let parseResult = try JSONSerialization.jsonObject(with: data as Data, options: options)
-            return parseResult as? JSONDictionary
-        } catch {
-            return nil
-        }
-    }
+/// Class for finding the test bundler
+private class BundlerFinder {
+    // Empty
 }

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,6 @@ final class ActivityContentFactoryTests: XCTestCase {`
`15`	`15`	`}`
`16`	`16`
`17`	`17`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`18`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`18`	`+ return JSONObject.loadFile(named: fileName)`
`19`	`19`	`}`
`20`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class ActivityLogTestData {`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`31`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`31`	`+ return JSONObject.loadFile(named: fileName)`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`func getCommentEventDictionary() -> [String: AnyObject] {`
Original file line number	Diff line number	Diff line change
`@@ -138,7 +138,7 @@ final class FormattableCommentContentTests: XCTestCase {`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`141`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`141`	`+ return JSONObject.loadFile(named: fileName)`
`142`	`142`	`}`
`143`	`143`
`144`	`144`	`private func loadLikeNotification() -> WordPress.Notification {`
Original file line number	Diff line number	Diff line change
`@@ -64,6 +64,6 @@ final class FormattableContentGroupTests: XCTestCase {`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`67`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`67`	`+ return JSONObject.loadFile(named: fileName)`
`68`	`68`	`}`
`69`	`69`	`}`
Original file line number	Diff line number	Diff line change
`@@ -134,7 +134,7 @@ final class FormattableUserContentTests: XCTestCase {`
`134`	`134`	`}`
`135`	`135`
`136`	`136`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`137`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`137`	`+ return JSONObject.loadFile(named: fileName)`
`138`	`138`	`}`
`139`	`139`
`140`	`140`	`private func loadLikeNotification() -> WordPress.Notification {`
Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,6 @@ final class NotificationContentRangeFactoryTests: XCTestCase {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`68`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`68`	`+ return JSONObject.loadFile(named: fileName)`
`69`	`69`	`}`
`70`	`70`	`}`
Original file line number	Diff line number	Diff line change
`@@ -96,7 +96,7 @@ final class NotificationTextContentTests: XCTestCase {`
`96`	`96`	`}`
`97`	`97`
`98`	`98`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`99`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`99`	`+ return JSONObject.loadFile(named: fileName)`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`private func loadLikeNotification() -> WordPress.Notification {`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ class NotificationUtility {`
`45`	`45`	`}`
`46`	`46`
`47`	`47`	`func mockCommentContent() -> FormattableCommentContent {`
`48`		`- let dictionary = JSONLoader().loadFile(named: "notifications-replied-comment.json") ?? [:]`
	`48`	`+ let dictionary = JSONObject.loadFile(named: "notifications-replied-comment.json")`
`49`	`49`	`let body = dictionary["body"]`
`50`	`50`	`let blocks = NotificationContentFactory.content(from: body as! [[String: AnyObject]], actionsParser: NotificationActionParser(), parent: WordPress.Notification(context: contextManager.mainContext))`
`51`	`51`	`return blocks.filter { $0.kind == .comment }.first! as! FormattableCommentContent`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ final class NotificationsContentFactoryTests: XCTestCase {`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`private func getDictionaryFromFile(named fileName: String) -> [String: AnyObject] {`
`39`		`- return JSONLoader().loadFile(named: fileName) ?? [:]`
	`39`	`+ return JSONObject.loadFile(named: fileName)`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`func loadLikeNotification() -> WordPress.Notification {`