IGListKit/Examples/Examples-macOS/IGListKitExamples/ViewControllers/UsersViewController.swift
Robert Payne 40625f8ff9 Swift name annotations
Summary:
This adds `NS_SWIFT_NAME` annotations to all public API's to provide cleaner integration into Swift:

- Removes the need to prefix classes in Swift code, instead rely on Swift module name spacing
- Adds more argument labels to C function API's like `IGListDiff([], [], .equality)` => `ListDiff(oldArray: [], newArray: [], option: .equality)`

While this is a large API change it should be as easy as:

- Find and replace `(IGList)([^K])` to `List$2` in Xcode with a scope set to Swift
- Build and follow compiler's auto fix corrections for C API's or any missed renames

I have not updated the documentation to reflect this yet, I am totally willing to do so but before I sink that amount of time into it I wanted to see if the Instagram team is even open to this change!

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
- [ ] I have updated the documentation
Closes https://github.com/Instagram/IGListKit/pull/593

Reviewed By: jessesquires

Differential Revision: D5028039

Pulled By: rnystrom

fbshipit-source-id: b473d874a1f9574e56b2ebaabd5b73d1b57d4bab
2017-05-09 14:31:28 -07:00

150 lines
4.5 KiB
Swift

/**
Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
The examples provided by Facebook are for non-commercial testing and evaluation
purposes only. Facebook reserves all rights not expressly granted.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
FACEBOOK BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import Cocoa
import IGListKit
final class UsersViewController: NSViewController {
@IBOutlet weak var tableView: NSTableView!
//MARK: Data
var users = [User]() {
didSet {
computeFilteredUsers()
}
}
var searchTerm = "" {
didSet {
computeFilteredUsers()
}
}
private func computeFilteredUsers() {
guard !searchTerm.characters.isEmpty else {
filteredUsers = users
return
}
filteredUsers = users.filter({ $0.name.localizedCaseInsensitiveContains(self.searchTerm) })
}
fileprivate func delete(user: User) {
guard let index = self.users.index(where: { $0.pk == user.pk }) else { return }
self.users.remove(at: index)
}
//MARK: -
//MARK: Diffing
var filteredUsers = [User]() {
didSet {
// get the difference between the old array of Users and the new array of Users
let diff = ListDiff(oldArray: oldValue, newArray: filteredUsers, option: .equality)
// this difference is used here to update the table view, but it can be used
// to update collection views and other similar interface elements
// this code can also be added to an extension of NSTableView ;)
tableView.beginUpdates()
tableView.insertRows(at: diff.inserts, withAnimation: .slideDown)
tableView.removeRows(at: diff.deletes, withAnimation: .slideUp)
tableView.reloadData(forRowIndexes: diff.updates, columnIndexes: .zero)
diff.moves.forEach { move in
self.tableView.moveRow(at: move.from, to: move.to)
}
tableView.endUpdates()
}
}
//MARK: -
private func loadSampleUsers() {
guard let file = Bundle.main.url(forResource: "users", withExtension: "json") else { return }
do {
self.users = try UsersProvider(with: file).users
} catch {
NSAlert(error: error).runModal()
}
}
// MARK: Interface
override func viewDidLoad() {
super.viewDidLoad()
loadSampleUsers()
}
override func viewDidAppear() {
super.viewDidAppear()
view.window?.titleVisibility = .hidden
}
@IBAction func shuffle(_ sender: Any?) {
users = users.shuffled
}
@IBAction func search(_ sender: NSSearchField) {
searchTerm = sender.stringValue
}
@IBAction func delete(_ sender: Any?) {
guard tableView.selectedRowIndexes.count > 0 else { return }
tableView.selectedRowIndexes.forEach({ self.delete(user: self.filteredUsers[$0]) })
}
}
extension UsersViewController: NSTableViewDataSource {
func numberOfRows(in tableView: NSTableView) -> Int {
return filteredUsers.count
}
}
extension UsersViewController: NSTableViewDelegate {
private struct Storyboard {
static let cellIdentifier = "cell"
}
func tableView(_ tableView: NSTableView, viewFor tableColumn: NSTableColumn?, row: Int) -> NSView? {
guard let cell = tableView.make(withIdentifier: Storyboard.cellIdentifier, owner: tableView) as? NSTableCellView else {
return nil
}
cell.textField?.stringValue = filteredUsers[row].name
return cell
}
@available(OSX 10.11, *)
func tableView(_ tableView: NSTableView, rowActionsForRow row: Int, edge: NSTableRowActionEdge) -> [NSTableViewRowAction] {
let delete = NSTableViewRowAction(style: .destructive, title: "Delete") { action, row in
guard row < self.filteredUsers.count else { return }
self.delete(user: self.filteredUsers[row])
}
return [delete]
}
}