Generate and render acknowledgements as Settings.bundle

.gitignore

@@ -15,6 +15,7 @@ xcuserdata
 
 # Build products
 build/
+.build/
 *.o
 *.LinkFileList
 *.hmap
@@ -30,9 +31,6 @@ build/
 *.dat
 *.dep
 
-# Cocoapods
-Pods
-
 # AppCode specific files
 .idea/
 *.iml
@@ -43,5 +41,9 @@ fastlane/Preview.html
 fastlane/screenshots
 fastlane/test_output
 
+# Config files
 Secrets.h
 .env
+
+# Generated files
+Sources/Tropos/Resources/Settings.bundle/Acknowledgements*

Cartfile

@@ -1,3 +1,3 @@
-github "ReactiveCocoa/ReactiveObjCBridge"
+github "ReactiveCocoa/ReactiveObjCBridge" "as-ras-6.1.0"
 github "ReactiveCocoa/ReactiveSwift"
 github "mixpanel/mixpanel-iphone"

Cartfile.resolved

@@ -1,8 +1,7 @@
-github "AliSoftware/OHHTTPStubs" "6.1.0"
-github "Quick/Nimble" "v8.0.1"
-github "Quick/Quick" "v1.3.0"
-github "ReactiveCocoa/ReactiveObjC" "3.1.0"
-github "ReactiveCocoa/ReactiveObjCBridge" "3.1.0"
-github "ReactiveCocoa/ReactiveSwift" "3.1.0"
-github "antitypical/Result" "3.2.4"
-github "mixpanel/mixpanel-iphone" "v3.3.7"
+github "AliSoftware/OHHTTPStubs" "8.0.0"
+github "Quick/Nimble" "v8.0.2"
+github "Quick/Quick" "v2.1.0"
+github "ReactiveCocoa/ReactiveObjC" "3.1.1"
+github "ReactiveCocoa/ReactiveObjCBridge" "c1c49ea807d783313f696184b55956094c993e2d"
+github "ReactiveCocoa/ReactiveSwift" "6.1.0"
+github "mixpanel/mixpanel-iphone" "v3.4.7"

Package.swift

@@ -0,0 +1,11 @@
+// swift-tools-version:4.2
+
+import PackageDescription
+
+let package = Package(
+    name: "Tropos",
+    targets: [
+        .target(name: "generate-acknowledgements", dependencies: ["Settings"]),
+        .target(name: "Settings"),
+    ]
+)

Sources/Settings/Bundle.swift

@@ -0,0 +1,9 @@
+import class Foundation.Bundle
+
+extension Bundle {
+    public var settingsBundle: Bundle? {
+        return url(forResource: "Settings", withExtension: "bundle").flatMap {
+            Bundle(url: $0)
+        }
+    }
+}

Sources/Settings/PreferencePage.swift

@@ -0,0 +1,13 @@
+public struct PreferencePage {
+    public var preferenceSpecifiers: [PreferenceSpecifier]
+
+    public init(preferenceSpecifiers: [PreferenceSpecifier] = []) {
+        self.preferenceSpecifiers = preferenceSpecifiers
+    }
+}
+
+extension PreferencePage: Codable {
+    private enum CodingKeys: String, CodingKey {
+        case preferenceSpecifiers = "PreferenceSpecifiers"
+    }
+}

Sources/Settings/PreferenceSpecifier.swift

@@ -0,0 +1,19 @@
+public struct PreferenceSpecifier {
+    public var file: String?
+    public var footerText: String?
+    public var title: String?
+    public let type: String
+
+    public init(type: String) {
+        self.type = type
+    }
+}
+
+extension PreferenceSpecifier: Codable {
+    private enum CodingKeys: String, CodingKey {
+        case file = "File"
+        case footerText = "FooterText"
+        case title = "Title"
+        case type = "Type"
+    }
+}

Sources/Tropos/Extensions/Optional.swift

@@ -0,0 +1,9 @@
+extension Optional {
+    func unwrap(file: StaticString = #file, line: UInt = #line) throws -> Wrapped {
+        if let value = self {
+            return value
+        } else {
+            throw NilError(file: file, line: line)
+        }
+    }
+}

Sources/Tropos/Models/NilError.swift

@@ -0,0 +1,20 @@
+import Foundation
+
+struct NilError: Error, CustomNSError {
+    static let lineNumberKey = "line-number"
+
+    let file: StaticString
+    let line: UInt
+
+    var errorDescription: String? {
+        return "Unexpectedly found nil while unwrapping optional"
+    }
+
+    var errorUserInfo: [String: Any] {
+        return [
+            NSFilePathErrorKey: file,
+            NSLocalizedDescriptionKey: errorDescription!,
+            NilError.lineNumberKey: line,
+        ]
+    }
+}

