Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaakati/viper-module-generator
A Swift 4.2 VIPER Module Boilerplate Generator with predefined functions and a BaseViewProtocol.
https://github.com/kaakati/viper-module-generator
ios ios-app ios-swift swift swift-3 swift-4 swift-4-2 viper viper-architecture viper-modules viper-pattern-architecture viper-template viper-templates-swift
Last synced: about 1 month ago
JSON representation
A Swift 4.2 VIPER Module Boilerplate Generator with predefined functions and a BaseViewProtocol.
- Host: GitHub
- URL: https://github.com/kaakati/viper-module-generator
- Owner: Kaakati
- License: mit
- Created: 2018-07-16T12:55:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-07-13T13:03:21.000Z (over 3 years ago)
- Last Synced: 2024-10-12T14:40:18.323Z (about 1 month ago)
- Topics: ios, ios-app, ios-swift, swift, swift-3, swift-4, swift-4-2, viper, viper-architecture, viper-modules, viper-pattern-architecture, viper-template, viper-templates-swift
- Language: Swift
- Homepage:
- Size: 7.06 MB
- Stars: 75
- Watchers: 3
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://badges.pufler.dev)
[](https://github.com/Kaakati/VIPER-Module-Generator/stargazers)
[](https://github.com/Kaakati/VIPER-Module-Generator/issues)
[](https://github.com/Kaakati/VIPER-Module-Generator/blob/master/LICENSE)
> Perfection is achieved, not when there is nothing more to add, but when there is nothing left to take away.
----
Are you new to VIPER Design Pattern? Want to Learn it But feel overwhelmed of all the files you have to create?
When you decide to use VIPER architecture in your project, it feels overwhelming to create new modules, because you need create at least 5 files for each. Imagine that you need to create 6 modules...We were suffering of this problem, and this is the reason why We've created this template. It's very useful for us and I hope that it be useful for you too.
## Available Generator options:
* [x] BaseViewProtocol - A Common Functions Placeholder.
* [x] With Generic Functions & Shortname - Fullname filenames - check Table below for shortnames.
* [x] With Generic Functions - Protocols with Generic Functions ready for implementation.
* [x] Without Generic Functions.
### UI Ready implementation.
* [x] Both Options With & Without Generic Functions contains a UI file ready for Implemntation.
## Generated files
This template generates all files that you need to create a new VIPER module. All generated code is Swift 3.2 & Swift 4 compatible.
#### The Fullname dropdown will Generate full filenames with Generic Functions.
#### Other Dropdown Selections With OR Without Generic Functions.
| File Name | Acts As | Description |
| :--- | :--- | :--- |
| `VYourFileNameUI.swift` | UIView | This is where your design layout should be. |
| `CYourFileName.swift` | Contract | This is where all your VIPER protocols should be implemented. |
| `VYourFileName.swift` | View | If you use Storyboard, Link this to it and ignore UI file. |
| `IYourFileName.swift` | Interactor | This is what will communicate with the Data Layer and Entity. |
| `PYourFileName.swift` | Presenter | This is what will communicate with the View and the Interactor. |
| `EYourFileName.swift` | Entity | This is the Entity, It's should be a String respresntation of your Model. |
| `RYourFileName.swift` | Router | This is where your routes to another views should be. |
#### BaseViewProtocol Option.
| File Name | Acts As | Description |
| :--- | :--- | :--- |
| `BaseViewProtocol.swift` | UIViewController | This where application wide UI Loaders OR TabBar should be. |
## How to install
#### Using script (easy)
Only need execute this command in terminal:
```swift
sudo swift install.swift
```
You should be this output message:
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/Project Templates/iOS/Application` and add "VIPER Module.xctemplate" file. Now you can find your template in Xcode.
## Easy to use
## VIPER diagram overview
## 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 UIViews.
* [ ] Interactors contain business logics and they should be independent of UI.
* [ ] Entities are model objects manipulated by Interactors.
* [ ] Wireframe is the only place to define screen navigations and their transition animations.
* [ ] Contracts contains all my functions that I'll use for the project.
## What is VIPER?
VIPER is not a framework but an approach to iOS application architecture, which stands for:
#### VIEW
>The view consists of views and view controllers. 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.
#### ENTITY
>Entities are the model objects manipulated by an Interactor and only by the Interactor. It is simply a Struct. It is model orientated and therefore should not contain any business logic, Entity is not the Model, it's a represntation of the Model.
#### ROUTING (WIREFRAME)
>Wireframe 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.
## 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?
* [x] Create bash script to install more easy.
* [x] Divide Interactor protocol (Input & Output) (**NEW!** Version 1.1).
* [x] Swift 4.2 & XCode 10 (**NEW!** Version 1.4).
* [ ] Create Data Layer for Interactor Implementations.
* [ ] Create a Tutorial on how VIPER Works and how to Implement it in a real-life project.
## References
- [iOS Architecture Patterns](https://medium.com/ios-os-x-development/ios-architecture-patterns-ecba4c38de52#.ba7q8dcih)
- [#8 VIPER to be or not to be?](https://swifting.io/blog/2016/03/07/8-viper-to-be-or-not-to-be/)
- [https://www.objc.io/issues/13-architecture/viper/](https://www.objc.io/issues/13-architecture/viper/)
- [https://www.ckl.io/blog/ios-project-architecture-using-viper/](https://www.ckl.io/blog/ios-project-architecture-using-viper/)
## Contributed
This is an open source project, so feel free to contribute.
- Open an [issue](https://github.com/Kaakti/VIPER-Module-Generator/issues/new).
----
> The knowledge that I own today is because of my parents support, What I am today is because of their efforts & hardwork providing the best, Thank you Mom & Dad :heart:.
## Authors
* [Mohamad Kaakati](https://www.twitter.com/kaakati)
* [Qutaibah Essa](https://www.twitter.com/qutaibah)