Skip to content

Gallery's list is now fed by nsfetchedresultscontroller #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
theospears merged 6 commits into from
Jan 14, 2025
Merged

Gallery's list is now fed by nsfetchedresultscontroller #607

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
824b7d1
use nsfetchedresultscontroller on the gallery
krugerk Jan 8, 2025
1b47683
using controller(:didChangeContentWith:) rather than constructing the…
krugerk Jan 13, 2025
ce89bb8
also start with user's preferred sort
krugerk Jan 13, 2025
4999161
one long class to rule them all
krugerk Jan 13, 2025
c3daf86
object at
krugerk Jan 13, 2025
27b7b7d
on less notification center observer
krugerk Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
128 changes: 65 additions & 63 deletions BeeSwift/Gallery/GalleryViewController.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import CoreData
import BeeKit


class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayout, UICollectionViewDelegate, UISearchBarDelegate, SFSafariViewControllerDelegate {
class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayout, UICollectionViewDelegate, UISearchBarDelegate, SFSafariViewControllerDelegate, NSFetchedResultsControllerDelegate {
let logger = Logger(subsystem: "com.beeminder.beeminder", category: "GalleryViewController")

// Dependencies
Expand All @@ -40,20 +40,22 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
let searchBar = UISearchBar()
var lastUpdated: Date?

var goals : [Goal] = []
var filteredGoals : [Goal] = []

private enum Section: CaseIterable {
case main
}

private var dataSource: UICollectionViewDiffableDataSource<Section, Goal>!
private typealias GallerySnapshot = NSDiffableDataSourceSnapshot<GalleryViewController.Section, NSManagedObjectID>

private var dataSource: UICollectionViewDiffableDataSource<Section, NSManagedObjectID>!

public enum NotificationName {
public static let openGoal = Notification.Name(rawValue: "com.beeminder.openGoal")
}

init(currentUserManager: CurrentUserManager,

private let fetchedResultsController: NSFetchedResultsController<Goal>!
private var fetchRequest: NSFetchRequest<Goal>?

init(currentUserManager: CurrentUserManager,
viewContext: NSManagedObjectContext,
versionManager: VersionManager,
goalManager: GoalManager,
Expand All @@ -63,7 +65,16 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
self.versionManager = versionManager
self.goalManager = goalManager
self.healthStoreManager = healthStoreManager

let fetchRequest = Goal.fetchRequest() as! NSFetchRequest<Goal>
fetchRequest.sortDescriptors = Self.preferredSort
fetchedResultsController = .init(fetchRequest: fetchRequest,
managedObjectContext: viewContext,
sectionNameKeyPath: nil, cacheName: nil)
self.fetchRequest = fetchRequest

super.init(nibName: nil, bundle: nil)
fetchedResultsController.delegate = self
}

required init?(coder: NSCoder) {
Expand All @@ -76,7 +87,6 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
NotificationCenter.default.addObserver(self, selector: #selector(self.handleSignIn), name: CurrentUserManager.NotificationName.signedIn, object: nil)
NotificationCenter.default.addObserver(self, selector: #selector(self.handleSignOut), name: CurrentUserManager.NotificationName.signedOut, object: nil)
NotificationCenter.default.addObserver(self, selector: #selector(self.openGoalFromNotification(_:)), name: GalleryViewController.NotificationName.openGoal, object: nil)
NotificationCenter.default.addObserver(self, selector: #selector(self.handleGoalsFetchedNotification), name: GoalManager.NotificationName.goalsUpdated, object: nil)

self.view.addSubview(stackView)
stackView.axis = .vertical
Expand Down Expand Up @@ -208,6 +218,9 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
logger.error("Error checking for current version: \(error)")
}
}

try? fetchedResultsController.performFetch()
Copy link
Copy Markdown
Collaborator

@theospears theospears Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Is it worth logging if this fails?


}

override func viewWillAppear(_ animated: Bool) {
Expand All @@ -219,8 +232,6 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
make.right.equalTo(self.view.safeAreaLayoutGuide.snp.rightMargin)
make.bottom.equalTo(self.collectionView!.keyboardLayoutGuide.snp.top)
}

applySnapshot()
}

override func viewDidAppear(_ animated: Bool) {
Expand All @@ -234,13 +245,6 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}
}

@objc func handleGoalsFetchedNotification() {
Task {
self.lastUpdated = await goalManager.goalsFetchedAt
self.updateGoals()
}
}

@objc func settingsButtonPressed() {
self.navigationController?.pushViewController(SettingsViewController(), animated: true)
}
Expand All @@ -253,7 +257,7 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
self.searchBar.isHidden.toggle()

if searchBar.isHidden {
self.searchBar.text = ""
self.searchBar.text = nil
self.searchBar.resignFirstResponder()
self.updateGoals()
} else {
Expand All @@ -271,9 +275,6 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}

@objc func handleSignOut() {
self.goals = []
self.filteredGoals = []
self.applySnapshot()
if self.presentedViewController != nil {
if type(of: self.presentedViewController!) == SignInViewController.self { return }
}
Expand Down Expand Up @@ -319,7 +320,7 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou

@objc func fetchGoals() {
Task { @MainActor in
if self.goals.count == 0 {
if self.filteredGoals.count == 0 {
MBProgressHUD.showAdded(to: self.view, animated: true)
}

Expand All @@ -334,70 +335,64 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}
self.collectionView?.refreshControl?.endRefreshing()
MBProgressHUD.hide(for: self.view, animated: true)
self.applySnapshot()
}
}
}

func updateGoals() {
let goals = goalManager.staleGoals(context: viewContext) ?? []
self.goals = sortedGoals(goals)
self.updateFilteredGoals()
self.didUpdateGoals()
}

func sortedGoals(_ goals: any Sequence<Goal>) -> [Goal] {
static private var preferredSort: [NSSortDescriptor] {
let selectedGoalSort = UserDefaults.standard.value(forKey: Constants.selectedGoalSortKey) as? String ?? Constants.urgencyGoalSortString

switch selectedGoalSort {
case Constants.nameGoalSortString:
return goals.sorted(using: [SortDescriptor(\.slug),
SortDescriptor(\.urgencyKey)])
return [
NSSortDescriptor(keyPath: \Goal.slug, ascending: true),
NSSortDescriptor(keyPath: \Goal.urgencyKey, ascending: true)
]
case Constants.recentDataGoalSortString:
return goals.sorted(using: [SortDescriptor(\.lastTouch, order: .reverse),
SortDescriptor(\.urgencyKey)])
return [
NSSortDescriptor(keyPath: \Goal.lastTouch, ascending: true),
NSSortDescriptor(keyPath: \Goal.urgencyKey, ascending: true)
]
case Constants.pledgeGoalSortString:
return goals.sorted(using: [SortDescriptor(\.pledge, order: .reverse),
SortDescriptor(\.urgencyKey)])
return [
NSSortDescriptor(keyPath: \Goal.pledge, ascending: true),
NSSortDescriptor(keyPath: \Goal.urgencyKey, ascending: true)
]
default:
return goals.sorted(using: SortDescriptor(\.urgencyKey))
return [
NSSortDescriptor(keyPath: \Goal.urgencyKey, ascending: true)
]
}
}

func updateFilteredGoals() {
let searchText = searchBar.text ?? ""

if searchText == "" {
self.filteredGoals = self.goals
if let searchText = searchBar.text, !searchText.isEmpty {
self.fetchedResultsController.fetchRequest.predicate = NSPredicate(format: "slug contains[cd] %@", searchText)
} else {
self.filteredGoals = self.goals.filter { (goal) -> Bool in
return goal.slug.lowercased().contains(searchText.lowercased())
}
self.fetchedResultsController.fetchRequest.predicate = nil
}

self.fetchedResultsController.fetchRequest.sortDescriptors = Self.preferredSort
try? self.fetchedResultsController.performFetch()
}

private func applySnapshot() {
var goalsToShow: [Goal] {
guard versionManager.lastChckedUpdateState() != .UpdateRequired else { return [] }
return filteredGoals
}

var snapshot = NSDiffableDataSourceSnapshot<Section, Goal>()
snapshot.appendSections([.main])
snapshot.appendItems(goalsToShow, toSection: .main)
snapshot.reconfigureItems(goalsToShow)
dataSource.apply(snapshot, animatingDifferences: true)
private var filteredGoals: [Goal] {
fetchedResultsController.fetchedObjects ?? []
}

@objc func didUpdateGoals() {
self.setupHealthKit()
self.collectionView?.refreshControl?.endRefreshing()
MBProgressHUD.hide(for: self.view, animated: true)
self.applySnapshot()
self.updateDeadbeatVisibility()
self.lastUpdated = Date()
self.updateLastUpdatedLabel()
if self.goals.count == 0 {
if self.filteredGoals.count == 0 {
self.noGoalsLabel.isHidden = false
self.collectionContainer.isHidden = true
} else {
Expand Down Expand Up @@ -433,12 +428,12 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}

func collectionView(_ collectionView: UICollectionView, layout collectionViewLayout: UICollectionViewLayout, referenceSizeForFooterInSection section: Int) -> CGSize {
return CGSize(width: 320, height: section == 0 && self.goals.count > 0 ? 5 : 0)
return CGSize(width: 320, height: section == 0 && self.filteredGoals.count > 0 ? 5 : 0)
}

func collectionView(_ collectionView: UICollectionView, didSelectItemAt indexPath: IndexPath) {
let row = (indexPath as NSIndexPath).row
if row < self.filteredGoals.count { self.openGoal(self.filteredGoals[row]) }
let goal = fetchedResultsController.object(at: indexPath)
self.openGoal(goal)
}

override func viewWillTransition(to size: CGSize, with coordinator: UIViewControllerTransitionCoordinator) {
Expand All @@ -458,7 +453,7 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}
}
else if let slug = notif.userInfo?["slug"] as? String {
matchingGoal = self.goals.filter({ (goal) -> Bool in
matchingGoal = self.filteredGoals.filter({ (goal) -> Bool in
return goal.slug == slug
}).last
}
Expand All @@ -482,18 +477,20 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
}

private func configureDataSource() {
let cellRegistration = UICollectionView.CellRegistration<GoalCollectionViewCell, Goal> { cell, indexPath, goal in
let cellRegistration = UICollectionView.CellRegistration<GoalCollectionViewCell, NSManagedObjectID> { [weak self] cell, indexPath, goalObjectId in
let goal = self?.fetchedResultsController.object(at: indexPath)
cell.configure(with: goal)
}

self.dataSource = .init(collectionView: collectionView!, cellProvider: { collectionView, indexPath, goal in
self.dataSource = .init(collectionView: collectionView!, cellProvider: { collectionView, indexPath, goalObjectId in
collectionView.dequeueConfiguredReusableCell(using: cellRegistration,
for: indexPath,
item: goal)
item: goalObjectId)
})
dataSource.supplementaryViewProvider = { collectionView, kind, indexPath in
collectionView.dequeueReusableSupplementaryView(ofKind: kind, withReuseIdentifier: "footer", for: indexPath)
}

self.collectionView?.dataSource = dataSource
}

Expand All @@ -503,4 +500,9 @@ class GalleryViewController: UIViewController, UICollectionViewDelegateFlowLayou
controller.dismiss(animated: true, completion: nil)
self.fetchGoals()
}

// MARK: - NSFetchedResultsControllerDelegate
func controller(_ controller: NSFetchedResultsController<any NSFetchRequestResult>, didChangeContentWith snapshot: NSDiffableDataSourceSnapshotReference) {
dataSource.apply(snapshot as GallerySnapshot, animatingDifferences: true)
}
}