Sources/Tropos/Resources/Settings.bundle/Root.plist

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>StringsTable</key>
+	<string>Root</string>
+	<key>PreferenceSpecifiers</key>
+	<array>
+		<dict>
+			<key>Type</key>
+			<string>PSChildPaneSpecifier</string>
+			<key>File</key>
+			<string>Acknowledgements</string>
+			<key>Title</key>
+			<string>Acknowledgements</string>
+		</dict>
+	</array>
+</dict>
+</plist>

Sources/Tropos/ViewControllers/AcknowledgementsViewController.swift

@@ -0,0 +1,79 @@
+import os.log
+import Settings
+import UIKit
+
+final class AcknowledgementsViewController: UITableViewController {
+    private var acknowledgements = PreferencePage()
+    private var settings = Bundle.main.settingsBundle!
+
+    override func viewDidLoad() {
+        super.viewDidLoad()
+
+        do {
+            acknowledgements = try loadAcknowledgementsList()
+        } catch {
+            guard #available(iOS 10.0, *) else { return }
+            os_log("Failed to load acknowledgements: %{public}@", type: .error, error.localizedDescription)
+        }
+    }
+
+    override func tableView(_ tableView: UITableView, numberOfRowsInSection section: Int) -> Int {
+        return acknowledgements.preferenceSpecifiers.count
+    }
+
+    override func tableView(_ tableView: UITableView, titleForHeaderInSection section: Int) -> String? {
+        return NSLocalizedString("Third-Party Code", comment: "Title for Acknowledgements library list")
+    }
+
+    override func tableView(_ tableView: UITableView, cellForRowAt indexPath: IndexPath) -> UITableViewCell {
+        let library = acknowledgements.preferenceSpecifiers[indexPath.row]
+        let cell = tableView.dequeueReusableCell(withIdentifier: "Library", for: indexPath)
+        cell.textLabel?.text = library.title
+        return cell
+    }
+
+    override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
+        defer { super.prepare(for: segue, sender: sender) }
+
+        guard let destination = segue.destination as? TextViewController,
+            let indexPath = (sender as? UITableViewCell).flatMap(tableView.indexPath(for:))
+        else { return }
+
+        let library = acknowledgements.preferenceSpecifiers[indexPath.row]
+        destination.title = library.title
+
+        do {
+            let libraryAcknowledgements = try loadAcknowledgements(forLibraryNamed: library.title.unwrap())
+            destination.text = libraryAcknowledgements.footerText
+        } catch {
+            guard #available(iOS 10.0, *) else { return }
+
+            os_log(
+                "Failed to load acknowledgements for library '%{public}@': %{public}@",
+                type: .error,
+                library.title ?? "nil",
+                error.localizedDescription
+            )
+        }
+    }
+}
+
+private extension AcknowledgementsViewController {
+    func loadAcknowledgementsList() throws -> PreferencePage {
+        return try settings
+            .url(forResource: "Acknowledgements", withExtension: "plist")
+            .map { try Data(contentsOf: $0) }
+            .map { try PropertyListDecoder().decode(PreferencePage.self, from: $0) }
+            .unwrap()
+    }
+
+    func loadAcknowledgements(forLibraryNamed libraryName: String) throws -> PreferenceSpecifier {
+        let page = try settings
+            .url(forResource: libraryName, withExtension: "plist", subdirectory: "Acknowledgements")
+            .map { try Data(contentsOf: $0) }
+            .map { try PropertyListDecoder().decode(PreferencePage.self, from: $0) }
+            .unwrap()
+
+        return try page.preferenceSpecifiers.first.unwrap()
+    }
+}

Sources/Tropos/ViewControllers/SettingsTableViewController.swift

