From 235398b7c3311468e0d395b8077b578ac4e7b550 Mon Sep 17 00:00:00 2001 From: Krunoslav Zaher Date: Sat, 29 Apr 2017 16:54:23 +0200 Subject: [PATCH] Deprecates `start(_:create:)` in favor of `start(disposed:create:)`. Deprecates `start(_:subscribed:disposed:create:)` in favor of `start(created:subscribed:disposed:create:)`. --- .jazzy.yml | 2 +- Rx.xcodeproj/project.pbxproj | 10 +++++++++ RxTest/Deprecated.swift | 21 +++++++++++++++++++ RxTest/Schedulers/TestScheduler.swift | 10 +++++---- Tests/RxSwiftTests/DisposableTest.swift | 2 +- .../Observable+CreationTest.swift | 12 +++++------ .../Observable+MultipleTest2.swift | 2 +- .../RxSwiftTests/Observable+SingleTest.swift | 16 +++++++------- ...rvable+StandardSequenceOperatorsTest.swift | 18 ++++++++-------- ...vable+StandardSequenceOperatorsTest2.swift | 20 +++++++++--------- Tests/RxSwiftTests/Observable+TimeTest.swift | 10 ++++----- 11 files changed, 78 insertions(+), 45 deletions(-) create mode 100644 RxTest/Deprecated.swift diff --git a/.jazzy.yml b/.jazzy.yml index dab12e15..37ab7881 100644 --- a/.jazzy.yml +++ b/.jazzy.yml @@ -48,7 +48,7 @@ custom_categories: children: - Bag+Rx - String+Rx -- name: RxSwift/Observables/Implementations +- name: RxSwift/Observables children: - AddRef - Amb diff --git a/Rx.xcodeproj/project.pbxproj b/Rx.xcodeproj/project.pbxproj index 35b8c0af..8b616603 100644 --- a/Rx.xcodeproj/project.pbxproj +++ b/Rx.xcodeproj/project.pbxproj @@ -476,6 +476,10 @@ C820A9411EB4DA5A00D431BC /* Zip+arity.tt in Resources */ = {isa = PBXBuildFile; fileRef = C820A82B1EB4DA5900D431BC /* Zip+arity.tt */; }; C820A9421EB4DA5A00D431BC /* Zip+arity.tt in Resources */ = {isa = PBXBuildFile; fileRef = C820A82B1EB4DA5900D431BC /* Zip+arity.tt */; }; C820A9431EB4DA5A00D431BC /* Zip+arity.tt in Resources */ = {isa = PBXBuildFile; fileRef = C820A82B1EB4DA5900D431BC /* Zip+arity.tt */; }; + C820A9451EB4E06800D431BC /* Deprecated.swift in Sources */ = {isa = PBXBuildFile; fileRef = C820A9441EB4E06800D431BC /* Deprecated.swift */; }; + C820A9461EB4E06800D431BC /* Deprecated.swift in Sources */ = {isa = PBXBuildFile; fileRef = C820A9441EB4E06800D431BC /* Deprecated.swift */; }; + C820A9471EB4E06800D431BC /* Deprecated.swift in Sources */ = {isa = PBXBuildFile; fileRef = C820A9441EB4E06800D431BC /* Deprecated.swift */; }; + C820A9481EB4E06800D431BC /* Deprecated.swift in Sources */ = {isa = PBXBuildFile; fileRef = C820A9441EB4E06800D431BC /* Deprecated.swift */; }; C822BACA1DB4058000F98810 /* Event+Test.swift in Sources */ = {isa = PBXBuildFile; fileRef = C822BAC51DB4048F00F98810 /* Event+Test.swift */; }; C822BACB1DB4058000F98810 /* Event+Test.swift in Sources */ = {isa = PBXBuildFile; fileRef = C822BAC51DB4048F00F98810 /* Event+Test.swift */; }; C822BACC1DB4058100F98810 /* Event+Test.swift in Sources */ = {isa = PBXBuildFile; fileRef = C822BAC51DB4048F00F98810 /* Event+Test.swift */; }; @@ -1717,6 +1721,7 @@ C820A8291EB4DA5900D431BC /* Zip.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Zip.swift; sourceTree = ""; }; C820A82A1EB4DA5900D431BC /* Zip+arity.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Zip+arity.swift"; sourceTree = ""; }; C820A82B1EB4DA5900D431BC /* Zip+arity.tt */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = "Zip+arity.tt"; sourceTree = ""; }; + C820A9441EB4E06800D431BC /* Deprecated.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Deprecated.swift; sourceTree = ""; }; C822BAC51DB4048F00F98810 /* Event+Test.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Event+Test.swift"; sourceTree = ""; }; C822BACD1DB424EC00F98810 /* Reactive+Tests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "Reactive+Tests.swift"; sourceTree = ""; }; C8323A8D1E33FD5200CC0C7F /* Resources.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Resources.swift; sourceTree = ""; }; @@ -2871,6 +2876,7 @@ C89CFA1C1DAABBE20079D23B /* TestableObserver.swift */, C89CFA1D1DAABBE20079D23B /* XCTest+Rx.swift */, C89CFA141DAABBE20079D23B /* Info.plist */, + C820A9441EB4E06800D431BC /* Deprecated.swift */, ); path = RxTest; sourceTree = ""; @@ -4468,6 +4474,7 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + C820A9451EB4E06800D431BC /* Deprecated.swift in Sources */, C89CFA321DAABBE20079D23B /* Recorded.swift in Sources */, C89CFA4A1DAABBE20079D23B /* TestableObserver.swift in Sources */, C89CFA4E1DAABBE20079D23B /* XCTest+Rx.swift in Sources */, @@ -4488,6 +4495,7 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + C820A9461EB4E06800D431BC /* Deprecated.swift in Sources */, C89CFA331DAABBE20079D23B /* Recorded.swift in Sources */, C89CFA4B1DAABBE20079D23B /* TestableObserver.swift in Sources */, C89CFA4F1DAABBE20079D23B /* XCTest+Rx.swift in Sources */, @@ -4508,6 +4516,7 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + C820A9471EB4E06800D431BC /* Deprecated.swift in Sources */, C89CFA341DAABBE20079D23B /* Recorded.swift in Sources */, C89CFA4C1DAABBE20079D23B /* TestableObserver.swift in Sources */, C89CFA501DAABBE20079D23B /* XCTest+Rx.swift in Sources */, @@ -4528,6 +4537,7 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + C820A9481EB4E06800D431BC /* Deprecated.swift in Sources */, C89CFA351DAABBE20079D23B /* Recorded.swift in Sources */, C89CFA4D1DAABBE20079D23B /* TestableObserver.swift in Sources */, C89CFA511DAABBE20079D23B /* XCTest+Rx.swift in Sources */, diff --git a/RxTest/Deprecated.swift b/RxTest/Deprecated.swift new file mode 100644 index 00000000..824f2b71 --- /dev/null +++ b/RxTest/Deprecated.swift @@ -0,0 +1,21 @@ +// +// Deprecated.swift +// RxTest +// +// Created by Krunoslav Zaher on 4/29/17. +// Copyright © 2017 Krunoslav Zaher. All rights reserved. +// + +import RxSwift + +extension TestScheduler { + @available(*, deprecated, renamed: "start(disposed:create:)") + public func start(_ disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { + return start(Defaults.created, subscribed: Defaults.subscribed, disposed: disposed, create: create) + } + + @available(*, deprecated, renamed: "start(created:subscribed:disposed:create:)") + public func start(_ created: TestTime, subscribed: TestTime, disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { + return start(created: created, subscribed: subscribed, disposed: disposed, create: create) + } +} diff --git a/RxTest/Schedulers/TestScheduler.swift b/RxTest/Schedulers/TestScheduler.swift index 16be924e..54448f77 100644 --- a/RxTest/Schedulers/TestScheduler.swift +++ b/RxTest/Schedulers/TestScheduler.swift @@ -93,7 +93,7 @@ public class TestScheduler : VirtualTimeScheduler(_ created: TestTime, subscribed: TestTime, disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { + public func start(created: TestTime, subscribed: TestTime, disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { var source : Observable? = nil var subscription : Disposable? = nil let observer = createObserver(Element.self) @@ -129,8 +129,8 @@ public class TestScheduler : VirtualTimeScheduler(_ disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { - return start(Defaults.created, subscribed: Defaults.subscribed, disposed: disposed, create: create) + public func start(disposed: TestTime, create: @escaping () -> Observable) -> TestableObserver { + return start(created: Defaults.created, subscribed: Defaults.subscribed, disposed: disposed, create: create) } /** @@ -145,6 +145,8 @@ public class TestScheduler : VirtualTimeScheduler(_ create: @escaping () -> Observable) -> TestableObserver { - return start(Defaults.created, subscribed: Defaults.subscribed, disposed: Defaults.disposed, create: create) + return start(created: Defaults.created, subscribed: Defaults.subscribed, disposed: Defaults.disposed, create: create) } } + + diff --git a/Tests/RxSwiftTests/DisposableTest.swift b/Tests/RxSwiftTests/DisposableTest.swift index ea8247dc..9ca87070 100644 --- a/Tests/RxSwiftTests/DisposableTest.swift +++ b/Tests/RxSwiftTests/DisposableTest.swift @@ -65,7 +65,7 @@ extension DisposableTest { completed(600) ]) - let res = scheduler.start(400) { () -> Observable in + let res = scheduler.start(disposed: 400) { () -> Observable in return xs.asObservable() } diff --git a/Tests/RxSwiftTests/Observable+CreationTest.swift b/Tests/RxSwiftTests/Observable+CreationTest.swift index eded5013..5381e1f6 100644 --- a/Tests/RxSwiftTests/Observable+CreationTest.swift +++ b/Tests/RxSwiftTests/Observable+CreationTest.swift @@ -45,7 +45,7 @@ extension ObservableCreationTests { func testJust_Disposed() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(200) { + let res = scheduler.start(disposed: 200) { return Observable.just(42, scheduler: scheduler) } @@ -145,7 +145,7 @@ extension ObservableCreationTests { func testFromArray_dispose() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(203) { + let res = scheduler.start(disposed: 203) { Observable.from([3, 1, 2, 4], scheduler: scheduler) } @@ -198,7 +198,7 @@ extension ObservableCreationTests { func testSequenceOf_dispose() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(203) { + let res = scheduler.start(disposed: 203) { Observable.of(3, 1, 2, 4, scheduler: scheduler) } @@ -384,7 +384,7 @@ extension ObservableCreationTests { func testGenerate_Dispose() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(203) { + let res = scheduler.start(disposed: 203) { Observable.generate(initialState: 0, condition: { _ in true }, scheduler: scheduler) { x in x + 1 } @@ -452,7 +452,7 @@ extension ObservableCreationTests { func testRange_Dispose() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(204) { + let res = scheduler.start(disposed: 204) { Observable.range(start: -10, count: 5, scheduler: scheduler) } @@ -481,7 +481,7 @@ extension ObservableCreationTests { func testRepeat_Element() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(207) { + let res = scheduler.start(disposed: 207) { Observable.repeatElement(42, scheduler: scheduler) } diff --git a/Tests/RxSwiftTests/Observable+MultipleTest2.swift b/Tests/RxSwiftTests/Observable+MultipleTest2.swift index 570f68aa..fe71311d 100644 --- a/Tests/RxSwiftTests/Observable+MultipleTest2.swift +++ b/Tests/RxSwiftTests/Observable+MultipleTest2.swift @@ -771,7 +771,7 @@ extension ObservableMultipleTest { completed(400) ]) - let res = scheduler.start(450) { + let res = scheduler.start(disposed: 450) { xs.merge(maxConcurrent: 2) } diff --git a/Tests/RxSwiftTests/Observable+SingleTest.swift b/Tests/RxSwiftTests/Observable+SingleTest.swift index 936afded..3a2770a4 100644 --- a/Tests/RxSwiftTests/Observable+SingleTest.swift +++ b/Tests/RxSwiftTests/Observable+SingleTest.swift @@ -922,7 +922,7 @@ extension ObservableSingleTest { error(250, testError), ]) - let res = scheduler.start(1100) { + let res = scheduler.start(disposed: 1100) { xs.retry() } @@ -991,7 +991,7 @@ extension ObservableSingleTest { error(20, testError) ]) - let res = scheduler.start(231) { + let res = scheduler.start(disposed: 231) { xs.retry(3) } @@ -1019,7 +1019,7 @@ extension ObservableSingleTest { error(20, testError) ]) - let res = scheduler.start(231) { + let res = scheduler.start(disposed: 231) { xs.retry(3) } @@ -1127,7 +1127,7 @@ extension ObservableSingleTest { completed(210) ]) - let res = scheduler.start(300) { + let res = scheduler.start(disposed: 300) { xs.retryWhen { (errors: Observable) in return empty } @@ -1267,7 +1267,7 @@ extension ObservableSingleTest { completed(40) ]) - let res = scheduler.start(300) { + let res = scheduler.start(disposed: 300) { xs.retryWhen { (errors: Observable) in return errors.scan(0) { (_a, e) in var a = _a @@ -1343,7 +1343,7 @@ extension ObservableSingleTest { completed(40) ]) - let res = scheduler.start(300) { + let res = scheduler.start(disposed: 300) { xs.retryWhen { (errors: Observable) in return errors.scan(0) { (a, e) in return a + 1 @@ -1415,7 +1415,7 @@ extension ObservableSingleTest { let maxAttempts = 4 - let res = scheduler.start(800) { + let res = scheduler.start(disposed: 800) { xs.retryWhen { (errors: Observable) in return errors.flatMapWithIndex { (e, a) -> Observable in if a >= maxAttempts - 1 { @@ -1455,7 +1455,7 @@ extension ObservableSingleTest { error(10, retryError) ]) - let res = scheduler.start(800) { + let res = scheduler.start(disposed: 800) { xs.retryWhen { (errors: Observable) in errors } diff --git a/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest.swift b/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest.swift index 13d2af4f..df83893e 100644 --- a/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest.swift +++ b/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest.swift @@ -194,7 +194,7 @@ extension ObservableStandardSequenceOperatorsTest { completed(600) ]) - let res = scheduler.start(400) { () -> Observable in + let res = scheduler.start(disposed: 400) { () -> Observable in return xs.filter { (num: Int) -> Bool in invoked += 1 return isPrime(num) @@ -421,7 +421,7 @@ extension ObservableStandardSequenceOperatorsTest { var invoked = 0 - let res = scheduler.start(300) { () -> Observable in + let res = scheduler.start(disposed: 300) { () -> Observable in return xs.takeWhile { (num: Int) -> Bool in invoked += 1 return isPrime(num) @@ -461,7 +461,7 @@ extension ObservableStandardSequenceOperatorsTest { var invoked = 0 - let res = scheduler.start(400) { () -> Observable in + let res = scheduler.start(disposed: 400) { () -> Observable in return xs.takeWhile { (num: Int) -> Bool in invoked += 1 return isPrime(num) @@ -505,7 +505,7 @@ extension ObservableStandardSequenceOperatorsTest { var invoked = 0 - let res = scheduler.start(300) { () -> Observable in + let res = scheduler.start(disposed: 300) { () -> Observable in return xs.takeWhile { (num: Int) -> Bool in invoked += 1 return isPrime(num) @@ -861,7 +861,7 @@ extension ObservableStandardSequenceOperatorsTest { error(300, testError) ]) - let res = scheduler.start(290) { xs.map { $0 * 2 } } + let res = scheduler.start(disposed: 290) { xs.map { $0 * 2 } } let correctMessages = [ next(210, 0 * 2), @@ -1020,7 +1020,7 @@ extension ObservableStandardSequenceOperatorsTest { error(300, testError) ]) - let res = scheduler.start(290) { xs.mapWithIndex { ($0 + $1) * 2 } } + let res = scheduler.start(disposed: 290) { xs.mapWithIndex { ($0 + $1) * 2 } } let correctMessages = [ next(210, (5 + 0) * 2), @@ -1228,7 +1228,7 @@ extension ObservableStandardSequenceOperatorsTest { error(300, testError) ]) - let res = scheduler.start(290) { xs.map { $0 * 10 }.map { $0 + 1 } } + let res = scheduler.start(disposed: 290) { xs.map { $0 * 10 }.map { $0 + 1 } } let correctMessages = [ next(210, 0 * 10 + 1), @@ -1795,7 +1795,7 @@ extension ObservableStandardSequenceOperatorsTest { completed(900) ]) - let res = scheduler.start(700) { + let res = scheduler.start(disposed: 700) { xs.flatMapFirst { $0 } } @@ -2431,7 +2431,7 @@ extension ObservableStandardSequenceOperatorsTest { completed(900) ]) - let res = scheduler.start(700) { + let res = scheduler.start(disposed: 700) { xs.flatMap { $0 } } diff --git a/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest2.swift b/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest2.swift index 6ccfbf49..fa039613 100644 --- a/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest2.swift +++ b/Tests/RxSwiftTests/Observable+StandardSequenceOperatorsTest2.swift @@ -525,7 +525,7 @@ extension ObservableStandardSequenceOperatorsTest completed(900) ]) - let res = scheduler.start(700) { + let res = scheduler.start(disposed: 700) { xs.flatMapWithIndex { x, _ in x } } @@ -1049,7 +1049,7 @@ extension ObservableStandardSequenceOperatorsTest { error(690, testError) ]) - let res = scheduler.start(250) { + let res = scheduler.start(disposed: 250) { xs.take(3) } @@ -1089,7 +1089,7 @@ extension ObservableStandardSequenceOperatorsTest { error(690, testError) ]) - let res = scheduler.start(400) { + let res = scheduler.start(disposed: 400) { xs.take(3) } @@ -1782,7 +1782,7 @@ extension ObservableStandardSequenceOperatorsTest { next(630, 10), ]) - let res = scheduler.start(250) { + let res = scheduler.start(disposed: 250) { xs.skip(3) } @@ -1819,7 +1819,7 @@ extension ObservableStandardSequenceOperatorsTest { next(630, 10), ]) - let res = scheduler.start(400) { + let res = scheduler.start(disposed: 400) { xs.skip(3) } @@ -2033,7 +2033,7 @@ extension ObservableStandardSequenceOperatorsTest { var invoked = 0 - let res = scheduler.start(300) { + let res = scheduler.start(disposed: 300) { xs.skipWhile { x in invoked += 1 return isPrime(x) @@ -2069,7 +2069,7 @@ extension ObservableStandardSequenceOperatorsTest { var invoked = 0 - let res = scheduler.start(470) { + let res = scheduler.start(disposed: 470) { xs.skipWhile { x in invoked += 1 return isPrime(x) @@ -2464,7 +2464,7 @@ extension ObservableStandardSequenceOperatorsTest { error(690, testError) ]) - let res = scheduler.start(250) { + let res = scheduler.start(disposed: 250) { xs.elementAt(3) } @@ -2501,7 +2501,7 @@ extension ObservableStandardSequenceOperatorsTest { error(690, testError) ]) - let res = scheduler.start(400) { + let res = scheduler.start(disposed: 400) { xs.elementAt(3) } @@ -2993,7 +2993,7 @@ extension ObservableSingleTest { error(650, testError) ]) - let res = scheduler.start(355) { () -> Observable in + let res = scheduler.start(disposed: 355) { () -> Observable in let group: Observable> = xs.groupBy { x in keyInvoked += 1 if x == "error" { throw testError } diff --git a/Tests/RxSwiftTests/Observable+TimeTest.swift b/Tests/RxSwiftTests/Observable+TimeTest.swift index 19516327..bdc86646 100644 --- a/Tests/RxSwiftTests/Observable+TimeTest.swift +++ b/Tests/RxSwiftTests/Observable+TimeTest.swift @@ -703,7 +703,7 @@ extension ObservableTimeTest { func testInterval_TimeSpan_Zero() { let scheduler = TestScheduler(initialClock: 0) - let res = scheduler.start(210) { + let res = scheduler.start(disposed: 210) { Observable.interval(0, scheduler: scheduler) } @@ -1039,7 +1039,7 @@ extension ObservableTimeTest { error(70, testError) ]) - let res = scheduler.start(291) { + let res = scheduler.start(disposed: 291) { xs.delaySubscription(30, scheduler: scheduler) } @@ -1282,7 +1282,7 @@ extension ObservableTimeTest { completed(600) ]) - let res = scheduler.start(370) { + let res = scheduler.start(disposed: 370) { xs.buffer(timeSpan: 70, count: 3, scheduler: scheduler).map { EquatableArray($0) } } @@ -1433,7 +1433,7 @@ extension ObservableTimeTest { completed(600) ]) - let res = scheduler.start(370) { () -> Observable in + let res = scheduler.start(disposed: 370) { () -> Observable in let window: Observable> = xs.window(timeSpan: 70, count: 3, scheduler: scheduler) let mappedWithIndex = window.mapWithIndex { (o: Observable, i: Int) -> Observable in return o.map { (e: Int) -> String in @@ -1654,7 +1654,7 @@ extension ObservableTimeTest { completed(600) ]) - let res = scheduler.start(370) { + let res = scheduler.start(disposed: 370) { xs.timeout(40, scheduler: scheduler) }