/VIPERModuleTemplate

Template of VIPER Module for Xcode

Primary LanguageSwiftMIT LicenseMIT

Swift_Version GitHub stars GitHub issues GitHub license

Once you decided to use VIPER architecture in your app, you shound know about routine. For each screen/module you should creat at least 6 files. Imagine that you need to create 10 modules. To avoid this boring work you can use this template which help you generate compete module. It's very useful for me and I hope this template can be useful for you too.

Generated files

This template generates all files that you need to create a new VIPER module. All generated code is Swift 4 compatible.

File Name Acts As Description
ModuleNameViewController.swift View UIViewController of your module.
ModuleNameInteractor.swift Interactor This is what will communicate with the Data Layer.
ModuleNamePresenter.swift Presenter This is what will communicate with the View and the Interactor.
ModuleNameRouter.swift Router This is where your routes to another module should be.
ModuleNameViewController.xib ViewControllerXib If you use Xibs, you can use it for layout.
ModuleNameAssembly.swift Assembly This is the Assembly, should build module.
ModuleNameModuleAPI.swift API This is the API, file with all protocols of your module

How to install

Using script (easy)

Only need execute this command in terminal:

sudo swift install.swift

You should be this output message:

✅ VIPER Template succesfully installed.

If all it's ok you now could find your template in Xcode.

Manual

Go to Application folder, browse to the Xcode application icon. Right-click it and choose 'Show Package Contents'. Then browse to: Contents/Developer/Platforms/iPhoneOS.platform/Developer/Library/Xcode/Templates/File Templates/Architecture and add "VIPER Module.xctemplate" file. Now you can find your template in Xcode.

Easy to use

VIPER Diagram overview

Preview

VIPER Checklist

To get started easier, we’ve prepared a list of notes to make sure everything follows the VIPER’s design principle. We hope this will be useful to you also as we find it to be.

  • Views and view controllers receive user interactions and pass them to presenters for decision making.
  • Presenters contain the view logics and prepare content for display and reacting to user inputs.
  • Presenters should not know about the existence of all UIViewController.
  • Interactors contain business logics and they should be independent of UI..

What is VIPER?

VIPER is not a framework but an approach to iOS application architecture, which stands for:

VIEW

View controller. It is responsible to receive user interactions and pass them to presenters for decision making. To keep the view simple, it shouldn’t contain any view logics. This is where to define how the view looks like, and nothing beyond this.

PRESENTER

The presenter defines the view logics, e.g. when to show a warning message or highlight a button. It is responsible to prepare content for the view to display. Whenever data is required, the presenter requests data from interactors (but not directly from the model).

INTERACTOR

The interactor mainly contains business logic, e.g. logging in the user / processing a purchase / sending a friend request. It should be independent of the UI. It only handles requests from the presenter and prepare corresponding data regardless of how the view looks like.

ROUTER

Router defines the routes from one screen to another. In VIPER, the responsibility for Routing is shared between the presenter and the wireframe. When the presenter receives user interactions and decided to navigate to another screen, it will use the wireframe to perform the desired navigation (to which screen and how to navigate). The wireframe can also contain transition animations.

ASSEMBLY

Assembly builds the modules with inpurt params and links all layers. Should connect Presenter with View, Router and Interactor, Interactor with Presenter, View with Presener. Should setup input data of module and can return module Input if needed.

Why VIPER?

After using VIPER, I've found it to be very beneficial in many ways. Let’s get back to the list of things we set out to accomplish when architecting our app to see if VIPER addresses them.

  • Single responsibility principles applied.
  • Easy to iterate on.
  • Collaboration friendly.
  • Separated out concerns.
  • Spec-ability.
  • Testability.

Next steps

Would you like decide what will be the next feature?

  • Storyboard support
  • Separated iPhone & iPad UI

References

Contributed

This is an open source project, so feel free to contribute.

Authors