@@ -3,7 +3,7 @@ import UIKit
 
 private enum SegueIdentifier: String {
     case privacyPolicy = "ShowWebViewController"
-    case acknowledgements = "ShowTextViewController"
+    case acknowledgements = "ShowAcknowledgementsViewController"
 
     init?(identifier: String?) {
         guard let identifier = identifier else { return nil }
@@ -76,15 +76,7 @@ class SettingsTableViewController: UITableViewController {
         case .privacyPolicy?:
             let webViewController = segue.destination as? WebViewController
             webViewController?.url = URL(string: "http://www.troposweather.com/privacy/")!
-        case .acknowledgements?:
-            let textViewController = segue.destination as? TextViewController
-            let fileURL = Bundle.main.url(
-                forResource: "Pods-Tropos-settings-metadata",
-                withExtension: "plist"
-            )
-            let parser = fileURL.flatMap { AcknowledgementsParser(fileURL: $0) }
-            textViewController?.text = parser?.displayString()
-        case nil:
+        default:
             break
         }
     }

Sources/TroposCore/Controllers/ForecastController.swift

@@ -1,6 +1,5 @@
 import CoreLocation
 import ReactiveSwift
-import Result
 
 private var locationNotFound: Error {
     return NSError(domain: TRErrorDomain, code: TRError.conditionsResponseLocationNotFound.rawValue)
@@ -33,8 +32,8 @@ public final class ForecastController: NSObject {
         urlSession = URLSession(configuration: configuration)
     }
 
-    public func fetchWeatherUpdate(for placemark: CLPlacemark) -> SignalProducer<WeatherUpdate, AnyError> {
-        guard let location = placemark.location else { return SignalProducer(error: AnyError(locationNotFound)) }
+    public func fetchWeatherUpdate(for placemark: CLPlacemark) -> SignalProducer<WeatherUpdate, Error> {
+        guard let location = placemark.location else { return SignalProducer(error: locationNotFound) }
 
         let today = conditionsRequest(for: location.coordinate, date: nil)
         let yesterday = conditionsRequest(for: location.coordinate, date: .yesterday)
@@ -44,7 +43,7 @@ public final class ForecastController: NSObject {
         }
     }
 
-    private func fetch(_ conditionsRequest: URLRequest) -> SignalProducer<[String: Any], AnyError> {
+    private func fetch(_ conditionsRequest: URLRequest) -> SignalProducer<[String: Any], Error> {
         return urlSession.reactive.data(with: conditionsRequest).attemptMap {
             let (data, response) = $0
             guard 200 ..< 300 ~= (response as! HTTPURLResponse).statusCode else { throw responseFailed }

Sources/TroposCore/Controllers/GeocodeController.swift

@@ -1,7 +1,6 @@
 import CoreLocation
 import ReactiveObjCBridge
 import ReactiveSwift
-import Result
 
 @objc(TRGeocodeController)
 public final class GeocodeController: NSObject {

Sources/TroposCore/Controllers/LocationController.swift

@@ -2,15 +2,14 @@ import CoreLocation
 import Foundation
 import ReactiveObjCBridge
 import ReactiveSwift
-import Result
 
 @objc(TRLocationController)
 open class LocationController: NSObject, CLLocationManagerDelegate {
     private let locationManager: CLLocationManager
-    private let locationUpdates = Signal<CLLocation, NoError>.pipe()
-    private let locationUpdateError = Signal<CLError, NoError>.pipe()
+    private let locationUpdates = Signal<CLLocation, Never>.pipe()
+    private let locationUpdateError = Signal<CLError, Never>.pipe()
 
-    private let statusChanged = Signal<CLAuthorizationStatus, NoError>.pipe()
+    private let statusChanged = Signal<CLAuthorizationStatus, Never>.pipe()
     private let authorizationStatus: Property<CLAuthorizationStatus>
 
     @objc public init(locationManager: CLLocationManager) {
@@ -56,7 +55,7 @@ open class LocationController: NSObject, CLLocationManagerDelegate {
         }
     }
 
-    public func requestAuthorization() -> SignalProducer<Bool, NoError> {
+    public func requestAuthorization() -> SignalProducer<Bool, Never> {
         return SignalProducer { [authorizationStatus, locationManager] observer, lifetime in
             let isAuthorized = authorizationStatus.producer.filterMap { status -> Bool? in
                 switch status {

Sources/TroposCore/Extensions/ForecastController+Bridging.swift

@@ -1,6 +1,5 @@
 import ReactiveObjCBridge
 import ReactiveSwift
-import Result
 
 extension ForecastController {
     @objc(fetchWeatherUpdateForPlacemark:)

Sources/TroposIntents/CheckWeatherIntentHandler.swift

@@ -1,7 +1,6 @@
 import Foundation
 import os.log
 import ReactiveSwift
-import Result
 import TroposCore
 
 @available(iOS 12.0, *)
@@ -20,7 +19,7 @@ public final class CheckWeatherIntentHandler: NSObject, CheckWeatherIntentHandli
         let weatherUpdate = location.requestAuthorization()
             .flatMap(.latest) { _ in location.requestLocation() }
             .flatMap(.latest) { location in geocode.reverseGeocode(location) }
-            .mapError(AnyError.init)
+            .mapError { $0 as Error }
             .flatMap(.latest) { placemark in forecast.fetchWeatherUpdate(for: placemark) }
 
         weatherUpdate.startWithResult { result in