Merge pull request #17 from Squarespace/avyazovoy/example-project-improvements

Example project improvements

Author: Vyazovoy

.github/fixed_podspecs/SwiftyJSON.podspec

@@ -29,7 +29,6 @@ jobs:
         run: |
           bundle exec pod lib lint \
           --allow-warnings \
-          --external-podspecs=".github/fixed_podspecs/**/*.podspec" \
           --validation-dir="${{ steps.define_validation_dir.outputs.path }}" \
           --no-clean
 

.github/workflows/ci.yml

@@ -4,7 +4,6 @@ target 'SimpleSourceExample' do
     use_frameworks!
 
     pod 'SimpleSource', :path => '..', :testspecs => ['Tests']
-    pod 'SwiftyJSON', '~> 5.0'
 end
 
 def inherit_project_deployment_target(installer)

Examples/Podfile

@@ -5,18 +5,15 @@ PODS:
   - SimpleSource/Tests (3.0.0):
     - Nimble (~> 12.0)
     - Quick (~> 7.0)
-  - SwiftyJSON (5.0.1)
 
 DEPENDENCIES:
   - SimpleSource (from `..`)
   - SimpleSource/Tests (from `..`)
-  - SwiftyJSON (~> 5.0)
 
 SPEC REPOS:
   trunk:
     - Nimble
     - Quick
-    - SwiftyJSON
 
 EXTERNAL SOURCES:
   SimpleSource:
@@ -26,8 +23,7 @@ SPEC CHECKSUMS:
   Nimble: f8a8219d16f176429b951e8f7e72df5c23ceddc0
   Quick: d32871931c05547cb4e0bc9009d66a18b50d8558
   SimpleSource: 611bfe53fe55132415a3c72a9a0126f9aa846d8b
-  SwiftyJSON: 2f33a42c6fbc52764d96f13368585094bfd8aa5e
 
-PODFILE CHECKSUM: a5deddba5204624da3222bdb26450e64fabfabc5
+PODFILE CHECKSUM: 5ebdafbbdb9020f19e05fb40cff22a580d64a844
 
 COCOAPODS: 1.13.0

Examples/Podfile.lock

@@ -40,7 +40,8 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES">
       <MacroExpansion>
          <BuildableReference
             BuildableIdentifier = "primary"

Examples/SimpleSourceExample.xcodeproj/xcshareddata/xcschemes/SimpleSourceExample.xcscheme

@@ -1,25 +1,20 @@
 import Foundation
 import CoreData
-import SwiftyJSON
 
 /// A helper class to load some content into an `NSManagedObjectContext`.
 struct CharacterLoader {
     static func load(into context: NSManagedObjectContext) {
         let dataURL = Bundle.main.url(forResource: "characters", withExtension: "json")!
         let data = try! Data(contentsOf: dataURL)
-        try! JSON(data: data).arrayValue.forEach {
-            loadCharacter(json: $0, into: context)
+        try! JSONDecoder().decode([CharacterRepresentation].self, from: data).forEach { representation in
+            let character = Character(context: context)
+            character.name = representation.name
+            character.race = representation.race
         }
     }
 
-    private static func loadCharacter(json: JSON, into context: NSManagedObjectContext) {
-        guard
-            let name = json["name"].string,
-            let race = json["race"].string
-            else { return }
-        
-        let character = Character(context: context)
-        character.name = name
-        character.race = race
+    private struct CharacterRepresentation: Decodable {
+        let name: String
+        let race: String
     }
 }

Examples/SimpleSourceExample/CharacterLoader.swift

@@ -1,57 +1,11 @@
 import Foundation
-import SwiftyJSON
 
 struct ColorLoader {
 
     /// Loads colors (organized into sections) from a JSON file.
     static func loadSections() -> [ColorSection] {
         let dataURL = Bundle.main.url(forResource: "colors", withExtension: "json")!
         let data = try! Data(contentsOf: dataURL)
-        return try! JSON(data: data).arrayValue.compactMap(parseSection)
-    }
-    
-    // MARK: Private
-    
-    private static func parseSection(json: JSON) -> ColorSection? {
-        guard
-            let title = json["title"].string,
-            let colors = json["colors"].array
-        else { return nil }
-        
-        return ColorSection(title: title, items: colors.compactMap(parseItem))
-    }
-    
-    private static func parseItem(json: JSON) -> ColorItem? {
-        guard
-            let name = json["name"].string,
-            let rgbString = json["rgb"].string,
-            let rgb = parseRGB(rgbString: rgbString)
-        else { return nil }
-        
-        return ColorItem(name: name, rgb: rgb)
-    }
-    
-    private static func parseRGB(rgbString: String) -> (CGFloat, CGFloat, CGFloat)? {
-        let r, g, b: CGFloat
-        
-        if rgbString.hasPrefix("#") {
-            let start = rgbString.index(rgbString.startIndex, offsetBy: 1)
-            let hexColor = String(rgbString[start...])
-            
-            if hexColor.lengthOfBytes(using: .utf8) == 6 {
-                let scanner = Scanner(string: hexColor)
-                var hexNumber: UInt64 = 0
-                
-                if scanner.scanHexInt64(&hexNumber) {
-                    r = CGFloat((hexNumber & 0xff0000) >> 16) / 255
-                    g = CGFloat((hexNumber & 0x00ff00) >> 8)  / 255
-                    b = CGFloat((hexNumber & 0x0000ff) >> 0)  / 255
-                    
-                    return (r, g, b)
-                }
-            }
-        }
-        
-        return nil
+        return try! JSONDecoder().decode([ColorSection].self, from: data)
     }
 }

Examples/SimpleSourceExample/ColorLoader.swift

@@ -13,9 +13,16 @@ extension ColorSection: IdentifiableSection {
     var sectionIdentifier: String { return title }
 }
 
+extension ColorSection: Decodable {
+    enum CodingKeys: String, CodingKey {
+        case title
+        case items = "colors"
+    }
+}
+
 // MARK: Items
 
-struct ColorItem: Equatable {
+struct ColorItem {
     let name: String
     let rgb: (CGFloat, CGFloat, CGFloat)
 
@@ -24,7 +31,36 @@ struct ColorItem: Equatable {
     }
 }
 
-func ==(lhs: ColorItem, rhs: ColorItem) -> Bool {
-    return lhs.name == rhs.name && lhs.rgb == rhs.rgb
+extension ColorItem: Equatable {
+    static func == (lhs: ColorItem, rhs: ColorItem) -> Bool {
+        lhs.name == rhs.name && lhs.rgb == rhs.rgb
+    }
 }
 
+extension ColorItem: Decodable {
+    enum Errors: Error {
+        case rgbDecodingFailure
+    }
+    enum CodingKeys: String, CodingKey {
+        case name
+        case rgb
+    }
+
+    init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        name = try container.decode(String.self, forKey: .name)
+        let scanner = try Scanner(string: container.decode(String.self, forKey: .rgb))
+        guard
+            scanner.scanCharacters(from: .init(charactersIn: "#")) == "#",
+            let rgbUInt64 = scanner.scanUInt64(representation: .hexadecimal)
+        else {
+            print("Name: \(name)\nRGBString: \(scanner.string)")
+            throw Errors.rgbDecodingFailure
+        }
+        rgb = (
+            CGFloat((rgbUInt64 & 0xff0000) >> 16) / 255,
+            CGFloat((rgbUInt64 & 0x00ff00) >> 8)  / 255,
+            CGFloat((rgbUInt64 & 0x0000ff) >> 0)  / 255
+        )
+    }
+}