Merge pull request #586 from iv-mexx/feature/propertyFilter

Add Property.filter

CHANGELOG.md

@@ -1,6 +1,7 @@
 # master
 *Please add new entries at the top.*
 
+1. New property operator: `filter` (#586, kudos to @iv-mexx)
 1. New operator `merge(with:)` (#600, kudos to @ra1028)
 1. New operator `map(value:)` (#601, kudos to @ra1028)
 

Sources/Property.swift

@@ -123,6 +123,20 @@ extension PropertyProtocol {
 		return lift { $0.map(keyPath) }
 	}
 
+	/// Passes only the values of the property that pass the given predicate
+	/// to a new property.
+	///
+	/// - parameters:
+	///   - initial: A `Property` always needs a `value`. The initial `value` is necessary in case the
+	///              predicate excludes the first (or all) `value`s of this `Property`
+	///   - predicate: A closure that accepts value and returns `Bool` denoting
+	///                whether current `value` of this `Property`  has passed the test.
+	///
+	/// - returns: A property that holds only values from `self` passing the given predicate.
+	public func filter(initial: Value, _ predicate: @escaping (Value) -> Bool) -> Property<Value> {
+		return Property(initial: initial, then: self.producer.filter(predicate))
+	}
+
 	/// Combines the current value and the subsequent values of two `Property`s in
 	/// the manner described by `Signal.combineLatest(with:)`.
 	///

Tests/ReactiveSwiftTests/PropertySpec.swift

@@ -758,6 +758,43 @@ class PropertySpec: QuickSpec {
 				}
 			}
 
+			describe("filter") {
+				it("should only receive values that pass the predicate")  {
+					let property = MutableProperty(1)
+					let filteredProperty = property
+						.filter(initial: 0) { $0 > 0 }
+					expect(filteredProperty.value) == 1
+
+					property.value = 0
+					expect(filteredProperty.value) == 1
+
+					property.value = 2
+					expect(filteredProperty.value) == 2
+
+					property.value = -5
+					expect(filteredProperty.value) == 2
+
+					property.value = 3
+					expect(filteredProperty.value) == 3
+				}
+
+				it("should behave correctly if the filter excludes the initial value")  {
+					let property = MutableProperty(1)
+					let filteredProperty = property
+						.filter(initial: 0) { $0 < 0 }
+					expect(filteredProperty.value) == 0
+
+					property.value = 2
+					expect(filteredProperty.value) == 0
+
+					property.value = -2
+					expect(filteredProperty.value) == -2
+
+					property.value = 0
+					expect(filteredProperty.value) == -2
+				}
+			}
+
 			describe("combineLatest") {
 				var property: MutableProperty<String>!
 				var otherProperty: MutableProperty<String>!