Skip to content
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.

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

Extend for explicit results type #30

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
36 changes: 35 additions & 1 deletion PredicateKit/CoreData/NSManagedObjectContextExtensions.swift
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,24 @@ public struct FetchRequest<Entity: NSManagedObject> {
#endif
return try context.fetch(request)
}


// MARK: -

/// Executes the fetch request.
///
/// - Returns: An array of objects of type `Entity` matching the criteria specified by the fetch request.
///
/// ## Example
///
/// let notes: [Note] = try managedObjectContext
/// .fetch(where: (\Note.text).contains("Hello, World!"))
/// .sorted(by: \.creationDate, .descending)
/// .entityResult()
///
public func entityResult() throws -> [Entity] {
try result()
}

/// Executes the fetch request.
///
/// - Returns: An array of `[String: Any]` containing the keys or a subset of the keys of the objects of type `Entity`
Expand All @@ -356,6 +373,23 @@ public struct FetchRequest<Entity: NSManagedObject> {
return try context.fetch(request) as! [[String: Any]]
}

/// Executes the fetch request.
///
/// - Returns: An array of `[String: Any]` containing the keys or a subset of the keys of the objects of type `Entity`
/// matching the criteria specified by the fetch request.
///
/// ## Example
///
/// let dictionaries: [[String: Any]] = try managedObjectContext
/// .fetch(where: (\Note.text).contains("Hello, World!"))
/// .sorted(by: \.creationDate, .descending)
/// .fetchingOnly(\.text, \.creationDate)
/// .dictionaryResult()
///
public func dictionaryResult() throws -> [[String: Any]] {
try result()
}

/// Counts the number of objects matching the criteria specified by the fetch request.
///
/// - Returns: The number of objects matching the criteria specified by the fetch request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,26 @@ final class NSManagedObjectContextExtensionsTests: XCTestCase {
XCTAssertNil(texts.first?["numberOfViews"])
XCTAssertNil(texts.first?["creationDate"])
}

func testFetchDictionaryResultWithBasicComparison() throws {
try container.viewContext.insertNotes(
(text: "Hello, World!", creationDate: Date(), numberOfViews: 42, tags: ["greeting"]),
(text: "Goodbye!", creationDate: Date(), numberOfViews: 3, tags: ["greeting"])
)

let texts: [[String: Any]] = try container
.viewContext
.fetch(where: \Note.text == "Hello, World!")
.fetchingOnly(\Note.text)
.dictionaryResult()

XCTAssertEqual(texts.count, 1)
XCTAssertEqual(texts.first?.count, 1)
XCTAssertEqual(texts.first?["text"] as? String, "Hello, World!")
XCTAssertNil(texts.first?["tags"])
XCTAssertNil(texts.first?["numberOfViews"])
XCTAssertNil(texts.first?["creationDate"])
}

@available(iOS 13.0, watchOS 6.0, tvOS 13.0, *)
func testFetchWithObjectComparison() throws {
Expand Down Expand Up @@ -204,6 +224,21 @@ final class NSManagedObjectContextExtensionsTests: XCTestCase {
XCTAssertTrue(notes.contains(where: { $0.text == "Hello, World!" }))
XCTAssertTrue(notes.contains(where: { $0.text == "Goodbye!" }))
}

func testFetchAllEntityResults() throws {
try container.viewContext.insertNotes(
(text: "Hello, World!", creationDate: Date(), numberOfViews: 42, tags: ["greeting"]),
(text: "Goodbye!", creationDate: Date(), numberOfViews: 3, tags: ["greeting"])
)

let notes: [Note] = try container.viewContext
.fetchAll()
.entityResult()

XCTAssertEqual(notes.count, 2)
XCTAssertTrue(notes.contains(where: { $0.text == "Hello, World!" }))
XCTAssertTrue(notes.contains(where: { $0.text == "Goodbye!" }))
}

func testFetchWithStringComparison1() throws {
try container.viewContext.insertNotes(
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,14 +111,19 @@ dependencies: [

## Fetching objects

To fetch objects using PredicateKit, use the function `fetch(where:)` on an instance of `NSManagedObjectContext` passing as argument a predicate. `fetch(where:)` returns an object of type `FetchRequest` on which you call `result()` to execute the request and retrieve the matching objects.
To fetch objects using PredicateKit, use the function `fetch(where:)` on an instance of `NSManagedObjectContext` passing as argument a predicate. `fetch(where:)` returns an object of type `FetchRequest` on which you call `result()` (or `entityResult()` to allow function chaining) to execute the request and retrieve the matching objects.

###### Example

```swift
let notes: [Note] = try managedObjectContext
.fetch(where: \Note.text == "Hello, World!" && \Note.creationDate < Date())
.result()

let notes = try managedObjectContext
.fetch(where: \Note.text == "Hello, World!" && \Note.creationDate < Date())
.entityResult()
.first
```

You write your predicates using the [key-paths](https://developer.apple.com/documentation/swift/keypath) of the entity to filter and a combination of comparison and logical operators, literal values, and functions calls.
Expand All @@ -127,15 +132,19 @@ See [Writing predicates](#writing-predicates) for more about writing predicates.

### Fetching objects as dictionaries

By default, `fetch(where:)` returns an array of subclasses of `NSManagedObject`. You can specify that the objects be returned as an array of dictionaries (`[[String: Any]]`)
simply by changing the type of the variable storing the result of the fetch.
By default, `fetch(where:)` returns an array of subclasses of `NSManagedObject`. You can specify that the objects be returned as an array of dictionaries `[[String: Any]]`
simply by changing the type of the variable storing the result of the fetch or specifically calling `dictionaryResult()`.

###### Example

```swift
let notes: [[String: Any]] = try managedObjectContext
.fetch(where: \Note.text == "Hello, World!" && \Note.creationDate < Date())
.result()

let notes = try managedObjectContext
.fetch(where: \Note.text == "Hello, World!" && \Note.creationDate < Date())
.dictionaryResult()
```

## Configuring the fetch
Expand Down