Show goals in Spotlight (#472)

Uses the integration between CoreData and Spotlight to make goal
information available in spotlight search.

Testing:
Ran on device and saw the entries appear in spotlight
Verified clicking on items navigates to the app

Author: theospears

BeeKit/Model/BeeminderModel.xcdatamodeld/BeeminderModel.xcdatamodel/contents

@@ -9,7 +9,7 @@
         <attribute name="value" attributeType="Decimal" defaultValueString="0.0"/>
         <relationship name="goal" maxCount="1" deletionRule="Nullify" destinationEntity="Goal" inverseName="data" inverseEntity="Goal"/>
     </entity>
-    <entity name="Goal" representedClassName="Goal" syncable="YES">
+    <entity name="Goal" representedClassName="Goal" syncable="YES" coreSpotlightDisplayNameExpression="slug">
         <attribute name="alertStart" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES"/>
         <attribute name="autodata" optional="YES" attributeType="String"/>
         <attribute name="deadline" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES"/>
@@ -25,9 +25,9 @@
         <attribute name="queued" attributeType="Boolean" usesScalarValueType="YES"/>
         <attribute name="safeBuf" attributeType="Integer 64" defaultValueString="0" usesScalarValueType="YES"/>
         <attribute name="safeSum" attributeType="String"/>
-        <attribute name="slug" attributeType="String"/>
+        <attribute name="slug" attributeType="String" spotlightIndexingEnabled="YES"/>
         <attribute name="thumbUrl" attributeType="String"/>
-        <attribute name="title" attributeType="String"/>
+        <attribute name="title" attributeType="String" spotlightIndexingEnabled="YES"/>
         <attribute name="todayta" attributeType="Boolean" usesScalarValueType="YES"/>
         <attribute name="urgencyKey" attributeType="String"/>
         <attribute name="useDefaults" attributeType="Boolean" usesScalarValueType="YES"/>

BeeKit/Model/BeeminderPersistantContainer.swift

@@ -4,6 +4,8 @@ import OSLog
 
 public class BeeminderPersistentContainer: NSPersistentContainer {
     private static let logger = Logger(subsystem: "com.beeminder.beeminder", category: "BeeminderPersistentContainer")
+    private var spotlightIndexer: NSCoreDataCoreSpotlightDelegate?
+
 
     override open class func defaultDirectoryURL() -> URL {
         let storeURL = FileManager.default.containerURL(forSecurityApplicationGroupIdentifier: "group.beeminder.beeminder")
@@ -12,6 +14,14 @@ public class BeeminderPersistentContainer: NSPersistentContainer {
 
     static func create() -> BeeminderPersistentContainer {
         let container = BeeminderPersistentContainer(name: "BeeminderModel")
+
+        guard let description = container.persistentStoreDescriptions.first else {
+            fatalError("Failed to retrieve a persistent store description.")
+        }
+        // Spotlight indexing requires sqlite and history tracking
+        description.type = NSSQLiteStoreType
+        description.setOption(true as NSNumber, forKey: NSPersistentHistoryTrackingKey)
+
         container.loadPersistentStores { description, error in
             if let error = error {
                 logger.error("Unable to load persistent stores: \(error, privacy: .public)")
@@ -30,6 +40,10 @@ public class BeeminderPersistentContainer: NSPersistentContainer {
                 }
             }
         }
+
+        container.spotlightIndexer = BeeminderSpotlightDelegate(forStoreWith: description, coordinator: container.persistentStoreCoordinator)
+        container.spotlightIndexer?.startSpotlightIndexing()
+
         return container
     }
 

BeeKit/Model/BeeminderSpotlightDelegate.swift

@@ -0,0 +1,17 @@
+import Foundation
+import CoreData
+import CoreSpotlight
+
+class BeeminderSpotlightDelegate: NSCoreDataCoreSpotlightDelegate {
+
+    override func attributeSet(for object: NSManagedObject) -> CSSearchableItemAttributeSet? {
+        if let goal = object as? Goal {
+            let attributeSet = CSSearchableItemAttributeSet(contentType: .content)
+            attributeSet.identifier = goal.slug
+            attributeSet.displayName = goal.slug
+            attributeSet.contentDescription = goal.title
+            return attributeSet
+        }
+        return nil
+    }
+}

BeeSwift.xcodeproj/project.pbxproj

@@ -129,6 +129,7 @@
 		E4B0A33228C194CA00055EA7 /* AddDataIntents.intentdefinition in Sources */ = {isa = PBXBuildFile; fileRef = E540953B260FB6A100C30784 /* AddDataIntents.intentdefinition */; };
 		E4B6FEC62A776A2900690376 /* GoalTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4B6FEC52A776A2900690376 /* GoalTests.swift */; };
 		E4D5BD5D2C5DFBA30007B0BE /* HealthKitMetricMonitor.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4D5BD5C2C5DFBA30007B0BE /* HealthKitMetricMonitor.swift */; };
+		E4D5BD5F2C6709060007B0BE /* BeeminderSpotlightDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4D5BD5E2C6709060007B0BE /* BeeminderSpotlightDelegate.swift */; };
 		E4E43D8829F39CE800697116 /* LogsViewController.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4E43D8729F39CE800697116 /* LogsViewController.swift */; };
 		E4E63C6D2C3F9083005E00DA /* DataPointManager.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4E63C6C2C3F9083005E00DA /* DataPointManager.swift */; };
 		E4E63C732C5DDE98005E00DA /* GoalExtensions.swift in Sources */ = {isa = PBXBuildFile; fileRef = E4E63C722C5DDE98005E00DA /* GoalExtensions.swift */; };
