Migrate ViewModel to Swift 3

jakubvano · jakubvano · commit 468cc9b6d221 · 2016-11-18T17:06:19.000+01:00
diff --git a/ExampleViewModel/ImageDetailViewModel.swift b/ExampleViewModel/ImageDetailViewModel.swift
@@ -6,35 +6,36 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
+import Result
 import ExampleModel
 
 public final class ImageDetailViewModel: ImageDetailViewModeling {
-    public var id: AnyProperty<UInt64?> { return AnyProperty(_id) }
-    public var pageImageSizeText: AnyProperty<String?> { return AnyProperty(_pageImageSizeText) }
-    public var tagText: AnyProperty<String?> { return AnyProperty(_tagText) }
-    public var usernameText: AnyProperty<String?> { return AnyProperty(_usernameText) }
-    public var viewCountText: AnyProperty<String?> { return AnyProperty(_viewCountText) }
-    public var downloadCountText: AnyProperty<String?> { return AnyProperty(_downloadCountText) }
-    public var likeCountText: AnyProperty<String?> { return AnyProperty(_likeCountText) }
-    public var image: AnyProperty<UIImage?> { return AnyProperty(_image) }
+    public var id: Property<UInt64?> { return Property(_id) }
+    public var pageImageSizeText: Property<String?> { return Property(_pageImageSizeText) }
+    public var tagText: Property<String?> { return Property(_tagText) }
+    public var usernameText: Property<String?> { return Property(_usernameText) }
+    public var viewCountText: Property<String?> { return Property(_viewCountText) }
+    public var downloadCountText: Property<String?> { return Property(_downloadCountText) }
+    public var likeCountText: Property<String?> { return Property(_likeCountText) }
+    public var image: Property<UIImage?> { return Property(_image) }
     
-    private let _id = MutableProperty<UInt64?>(nil)
-    private let _pageImageSizeText = MutableProperty<String?>(nil)
-    private let _tagText = MutableProperty<String?>(nil)
-    private let _usernameText = MutableProperty<String?>(nil)
-    private let _viewCountText = MutableProperty<String?>(nil)
-    private let _downloadCountText = MutableProperty<String?>(nil)
-    private let _likeCountText = MutableProperty<String?>(nil)
-    private let _image = MutableProperty<UIImage?>(nil)
+    fileprivate let _id = MutableProperty<UInt64?>(nil)
+    fileprivate let _pageImageSizeText = MutableProperty<String?>(nil)
+    fileprivate let _tagText = MutableProperty<String?>(nil)
+    fileprivate let _usernameText = MutableProperty<String?>(nil)
+    fileprivate let _viewCountText = MutableProperty<String?>(nil)
+    fileprivate let _downloadCountText = MutableProperty<String?>(nil)
+    fileprivate let _likeCountText = MutableProperty<String?>(nil)
+    fileprivate let _image = MutableProperty<UIImage?>(nil)
     
-    internal var locale = NSLocale.currentLocale() // For testing.
-    private var imageEntities = [ImageEntity]()
-    private var currentImageIndex = 0
-    private var (stopSignalProducer, stopSignalObserver) = SignalProducer<(), NoError>.buffer()
+    internal var locale = Locale.current // For testing.
+    fileprivate var imageEntities = [ImageEntity]()
+    fileprivate var currentImageIndex = 0
+    fileprivate var stop = MutableProperty<Void>()
     
-    private let network: Networking
-    private let externalAppChannel: ExternalAppChanneling
+    fileprivate let network: Networking
+    fileprivate let externalAppChannel: ExternalAppChanneling
 
     public init(network: Networking, externalAppChannel: ExternalAppChanneling) {
         self.network = network
@@ -43,19 +44,19 @@ public final class ImageDetailViewModel: ImageDetailViewModeling {
     
     public func openImagePage() {
         if let currentImageEntity = currentImageEntity {
-            externalAppChannel.openURL(currentImageEntity.pageURL)
+            externalAppChannel.openURL(url: currentImageEntity.pageURL)
         }
     }
     
-    private var currentImageEntity: ImageEntity? {
+    fileprivate var currentImageEntity: ImageEntity? {
         return imageEntities.indices.contains(currentImageIndex) ? imageEntities[currentImageIndex] : nil
     }
 }
 
 extension ImageDetailViewModel: ImageDetailViewModelModifiable {
-    public func update(imageEntities: [ImageEntity], atIndex index: Int) {
-        stopSignalObserver.sendNext(())
-        (stopSignalProducer, stopSignalObserver) = SignalProducer<(), NoError>.buffer()
+    public func update(_ imageEntities: [ImageEntity], atIndex index: Int) {
+        stop.value = ()
+        stop = MutableProperty<Void>()
         
         self.imageEntities = imageEntities
         currentImageIndex = index
@@ -64,23 +65,23 @@ extension ImageDetailViewModel: ImageDetailViewModelModifiable {
         self._id.value = imageEntity?.id
         self._usernameText.value = imageEntity?.username
         self._pageImageSizeText.value = imageEntity.map { "\($0.pageImageWidth) x \($0.pageImageHeight)" }
-        self._tagText.value = imageEntity.map { $0.tags.joinWithSeparator(", ") }
+        self._tagText.value = imageEntity.map { $0.tags.joined(separator: ", ") }
         self._viewCountText.value = imageEntity.map { formatInt64($0.viewCount) }
         self._downloadCountText.value = imageEntity.map { formatInt64($0.downloadCount) }
         self._likeCountText.value = imageEntity.map { formatInt64($0.likeCount) }
         
         _image.value = nil
         if let imageEntity = imageEntity {
-            _image <~ network.requestImage(imageEntity.imageURL)
-                .takeUntil(stopSignalProducer)
+            _image <~ network.requestImage(url: imageEntity.imageURL)
+                .take(until: stop.producer)
                 .map { $0 as UIImage? }
                 .flatMapError { _ in SignalProducer<UIImage?, NoError>(value: nil) }
-                .observeOn(UIScheduler())
+                .observe(on: UIScheduler())
         }
     }
     
-    private func formatInt64(value: Int64) -> String {
-        return NSNumber(longLong: value).descriptionWithLocale(locale)
+    fileprivate func formatInt64(_ value: Int64) -> String {
+        return NSNumber(value: value as Int64).description(withLocale: locale)
     }
     
     // This method can be used if you add next and previsou buttons on image detail view
diff --git a/ExampleViewModel/ImageDetailViewModeling.swift b/ExampleViewModel/ImageDetailViewModeling.swift
@@ -6,22 +6,22 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
 import ExampleModel
 
 public protocol ImageDetailViewModeling {
-    var id: AnyProperty<UInt64?> { get }
-    var pageImageSizeText: AnyProperty<String?> { get }
-    var tagText: AnyProperty<String?> { get }
-    var usernameText: AnyProperty<String?> { get }
-    var viewCountText: AnyProperty<String?> { get }
-    var downloadCountText: AnyProperty<String?> { get }
-    var likeCountText: AnyProperty<String?> { get }
-    var image: AnyProperty<UIImage?> { get }
+    var id: Property<UInt64?> { get }
+    var pageImageSizeText: Property<String?> { get }
+    var tagText: Property<String?> { get }
+    var usernameText: Property<String?> { get }
+    var viewCountText: Property<String?> { get }
+    var downloadCountText: Property<String?> { get }
+    var likeCountText: Property<String?> { get }
+    var image: Property<UIImage?> { get }
     
     func openImagePage()
 }
 
 public protocol ImageDetailViewModelModifiable: ImageDetailViewModeling {
-    func update(imageEntities: [ImageEntity], atIndex index: Int)
+    func update(_ imageEntities: [ImageEntity], atIndex index: Int)
 }
diff --git a/ExampleViewModel/ImageSearchTableViewCellModel.swift b/ExampleViewModel/ImageSearchTableViewCellModel.swift
@@ -6,7 +6,8 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
+import Result
 import ExampleModel
 
 // Inherits NSObject to use rac_willDeallocSignal.
@@ -15,14 +16,14 @@ public final class ImageSearchTableViewCellModel: NSObject, ImageSearchTableView
     public let pageImageSizeText: String
     public let tagText: String
     
-    private let network: Networking
-    private let previewURL: String
-    private var previewImage: UIImage?
+    fileprivate let network: Networking
+    fileprivate let previewURL: String
+    fileprivate var previewImage: UIImage?
     
     internal init(image: ImageEntity, network: Networking) {
         id = image.id
         pageImageSizeText = "\(image.pageImageWidth) x \(image.pageImageHeight)"
-        tagText = image.tags.joinWithSeparator(", ")
+        tagText = image.tags.joined(separator: ", ")
         
         self.network = network
         previewURL = image.previewURL
@@ -32,18 +33,18 @@ public final class ImageSearchTableViewCellModel: NSObject, ImageSearchTableView
     
     public func getPreviewImage() -> SignalProducer<UIImage?, NoError> {
         if let previewImage = self.previewImage {
-            return SignalProducer(value: previewImage).observeOn(UIScheduler())
+            return SignalProducer(value: previewImage).observe(on: UIScheduler())
         }
         else {
-            let imageProducer = network.requestImage(previewURL)
-                .takeUntil(self.racutil_willDeallocProducer)
-                .on(next: { self.previewImage = $0 })
+            let imageProducer = network.requestImage(url: previewURL)
+                .take(until: self.reactive.lifetime.ended)
+                .on(value: { self.previewImage = $0 })
                 .map { $0 as UIImage? }
                 .flatMapError { _ in SignalProducer<UIImage?, NoError>(value: nil) }
             
             return SignalProducer(value: nil)
                 .concat(imageProducer)
-                .observeOn(UIScheduler())
+                .observe(on: UIScheduler())
         }
     }
 }
diff --git a/ExampleViewModel/ImageSearchTableViewCellModeling.swift b/ExampleViewModel/ImageSearchTableViewCellModeling.swift
@@ -6,7 +6,8 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
+import Result
 
 public protocol ImageSearchTableViewCellModeling {
     var id: UInt64 { get }
diff --git a/ExampleViewModel/ImageSearchTableViewModel.swift b/ExampleViewModel/ImageSearchTableViewModel.swift
@@ -6,65 +6,66 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
+import Result
 import ExampleModel
 
 public final class ImageSearchTableViewModel: ImageSearchTableViewModeling {
-    public var cellModels: AnyProperty<[ImageSearchTableViewCellModeling]> { return AnyProperty(_cellModels) }
-    public var searching: AnyProperty<Bool> { return AnyProperty(_searching) }
-    public var errorMessage: AnyProperty<String?> { return AnyProperty(_errorMessage) }
+    public var cellModels: Property<[ImageSearchTableViewCellModeling]> { return Property(_cellModels) }
+    public var searching: Property<Bool> { return Property(_searching) }
+    public var errorMessage: Property<String?> { return Property(_errorMessage) }
     
-    private let _cellModels = MutableProperty<[ImageSearchTableViewCellModeling]>([])
-    private let _searching = MutableProperty<Bool>(false)
-    private let _errorMessage = MutableProperty<String?>(nil)
+    fileprivate let _cellModels = MutableProperty<[ImageSearchTableViewCellModeling]>([])
+    fileprivate let _searching = MutableProperty<Bool>(false)
+    fileprivate let _errorMessage = MutableProperty<String?>(nil)
     
     /// Accepts property injection.
     public var imageDetailViewModel: ImageDetailViewModelModifiable?
     
     public var loadNextPage: Action<(), (), NoError> {
         return Action(enabledIf: nextPageLoadable) { _ in
             return SignalProducer { observer, disposable in
-                if let (_, observer) = self.nextPageTrigger.value {
+                if let observer = self.nextPageTrigger.value {
                     self._searching.value = true
-                    observer.sendNext(())
+                    observer.value = ()
                 }
             }
         }
     }
-    private var nextPageLoadable: AnyProperty<Bool> {
-        return AnyProperty(
-            initialValue: false,
-            producer: searching.producer.combineLatestWith(nextPageTrigger.producer).map { searching, trigger in
+    fileprivate var nextPageLoadable: Property<Bool> {
+        return Property(
+            initial: false,
+            then: searching.producer.combineLatest(with: nextPageTrigger.producer).map { searching, trigger in
                 !searching && trigger != nil
             })
     }
-    private let nextPageTrigger = MutableProperty<(SignalProducer<(), NoError>, Observer<(), NoError>)?>(nil) // SignalProducer buffer
+    fileprivate let nextPageTrigger = MutableProperty<MutableProperty<Void>?>(nil) // SignalProducer buffer
 
-    private let imageSearch: ImageSearching
-    private let network: Networking
+    fileprivate let imageSearch: ImageSearching
+    fileprivate let network: Networking
     
-    private var foundImages = [ImageEntity]()
+    fileprivate var foundImages = [ImageEntity]()
     
     public init(imageSearch: ImageSearching, network: Networking) {
         self.imageSearch = imageSearch
         self.network = network
     }
     
     public func startSearch() {
-        func toCellModel(image: ImageEntity) -> ImageSearchTableViewCellModeling {
+        func toCellModel(_ image: ImageEntity) -> ImageSearchTableViewCellModeling {
             return ImageSearchTableViewCellModel(image: image, network: self.network) as ImageSearchTableViewCellModeling
         }
         
         _searching.value = true
-        nextPageTrigger.value = SignalProducer<(), NoError>.buffer()
-        let (trigger, _) = nextPageTrigger.value!
+        nextPageTrigger.value = MutableProperty()
+        let trigger = nextPageTrigger.value!.producer
 
         imageSearch.searchImages(nextPageTrigger: trigger)
             .map { response in
                 (response.images, response.images.map { toCellModel($0) })
             }
-            .observeOn(UIScheduler())
-            .on(next: { images, cellModels in
+            .observe(on: UIScheduler())
+            .on(value: { images, cellModels in
                 self.foundImages += images
                 self._cellModels.value += cellModels
                 self._searching.value = false
@@ -74,7 +75,7 @@ public final class ImageSearchTableViewModel: ImageSearchTableViewModeling {
             })
             .on(event: { event in
                 switch event {
-                case .Completed, .Failed, .Interrupted:
+                case .completed, .failed, .interrupted:
                     self.nextPageTrigger.value = nil
                     self._searching.value = false
                 default:
@@ -84,7 +85,7 @@ public final class ImageSearchTableViewModel: ImageSearchTableViewModeling {
             .start()
     }
 
-    public func selectCellAtIndex(index: Int) {
+    public func selectCellAtIndex(_ index: Int) {
         imageDetailViewModel?.update(foundImages, atIndex: index)
     }
 }
diff --git a/ExampleViewModel/ImageSearchTableViewModeling.swift b/ExampleViewModel/ImageSearchTableViewModeling.swift
@@ -6,15 +6,16 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-import ReactiveCocoa
+import ReactiveSwift
+import Result
 
 public protocol ImageSearchTableViewModeling {
-    var cellModels: AnyProperty<[ImageSearchTableViewCellModeling]> { get }
-    var searching: AnyProperty<Bool> { get }
-    var errorMessage: AnyProperty<String?> { get }
+    var cellModels: Property<[ImageSearchTableViewCellModeling]> { get }
+    var searching: Property<Bool> { get }
+    var errorMessage: Property<String?> { get }
     
     func startSearch()
     var loadNextPage: Action<(), (), NoError> { get }
     
-    func selectCellAtIndex(index: Int)
+    func selectCellAtIndex(_ index: Int)
 }
diff --git a/ExampleViewModel/LocalizedString.swift b/ExampleViewModel/LocalizedString.swift
@@ -6,9 +6,9 @@
 //  Copyright © 2015 Swinject Contributors. All rights reserved.
 //
 
-internal func LocalizedString(key: String, comment: String?) -> String {
+internal func LocalizedString(_ key: String, comment: String?) -> String {
     struct Static {
-        static let bundle = NSBundle(identifier: "com.github.Swinject.SwinjectMVVMExample.ExampleViewModel")!
+        static let bundle = Bundle(identifier: "com.github.Swinject.SwinjectMVVMExample.ExampleViewModel")!
     }
     return NSLocalizedString(key, bundle: Static.bundle, comment: comment ?? "")
 }
diff --git a/ExampleViewModel/RACUtil.swift b/ExampleViewModel/RACUtil.swift
diff --git a/SwinjectMVVMExample.xcodeproj/project.pbxproj b/SwinjectMVVMExample.xcodeproj/project.pbxproj

Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,9 @@`
`6`	`6`	`// Copyright © 2015 Swinject Contributors. All rights reserved.`
`7`	`7`	`//`
`8`	`8`
`9`		`-internal func LocalizedString(key: String, comment: String?) -> String {`
	`9`	`+internal func LocalizedString(_ key: String, comment: String?) -> String {`
`10`	`10`	`struct Static {`
`11`		`- static let bundle = NSBundle(identifier: "com.github.Swinject.SwinjectMVVMExample.ExampleViewModel")!`
	`11`	`+ static let bundle = Bundle(identifier: "com.github.Swinject.SwinjectMVVMExample.ExampleViewModel")!`
`12`	`12`	`}`
`13`	`13`	`return NSLocalizedString(key, bundle: Static.bundle, comment: comment ?? "")`
`14`	`14`	`}`