vipergen-xctestable 0.2.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a71f6a94281f10015bf3348df55987ad188ff13
+  data.tar.gz: 2036ddb12d9e6b788224d3e615fdb08da9bb84e6
+SHA512:
+  metadata.gz: 1438cf8e5b1063abd554f3e9b847927601367314a45b443d48e685a14608c219f5bfb3e41ee8cd8c850950ea757822b7307707d6243c75761edae0c134f6ca19
+  data.tar.gz: 6b75244efed57001fa71839e4f61ea87b7ccbe6f556090361b7ea1393a442b3d3da7f0b88284a4a08bd58e401fe15226289590bb5c6943a0547b483c188c36c3

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Redbooth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,157 @@
+Viper Module Generator
+======================
+[![Code Climate](https://codeclimate.com/github/teambox/viper-module-generator/badges/gpa.svg)](https://codeclimate.com/github/teambox/viper-module-generator)
+[![Build Status](https://travis-ci.org/teambox/viper-module-generator.svg?branch=master)](https://travis-ci.org/teambox/viper-module-generator)
+[![Test Coverage](https://codeclimate.com/github/teambox/viper-module-generator/badges/coverage.svg)](https://codeclimate.com/github/teambox/viper-module-generator)
+[![Dependency Status](https://gemnasium.com/teambox/viper-module-generator.svg)](https://gemnasium.com/teambox/viper-module-generator)
+
+
+![image](http://www.objc.io/images/issue-13/2014-06-07-viper-intro.jpg)
+
+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, http://www.objc.io/issue-13/viper.html .
+
+- [Features](#features)
+  - [Changelog](#changelog-0.1)
+  - [Expected in version 0.2](#expected-in-version-0.2)
+- [Viper files structure](#viper-files-structure)
+- [How to install vipergen](#how-to-install-vipergen)
+- [How to generate a VIPER module with a given name?](#how-to-generate-viper-module-with-a-given-name?)
+- [Developer tips](#developer-tips)
+  - [Update the gem](#update-the-gem)
+  - [Add a new template](#add-a-new-template)
+- [Resources](#resources)
+
+## Features
+- Generates the module in Swift and Objective-C
+- Ready to be installed as a gem https://rubygems.org/gems/VIPERGen
+
+### Changelog 0.1.6
+- Added `templates` command to know which templates are available
+- YAML file in each template with the information about the template (more scalable)
+
+### Changelog 0.1
+- Added default template
+- Fully components tested
+
+### Changelog 0.2.3
+- VIPER Example using the Twitter API 
+- Default template implemented in Swift
+- 
+
+### Expected in version 0.3
+- Integrate with XCode as a plugin (http://nshipster.com/xcode-plugins/)
+
+## Viper files structure
+```bash
+.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
+|   +-- VIPERInteractorSpec.swift
++-- Presenter
+|   +-- VIPERPresenter.swift
+|   +-- VIPERPresenterSpec.swift
++-- View
+|   +-- VIPERView.swift
+|   +-- VIPERViewSpec.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:
+```bash
+sudo gem install vipergen-roche
+```
+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
+```bash
+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
+```bash
+vipergen help generate
+```
+And then you will see all options available
+
+Sample:
+```bash
+vipergen 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 http://amaras-tech.co.uk/article/43/Creating_executable_gems that basically says that once you have your gem ready execute:
+```bash
+gem build vipergen.gemspec
+gem install vipergen-0.1.gem
+gem push vipergen-0.1.gem
+```
+Then you'll be asked for your credentials in order to make the update in the repo (http://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:
+```yaml
+author: pepi
+author_email: pepibumur@gmail.com
+template_description: Default template with the simplest structure using VIPER
+updated_at: 2014-08-24
+```
+- Report it as a PR in this repo updating the gem version in Gemspec.
+
+### Available Templates
+- default by pepimbur
+- testable by wojtysim (includes Spec file templates for Interactor, Presenter and View)
+
+## Resources
+- Redbooth presentation: https://speakerdeck.com/sergigracia/clean-architecture-viper
+- Rspec documentation: http://rubydoc.info/gems/rspec-expectations/frames
+- XCode Plugins: http://nshipster.com/xcode-plugins/
+- XCodeProj gem (to modify project groups structure): https://github.com/CocoaPods/Xcodeproj
+- Thor, powerful Ruby library for command line: http://whatisthor.com/
+- Cocoa Design Patters: https://developer.apple.com/legacy/library/documentation/Cocoa/Conceptual/CocoaFundamentals/CocoaDesignPatterns/CocoaDesignPatterns.html
+
+## 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

data/bin/vipergen

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+#require 'rubygems'
+require 'vipergen/viperthor'
+
+puts "------- VIPER GENERATOR---------\n"
+puts ARGV
+Vipergen::ViperThor.start(ARGV)
+puts "--------------------------------\n"

data/lib/templates/default/objc/DataManager/API/VIPERAPIDataManager.h

@@ -0,0 +1,12 @@
+//
+// Created by AUTHOR.
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+
+@interface VIPERAPIDataManager : NSObject <VIPERAPIDataManagerInputProtocol>
+
+@end

data/lib/templates/default/objc/DataManager/API/VIPERAPIDataManager.m

@@ -0,0 +1,10 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERAPIDataManager.h"
+
+@implementation VIPERAPIDataManager
+
+@end

data/lib/templates/default/objc/DataManager/Local/VIPERLocalDataManager.h

@@ -0,0 +1,12 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+
+@interface VIPERLocalDataManager : NSObject <VIPERLocalDataManagerInputProtocol>
+
+@end

data/lib/templates/default/objc/DataManager/Local/VIPERLocalDataManager.m

@@ -0,0 +1,10 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERLocalDataManager.h"
+
+@implementation VIPERLocalDataManager
+
+@end

data/lib/templates/default/objc/Interactor/VIPERInteractor.h

@@ -0,0 +1,16 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+
+@interface VIPERInteractor : NSObject <VIPERInteractorInputProtocol>
+
+@property (nonatomic, weak) id <VIPERInteractorOutputProtocol> presenter;
+@property (nonatomic, strong) id <VIPERAPIDataManagerInputProtocol> APIDataManager;
+@property (nonatomic, strong) id <VIPERLocalDataManagerInputProtocol> localDataManager;
+
+@end

data/lib/templates/default/objc/Interactor/VIPERInteractor.m

@@ -0,0 +1,10 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERInteractor.h"
+
+@implementation VIPERInteractor
+
+@end

data/lib/templates/default/objc/Interactor/VIPERItem.h

@@ -0,0 +1,10 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+
+@interface VIPERItem : NSObject
+
+@end

data/lib/templates/default/objc/Interactor/VIPERItem.m

@@ -0,0 +1,10 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERItem.h"
+
+@implementation VIPERItem
+
+@end

data/lib/templates/default/objc/Presenter/VIPERPresenter.h

@@ -0,0 +1,17 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+@class VIPERWireFrame;
+
+@interface VIPERPresenter : NSObject <VIPERPresenterProtocol, VIPERInteractorOutputProtocol>
+
+@property (nonatomic, weak) id <VIPERViewProtocol> view;
+@property (nonatomic, strong) id <VIPERInteractorInputProtocol> interactor;
+@property (nonatomic, strong) id <VIPERWireFrameProtocol> wireFrame;
+
+@end

data/lib/templates/default/objc/Presenter/VIPERPresenter.m

@@ -0,0 +1,11 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERPresenter.h"
+#import "VIPERWireframe.h"
+
+@implementation VIPERPresenter
+
+@end

data/lib/templates/default/objc/Protocols/VIPERProtocols.h

@@ -0,0 +1,80 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import <UIKit/UIKit.h>
+
+@protocol VIPERInteractorOutputProtocol;
+@protocol VIPERInteractorInputProtocol;
+@protocol VIPERViewProtocol;
+@protocol VIPERPresenterProtocol;
+@protocol VIPERLocalDataManagerInputProtocol;
+@protocol VIPERAPIDataManagerInputProtocol;
+
+
+@class VIPERWireFrame;
+
+@protocol VIPERViewProtocol
+@required
+@property (nonatomic, strong) id <VIPERPresenterProtocol> presenter;
+/**
+ * Add here your methods for communication PRESENTER -> VIEWCONTROLLER
+ */
+@end
+
+@protocol VIPERWireFrameProtocol
+@required
++ (void)presentVIPERModuleFrom:(id)fromView;
+/**
+ * Add here your methods for communication PRESENTER -> WIREFRAME
+ */
+@end
+
+@protocol VIPERPresenterProtocol
+@required
+@property (nonatomic, weak) id <VIPERViewProtocol> view;
+@property (nonatomic, strong) id <VIPERInteractorInputProtocol> interactor;
+@property (nonatomic, strong) id <VIPERWireFrameProtocol> wireFrame;
+/**
+ * Add here your methods for communication VIEWCONTROLLER -> PRESENTER
+ */
+@end
+
+@protocol VIPERInteractorOutputProtocol
+/**
+ * Add here your methods for communication INTERACTOR -> PRESENTER
+ */
+@end
+
+@protocol VIPERInteractorInputProtocol
+@required
+@property (nonatomic, weak) id <VIPERInteractorOutputProtocol> presenter;
+@property (nonatomic, strong) id <VIPERAPIDataManagerInputProtocol> APIDataManager;
+@property (nonatomic, strong) id <VIPERLocalDataManagerInputProtocol> localDataManager;
+/**
+ * Add here your methods for communication PRESENTER -> INTERACTOR
+ */
+@end
+
+
+@protocol VIPERDataManagerInputProtocol
+/**
+ * Add here your methods for communication INTERACTOR -> DATAMANAGER
+ */
+@end
+
+@protocol VIPERAPIDataManagerInputProtocol <VIPERDataManagerInputProtocol>
+/**
+ * Add here your methods for communication INTERACTOR -> APIDATAMANAGER
+ */
+@end
+
+@protocol VIPERLocalDataManagerInputProtocol <VIPERDataManagerInputProtocol>
+/**
+ * Add here your methods for communication INTERACTOR -> LOCLDATAMANAGER
+ */
+@end
+
+

data/lib/templates/default/objc/View/VIPERView.h

@@ -0,0 +1,13 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <UIKit/UIKit.h>
+#import "VIPERProtocols.h"
+
+@interface VIPERView : UIViewController <VIPERViewProtocol>
+
+@property (nonatomic, strong) id <VIPERPresenterProtocol> presenter;
+
+@end

data/lib/templates/default/objc/View/VIPERView.m

@@ -0,0 +1,32 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERView.h"
+
+@implementation VIPERView
+
+#pragma mark - ViewController Lifecycle
+
+- (void)viewDidLoad
+{
+    [super viewDidLoad];
+}
+
+- (void)viewDidDisappear:(BOOL)animated
+{
+    [super viewDidDisappear:animated];
+}
+
+- (void)viewWillAppear:(BOOL)animated
+{
+    [super viewWillAppear:animated];
+}
+
+- (void)viewWillDisappear:(BOOL)animated
+{
+    [super viewWillDisappear:animated];
+}
+
+@end

data/lib/templates/default/objc/WireFrame/VIPERWireFrame.h

@@ -0,0 +1,18 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+#import "VIPERView.h"
+#import "VIPERLocalDataManager.h"
+#import "VIPERAPIDataManager.h"
+#import "VIPERInteractor.h"
+#import "VIPERPresenter.h"
+#import "VIPERWireframe.h"
+#import <UIKit/UIKit.h>
+
+@interface VIPERWireFrame : NSObject <VIPERWireFrameProtocol>
+
+@end

data/lib/templates/default/objc/WireFrame/VIPERWireFrame.m

@@ -0,0 +1,32 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+#import "VIPERWireFrame.h"
+
+@implementation VIPERWireFrame
+
++ (void)presentVIPERModuleFrom:(UIViewController*)fromViewController
+{
+    // Generating module components
+    id <VIPERViewProtocol> view = [[VIPERView alloc] init];
+    id <VIPERPresenterProtocol, VIPERInteractorOutputProtocol> presenter = [VIPERPresenter new];
+    id <VIPERInteractorInputProtocol> interactor = [VIPERInteractor new];
+    id <VIPERAPIDataManagerInputProtocol> APIDataManager = [VIPERAPIDataManager new];
+    id <VIPERLocalDataManagerInputProtocol> localDataManager = [VIPERLocalDataManager new];
+    id <VIPERWireFrameProtocol> wireFrame= [VIPERWireFrame new];
+    
+    // Connecting
+    view.presenter = presenter;
+    presenter.view = view;
+    presenter.wireFrame = wireFrame;
+    presenter.interactor = interactor;
+    interactor.presenter = presenter;
+    interactor.APIDataManager = APIDataManager;
+    interactor.localDataManager = localDataManager;
+    
+    //TOODO - New view controller presentation (present, push, pop, .. )
+}
+
+@end

data/lib/templates/default/swift/DataManager/API/VIPERAPIDataManager.swift

@@ -0,0 +1,11 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+class VIPERAPIDataManager: VIPERAPIDataManagerInputProtocol
+{
+    init() {}
+}

data/lib/templates/default/swift/DataManager/Local/VIPERLocalDataManager.swift

@@ -0,0 +1,11 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+class VIPERLocalDataManager: VIPERLocalDataManagerInputProtocol
+{
+    init() {}
+}

data/lib/templates/default/swift/Interactor/VIPERInteractor.swift

@@ -0,0 +1,15 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+class VIPERInteractor: VIPERInteractorInputProtocol
+{
+    weak var presenter: VIPERInteractorOutputProtocol?
+    var APIDataManager: VIPERAPIDataManagerInputProtocol?
+    var localDatamanager: VIPERLocalDataManagerInputProtocol?
+    
+    init() {}
+}

data/lib/templates/default/swift/Interactor/VIPERItem.swift

@@ -0,0 +1,13 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+struct VIPERItem
+{
+    /**
+    *  Attributes here
+    */
+}

data/lib/templates/default/swift/Presenter/VIPERPresenter.swift

@@ -0,0 +1,15 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+class VIPERPresenter: VIPERPresenterProtocol, VIPERInteractorOutputProtocol
+{
+    weak var view: VIPERViewProtocol?
+    var interactor: VIPERInteractorInputProtocol?
+    var wireFrame: VIPERWireFrameProtocol?
+    
+    init() {}
+}

data/lib/templates/default/swift/Protocols/VIPERProtocols.swift

@@ -0,0 +1,70 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+protocol VIPERViewProtocol: class
+{
+    var presenter: VIPERPresenterProtocol? { get set }
+    /**
+    * Add here your methods for communication PRESENTER -> VIEW
+    */
+}
+
+protocol VIPERWireFrameProtocol: class
+{
+    class func presentVIPERModule(fromView view: AnyObject)
+    /**
+    * Add here your methods for communication PRESENTER -> WIREFRAME
+    */
+}
+
+protocol VIPERPresenterProtocol: class
+{
+    var view: VIPERViewProtocol? { get set }
+    var interactor: VIPERInteractorInputProtocol? { get set }
+    var wireFrame: VIPERWireFrameProtocol? { get set }
+    /**
+    * Add here your methods for communication VIEW -> PRESENTER
+    */
+}
+
+protocol VIPERInteractorOutputProtocol: class
+{
+    /**
+    * Add here your methods for communication INTERACTOR -> PRESENTER
+    */
+}
+
+protocol VIPERInteractorInputProtocol: class
+{
+    var presenter: VIPERInteractorOutputProtocol? { get set }
+    var APIDataManager: VIPERAPIDataManagerInputProtocol? { get set }
+    var localDatamanager: VIPERLocalDataManagerInputProtocol? { get set }
+    /**
+    * Add here your methods for communication PRESENTER -> INTERACTOR
+    */
+}
+
+protocol VIPERDataManagerInputProtocol: class
+{
+    /**
+    * Add here your methods for communication INTERACTOR -> DATAMANAGER
+    */
+}
+
+protocol VIPERAPIDataManagerInputProtocol: class
+{
+    /**
+    * Add here your methods for communication INTERACTOR -> APIDATAMANAGER
+    */
+}
+
+protocol VIPERLocalDataManagerInputProtocol: class
+{
+    /**
+    * Add here your methods for communication INTERACTOR -> LOCALDATAMANAGER
+    */
+}

data/lib/templates/default/swift/View/VIPERView.swift

@@ -0,0 +1,12 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+import UIKit
+
+class VIPERView: UIViewController, VIPERViewProtocol
+{
+    var presenter: VIPERPresenterProtocol?
+}