Implement Codable & Remove SwiftyJSON dependency

Author: otaviolima

ConfCore/Adapter.swift

@@ -7,46 +7,28 @@
 //
 
 import Foundation
-import SwiftyJSON
 
-enum AdapterError: Error {
-    case invalidData
-    case unsupported
-    case missingKey(JSONSubscriptType)
+// This is needed to keep the same behavior that adapters had before
+// Where it could adapt array of items even if some of the individual items failed to adapt
+struct FailableItemArrayWrapper<T: Decodable>: Decodable {
 
-    var localizedDescription: String {
-        switch self {
-        case .invalidData:
-            return "Invalid input data"
-        case .unsupported:
-            return "This type of entity is not supported"
-        case .missingKey(let key):
-            return "Input is missing a required key: \"\(key)\""
-        }
-    }
-}
+    private struct Empty: Codable {}
 
-protocol Adapter {
-    associatedtype InputType
-    associatedtype OutputType
+    let items: [T]
 
-    func adapt(_ input: InputType) -> Result<OutputType, AdapterError>
-    func adapt(_ input: [InputType]) -> Result<[OutputType], AdapterError>
-}
-
-extension Adapter {
+    public init(from decoder: Decoder) throws {
+        var container = try decoder.unkeyedContainer()
+        var items = [T]()
 
-    func adapt(_ input: [InputType]) -> Result<[OutputType], AdapterError> {
-        let collection = input.compactMap { (item: InputType) -> OutputType? in
-            let itemResult = adapt(item)
-            switch itemResult {
-            case .success(let resultingItem):
-                return resultingItem
-            default: return nil
+        while !container.isAtEnd {
+            if let item = try? container.decode(T.self) {
+                items.append(item)
+            } else {
+                // container.currentIndex is not incremented unless something is decoded
+                _ = try? container.decode(Empty.self)
             }
         }
 
-        return .success(collection)
+        self.items = items
     }
-
 }

ConfCore/AppleAPIClient.swift

@@ -8,7 +8,6 @@
 
 import Foundation
 import Siesta
-import SwiftyJSON
 
 // MARK: - Initialization and configuration
 
@@ -36,53 +35,45 @@ public final class AppleAPIClient {
         }
     }
 
-    private let jsonParser = ResponseContentTransformer { JSON($0.content as AnyObject) }
+
 
     private func configureService() {
         service.configure("**") { config in
-            config.pipeline[.parsing].add(self.jsonParser, contentTypes: ["*/json"])
+            // Parsing & Transformation is done using Codable, no need to let Siesta do the parsing
+            config.pipeline[.parsing].removeTransformers()
         }
 
-        service.configureTransformer(environment.newsPath) { [weak self] (entity: Entity<JSON>) throws -> [NewsItem]? in
-            guard let newsItemsJson = entity.content["items"].array else {
-                throw APIError.adapter
+        let decoder = JSONDecoder()
+        decoder.dateDecodingStrategy = .formatted(.confCoreFormatter)
+
+        service.configureTransformer(environment.newsPath) { (entity: Entity<Data>) throws -> [NewsItem]? in
+            struct NewsItemWrapper: Decodable {
+                let items: FailableItemArrayWrapper<NewsItem>
             }
 
-            return try self?.failableAdaptCollection(newsItemsJson, using: NewsItemsJSONAdapter())
+            let result = try decoder.decode(NewsItemWrapper.self, from: entity.content).items.items
+            return result
         }
 
-        service.configureTransformer(environment.featuredSectionsPath) { [weak self] (entity: Entity<JSON>) throws -> [FeaturedSection]? in
-            guard let sectionsJSON = entity.content["sections"].array else {
-                throw APIError.adapter
+        service.configureTransformer(environment.featuredSectionsPath) { (entity: Entity<Data>) throws -> [FeaturedSection]? in
+            struct FeaturedContentWrapper: Decodable {
+                let sections: FailableItemArrayWrapper<FeaturedSection>
             }
 
-            return try self?.failableAdaptCollection(sectionsJSON, using: FeaturedSectionsJSONAdapter())
+            let result = try decoder.decode(FeaturedContentWrapper.self, from: entity.content).sections.items
+            return result
         }
 
-        service.configureTransformer(environment.sessionsPath) { [weak self] (entity: Entity<JSON>) throws -> ContentsResponse? in
-            return try self?.failableAdapt(entity.content, using: ContentsResponseAdapter())
+        service.configureTransformer(environment.sessionsPath) { (entity: Entity<Data>) throws -> ContentsResponse? in
+            return try decoder.decode(ContentsResponse.self, from: entity.content)
         }
 
-        service.configureTransformer(environment.videosPath) { [weak self] (entity: Entity<JSON>) throws -> SessionsResponse? in
-            return try self?.failableAdapt(entity.content, using: SessionsResponseAdapter())
+        service.configureTransformer(environment.videosPath) { (entity: Entity<Data>) throws -> SessionsResponse? in
+            return try decoder.decode(SessionsResponse.self, from: entity.content)
         }
 
-        service.configureTransformer(environment.liveVideosPath) { [weak self] (entity: Entity<JSON>) throws -> [SessionAsset]? in
-            guard let sessionsDict = entity.content["live_sessions"].dictionary else {
-                throw APIError.adapter
-            }
-
-            let sessionsArray = sessionsDict.compactMap { key, value -> JSON? in
-                guard let id = JSON.init(rawValue: key) else { return nil }
-
-                var v = value
-
-                v["sessionId"] = id
-
-                return v
-            }
-
-            return try self?.failableAdaptCollection(sessionsArray, using: LiveVideosAdapter())
+        service.configureTransformer(environment.liveVideosPath) { (entity: Entity<Data>) throws -> [SessionAsset]? in
+            return try decoder.decode(LiveVideosWrapper.self, from: entity.content).liveAssets
         }
     }
 
@@ -199,30 +190,6 @@ public final class AppleAPIClient {
 
 extension AppleAPIClient {
 
-    /// Convenience method to use a model adapter as a method that returns the model(s) or throws an error
-    fileprivate func failableAdapt<A: Adapter, T>(_ input: JSON, using adapter: A) throws -> T where A.InputType == JSON, A.OutputType == T {
-        let result = adapter.adapt(input)
-
-        switch result {
-        case let .error(error):
-            throw error
-        case let .success(output):
-            return output
-        }
-    }
-
-    /// Convenience method to use a model adapter as a method that returns the model(s) or throws an error
-    fileprivate func failableAdaptCollection<A: Adapter, T>(_ input: [JSON], using adapter: A) throws -> [T] where A.InputType == JSON, A.OutputType == T {
-        let result = adapter.adapt(input)
-
-        switch result {
-        case let .error(error):
-            throw error
-        case let .success(output):
-            return output
-        }
-    }
-
     fileprivate func process<M>(_ resource: Resource, event: ResourceEvent, with completion: @escaping (Result<M, APIError>) -> Void) {
         switch event {
         case .error:

ConfCore/Bookmark.swift

@@ -10,7 +10,7 @@ import Cocoa
 import RealmSwift
 
 /// Bookmarks are notes the user can create while watching session videos to reference later, bookmarks can be private or shared with other users
-public final class Bookmark: Object, HasCloudKitFields, SoftDeletable {
+public final class Bookmark: Object, HasCloudKitFields, SoftDeletable, Decodable {
 
     @objc public dynamic var ckFields = Data()
 
@@ -57,4 +57,33 @@ public final class Bookmark: Object, HasCloudKitFields, SoftDeletable {
         return "identifier"
     }
 
+    // MARK: - Codable
+
+    private enum CodingKeys: String, CodingKey {
+        case body
+        case attributedBody
+        case timecode
+        case duration
+    }
+
+    public required convenience init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+
+        let body = try container.decode(String.self, forKey: .body)
+        let timecode = try container.decode(Double.self, forKey: .timecode)
+        let duration = try container.decode(Double.self, forKey: .duration)
+
+        self.init()
+
+        self.body = body
+        self.timecode = timecode
+        self.duration = duration
+        self.isShared = true
+
+        if let attributedBody = try container.decodeIfPresent(String.self, forKey: .attributedBody),
+            let attributedBodyData = Data(base64Encoded: attributedBody) {
+            self.attributedBody = attributedBodyData
+        }
+    }
+
 }

ConfCore/BookmarkJSONAdapter.swift

@@ -7,7 +7,6 @@
 //
 
 import Cocoa
-import SwiftyJSON
 import os.log
 
 public final class ContributorsFetcher {
@@ -72,17 +71,11 @@ public final class ContributorsFetcher {
     }
 
     fileprivate func parseResponse(_ data: Data) -> [String] {
-
-        guard let jsonData = try? JSON(data: data), let contributors = jsonData.array else { return [String]() }
-
-        var contributorNames = [String]()
-        for contributor in contributors {
-            if let name = contributor["login"].string {
-                contributorNames.append(name)
-            }
+        guard let contributors = try? JSONDecoder().decode(Array<GitHubUser>.self, from: data) else {
+            return [String]()
         }
 
-        return contributorNames
+        return contributors.map { $0.login }
     }
 
     fileprivate func buildInfoText(_ names: [String]) {
@@ -98,6 +91,10 @@ public final class ContributorsFetcher {
     }
 }
 
+private struct GitHubUser: Codable {
+    var login: String
+}
+
 private struct GitHubPagination {
 
     var first: URL?

ConfCore/ContributorsFetcher.swift

@@ -10,38 +10,15 @@ import Foundation
 
 public let confCoreDateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
 
-final class DateAdapter: Adapter {
-    typealias InputType = String
-    typealias OutputType = Date
+extension DateFormatter {
 
-    func adapt(_ input: String) -> Result<Date, AdapterError> {
-        let formatter = DateFormatter()
-        formatter.dateFormat = "yyyy-MM-dd"
-        formatter.locale = Locale(identifier: "en-US")
-        formatter.timeZone = TimeZone.current
-
-        if let date = formatter.date(from: input) {
-            return .success(date)
-        } else {
-            return .error(.invalidData)
-        }
-    }
-}
-
-final class DateTimeAdapter: Adapter {
-    typealias InputType = String
-    typealias OutputType = Date
-
-    func adapt(_ input: String) -> Result<Date, AdapterError> {
+    static let confCoreFormatter: DateFormatter = {
         let formatter = DateFormatter()
         formatter.dateFormat = confCoreDateFormat
         formatter.locale = Locale(identifier: "en-US")
         formatter.timeZone = TimeZone.current
 
-        if let date = formatter.date(from: input) {
-            return .success(date)
-        } else {
-            return .error(.invalidData)
-        }
-    }
+        return formatter
+    }()
+
 }