noahkamara/compoundpredicate

## For Developers targeting macOS 14.4 / iOS 17.4 or later:

For Developers targeting macOS 14.4 / iOS 17.4 or later:

This PR For Swift Foundation adds compound functionality to Predicates like so: If you are targeting only those versions and above you should use this instead:

let notTooShort = #Predicate<Book> { $0.pages > 50 }
let notTooLong = #Predicate<Book> { $0.pages <= 350 }
let titleFilter = #Predicate<Book> { $0.title.contains("Swift") }

let filter = #Predicate<Book> {
    (notTooShort.evaluate($0) && notTooLong.evaluate($0)) || titleFilter.evaluate($0)
}

CompoundPredicate aims to improve the Predicate system to enable combining multiple predicates after constructing them:

let notTooShort = #Predicate<Book> {
    $0.pages > 50
}

let notTooLong = #Predicate<Book> {
    $0.pages <= 350
}

let lengthFilter = [notTooShort, notTooShort].conjunction()

// Match Books that are just the right length
let titleFilter = #Predicate<Book> {
    $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 and as Docc archive you can view using Xcode

Feedback

Please feel free to create an Issue, or even better contribute actively by creating a pull request

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..<z).contains(y) PredicateExpressions.RangeExpressionContains

[x] Comparison (<, <=, >, >=, ==, !=)

- [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

Package Metadata

Repository: noahkamara/compoundpredicate

Default branch: main

README: README.md