Add withUnretained to SharedSequence

[freak4pc]

Based on the request in #242. IRT other traits - there's no real value to add it to Completable... we could add to Maybe and Single in a separate PR.

This PR has a single failing test, I can't really put my finger on what's going on there (the same test passes for Signal but fails for Driver).

If anyone can take a poke at it, that'd be great :)

Thanks !

[freak4pc]

I'm casting back and forth to be able to throw a sequence-terminating error. The original implementation used a flatMap but that would be tricky given a completion doesn't affect the upstream.

[M0rtyMerr]

Really strange case about failing test case. I am interested in resolution of it :)

[M0rtyMerr]

Package.swift has .v4_2 version. Is it ok to migrate to Swift 5.1 syntax? I think it's better to perform this migration in separate PR for whole repo.

[freak4pc]

Uhm yeah, we'll just do the migration in a separate PR.

Once RxSwift 6 is out, it will only support Xcode 11 & Swift 5.1. So we'll release RxSwiftExt 6 accordingly.

[M0rtyMerr]

nit: all properties could be private

[freak4pc]

Good point!

[getogrand]

I found a bug on this implementation.

In below scenario, the viewModel.estimatedShippingDate is not disposed, so that the viewController and viewModel were not removed in the memory.
I don't really understand why this causes retain cycle nevertheless the self is not referred in the closure body.

The retain cycle is not caused if I change .withUnretained(self) with normal [weak self] capture list.

enum YGShippingType: String, Codable, Comparable, CustomStringConvertible {
  // ...
}

class SomeViewModel {
  private let _estimatedShippingDate = PublishRelay<(Date, YGShippingType)?>()

  // ...

  var estimatedShippingDate: Driver<(Date, YGShippingType)?> {
    _estimatedShippingDate.asDriver(onErrorJustReturn: nil)
      .distinctUntilChanged({
        $0?.0 == $1?.0 && $0?.1 == $1?.1
      })
  }
}

class SomeViewController: UIViewController {
  private let disposeBag = DisposeBag()
  var viewModel: ViewModel! // Injected by swinject

  // ...

  override func viewDidLoad() {
    super.viewDidLoad()
    bindCartTableHeaderView()
  }

  private func bindCartTableHeaderView() {
    // SharedSequence.withUnretained() causes retain cycle
    viewModel.estimatedShippingDate // Driver<(Date, YGShippingType)?>
      .map({ $0 == nil })
      .distinctUntilChanged()
      .withUnretained(self)
      .drive(onNext: { (self, hide) in
        // Note that we did not refer `self`
        print("blabla")
      })
      .disposed(by: disposeBag)

    /* 
    // ObservableType.withUnretained() doesn't cause retain cycle
    viewModel.estimatedShippingDate
      .map({ $0 == nil })
      .distinctUntilChanged()
      .asObservable()
      .withUnretained(self)
      .subscribe(onNext: { (self, hide) in
        print("blabla")
      })
      .disposed(by: disposeBag)
    */
  }
}