Viper Module Generator ↑

Gem to generate VIPER modules to use them in your Objective-C/Swift projects The implementation scheme returned by this generator is hardly inspired in the example and post of Objc.io, www.objc.io/issue-13/viper.html .

Features ↑

Changelog 0.1.6 ↑

Changelog 0.1 ↑

Changelog 0.2.3 ↑

-

Expected in version 0.3 ↑

Viper files structure ↑

.objc
+-- DataManager
|   +-- VIPERDataManager.h
|   +-- VIPERDataManager.m
+-- Interactor
|   +-- VIPERInteractor.h
|   +-- VIPERInteractor.m
|   +-- VIPERInteractorSpec.m
+-- Presenter
|   +-- VIPERPresenter.h
|   +-- VIPERPresenter.m
|   +-- VIPERPresenterSpec.m
+-- ViewController
|   +-- VIPERViewController.h
|   +-- VIPERViewController.m
|   +-- VIPERViewControllerSpec.m
+-- WireFrame
|   +-- VIPERWireFrame.h
|   +-- VIPERWireFrame.m
+-- Protocols
|   +-- VIPERProtocols.h
.swift
+-- DataManager
|   +-- VIPERDataManager.swift
+-- Interactor
|   +-- VIPERInteractor.swift
|   +-- VIPERInteractorTests.swift
+-- Presenter
|   +-- VIPERPresenter.swift
|   +-- VIPERPresenterTests.swift
+-- View
|   +-- VIPERView.swift
|   +-- VIPERViewTests.swift
+-- WireFrame
|   +-- VIPERWireFrame.swift
+-- Protocols
|   +-- VIPERProtocols.swift

How to install vipergen ? ↑

You can install it easily as using the gem. With ruby installed in your OSX execute:

sudo gem install vipergen-xctestable

If everything were right, you should have now the vipergem command available in your system console

How to generate a VIPER module with a given name? ↑

You have just to execute the following command

vipergen generate MyFirstViperModule --path=~/myproject/shared

And then the files structure will be automatically created. Don't forget to add this folder to your project dragging it into the XCode/Appcode inspector

What options are available in generator? ↑

You have just to execute the following command

vipergen help generate

And then you will see all options available

Sample:

vipergen-xctestable generate <Module_Name> --path=<Path> --language=swift --author='michal' --template=testable --swift-module <MY_Project>

How can I try the demo project? ↑

  1. Clone the repo git clone https://github.com/pepibumur/viper-module-generator.git

  2. Move into the repo folder and update the git submodules git sumodule update --init

  3. In the folder VIPERGenDemo install the pods pod install

  4. Open the project from the VIPERGenDemo.xcworkspace file

  5. Enjoy it!

Developer tips ↑

Update the gem ↑

When the gem is updated it has to be reported to the gem repository. I followed this tutorial amaras-tech.co.uk/article/43/Creating_executable_gems that basically says that once you have your gem ready execute:

gem build vipergen.gemspec
gem install vipergen-xctestable-0.3.0.gem
gem push vipergen-xctestable-0.3.0.gem

Then you'll be asked for your credentials in order to make the update in the repo (guides.rubygems.org/publishing/)

Add a new template ↑

Are you interested in VIPER and you would like to contribute with this gem adding new templates? Feel free to do it. It's pretty easy. You've just to: - Create a folder inside templates with the name of your template - You'll have to create inside the templates in both languages, Swift and Objective-C (get inspired from existing templates) - Use the word VIPER where you want the name to be replaced in. - Remember to add the file viperspec.yml with the description of your template as below:

author: pepi
author_email: pepibumur@gmail.com
template_description: Default template with the simplest structure using VIPER
updated_at: 2014-08-24

Available Templates ↑

Resources ↑

Contact ↑

If you have any doubt about the gem or even if you want to make any suggestion you can do it directly to my email address, pedro@redbooth.com . You can use the issues Github page too