https://github.com/etsy/VIPERBuilder

Scaffolding for building apps in a clean way with VIPER architecture
https://github.com/etsy/VIPERBuilder

etsy ios ios-swift non-sox viper viper-architecture

Last synced: about 1 month ago
JSON representation

Scaffolding for building apps in a clean way with VIPER architecture

• Host: GitHub
• URL: https://github.com/etsy/VIPERBuilder
• Owner: etsy
• License: apache-2.0
• Created: 2017-11-27T18:08:00.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-13T17:52:12.000Z (almost 5 years ago)
• Last Synced: 2024-07-21T18:55:47.317Z (about 2 months ago)
• Topics: etsy, ios, ios-swift, non-sox, viper, viper-architecture
• Language: Swift
• Homepage:
• Size: 80.1 KB
• Stars: 41
• Watchers: 16
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VIPERBuilder

![](https://img.shields.io/badge/platform-ios-lightgrey.svg)

![](https://img.shields.io/badge/swift-5.0-brightgreen.svg)

[![Build Status](https://travis-ci.org/etsy/VIPERBuilder.svg?branch=master)](https://travis-ci.org/etsy/VIPERBuilder)

[![codecov.io](http://codecov.io/github/etsy/VIPERBuilder/branch/master/graphs/badge.svg)](http://codecov.io/github/etsy/VIPERBuilder)

[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1729/badge)](https://bestpractices.coreinfrastructure.org/projects/1729)

Scaffolding for building apps in a clean way with VIPER architecture.

- [What is VIPER?](https://medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52#.us2szxd78).

- [How does Etsy use VIPER?](https://codeascraft.com/2017/12/11/viper-on-ios-at-etsy/)

- [Check out VIPERBuilder on FLOSSWeekly](https://twit.tv/shows/floss-weekly/episodes/476?autostart=false)

VIPER inherently has a few problems:

* Boilerplate

* Potential retain cycles due to management of many classes

* Cognitive overhead of setup

This framework aims to address those problems by providing a set of base classes to divide your app's functionality and builder object to manage the connections.

## Installation

### Cocoapod

Add `pod VIPERBuilder` to your Podfile

Run `pod install`

## Usage

1. Create subclasses of `VIPERInteractor`, `VIPERPresenter` and `VIPERRouter` as needed

2. Create a strong reference to an instance of `VIPERBuilder` with the new subclasses specified. Lazy loading in Swift will ensure that the builder object is available as soon as it is called

	lazy var viperBuilder: VIPERBuilder = {

	    return VIPERBuilder(controller: self)

	}()

Note: If not all classes are needed for the implementation passing the superclass to the Builder object is supported

For a more detailed implementation, please check out the demo project included in this repo

## Code Separation

This framework provides three base classes for the three main parts of VIPER: Interactor, Presenter, Router. Each class should contain certain pieces of code and has references to other classes for specific reasons, however these can be extended through subclassing.

---

#### Interactor

##### Purpose

* User interaction (directly and through delegation from other classes)

* Data fetching/mutation

###### Reference usages

* Presenter: should be used to update view after fetching or mutating data

* Router: Used for navigation based on actions taken

---

#### Presenter

##### Purpose

* Configuring view/view model (entity objects)

* Presenting modals/loading screens

###### Reference usages

* Controller: Presenting modals/error messages

* Interactor: Can be used as a delegate for any actions from views

---

#### Router

##### Purpose

* Navigation (pushing views onto UINavigationController's stack)

###### Reference usages

* Navigation controller: Used for pushing screens

---