@swiftbrowser/swift 0.0.0-stage → 0.2.0

package/Sources/Combine/Publishers/Publishers.CompactMap.swift

@@ -0,0 +1,241 @@
+//
+//  Publishers.CompactMap.swift
+//  
+//
+//  Created by Sergej Jaskiewicz on 11.07.2019.
+//
+
+extension Publisher {
+
+    /// Calls a closure with each received element and publishes any returned optional
+    /// that has a value.
+    ///
+    /// OpenCombine’s `compactMap(_:)` operator performs a function similar to that of
+    /// `compactMap(_:)` in the Swift standard library: the `compactMap(_:)` operator in
+    /// OpenCombine removes `nil` elements in a publisher’s stream and republishes
+    /// non-`nil` elements to the downstream subscriber.
+    ///
+    /// The example below uses a range of numbers as the source for a collection based
+    /// publisher. The `compactMap(_:)` operator consumes each element from the `numbers`
+    /// publisher attempting to access the dictionary using the element as the key.
+    /// If the example’s dictionary returns a `nil`, due to a non-existent key,
+    /// `compactMap(_:)` filters out the `nil` (missing) elements.
+    ///
+    ///     let numbers = (0...5)
+    ///     let romanNumeralDict: [Int : String] =
+    ///         [1: "I", 2: "II", 3: "III", 5: "V"]
+    ///
+    ///     cancellable = numbers.publisher
+    ///         .compactMap { romanNumeralDict[$0] }
+    ///         .sink { print("\($0)", terminator: " ") }
+    ///
+    ///     // Prints: "I II III V"
+    ///
+    /// - Parameter transform: A closure that receives a value and returns an optional
+    ///   value.
+    /// - Returns: Any non-`nil` optional results of the calling the supplied closure.
+    public func compactMap<ElementOfResult>(
+        _ transform: @escaping (Output) -> ElementOfResult?
+    ) -> Publishers.CompactMap<Self, ElementOfResult> {
+        return .init(upstream: self, transform: transform)
+    }
+
+    /// Calls an error-throwing closure with each received element and publishes any
+    /// returned optional that has a value.
+    ///
+    /// Use `tryCompactMap(_:)` to remove `nil` elements from a publisher’s stream based
+    /// on an error-throwing closure you provide. If the closure throws an error,
+    /// the publisher cancels the upstream publisher and sends the thrown error to
+    /// the downstream subscriber as a `Publisher.Failure`.
+    ///
+    /// The following example uses an array of numbers as the source for
+    /// a collection-based publisher. A `tryCompactMap(_:)` operator consumes each integer
+    /// from the publisher and uses a dictionary to transform the numbers from its Arabic
+    /// to Roman numerals, as an optional `String`.
+    ///
+    /// If the closure called by `tryCompactMap(_:)` fails to look up a Roman numeral,
+    /// it returns the optional String `(unknown)`.
+    ///
+    /// If the closure called by `tryCompactMap(_:)` determines the input is `0`, it
+    /// throws an error. The `tryCompactMap(_:)` operator catches this error and stops
+    /// publishing, sending a `Subscribers.Completion.failure(_:)` that wraps the error.
+    ///
+    ///     struct ParseError: Error {}
+    ///     func romanNumeral(from: Int) throws -> String? {
+    ///         let romanNumeralDict: [Int : String] =
+    ///             [1: "I", 2: "II", 3: "III", 4: "IV", 5: "V"]
+    ///         guard from != 0 else { throw ParseError() }
+    ///         return romanNumeralDict[from]
+    ///     }
+    ///     let numbers = [6, 5, 4, 3, 2, 1, 0]
+    ///     cancellable = numbers.publisher
+    ///         .tryCompactMap { try romanNumeral(from: $0) }
+    ///         .sink(
+    ///               receiveCompletion: { print ("\($0)") },
+    ///               receiveValue: { print ("\($0)", terminator: " ") }
+    ///          )
+    ///
+    ///     // Prints: "(Unknown) V IV III II I failure(ParseError())"
+    ///
+    /// - Parameter transform: An error-throwing closure that receives a value and returns
+    ///   an optional value.
+    /// - Returns: Any non-`nil` optional results of calling the supplied closure.
+    public func tryCompactMap<ElementOfResult>(
+        _ transform: @escaping (Output) throws -> ElementOfResult?
+    ) -> Publishers.TryCompactMap<Self, ElementOfResult> {
+        return .init(upstream: self, transform: transform)
+    }
+}
+
+extension Publishers.CompactMap {
+
+    public func compactMap<ElementOfResult>(
+        _ transform: @escaping (Output) -> ElementOfResult?
+    ) -> Publishers.CompactMap<Upstream, ElementOfResult> {
+        return .init(upstream: upstream,
+                     transform: { self.transform($0).flatMap(transform) })
+    }
+
+    public func map<ElementOfResult>(
+        _ transform: @escaping (Output) -> ElementOfResult
+    ) -> Publishers.CompactMap<Upstream, ElementOfResult> {
+        return .init(upstream: upstream,
+                     transform: { self.transform($0).map(transform) })
+    }
+}
+
+extension Publishers.TryCompactMap {
+
+    public func compactMap<ElementOfResult>(
+        _ transform: @escaping (Output) throws -> ElementOfResult?
+    ) -> Publishers.TryCompactMap<Upstream, ElementOfResult> {
+        return .init(upstream: upstream,
+                     transform: { try self.transform($0).flatMap(transform) })
+    }
+}
+
+extension Publishers {
+
+    /// A publisher that republishes all non-`nil` results of calling a closure
+    /// with each received element.
+    public struct CompactMap<Upstream: Publisher, Output>: Publisher {
+
+        public typealias Failure = Upstream.Failure
+
+        /// The publisher from which this publisher receives elements.
+        public let upstream: Upstream
+
+        /// A closure that receives values from the upstream publisher
+        /// and returns optional values.
+        public let transform: (Upstream.Output) -> Output?
+
+        public init(upstream: Upstream,
+                    transform: @escaping (Upstream.Output) -> Output?) {
+            self.upstream = upstream
+            self.transform = transform
+        }
+
+        public func receive<Downstream: Subscriber>(subscriber: Downstream)
+            where Downstream.Input == Output, Downstream.Failure == Failure
+        {
+            upstream.subscribe(Inner(downstream: subscriber, filter: transform))
+        }
+    }
+
+    /// A publisher that republishes all non-`nil` results of calling an error-throwing
+    /// closure with each received element.
+    public struct TryCompactMap<Upstream: Publisher, Output>: Publisher {
+
+        public typealias Failure = Error
+
+        /// The publisher from which this publisher receives elements.
+        public let upstream: Upstream
+
+        /// An error-throwing closure that receives values from the upstream publisher
+        /// and returns optional values.
+        ///
+        /// If this closure throws an error, the publisher fails.
+        public let transform: (Upstream.Output) throws -> Output?
+
+        public init(upstream: Upstream,
+                    transform: @escaping (Upstream.Output) throws -> Output?) {
+            self.upstream = upstream
+            self.transform = transform
+        }
+
+        public func receive<Downstream: Subscriber>(subscriber: Downstream)
+            where Downstream.Input == Output, Downstream.Failure == Failure
+        {
+            upstream.subscribe(Inner(downstream: subscriber, filter: transform))
+        }
+    }
+}
+
+extension Publishers.CompactMap {
+    private struct Inner<Downstream: Subscriber>
+        : Subscriber,
+          CustomStringConvertible,
+          CustomReflectable,
+          CustomPlaygroundDisplayConvertible
+        where Upstream.Failure == Downstream.Failure
+    {
+        typealias Input = Upstream.Output
+        typealias Failure = Upstream.Failure
+
+        private let downstream: Downstream
+        private let filter: (Input) -> Downstream.Input?
+
+        let combineIdentifier = CombineIdentifier()
+
+        init(downstream: Downstream, filter: @escaping (Input) -> Downstream.Input?) {
+            self.downstream = downstream
+            self.filter = filter
+        }
+
+        func receive(subscription: Subscription) {
+            downstream.receive(subscription: subscription)
+        }
+
+        func receive(_ input: Input) -> Subscribers.Demand {
+            if let output = filter(input) {
+                return downstream.receive(output)
+            }
+            return .max(1)
+        }
+
+        func receive(completion: Subscribers.Completion<Failure>) {
+            downstream.receive(completion: completion)
+        }
+
+        var description: String { return "CompactMap" }
+
+        var customMirror: Mirror {
+            return Mirror(self, children: EmptyCollection())
+        }
+
+        var playgroundDescription: Any { return description }
+    }
+}
+
+extension Publishers.TryCompactMap {
+    private final class Inner<Downstream: Subscriber>
+        : FilterProducer<Downstream,
+                         Upstream.Output,
+                         Output,
+                         Upstream.Failure,
+                         (Upstream.Output) throws -> Output?>
+        where Downstream.Failure == Error, Downstream.Input == Output
+    {
+        override func receive(
+            newValue: Upstream.Output
+        ) -> PartialCompletion<Output?, Error> {
+            do {
+                return try .continue(filter(newValue))
+            } catch {
+                return .failure(error)
+            }
+        }
+
+        override var description: String { return "TryCompactMap" }
+    }
+}

