• Stars
    star
    143
  • Rank 257,007 (Top 6 %)
  • Language
    Swift
  • License
    MIT License
  • Created almost 6 years ago
  • Updated over 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Protocols that help make your MVVM setup more consistent

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 ScopedDisposable: ViewModelOwnerDisposeBagProtocol where Inner == CompositeDisposable {
    public convenience init() {
        self.init(CompositeDisposable())
    }

    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) {
        inner.add(Wrapper(disposable))
    }
}

and you can now use ViewModelOwners with the ReactiveSwift:

func didSetViewModel(_ viewModel: ViewModel, disposeBag: ScopedDisposable<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.

More Repositories

1

Sourcery

Meta-programming for Swift, stop writing boilerplate code.
Swift
7,677
star
2

LifetimeTracker

Find retain cycles / memory leaks sooner.
Swift
3,144
star
3

Playgrounds

Better playgrounds that work both for Objective-C and Swift
Objective-C
2,633
star
4

Inject

Hot Reloading for Swift applications!
Swift
2,127
star
5

Swift-Macros

A curated list of awesome Swift Macros
Swift
2,120
star
6

Bootstrap

iOS project bootstrap aimed at high quality coding.
Objective-C
2,047
star
7

LineDrawing

Beatiful and fast smooth line drawing algorithm for iOS - as seen in Foldify.
Objective-C
1,288
star
8

Difference

Simple way to identify what is different between 2 instances of any type. Must have for TDD.
Swift
1,217
star
9

PropertyMapper

Property mapping for Objective-C iOS apps.
Objective-C
1,124
star
10

KZFileWatchers

A micro-framework for observing file changes, both local and remote. Helpful in building developer tools.
Swift
1,078
star
11

LinkedConsole

Clickable links in your Xcode console, so you never wonder which class logged the message.
Swift
931
star
12

Traits

Modify your native iOS app in real time.
Swift
904
star
13

IconOverlaying

Build informations on top of your app icon.
Shell
650
star
14

crafter

Crafter - Xcode project configuration CLI made easy.
Ruby
547
star
15

Strongify

Strongify is a 1-file µframework providing a nicer API for avoiding weak-strong dance.
Swift
444
star
16

KZNodes

Have you ever wonder how you could make Origami like editor in 1h ?
Objective-C
336
star
17

SFObservers

NSNotificationCenter and KVO auto removal of observers.
Objective-C
307
star
18

AutomaticSettings

Data driven settings UI generation.
Swift
302
star
19

CCNode-SFGestureRecognizers

Adding UIGestureRecognizers to cocos2d, painless.
Objective-C
202
star
20

DetailsMatter

Objective-C
199
star
21

Pinch-to-reveal

Pinch to reveal animation transition built with Layer masking, as seen in boeing app for iPad.
Objective-C
192
star
22

KZAsserts

Asserts on roids, test all your assumptions with ease.
Objective-C
100
star
23

OhSnap

Reproduce bugs your user saw by capturing and replaying data snapshots with ease.
Swift
89
star
24

Versionable

Migration for `Codable` objects.
Swift
83
star
25

SFContainerViewController

UIViewControllers containment predating Apple implementation. Works in both 4.x and 5.x iOS, no memory or hierarchy issues.
Objective-C
82
star
26

Swift-Observable

Native KVO like behaviour build in Swift.
Swift
64
star
27

BehavioursExample

Objective-C
58
star
28

SourceryWorkshops

Swift
45
star
29

Learn-iOS-GameDev-Level-0

Teeter clone accompanying tutorial at http://merowing.info/2013/04/learn-ios-game-dev-level-0/
Objective-C
24
star
30

XibReferencing

Simple category and sample showing how you can reference one Xib view from another
Objective-C
20
star
31

KZImageSplitView

Objective-C
17
star
32

NSObject-SFExecuteOnDealloc

A simple category on NSObject that allows you to execute block when object is deallocated
Objective-C
17
star
33

jenkins_jobs_to_statusboard

Ruby script that generates html table for embedding in StatusBoard by Panic http://panic.com/statusboard/
Ruby
15
star
34

SourceryPro-Feedback

Repository for discussing https://merowing.info/sourcery-pro/
12
star
35

krzysztofzablocki

2
star
36

krzysztofzablocki.github.io

Blog
HTML
2
star
37

starter-hugo-academic

Jupyter Notebook
1
star