@@ -346,6 +347,7 @@
 		E4B0833C293810EB00A71564 /* BeeDataPoint.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BeeDataPoint.swift; sourceTree = "<group>"; };
 		E4B6FEC52A776A2900690376 /* GoalTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GoalTests.swift; sourceTree = "<group>"; };
 		E4D5BD5C2C5DFBA30007B0BE /* HealthKitMetricMonitor.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = HealthKitMetricMonitor.swift; sourceTree = "<group>"; };
+		E4D5BD5E2C6709060007B0BE /* BeeminderSpotlightDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BeeminderSpotlightDelegate.swift; sourceTree = "<group>"; };
 		E4E43D8729F39CE800697116 /* LogsViewController.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LogsViewController.swift; sourceTree = "<group>"; };
 		E4E63C6C2C3F9083005E00DA /* DataPointManager.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DataPointManager.swift; sourceTree = "<group>"; };
 		E4E63C722C5DDE98005E00DA /* GoalExtensions.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GoalExtensions.swift; sourceTree = "<group>"; };
@@ -641,6 +643,7 @@
 				E46070EE2B36A4D900305DB4 /* User.swift */,
 				E4E8DD3A2BE87F890059C64F /* Goal.swift */,
 				E4E8DD3C2BE881440059C64F /* DataPoint.swift */,
+				E4D5BD5E2C6709060007B0BE /* BeeminderSpotlightDelegate.swift */,
 			);
 			path = Model;
 			sourceTree = "<group>";
@@ -1221,6 +1224,7 @@
 				E458C8022AD11BB9000DCA5C /* CurrentUserManager.swift in Sources */,
 				E458C8182AD11CAC000DCA5C /* TimeAsleepHealthKitMetric.swift in Sources */,
 				E458C80B2AD11C2B000DCA5C /* ServiceLocator.swift in Sources */,
+				E4D5BD5F2C6709060007B0BE /* BeeminderSpotlightDelegate.swift in Sources */,
 				E458C81B2AD11CD8000DCA5C /* UIColorExtension.swift in Sources */,
 				E458C8082AD11BFB000DCA5C /* BeeDataPoint.swift in Sources */,
 				E458C81C2AD11CDE000DCA5C /* UIFontExtension.swift in Sources */,

BeeSwift/AppDelegate.swift

@@ -6,12 +6,15 @@
 //  Copyright (c) 2015 APB. All rights reserved.
 //
 
+import CoreSpotlight
+import HealthKit
+import OSLog
 import UIKit
+
 import IQKeyboardManagerSwift
-import HealthKit
 import AlamofireNetworkActivityIndicator
+
 import BeeKit
-import OSLog
 
 @UIApplicationMain
 class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate {
@@ -171,7 +174,11 @@ class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterD
         UNUserNotificationCenter.current().removeAllPendingNotificationRequests()
     }
     func application(_ application: UIApplication, continue userActivity: NSUserActivity, restorationHandler: @escaping ([UIUserActivityRestoring]?) -> Void) -> Bool {
-        if let intent = userActivity.interaction?.intent as? AddDataIntent {
+        if userActivity.activityType == CSSearchableItemActionType {
+            guard let goalIdentifier = userActivity.userInfo?[CSSearchableItemActivityIdentifier] as? String else { return false
+            }
+            NotificationCenter.default.post(name: Notification.Name(rawValue: "openGoal"), object: nil, userInfo: ["identifier": goalIdentifier])
+        } else if let intent = userActivity.interaction?.intent as? AddDataIntent {
             guard let goalSlug = intent.goal else { return false }
             NotificationCenter.default.post(name: Notification.Name(rawValue: "openGoal"), object: nil, userInfo: ["slug": goalSlug])
         } else if let goalSlug = userActivity.userInfo?["slug"] {

BeeSwift/Gallery/GalleryViewController.swift

@@ -486,10 +486,20 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
     }
 
     @objc func openGoalFromNotification(_ notification: Notification) {
-        let slug = (notification as NSNotification).userInfo!["slug"] as! String
-        let matchingGoal = self.goals.filter({ (goal) -> Bool in
-            return goal.slug == slug
-        }).last
+        guard let notif = notification as NSNotification? else { return }
+        var matchingGoal: Goal?
+
+        if let identifier = notif.userInfo?["identifier"] as? String {
+            let context = ServiceLocator.persistentContainer.viewContext
+            if let url = URL(string: identifier), let objectID = context.persistentStoreCoordinator?.managedObjectID(forURIRepresentation: url) {
+                matchingGoal = context.object(with: objectID) as? Goal
+            }
+        }
+        else if let slug = notif.userInfo?["slug"] as? String {
+            matchingGoal = self.goals.filter({ (goal) -> Bool in
+                return goal.slug == slug
+            }).last
+        }
         if matchingGoal != nil {
             self.navigationController?.popToRootViewController(animated: false)
             self.openGoal(matchingGoal!)