package/Sources/Combine/Publishers/Publishers.Comparison.swift

@@ -0,0 +1,371 @@
+//
+//  Publishers.Comparison.swift
+//  OpenCombine
+//
+//  Created by Ilija Puaca on 22/7/19.
+//
+
+extension Publisher where Output: Comparable {
+
+    /// Publishes the minimum value received from the upstream publisher, after it
+    /// finishes.
+    ///
+    /// Use `min()` to find the minimum value in a stream of elements from
+    /// an upstream publisher.
+    ///
+    /// In the example below, the `min()` operator emits a value when the publisher
+    /// finishes, that value is the minimum of the values received from upstream, which
+    /// is `-1`.
+    ///
+    ///     let numbers = [-1, 0, 10, 5]
+    ///     numbers.publisher
+    ///         .min()
+    ///         .sink { print("\($0)") }
+    ///
+    ///     // Prints: "-1"
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Returns: A publisher that publishes the minimum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func min() -> Publishers.Comparison<Self> {
+        return max(by: >)
+    }
+
+    /// Publishes the maximum value received from the upstream publisher, after it
+    /// finishes.
+    ///
+    /// Use `max()` to determine the maximum value in the stream of elements from
+    /// an upstream publisher.
+    ///
+    /// In the example below, the `max()` operator emits a value when the publisher
+    /// finishes, that value is the maximum of the values received from upstream, which
+    /// is `10`.
+    ///
+    ///     let numbers = [0, 10, 5]
+    ///     cancellable = numbers.publisher
+    ///         .max()
+    ///         .sink { print("\($0)") }
+    ///
+    ///     // Prints: "10"
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Returns: A publisher that publishes the maximum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func max() -> Publishers.Comparison<Self> {
+        return max(by: <)
+    }
+}
+
+extension Publisher {
+
+    /// Publishes the minimum value received from the upstream publisher, after it
+    /// finishes.
+    ///
+    /// Use `min(by:)` to determine the minimum value in the stream of elements from
+    /// an upstream publisher using a comparison operation you specify.
+    ///
+    /// This operator is useful when the value received from the upstream publisher isn’t
+    /// `Comparable`.
+    ///
+    /// In the example below an array publishes enumeration elements representing playing
+    /// card ranks. The `min(by:)` operator compares the current and next elements using
+    /// the `rawValue` property of each enumeration value in the user supplied closure and
+    /// prints the minimum value found after publishing all of the elements.
+    ///
+    ///     enum Rank: Int {
+    ///         case ace = 1, two, three, four, five, six, seven, eight, nine,
+    ///         ten, jack, queen, king
+    ///     }
+    ///
+    ///     let cards: [Rank] = [.five, .queen, .ace, .eight, .king]
+    ///     cancellable = cards.publisher
+    ///         .min {
+    ///             return  $0.rawValue < $1.rawValue
+    ///         }
+    ///         .sink { print("\($0)") }
+    ///
+    ///     // Prints: "ace"
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Parameter areInIncreasingOrder: A closure that receives two elements and returns
+    ///   `true` if they’re in increasing order.
+    /// - Returns: A publisher that publishes the minimum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func min(
+        by areInIncreasingOrder: @escaping (Output, Output) -> Bool
+    ) -> Publishers.Comparison<Self> {
+        return max(by: { areInIncreasingOrder($1, $0) })
+    }
+
+    /// Publishes the minimum value received from the upstream publisher, using
+    /// the provided error-throwing closure to order the items.
+    ///
+    /// Use `tryMin(by:)` to determine the minimum value of elements received from
+    /// the upstream publisher using an error-throwing closure you specify.
+    ///
+    /// In the example below, an array publishes elements. The `tryMin(by:)` operator
+    /// executes the error-throwing closure that throws when the `first` element is an odd
+    /// number, terminating the publisher.
+    ///
+    ///     struct IllegalValueError: Error {}
+    ///
+    ///     let numbers: [Int]  = [0, 10, 6, 13, 22, 22]
+    ///     numbers.publisher
+    ///         .tryMin { first, second -> Bool in
+    ///             if (first % 2 != 0) {
+    ///                 throw IllegalValueError()
+    ///             }
+    ///             return first < second
+    ///         }
+    ///         .sink(
+    ///             receiveCompletion: { print ("completion: \($0)") },
+    ///             receiveValue: { print ("value: \($0)") }
+    ///         )
+    ///
+    ///     // Prints: "completion: failure(IllegalValueError())"
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Parameter areInIncreasingOrder: A throwing closure that receives two elements
+    ///   and returns `true` if they’re in increasing order. If this closure throws,
+    ///   the publisher terminates with a `Subscribers.Completion.failure(_:)`.
+    /// - Returns: A publisher that publishes the minimum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func tryMin(
+        by areInIncreasingOrder: @escaping (Output, Output) throws -> Bool
+    ) -> Publishers.TryComparison<Self> {
+        return tryMax(by: { try areInIncreasingOrder($1, $0) })
+    }
+
+    /// Publishes the maximum value received from the upstream publisher, using
+    /// the provided ordering closure.
+    ///
+    /// Use `max(by:)` to determine the maximum value of elements received from
+    /// the upstream publisher based on an ordering closure you specify.
+    ///
+    /// In the example below, an array publishes enumeration elements representing playing
+    /// card ranks. The `max(by:)` operator compares the current and next elements using
+    /// the `rawValue` property of each enumeration value in the user supplied closure and
+    /// prints the maximum value found after publishing all of the elements.
+    ///
+    ///     enum Rank: Int {
+    ///         case ace = 1, two, three, four, five, six, seven, eight, nine,
+    ///         ten, jack, queen, king
+    ///     }
+    ///
+    ///     let cards: [Rank] = [.five, .queen, .ace, .eight, .jack]
+    ///     cancellable = cards.publisher
+    ///         .max {
+    ///             return  $0.rawValue > $1.rawValue
+    ///         }
+    ///         .sink { print("\($0)") }
+    ///
+    ///     // Prints: "queen"
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Parameter areInIncreasingOrder: A closure that receives two elements and returns
+    ///   `true` if they’re in increasing order.
+    /// - Returns: A publisher that publishes the maximum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func max(
+        by areInIncreasingOrder: @escaping (Output, Output) -> Bool
+    ) -> Publishers.Comparison<Self> {
+        return .init(upstream: self, areInIncreasingOrder: areInIncreasingOrder)
+    }
+
+    /// Publishes the maximum value received from the upstream publisher, using
+    /// the provided error-throwing closure to order the items.
+    ///
+    /// Use `tryMax(by:)` to determine the maximum value of elements received from
+    /// the upstream publisher using an error-throwing closure you specify.
+    ///
+    /// In the example below, an array publishes elements. The `tryMax(by:)` operator
+    /// executes the error-throwing closure that throws when the `first` element is
+    /// an odd number, terminating the publisher.
+    ///
+    ///     struct IllegalValueError: Error {}
+    ///
+    ///     let numbers: [Int]  = [0, 10, 6, 13, 22, 22]
+    ///     cancellable = numbers.publisher
+    ///         .tryMax { first, second -> Bool in
+    ///             if (first % 2 != 0) {
+    ///                 throw IllegalValueError()
+    ///             }
+    ///             return first > second
+    ///         }
+    ///         .sink(
+    ///             receiveCompletion: { print ("completion: \($0)") },
+    ///             receiveValue: { print ("value: \($0)") }
+    ///         )
+    ///
+    ///     // Prints: completion: failure(IllegalValueError())
+    ///
+    /// After this publisher receives a request for more than 0 items, it requests
+    /// unlimited items from its upstream publisher.
+    ///
+    /// - Parameter areInIncreasingOrder: A throwing closure that receives two elements
+    ///   and returns `true` if they’re in increasing order. If this closure throws,
+    ///   the publisher terminates with a ``Subscribers/Completion/failure(_:)``.
+    ///
+    /// - Returns: A publisher that publishes the maximum value received from the upstream
+    ///   publisher, after the upstream publisher finishes.
+    public func tryMax(
+        by areInIncreasingOrder:  @escaping (Output, Output) throws -> Bool
+    ) -> Publishers.TryComparison<Self> {
+        return .init(upstream: self, areInIncreasingOrder: areInIncreasingOrder)
+    }
+}
+
+extension Publishers {
+
+    /// A publisher that republishes items from another publisher only if each new item is
+    /// in increasing order from the previously-published item.
+    public struct Comparison<Upstream: Publisher>: Publisher {
+
+        public typealias Output = Upstream.Output
+
+        public typealias Failure = Upstream.Failure
+
+        /// The publisher that this publisher receives elements from.
+        public let upstream: Upstream
+
+        /// A closure that receives two elements and returns `true` if they are in
+        /// increasing order.
+        public let areInIncreasingOrder: (Upstream.Output, Upstream.Output) -> Bool
+
+        public init(
+            upstream: Upstream,
+            areInIncreasingOrder: @escaping (Upstream.Output, Upstream.Output) -> Bool
+        ) {
+            self.upstream = upstream
+            self.areInIncreasingOrder = areInIncreasingOrder
+        }
+
+        public func receive<Downstream: Subscriber>(subscriber: Downstream)
+            where Upstream.Failure == Downstream.Failure,
+                  Upstream.Output == Downstream.Input
+        {
+            let inner = Inner(downstream: subscriber,
+                              areInIncreasingOrder: areInIncreasingOrder)
+            upstream.subscribe(inner)
+        }
+    }
+
+    /// A publisher that republishes items from another publisher only if each new item is
+    /// in increasing order from the previously-published item, and fails if the ordering
+    /// logic throws an error.
+    public struct TryComparison<Upstream: Publisher>: Publisher {
+
+        public typealias Output = Upstream.Output
+
+        public typealias Failure = Error
+
+        /// The publisher that this publisher receives elements from.
+        public let upstream: Upstream
+
+        /// A closure that receives two elements and returns `true` if they are in
+        /// increasing order.
+        public let areInIncreasingOrder: (Upstream.Output, Upstream.Output) throws -> Bool
+
+        public init(
+            upstream: Upstream,
+            areInIncreasingOrder:
+                @escaping (Upstream.Output, Upstream.Output) throws -> Bool
+        ) {
+            self.upstream = upstream
+            self.areInIncreasingOrder = areInIncreasingOrder
+        }
+
+        public func receive<Downstream: Subscriber>(subscriber: Downstream)
+            where Upstream.Output == Downstream.Input, Downstream.Failure == Error
+        {
+            let inner = Inner(downstream: subscriber,
+                              areInIncreasingOrder: areInIncreasingOrder)
+            upstream.subscribe(inner)
+        }
+    }
+}
+
+extension Publishers.Comparison {
+    private final class Inner<Downstream: Subscriber>
+        : ReduceProducer<Downstream,
+                         Upstream.Output,
+                         Upstream.Output,
+                         Upstream.Failure,
+                         (Upstream.Output, Upstream.Output) -> Bool>
+    where Downstream.Input == Upstream.Output, Downstream.Failure == Upstream.Failure
+    {
+        fileprivate init(
+            downstream: Downstream,
+            areInIncreasingOrder: @escaping (Upstream.Output, Upstream.Output) -> Bool
+        ) {
+            super.init(downstream: downstream, initial: nil, reduce: areInIncreasingOrder)
+        }
+
+        override func receive(
+            newValue: Upstream.Output
+        ) -> PartialCompletion<Void, Downstream.Failure> {
+            if let result = self.result {
+                if reduce(result, newValue) {
+                    self.result = newValue
+                }
+            } else {
+                self.result = newValue
+            }
+            return .continue
+        }
+
+        override var description: String {
+            return "Comparison"
+        }
+    }
+}
+
+extension Publishers.TryComparison {
+    private final class Inner<Downstream: Subscriber>
+        : ReduceProducer<Downstream,
+                         Upstream.Output,
+                         Upstream.Output,
+                         Upstream.Failure,
+                         (Upstream.Output, Upstream.Output) throws -> Bool>
+    where Downstream.Input == Upstream.Output, Downstream.Failure == Error
+    {
+        fileprivate init(
+            downstream: Downstream,
+            areInIncreasingOrder:
+                @escaping (Upstream.Output, Upstream.Output) throws -> Bool
+        ) {
+            super.init(downstream: downstream, initial: nil, reduce: areInIncreasingOrder)
+        }
+
+        override func receive(
+            newValue: Upstream.Output
+        ) -> PartialCompletion<Void, Downstream.Failure> {
+            do {
+                if let result = self.result {
+                    if try reduce(result, newValue) {
+                        self.result = newValue
+                    }
+                } else {
+                    self.result = newValue
+                }
+                return .continue
+            } catch {
+                return .failure(error)
+            }
+        }
+
+        override var description: String {
+            return "TryComparison"
+        }
+    }
+}