Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noahkamara/compoundpredicate
A library for combining swift predicates
https://github.com/noahkamara/compoundpredicate
swift swiftdata
Last synced: about 1 month ago
JSON representation
A library for combining swift predicates
- Host: GitHub
- URL: https://github.com/noahkamara/compoundpredicate
- Owner: NoahKamara
- License: mit
- Created: 2024-03-06T23:00:18.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-23T13:03:16.000Z (8 months ago)
- Last Synced: 2024-04-23T15:02:21.640Z (7 months ago)
- Topics: swift, swiftdata
- Language: Swift
- Homepage: https://noahkamara.github.io/CompoundPredicate/documentation/compoundpredicate/
- Size: 607 KB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/NoahKamara/CompoundPredicate/actions/workflows/build-and-test.yml)
## For Developers targeting macOS 14.4 / iOS 17.4 or later:
This [PR](https://github.com/apple/swift-foundation/pull/343) For Swift Foundation adds compound functionality to Predicates like so:
If you are targeting only those versions and above you should use this instead:
```swift
let notTooShort = #Predicate { $0.pages > 50 }
let notTooLong = #Predicate { $0.pages <= 350 }
let titleFilter = #Predicate { $0.title.contains("Swift") }
let filter = #Predicate {
(notTooShort.evaluate($0) && notTooLong.evaluate($0)) || titleFilter.evaluate($0)
}
```
# CompoundPredicate
CompoundPredicate aims to improve the Predicate system to enable combining multiple predicates after constructing them:
```swift
let notTooShort = #Predicate {
$0.pages > 50
}
let notTooLong = #Predicate {
$0.pages <= 350
}
let lengthFilter = [notTooShort, notTooShort].conjunction()
// Match Books that are just the right length
let titleFilter = #Predicate {
$0.title.contains("Swift")
}
// Match Books that contain "Swift" in the title or
// are just the right length
let filter = [lengthFilter, titleFilter].disjunction()
```
## Documentation
The documentation is available [here](https://noahkamara.github.io/CompoundPredicate/documentation/compoundpredicate/) and as Docc archive you can view using Xcode
## Feedback
Please feel free to create an [Issue](https://github.com/NoahKamara/CompoundPredicate/issues), or even better contribute actively by creating a [pull request](https://github.com/NoahKamara/CompoundPredicate/pulls)
## Implementation Progress
- [x] Arithmetic (+, -, *, /, %)
- [x] `+`, `-`, `*` `PredicateExpressions.Arithmetic`
- [x] `/` `PredicateExpressions.FloatDivision`
- [x] `/` `PredicateExpressions.IntDivision`
- [x] `%` `PredicateExpressions.IntRemainder`
- [x] Unary minus `-` `PredicateExpressions.UnaryMinus`
- [x] Range (..., ..<)
- [x] `...` `PredicateExpressions.ClosedRange`
- [x] `..<` `PredicateExpressions.Range`
- [x] `x.., >=, ==, !=)
- [x] `<`, `<=`, `>`, `>=` `PredicateExpressions.Comparison`
- [x] `==` `PredicateExpressions.Equal`
- [x] `!=` `PredicateExpressions.NotEqual`
- [x] Conditionals & Ternary (?:) `PredicateExpressions.Conditional`
- [x] Boolean logic (&&, ||, !)
- [x] `&&` `PredicateExpressions.Conjunction`
- [x] `||` `PredicateExpressions.Disjunction`
- [x] `!` `PredicateExpressions.Negation`
- [x] Swift optionals (?, ??, !, flatMap(_:), if-let expressions)
- [x] `?`, `flatMap(_:)` `PredicateExpressions.OptionalFlatMap`
- [x] `??`, `if-let` `PredicateExpressions.NilCoalesce`
- [x] Types (as, as?, as!, is)
- [x] `as?` `PredicateExpressions.ConditionalCast`
- [x] `as`, `as!` `PredicateExpressions.ForceCast`
- [x] Sequence operations (allSatisfy(), filter(), contains(), contains(where:), starts(with:), max(), min())
- [x] `allSatisfy()` `PredicateExpressions.SequenceAllSatisfy`
- [x] `filter()` `PredicateExpressions.Filter` [completion:: 2024-03-10]
- [x] `contains()` `PredicateExpressions.SequenceContains` [completion:: 2024-03-10]
- [x] `contains(where:)` `PredicateExpressions.SequenceContainsWhere`
- [x] `starts(with:)` `PredicateExpressions.SequenceStartsWith`
- [x] `min()` `PredicateExpressions.SequenceMinimum` [completion:: 2024-03-10]
- [x] `max()` `PredicateExpressions.SequenceMaximum`
- [x] Subscript and member access ([], .)
- [x] `[0,1][0]` `PredicateExpressions.CollectionIndexSubscript`
- [x] `["a": "b"]["a"]` `PredicateExpressions.DictionaryKeySubscript`
- [x] `["a": "b"]["a", defaultValue: "b"]` `PredicateExpressions.DictionaryKeyDefaultValueSubscript`
- [x] `obj.someKey` `PredicateExpressions.KeyPath`
- [x] String comparisons
- [x] `contains(_:)` `PredicateExpressions.CollectionContainsCollection`
- [x] `localizedStandardContains(_:)` `PredicateExpressions.StringLocalizedStandardContains`
- [x] `caseInsensitiveCompare(_:)` `PredicateExpressions.StringCaseInsensitiveCompare`
- [x] `localizedCompare(_:)` `PredicateExpressions.StringLocalizedCompare`