Changed TestableSubscriber recorded property names

Author: tcldr

Assets/EntwineTest/README.md

@@ -182,7 +182,7 @@ func testMap() {
     // uses the method described above (schedules a subscription at 200, to be cancelled at 900)
     let results = testScheduler.start { subjectUnderTest }
 
-    XCTAssertEqual(results.sequence, [
+    XCTAssertEqual(results.recordedOutput, [
         (200, .subscription),           // subscribed at 200
         (300, .input("A")),             // received uppercased input @ 100 + subscription time
         (400, .input("B")),             // received uppercased input @ 200 + subscription time

README.md

@@ -82,7 +82,7 @@ func testMap() {
     // schedules a subscription at 200, to be cancelled at 900
     let results = testScheduler.start { subjectUnderTest }
 
-    XCTAssertEqual(results.sequence, [
+    XCTAssertEqual(results.recordedOutput, [
         (200, .subscription),           // subscribed at 200
         (300, .input("A")),             // received uppercased input @ 100 + subscription time
         (400, .input("B")),             // received uppercased input @ 200 + subscription time

Sources/Entwine/Deprecations.swift

@@ -1,9 +1,26 @@
 //
-//  File.swift
-//  
+//  Entwine
+//  https://github.com/tcldr/Entwine
 //
-//  Created by Tristan Celder on 01/07/2019.
+//  Copyright © 2019 Tristan Celder. All rights reserved.
 //
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
 
 @available(*, deprecated, renamed: "CancellableBag")
 public typealias CancellationBag = CancellableBag

Sources/Entwine/Operators/Dematerialize.swift

@@ -24,21 +24,10 @@
 
 import Combine
 
-/// Represents an error for a dematerialized sequence
-///
-/// Consumers of publishers with a `Failure` of this type can opt-in to force unwrapping
-/// the error using the `assertNoDematerializationFailure()` operator
-public enum DematerializationError<SourceError: Error>: Error {
-    /// Sequencing error during dematerialization. e.g. an `.input` arriving after a `.completion`
-    case outOfSequence
-    /// A wrapped error of the represented material sequence
-    case sourceError(SourceError)
-}
-
-extension DematerializationError: Equatable where SourceError: Equatable {}
-
 extension Publishers {
 
+    // MARK: - Publisher
+    
     /// Converts a materialized publisher of `Signal`s into the represented sequence. Fails on a malformed
     /// source sequence.
     ///
@@ -70,6 +59,8 @@ extension Publishers {
         }
     }
 
+    // MARK: - Subscription
+    
     fileprivate class DematerializeSubscription<Upstream: Publisher, Downstream: Subscriber>: Subscription
          where
             Upstream.Output: SignalConvertible,
@@ -102,6 +93,8 @@ extension Publishers {
         }
     }
 
+    // MARK: - Sink
+    
     fileprivate class DematerializeSink<Upstream: Publisher, Downstream: Subscriber>: Subscriber
         where
             Upstream.Output: SignalConvertible,
@@ -194,6 +187,8 @@ extension Publishers {
     }
 }
 
+// MARK: - Operators
+
 extension Publisher where Output: SignalConvertible, Failure == Never {
 
     private func dematerializedValuesPublisherSequence() -> Publishers.Dematerialize<Self> {
@@ -247,6 +242,21 @@ extension Publisher where Failure: DematerializationErrorConvertible {
     }
 }
 
+// MARK: - Errors
+
+/// Represents an error for a dematerialized sequence
+///
+/// Consumers of publishers with a `Failure` of this type can opt-in to force unwrapping
+/// the error using the `assertNoDematerializationFailure()` operator
+public enum DematerializationError<SourceError: Error>: Error {
+    /// Sequencing error during dematerialization. e.g. an `.input` arriving after a `.completion`
+    case outOfSequence
+    /// A wrapped error of the represented material sequence
+    case sourceError(SourceError)
+}
+
+extension DematerializationError: Equatable where SourceError: Equatable {}
+
 /// A type which can be converted into a `DematerializationError`
 public protocol DematerializationErrorConvertible {
 

Sources/Entwine/Operators/Materialize.swift

@@ -26,6 +26,8 @@ import Combine
 
 extension Publishers {
 
+    // MARK: - Publisher
+    
     /// Wraps all the elements as well as the subscription and completion events of an upstream publisher
     /// into a stream of `Signal` elements
     public struct Materialize<Upstream: Publisher>: Publisher {
@@ -44,6 +46,8 @@ extension Publishers {
         }
     }
 
+    // MARK: - Subscription
+    
     // Owned by the downstream subscriber
     fileprivate class MaterializeSubscription<Upstream: Publisher, Downstream: Subscriber>: Subscription
         where Never == Downstream.Failure, Signal<Upstream.Output, Upstream.Failure> == Downstream.Input
@@ -72,6 +76,8 @@ extension Publishers {
         }
     }
 
+    // MARK: - Sink
+    
     fileprivate class MaterializeSink<Upstream: Publisher, Downstream: Subscriber>: Subscriber
          where Never == Downstream.Failure, Signal<Upstream.Output, Upstream.Failure> == Downstream.Input
     {
@@ -130,6 +136,8 @@ extension Publishers {
     }
 }
 
+// MARK: - Operator
+
 public extension Publisher {
 
     /// Wraps each element from the upstream publisher, as well as its subscription and completion events,

Sources/Entwine/Operators/ReplaySubject.swift

@@ -78,9 +78,12 @@ extension ReplaySubject: Publisher {
         subscriptions.append(subscription)
 
         subscription.cleanupHandler = { [weak self] in
-            if let index = self?.subscriptions.firstIndex(where: { subscriberIdentifier == $0.subscriberIdentifier }) {
-                self?.subscriberIdentifiers.remove(subscriberIdentifier)
-                self?.subscriptions.remove(at: index)
+            
+            guard let self = self else { return }
+            
+            if let index = self.subscriptions.firstIndex(where: { subscriberIdentifier == $0.subscriberIdentifier }) {
+                self.subscriberIdentifiers.remove(subscriberIdentifier)
+                self.subscriptions.remove(at: index)
             }
         }
         subscriber.receive(subscription: subscription)

Sources/Entwine/Signal.swift

@@ -44,6 +44,16 @@ public enum Signal <Input, Failure: Error> {
     case completion(Subscribers.Completion<Failure>)
 }
 
+// MARK: - Signal extensions
+
+public extension Signal {
+    /// Whether the signal indicates sequence completion
+    var isCompletion: Bool {
+        guard case .completion(_) = self else { return false }
+        return true
+    }
+}
+
 // MARK: - Equatable conformance
 
 extension Signal: Equatable where Input: Equatable, Failure: Equatable {

Sources/EntwineTest/Deprecations.swift

@@ -0,0 +1,32 @@
+//
+//  Entwine
+//  https://github.com/tcldr/Entwine
+//
+//  Copyright © 2019 Tristan Celder. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+
+public extension TestableSubscriber {
+    
+    @available(*, deprecated, renamed: "recordedOutput")
+    var sequence: TestSequence<Input, Failure>{ recordedOutput }
+    
+    @available(*, deprecated, renamed: "recordedDemandLog")
+    var demands: DemandLedger<VirtualTime>{ recordedDemandLog }
+}

Sources/EntwineTest/TestableSubscriber/TestableSubscriber.swift

@@ -61,10 +61,10 @@ public final class TestableSubscriber<Input, Failure: Error> {
     public typealias Sequence = TestSequence<Input, Failure>
 
     /// A time-stamped log of `Signal`s produced during the lifetime of a subscription to a publisher.
-    public internal(set) var sequence = TestSequence<Input, Failure>()
+    public internal(set) var recordedOutput = TestSequence<Input, Failure>()
     /// A time-stamped account of `Subscribers.Demand`s issued upstream, and incoming elements
     /// downstream, during the lifetime of a subscription to a publisher.
-    public internal(set) var demands = DemandLedger<VirtualTime>()
+    public internal(set) var recordedDemandLog = DemandLedger<VirtualTime>()
 
     private let scheduler: TestScheduler
     private let options: TestableSubscriberOptions
@@ -85,7 +85,7 @@ public final class TestableSubscriber<Input, Failure: Error> {
     func issueDemandCredit(_ demand: Subscribers.Demand) {
 
         demandBalance += demand
-        demands.append((scheduler.now, demandBalance, .credit(amount: demand)))
+        recordedDemandLog.append((scheduler.now, demandBalance, .credit(amount: demand)))
 
         subscription?.request(demand)
     }
@@ -94,7 +94,7 @@ public final class TestableSubscriber<Input, Failure: Error> {
 
         let authorized = (demandBalance > .none)
         demandBalance -= authorized ? demand : .none
-        demands.append((scheduler.now, demandBalance, .debit(authorized: authorized)))
+        recordedDemandLog.append((scheduler.now, demandBalance, .debit(authorized: authorized)))
         if !authorized {
             signalNegativeBalance()
         }
@@ -147,14 +147,14 @@ extension TestableSubscriber: Subscriber {
         self.demandBalance = .none
         self.subscription = subscription
 
-        sequence.append((scheduler.now, .subscription))
+        recordedOutput.append((scheduler.now, .subscription))
 
         issueDemandCredit(options.initialDemand)
         delayedReplenishDemandIfNeeded()
     }
 
     public func receive(_ input: Input) -> Subscribers.Demand {
-        sequence.append((scheduler.now, .input(input)))
+        recordedOutput.append((scheduler.now, .input(input)))
 
         debitDemand(.max(1))
         delayedReplenishDemandIfNeeded()
@@ -163,7 +163,7 @@ extension TestableSubscriber: Subscriber {
     }
 
     public func receive(completion: Subscribers.Completion<Failure>) {
-        sequence.append((scheduler.now, .completion(completion)))
+        recordedOutput.append((scheduler.now, .completion(completion)))
     }    
 }
 

Tests/EntwineTestTests/TestSchedulerTests.swift

@@ -153,7 +153,7 @@ final class TestSchedulerTests: XCTestCase {
             (310, .input(2)),
         ]
 
-        XCTAssertEqual(expected, results.sequence)
+        XCTAssertEqual(expected, results.recordedOutput)
     }
 
     func testFiresEventsScheduledBeforeStartCalled() {
@@ -175,7 +175,7 @@ final class TestSchedulerTests: XCTestCase {
             (500, .input(2)),
         ]
 
-        XCTAssertEqual(expected, testableSubscriber.sequence)
+        XCTAssertEqual(expected, testableSubscriber.recordedOutput)
     }
 
     func testTrampolinesImmediatelyScheduledTasks() {
@@ -206,7 +206,7 @@ final class TestSchedulerTests: XCTestCase {
             (200, .input(2)),
         ]
 
-        XCTAssertEqual(expected, results.sequence)
+        XCTAssertEqual(expected, results.recordedOutput)
     }
 
     static var allTests = [