Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ferranabello/Viperit

Viper Framework for iOS using Swift
https://github.com/ferranabello/Viperit

carthage cocoapods swift swift-5 swift5 viper

Last synced: 3 months ago
JSON representation

Viper Framework for iOS using Swift

Awesome Lists containing this project

README 

        
![Viperit](/Assets/logo_light.png)



[![Language](https://img.shields.io/badge/swift-5.1-green.svg)](https://swift.org)

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

[![Platform](http://img.shields.io/badge/platform-ios-blue.svg)](https://developer.apple.com/iphone/index.action)

[![License](http://img.shields.io/badge/license-MIT-orange.svg)](http://mit-license.org)

[![Codecov](https://img.shields.io/codecov/c/github/ferranabello/Viperit.svg)](https://codecov.io/gh/ferranabello/Viperit)

[![codebeat badge](https://codebeat.co/badges/17d36823-4e6c-4b45-bad3-746611689636)](https://codebeat.co/projects/github-com-ferranabello-viperit-master)

[![CocoaPods](https://img.shields.io/cocoapods/v/Viperit.svg)](http://github.com/ferranabello/Viperit)

[![Carthage Compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![Accio](https://img.shields.io/badge/Accio-supported-0A7CF5.svg?style=flat)](https://github.com/JamitLabs/Accio)

[![Swift Package Manager compatible](https://img.shields.io/badge/Swift%20Package%20Manager-compatible-brightgreen.svg)](https://github.com/apple/swift-package-manager)

[![SwiftUI compatible](https://img.shields.io/badge/SwiftUI-compatible-green.svg)](https://developer.apple.com/xcode/swiftui/)



Write an iOS app following VIPER architecture. But in an **easy way**.



## Viper the easy way

We all know Viper is cool. But we also know that it's hard to setup. This library intends to simplify all that boilerplate process. If you don't know yet what Viper is, check this out: [Architecting iOS Apps with VIPER (objc.io)](https://www.objc.io/issues/13-architecture/viper/)



## Installation



### Requirements



- iOS 12.0+

- Swift 5.1+

- Xcode 12.0+



### Swift Package Manager (SPM)

You can easily install this framework using SPM on Xcode. Go to `File | Swift Packages | Add Package Dependency...` in Xcode and search for "http://github.com/ferranabello/Viperit"



### CocoaPods



[CocoaPods](https://cocoapods.org/) is a dependency manager for Cocoa projects.



Specify Viperit into your project's Podfile:



```ruby

source 'https://github.com/CocoaPods/Specs.git'

platform :ios, '12.0'

use_frameworks!



pod 'Viperit'

```



### Carthage



[Carthage](https://github.com/Carthage/Carthage) is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.



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



```ogdl

github "ferranabello/Viperit"

```



Run `carthage update` to build the framework and drag the built `Viperit.framework` into your Xcode project.



## Features



### Create modules easily using Xcode templates

Viperit Xcode templates can be downloaded from the [latest release](https://github.com/ferranabello/Viperit/releases) page. Download the **Templates.zip** file.



To install them, unzip the file, open your terminal and run:



```bash

cd PATH/TO/UNZIPPED/FOLDER

mkdir -p ~/Library/Developer/Xcode/Templates/

cp -R Viperit ~/Library/Developer/Xcode/Templates/

```



![Module Creation](/Assets/Instructions/module_creation.gif)



You can check "Also create a Storyboard file for module" if you want the storyboard file to be automatically created for you.

Choose between "Universal" to use just one view for phones and tablets, and "Dedicated Tablet View" if you want to have a separated view for tablet devices.



### Use storyboard, xib, programmatic views or SwiftUI

Any Viperit module will assume its view is loaded from a Storyboard by default. But you can use **storyboards**, **nibs**, **code** or even **SwiftUI** views! All you need to do is to override the variable *viewType* in your modules enum:



```swift

enum MySuperCoolModules: String, ViperitModule {

    case theStoryboardThing  

    case oldSchool

    case xibModule

    case whatTheSwift



    var viewType: ViperitViewType {

        switch self {

        case .theStoryboardThing: return .storyboard

        case .oldSchool: return .code

        case .xibModule: return .nib

        case .whatTheSwift: return .swiftUI

        }

    }

}

```



### Built-in router functions

This framework is very flexible, it's meant to be used in any way you want, but it has some useful built-in functionalities in the router that you could use:

```swift

    //Show your module as the root view controller of the given window

    func show(inWindow window: UIWindow?, embedInNavController: Bool, setupData: Any?, makeKeyAndVisible: Bool)



    //Show your module from any given view controller

    func show(from: UIViewController, embedInNavController: Bool, setupData: Any?)



    //Show your module inside another view

    func show(from containerView: UIViewController, insideView targetView: UIView, setupData: Any?)



    //Present your module modally

    func present(from: UIViewController, embedInNavController: Bool, presentationStyle: UIModalPresentationStyle, transitionStyle: UIModalTransitionStyle, setupData: Any?, completion: (() -> Void)?)

```



### Easy to test

You can test your module injecting mock layers like so:

```swift

    var module = AppModules.home.build()

    view = HomeMockView()

    view.expectation = expectation(description: "Test expectation")

    module.injectMock(view: view)

    ...

```



## Usage

Now, let's create our first Viperit module called "myFirstModule"!



### 0. Create your module files

Let's use the provided Xcode template to easily create all the needed classes for the module. Just click  **New file** in the document panel and choose between **Protocol-oriented module**,  **Object-oriented module** or **SwiftUI module** under the "Viperit" section.



### 1. Create a modules enum

You need at least one (you can use as many as you like, maybe to group modules by functionality) enum that implements the ViperitModule protocol to enumerate your application modules.

```swift

import Viperit



//MARK: - Application modules

enum AppModules: String, ViperitModule {

    case myFirstModule

}

```



### 2. Build the module and perform navigation

Imagine this is a new app and we want to load our "myFirstModule" module as the app's startup module

```swift

import Viperit



@UIApplicationMain

class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?



    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

        window = UIWindow(frame: UIScreen.main.bounds)

        let module = AppModules.myFirstModule.build()

        let router = module.router as! MyFirstModuleRouter

        router.show(inWindow: window)

        return true

    }

}

```

This is just an example, you could of course use your own router functions instead of the provided show(inWindow:):

```swift

    window = UIWindow(frame: UIScreen.main.bounds)

    let module = AppModules.myFirstModule.build()

    let router = module.router as! MyFirstModuleRouter

    router.mySuperCoolShowFunction(inWindow: window)

```



### 2.1. Are you using SwiftUI?

Let's say you created a module based on SwiftUI called 'Cool'.

All you need to do is to use the new Viperit SwiftUI module builder:



```swift

import SwiftUI

import Viperit



//A sample function that could be implemented in some Router to show your Cool SwiftUI module

//You can even inject an @EnvironmentObject view model to your SwiftUI view.

func showTheCoolModule() {

  let module = AppModules.cool.build { presenter -> (CoolView, UserSettings) in

      let p = presenter as! CoolPresenterApi

      let settings = p.settings()

      return (CoolView(presenter: p), settings)

  }

  let router = module.router as! CoolRouter

  router.show(from: viewController)

}

```



Check the example app to have a better understanding of how it works, and how to manage data flow on SwiftUI with the presenter.



### 3. Follow the Viper flow

Everything is ready for you to make great things the Viper way!

Clone the repo and run the 'Example' target to see it in action! Or just try it with Cocoapods:

```ruby

pod try Viperit

```



## Author



[Ferran AbellĂł](https://www.github.com/ferranabello "Ferran AbellĂł Github")



## License



Viperit is released under [MIT license](https://raw.githubusercontent.com/ferranabello/viperit/master/LICENSE) and copyrighted by Ferran AbellĂł.