Change SubscriptionReferenceType to be non-optional

Author: Qata

Docs/Reactive/CwlSignal.md

@@ -12,14 +12,14 @@ extension Signal: StreamType {
     public typealias ValueType = T
     public typealias DisposableType = DisposableWrapper<T>
 
-    public func subscribe(_ function: @escaping (T) -> Void) -> DisposableWrapper<T>? {
+    public func subscribe(_ function: @escaping (T) -> Void) -> DisposableWrapper<T> {
         return DisposableWrapper(disposable: subscribeValues(handler: function))
     }
 }
 
 public struct DisposableWrapper<T>: SubscriptionReferenceType {
     let disposable: SignalEndpoint<T>
-    
+
     public func dispose() {
         disposable.cancel()
     }

Docs/Reactive/PromiseKit.md

@@ -9,9 +9,9 @@ extension Promise: StreamType {
     public typealias ValueType = T
     public typealias DisposableType = DisposableFake
 
-    public func subscribe(_ function: @escaping (T) -> Void) -> DisposableFake? {
+    public func subscribe(_ function: @escaping (T) -> Void) -> DisposableFake {
         _ = self.then(execute: function)
-        return nil
+        return .init()
     }
 }
 

Docs/Reactive/ReactiveKit.md

@@ -11,8 +11,8 @@ import ReactiveReSwift
 extension Signal: StreamType {
     public typealias ValueType = Element
     public typealias DisposableType = DisposableWrapper
-    
-    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper? {
+
+    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper {
         return DisposableWrapper(disposable: self.observeNext(with: function))
     }
 }
@@ -21,14 +21,14 @@ extension Property: ObservablePropertyType {
     public typealias ValueType = Value
     public typealias DisposableType = DisposableWrapper
 
-    public func subscribe(_ function: @escaping (Value) -> Void) -> DisposableWrapper? {
+    public func subscribe(_ function: @escaping (Value) -> Void) -> DisposableWrapper {
         return DisposableWrapper(disposable: observeNext(with: function))
     }
 }
 
 public struct DisposableWrapper: SubscriptionReferenceType {
     let disposable: Disposable
-    
+
     public func dispose() {
         disposable.dispose()
     }

Docs/Reactive/ReactiveSwift.md

@@ -39,7 +39,7 @@ extension SignalProducer: StreamType {
     public typealias DisposableType = AnyDisposable
 
     @discardableResult
-    public func subscribe(_ function: @escaping (Value) -> Void) -> AnyDisposable? {
+    public func subscribe(_ function: @escaping (Value) -> Void) -> AnyDisposable {
         return AnyDisposable(self.on(value: function).start())
     }
 }

Docs/Reactive/RxSwift.md

@@ -12,7 +12,7 @@ extension Variable: ObservablePropertyType {
     public typealias ValueType = Element
     public typealias DisposableType = DisposableWrapper
 
-    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper? {
+    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper {
         return DisposableWrapper(disposable: asObservable().subscribe(onNext: function))
     }
 }
@@ -21,7 +21,7 @@ extension Observable: StreamType {
     public typealias ValueType = Element
     public typealias DisposableType = DisposableWrapper
 
-    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper? {
+    public func subscribe(_ function: @escaping (Element) -> Void) -> DisposableWrapper {
         return DisposableWrapper(disposable: subscribe(onNext: function))
     }
 }

Sources/CoreTypes/Store.swift

@@ -36,7 +36,7 @@ open class Store<ObservableProperty: ObservablePropertyType> {
     }
 
     @discardableResult
-    public func dispatch<S: StreamType>(_ stream: S) -> SubscriptionReferenceType? where S.ValueType: Action {
+    public func dispatch<S: StreamType>(_ stream: S) -> SubscriptionReferenceType where S.ValueType: Action {
         let disposable = stream.subscribe { [unowned self] action in
             self.dispatch(action)
         }

Sources/Reactive/ObservableProperty.swift

@@ -33,7 +33,7 @@ public class ObservableProperty<ValueType>: ObservablePropertyType {
     }
 
     @discardableResult
-    public func subscribe(_ function: @escaping (ValueType) -> Void) -> DisposableType? {
+    public func subscribe(_ function: @escaping (ValueType) -> Void) -> DisposableType {
         defer { subscriptionToken += 1 }
         retainReference = self
         function(value)

Sources/Reactive/StreamType.swift

@@ -19,5 +19,5 @@ public protocol StreamType {
     associatedtype DisposableType: SubscriptionReferenceType
 
     /// Register a callback to be called when new values flow down the stream.
-    func subscribe(_ function: @escaping (ValueType) -> Void) -> DisposableType?
+    func subscribe(_ function: @escaping (ValueType) -> Void) -> DisposableType
 }

Tests/Observable/ReactiveTests.swift

@@ -57,7 +57,7 @@ class ReactiveTests: XCTestCase {
         let property = ObservableProperty(())
         let reference = property.subscribe({})
         XCTAssertEqual(property.subscriptions.count, 1)
-        reference?.dispose()
+        reference.dispose()
         XCTAssertEqual(property.subscriptions.count, 0)
     }
 
@@ -73,7 +73,7 @@ class ReactiveTests: XCTestCase {
     func testThatDisposingOfAReferenceTwiceIsOkay() {
         let property = ObservableProperty(())
         let reference = property.subscribe({})
-        reference?.dispose()
-        reference?.dispose()
+        reference.dispose()
+        reference.dispose()
     }
 }