Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add skipUntil operator #2576

Merged
merged 4 commits into from
Nov 30, 2015
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 21 additions & 0 deletions ReactiveCocoa/Swift/Signal.swift
Original file line number Diff line number Diff line change
Expand Up @@ -1016,6 +1016,27 @@ extension SignalType {
return disposable
}
}

/// Does not forward any values from `self` until `trigger` sends a Next or
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sends a Next or Completed event.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, sorry.

/// Completed, at which point the returned signal behaves exactly like `signal`.
@warn_unused_result(message="Did you forget to call `observe` on the signal?")
public func skipUntil(trigger: Signal<(), NoError>) -> Signal<Value, Error> {
return Signal { observer in
let disposable = SerialDisposable()

disposable.innerDisposable = trigger.observe { event in
switch event {
case .Next, .Completed:
disposable.innerDisposable = self.observe(observer)

case .Failed, .Interrupted:
break
}
}

return disposable
}
}

/// Forwards events from `self` with history: values of the returned signal
/// are a tuple whose first member is the previous value and whose second member
Expand Down
14 changes: 14 additions & 0 deletions ReactiveCocoa/Swift/SignalProducer.swift
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,20 @@ extension SignalProducerType {
return lift(Signal.takeUntil)(trigger)
}

/// Does not forward any values from `self` until `trigger` sends a Next or
/// Completed, at which point the returned signal behaves exactly like `signal`.
@warn_unused_result(message="Did you forget to call `start` on the producer?")
public func skipUntil(trigger: SignalProducer<(), NoError>) -> SignalProducer<Value, Error> {
return liftRight(Signal.skipUntil)(trigger)
}

/// Does not forward any values from `self` until `trigger` sends a Next or
/// Completed, at which point the returned signal behaves exactly like `signal`.
@warn_unused_result(message="Did you forget to call `start` on the producer?")
public func skipUntil(trigger: Signal<(), NoError>) -> SignalProducer<Value, Error> {
return lift(Signal.skipUntil)(trigger)
}

/// Forwards events from `self` with history: values of the returned producer
/// are a tuple whose first member is the previous value and whose second member
/// is the current value. `initial` is supplied as the first member when `self`
Expand Down
42 changes: 42 additions & 0 deletions ReactiveCocoaTests/Swift/SignalProducerLiftingSpec.swift
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,48 @@ class SignalProducerLiftingSpec: QuickSpec {
expect(lastValue).to(equal(1))
}
}

describe("skipUntil") {
var producer: SignalProducer<Int, NoError>!
var observer: Signal<Int, NoError>.Observer!
var triggerObserver: Signal<(), NoError>.Observer!

var lastValue: Int? = nil

beforeEach {
let (baseProducer, baseIncomingObserver) = SignalProducer<Int, NoError>.buffer()
let (triggerSignal, incomingTriggerObserver) = SignalProducer<(), NoError>.buffer()

producer = baseProducer.skipUntil(triggerSignal)
observer = baseIncomingObserver
triggerObserver = incomingTriggerObserver

lastValue = nil

producer.start { event in
switch event {
case let .Next(value):
lastValue = value
default:
break
}
}
}

it("should skip values until the trigger fires") {
expect(lastValue).to(beNil())

observer.sendNext(1)
expect(lastValue).to(beNil())

observer.sendNext(2)
expect(lastValue).to(beNil())

triggerObserver.sendNext(())
observer.sendNext(0)
expect(lastValue).to(equal(0))
}
}

describe("take") {
it("should take initial values") {
Expand Down
42 changes: 42 additions & 0 deletions ReactiveCocoaTests/Swift/SignalSpec.swift
Original file line number Diff line number Diff line change
Expand Up @@ -784,6 +784,48 @@ class SignalSpec: QuickSpec {
expect(lastValue).to(equal(1))
}
}

describe("skipUntil") {
var signal: Signal<Int, NoError>!
var observer: Signal<Int, NoError>.Observer!
var triggerObserver: Signal<(), NoError>.Observer!

var lastValue: Int? = nil

beforeEach {
let (baseSignal, incomingObserver) = Signal<Int, NoError>.pipe()
let (triggerSignal, incomingTriggerObserver) = Signal<(), NoError>.pipe()

signal = baseSignal.skipUntil(triggerSignal)
observer = incomingObserver
triggerObserver = incomingTriggerObserver

lastValue = nil

signal.observe { event in
switch event {
case let .Next(value):
lastValue = value
default:
break
}
}
}

it("should skip values until the trigger fires") {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you write another test for when the trigger completes without sending any events?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Of course! I also added the same tests to takeUntil spec, to keep the correspondence. Have a look and let me know your thoughts.

expect(lastValue).to(beNil())

observer.sendNext(1)
expect(lastValue).to(beNil())

observer.sendNext(2)
expect(lastValue).to(beNil())

triggerObserver.sendNext(())
observer.sendNext(0)
expect(lastValue).to(equal(0))
}
}

describe("take") {
it("should take initial values") {
Expand Down