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

allow "IN" Expression to have a list or a set as a parameter #11

Merged
merged 6 commits into from
Mar 23, 2022
Merged
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
8 changes: 8 additions & 0 deletions PredicateKit/Predicate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,14 @@ extension Expression where Value: Primitive {
public func `in`(_ list: Value...) -> Predicate<Root> {
.comparison(.init(self, .in, list))
}

public func `in`(_ list: [Value]) -> Predicate<Root> {
.comparison(.init(self, .in, list))
}

public func `in`(_ set: Set<Value>) -> Predicate<Root> where Value: Hashable {
.comparison(.init(self, .in, Array(set)))
}
}

extension Expression where Value: StringValue & Primitive {
Expand Down
43 changes: 43 additions & 0 deletions PredicateKitTests/OperatorTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1335,6 +1335,49 @@ final class OperatorTests: XCTestCase {
XCTAssertEqual(comparison.operator, .in)
XCTAssertEqual(value, ["hello", "world", "welcome"])
}

func testKeyPathInArray() throws {
let predicate: Predicate<Data> = (\Data.count).in([21, 42, 63])

guard case let .comparison(comparison) = predicate else {
XCTFail("count.in([21, 42, 63]) should result in a comparison")
return
}

guard let keyPath = comparison.expression.as(KeyPath<Data, Int>.self) else {
XCTFail("the left side of the comparison should be a key path expression")
return
}

let value = try XCTUnwrap(comparison.value as? [Int])

XCTAssertEqual(keyPath, \Data.count)
XCTAssertEqual(comparison.operator, .in)
XCTAssertEqual(value, [21, 42, 63])
}

func testKeyPathInSet() throws {
let predicate: Predicate<Data> = (\Data.count).in(Set([21, 42, 63]))

guard case let .comparison(comparison) = predicate else {
XCTFail("count.in(Set([21, 42, 63])) should result in a comparison")
return
}

guard let keyPath = comparison.expression.as(KeyPath<Data, Int>.self) else {
XCTFail("the left side of the comparison should be a key path expression")
return
}

let value = try XCTUnwrap(comparison.value as? [Int])

XCTAssertEqual(keyPath, \Data.count)
XCTAssertEqual(comparison.operator, .in)
XCTAssertTrue(value.contains(21), "searched item '\(21)' is missing in comparison.value")
XCTAssertTrue(value.contains(42), "searched item '\(42)' is missing in comparison.value")
XCTAssertTrue(value.contains(63), "searched item '\(63)' is missing in comparison.value")
XCTAssertEqual(value.count, 3, "IN expression had \(3) items, found \(value.count)")
}

func testKeyPathInCaseInsensitive() throws {
let predicate: Predicate<Data> = (\Data.text).in(["hello", "world", "welcome"], .caseInsensitive)
Expand Down
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,15 +341,21 @@ let predicate = \Note.numberOfViews ~= 100...200

###### in

You can use the `in` function to determine whether a property's value is one of the values in a specified list.
You can use the `in` function to determine whether a property's value is one of the values in a variadic arguments (comma-separated list), an array, or a set.


```swift
// Matches all notes where the text is one of the elements in the specified list.
// Matches all notes where the text is one of the elements in the specified variadic arguments list.
let predicate = (\Note.text).in("a", "b", "c", "d")

// Matches all notes where the text is one of the elements in the specified array.
let predicate = (\Note.text).in(["a", "b", "c", "d"])

// Matches all notes where the text is one of the elements in the specified set.
let predicate = (\Note.text).in(Set(["a", "b", "c", "d"]))
```

When the property is of type `String`, `in` accepts a second parameter that determines how the string should be compared to the elements in the list.
When the property type is a `String`, `in` accepts a second parameter that determines how the string should be compared to the elements in the list.

```swift
// Case-insensitive comparison.
Expand Down