Fork me on GitHub

Alex Rupérez

Link: http://j.mp/2UJGbho
Published: 05 Feb 16:13
I starred krzysztofzablocki/ViewModelOwners at GitHub.
Protocols that help make your MVVM setup more consistent
View on GitHub


View README


ViewModelOwners

Platforms License

Carthage compatible CocoaPods compatible

Travis

µframework that will simplify your MVVM integration and help manage subscription for side-effects.

  • No need to create viewModel property
  • Don't need to deal with nil state if programmer forgot to set viewModel using setter injection (for Reusable views)
  • Automatic management of subscriptions (via Disposable containers)
  • Consistent architecture / side-effects design that opens up door for useful dev tooling
class MyViewController: UIViewController, NonReusableViewModelOwner {
    func didSetViewModel(_ vm: MyViewModelProtocol, disposeBag: DisposeBag) {
        ...
    }
}

Read my blog post for details about this technique

To avoid triggering view loading, you can use following pattern:

class MyViewController: UIViewController, NonReusableViewModelOwner {
    func didSetViewModel(_ vm: MyViewModelProtocol, disposeBag: DisposeBag) {
        guard isViewLoaded else { return }
        ...
    }
    
    override func viewDidLoad() {
        super.viewDidLoad()
        reconfigureViewModel()
    }
}

Requirements

  • iOS 8.0+ / Mac OS X 10.10+ / tvOS 9.0+ / watchOS 2.0+
  • Xcode 10.0+

Installation

Dependency Managers

CocoaPods

CocoaPods is a dependency manager for Cocoa projects. You can install it with the following command:

$ gem install cocoapods

To integrate ViewModelOwners into your Xcode project using CocoaPods, specify it in your Podfile:

source 'https://github.com/CocoaPods/Specs.git'
platform :ios, '8.0'
use_frameworks!

pod 'ViewModelOwners', '~> 1.0.0'

Then, run the following command:

$ pod install
Carthage

Carthage is a decentralized dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate ViewModelOwners into your Xcode project using Carthage, specify it in your Cartfile:

github "krzysztofzablocki/ViewModelOwners" ~> 1.0.0

Manually

If you prefer not to use either of the aforementioned dependency managers, you can integrate ViewModelOwners into your project manually.

Git Submodules

  • Open up Terminal, cd into your top-level project directory, and run the following command "if" your project is not initialized as a git repository:
$ git init
  • Add ViewModelOwners as a git submodule by running the following command:
$ git submodule add https://github.com/krzysztofzablocki/ViewModelOwners.git
$ git submodule update --init --recursive
  • Open the new ViewModelOwners folder, and drag the ViewModelOwners.xcodeproj into the Project Navigator of your application's Xcode project.

    It should appear nested underneath your application's blue project icon. Whether it is above or below all the other Xcode groups does not matter.

  • Select the ViewModelOwners.xcodeproj in the Project Navigator and verify the deployment target matches that of your application target.

  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.

  • In the tab bar at the top of that window, open the "General" panel.

  • Click on the + button under the "Embedded Binaries" section.

  • You will see two different ViewModelOwners.xcodeproj folders each with two different versions of the ViewModelOwners.framework nested inside a Products folder.

    It does not matter which Products folder you choose from.

  • Select the ViewModelOwners.framework.

  • And that's it!

The ViewModelOwners.framework is automagically added as a target dependency, linked framework and embedded framework in a copy files build phase which is all you need to build on the simulator and a device.

Embedded Binaries

  • Download the latest release from https://github.com/krzysztofzablocki/ViewModelOwners/releases
  • Next, select your application project in the Project Navigator (blue project icon) to navigate to the target configuration window and select the application target under the "Targets" heading in the sidebar.
  • In the tab bar at the top of that window, open the "General" panel.
  • Click on the + button under the "Embedded Binaries" section.
  • Add the downloaded ViewModelOwners.framework.
  • And that's it!

Integration

RxSwift

Simply add this anywhere in your project to make Swift happy:

extension DisposeBag: ViewModelOwnerDisposeBagProtocol {
    private final class DisposableWrapper: Disposable {
        let disposable: ViewModelOwnerDisposable
        
        init(_ disposable: ViewModelOwnerDisposable) {
          self.disposable = disposable
        }

        func dispose() {
            disposable.dispose()
        }
    }

    public func add(_ disposable: ViewModelOwnerDisposable) {
        insert(DisposableWrapper(disposable: disposable))
    }
}

and you can now use ViewModelOwners with the RxSwift disposables:

func didSetViewModel(_ viewModel: ViewModel, disposeBag: DisposeBag) {

ReactiveSwift

Simply add this anywhere in your project to make Swift happy:

extension CompositeDisposable: ViewModelOwnerManualDisposeBagProtocol {
    private final class Wrapper: Disposable {
        var isDisposed: Bool
        let disposable: ViewModelOwnerDisposable

        init(_ disposable: ViewModelOwnerDisposable) {
            self.disposable = disposable
            isDisposed = false
        }

        func dispose() {
            disposable.dispose()
            isDisposed = true
        }
    }

    public func add(_ disposable: ViewModelOwnerDisposable) {
        add(Wrapper(disposable))
    }
}

and you can now use ViewModelOwners with the ReactiveSwift:

func didSetViewModel(_ viewModel: ViewModel, disposeBag: CompositeDisposable) {

Other libraries

You simply need to conform LibraryDisposeBag object to either ViewModelOwnerManualDisposeBagProtocol or ViewModelOwnerManualDisposeBagProtocol.

Note: use manual variant if your DisposeBag container doesn't automatically dispose on dealloc.:

You can use it in your code:

func didSetViewModel(_ viewModel: ViewModel, disposeBag: LibraryDisposeBag) {

Usage

Contributing

Issues and pull requests are welcome!

Author

Krzysztof Zablocki @merowing_

License

ViewModelOwners is released under the MIT license. See LICENSE for details.