boa 0.2.2 → 0.3.0

data/README.md

@@ -18,7 +18,14 @@ Install gem with:
 boa init
 ```
 
-3. Input your project name and the author (these will be used in generated files). You can change these settings in `.boa.yml`
+3. Input
+
+* your project name
+* preferred language
+* author
+# class prefix
+
+(these will be used in generated files). You can change these settings in `.boa.yml`
 
 4. Create your module with
 
@@ -26,8 +33,13 @@ boa init
 boa module create Example
 ```
 
+You can use saved configuration by just pressing enters.
+
 ## Changes
 
+#### v0.3
+  * Swift syntax added
+
 #### v0.2
   * added class prefix option
   * added basic appledoc comments for interfaces and protocols

data/lib/boa/commands.rb

@@ -12,18 +12,27 @@ module Boa
 
     # ----
     # initialize VIPER hierarchy
-    BASE_FILES = {
+    BASE_FILES_OBJC = {
       'AppDelegate.h'     => 'Classes',
       'AppDelegate.m'     => 'Classes',
       'AppDependencies.h' => 'Classes',
       'AppDependencies.m' => 'Classes'
     }
 
-    PROJECT_FILES = {
+    BASE_FILES_SWIFT = {
+      'AppDelegate.swift'     => 'Classes',
+      'AppDependencies.swift' => 'Classes'
+    }
+
+    PROJECT_FILES_OBJC = {
       'RootWireframe.h'   => 'Classes/Common/Wireframe',
       'RootWireframe.m'   => 'Classes/Common/Wireframe'
     }
 
+    PROJECT_FILES_SWIFT = {
+      'RootWireframe.swift' => 'Classes/Common/Wireframe'
+    }
+
     desc 'init', 'initializes VIPER project'
     def init
       config = invoke(:configure, [])
@@ -46,14 +55,23 @@ module Boa
       @project = config[:project]
       @author  = config[:author]
       @date    = Time.now.strftime('%d/%m/%y')
+      lang     = config[:language]
 
       # Generate files
-      BASE_FILES.each do |file_name, folder|
-        template "templates/#{file_name}", "#{folder}/#{@project}#{file_name}"
+      base_files = case lang
+                   when 'objc'  then BASE_FILES_OBJC
+                   when 'swift' then BASE_FILES_SWIFT
+                   end
+      base_files.each do |file_name, folder|
+        template "templates/#{lang}/#{file_name}", "#{folder}/#{@project}#{file_name}"
       end
 
-      PROJECT_FILES.each do |file_name, folder|
-        template "templates/#{file_name}", "#{folder}/#{file_name}"
+      project_files = case lang
+                      when 'objc'  then PROJECT_FILES_OBJC
+                      when 'swift' then PROJECT_FILES_SWIFT
+                      end
+      project_files.each do |file_name, folder|
+        template "templates/#{lang}/#{file_name}", "#{folder}/#{file_name}"
       end
     end
 
@@ -66,10 +84,12 @@ module Boa
       config = File.exists?(CONFIG_FILE) ? YAML.load_file(CONFIG_FILE) : {}
 
       project      = ask("Project name [#{config[:project]}] ?")
+      language     = ask("Project language [#{config[:language]}] ?", :limited_to => ["objc", "swift", ""])
       class_prefix = ask("Class prefix [#{config[:class_prefix]}] ?")
       author       = ask("Author [#{config[:author]}] ?")
 
       config[:project]      = project.empty?      ? config[:project] || ''      : project
+      config[:language]     = language.empty?     ? config[:language] || 'objc' : language
       config[:class_prefix] = class_prefix.empty? ? config[:class_prefix] || '' : class_prefix
       config[:author]       = author.empty?       ? config[:author] || ''       : author
 

data/lib/boa/module/module.rb

@@ -6,7 +6,7 @@ module Boa
 
     BASE_PATH = 'Classes/Modules'
 
-    FILES = {
+    FILES_OBJC = {
       'DataManager.h'     => 'DataManager',
       'DataManager.m'     => 'DataManager',
       'Interactor.h'      => 'Interactor',
@@ -21,6 +21,16 @@ module Boa
       'Wireframe.m'       => 'Wireframe'
     }
 
+    FILES_SWIFT = {
+      'DataManager.swift'     => 'DataManager',
+      'Interactor.swift'      => 'Interactor',
+      'ModuleInterface.swift' => 'ModuleInterface',
+      'Presenter.swift'       => 'Presenter',
+      'ViewInterface.swift'   => 'View',
+      'ViewController.swift'  => 'View',
+      'Wireframe.swift'       => 'Wireframe'
+    }
+
     Boa::Module.source_root(File.dirname(__FILE__))
 
     desc 'list', 'lists available VIPER modules'
@@ -40,22 +50,33 @@ module Boa
       @project         = config[:project]
       @author          = config[:author]
       @date            = Time.now.strftime('%d/%m/%y')
+      lang             = config[:language]
 
       # copying template files
-      FILES.each do |file_name, folder|
-        template "templates/#{file_name}", "#{BASE_PATH}/#{@module}/#{folder}/#{@prefixed_module}#{file_name}"
+      files = case lang
+              when 'objc'  then FILES_OBJC
+              when 'swift' then FILES_SWIFT
+              end
+      files.each do |file_name, folder|
+        template "templates/#{lang}/#{file_name}", "#{BASE_PATH}/#{@module}/#{folder}/#{@prefixed_module}#{file_name}"
       end
 
       # rendering dependencies head
       path = Dir::Tmpname.create('dep') { |path| path }
-      template 'templates/DependenciesHead.m', path
+      case lang
+      when 'objc'  then template('templates/objc/DependenciesHead.m', path)
+      when 'swift' then template('templates/swift/DependenciesHead.swift', path)
+      end
 
       say "\nAdd these lines to the AppDependencies imports:\n\n", :green
       say File.open(path).read + "\n", :yellow
 
       # rendering dependencies body
       path = Dir::Tmpname.create('dep') { |path| path }
-      template 'templates/DependenciesBody.m', path
+      case lang
+      when 'objc'  then template('templates/objc/DependenciesBody.m', path)
+      when 'swift' then template('templates/swift/DependenciesBody.swift', path)
+      end
 
       say "\nAdd these lines to the AppDependencies#configureDependencies:\n\n", :green
       say File.open(path).read + "\n", :yellow

data/lib/boa/module/templates/swift/DataManager.swift

@@ -0,0 +1,14 @@
+//
+//  <%= @prefixed_module %>DataManager.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+
+class <%= @prefixed_module %>DataManager: NSObject
+{
+
+}

data/lib/boa/module/templates/swift/DependenciesBody.swift

@@ -0,0 +1,32 @@
+// ------------------------------------------------------------------
+// begin <%= @module %> module
+
+// instantiate classes
+var <%= @module.downcase %>Wireframe: <%= @prefixed_module %>Wireframe      = <%= @prefixed_module %>Wireframe()
+var <%= @module.downcase %>Presenter: <%= @prefixed_module %>Presenter      = <%= @prefixed_module %>Presenter()
+var <%= @module.downcase %>DataManager: <%= @prefixed_module %>DataManager  = <%= @prefixed_module %>DataManager()
+var <%= @module.downcase %>Interactor: <%= @prefixed_module %>Interactor    = <%= @prefixed_module %>Interactor()
+
+// presenter <-> wireframe
+<%= @module.downcase %>Presenter.wireframe = <%= @module.downcase %>Wireframe
+<%= @module.downcase %>Wireframe.presenter = <%= @module.downcase %>Presenter
+
+// presenter <-> interactor
+<%= @module.downcase %>Presenter.interactor = <%= @module.downcase %>Interactor
+<%= @module.downcase %>Interactor.presenter = <%= @module.downcase %>Presenter
+
+// interactor -> data_manager
+<%= @module.downcase %>Interactor.dataManager = <%= @module.downcase %>DataManager
+
+// data_manager -> data_store
+// *** connect datastore
+
+// connect wireframes
+<%= @module.downcase %>Wireframe.rootWireframe = rootWireframe
+// *** connect more wireframes
+
+// configure delegate
+// *** add delegate here if needed
+
+// end <%= @module %> module
+// ------------------------------------------------------------------

data/lib/boa/module/templates/swift/DependenciesHead.swift

@@ -0,0 +1 @@
+// no adding needed

data/lib/boa/module/templates/swift/Interactor.swift

@@ -0,0 +1,15 @@
+//
+//  <%= @prefixed_module %>Interactor.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+
+class <%= @prefixed_module %>Interactor: NSObject
+{
+    var presenter: <%= @prefixed_module %>Presenter?
+    var dataManager: <%= @prefixed_module %>DataManager?
+}

data/lib/boa/module/templates/swift/ModuleInterface.swift

@@ -0,0 +1,19 @@
+//
+//  <%= @prefixed_module %>ModuleInterface.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+
+protocol <%= @prefixed_module %>ModuleInterface
+{
+
+}
+
+protocol <%= @prefixed_module %>ModuleDelegate
+{
+
+}

data/lib/boa/module/templates/swift/Presenter.swift

@@ -0,0 +1,19 @@
+//
+//  <%= @prefixed_module %>Presenter.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+
+class <%= @prefixed_module %>Presenter: NSObject, <%= @prefixed_module %>ModuleInterface
+{
+    var interactor: <%= @prefixed_module %>Interactor?
+    var wireframe: <%= @prefixed_module %>Wireframe?
+    var userInterface: <%= @prefixed_module %>ViewInterface?
+
+    // MARK: - <%= @prefixed_module %>ModuleInterface methods
+    // implement module interface here
+}

data/lib/boa/module/templates/swift/ViewController.swift

@@ -0,0 +1,40 @@
+//
+//  <%= @prefixed_module %>ViewController.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import UIKit
+
+class <%= @prefixed_module %>ViewController: UIViewController, <%= @prefixed_module %>ViewInterface
+{
+    var eventHandler: <%= @prefixed_module %>ModuleInterface?
+
+    // MARK: - View lifecycle
+
+    override func viewDidLoad()
+    {
+        super.viewDidLoad()
+    }
+
+    override func viewWillAppear(animated: Bool)
+    {
+        super.viewWillAppear(animated)
+    }
+
+    override func viewDidAppear(animated: Bool)
+    {
+        super.viewDidAppear(animated)
+    }
+
+    // MARK: - <%= @prefixed_module %>ViewInterface methods
+
+    // *** implement view_interface methods here
+
+    // MARK: - Button event handlers
+
+    // ** handle UI events here
+
+}

data/lib/boa/module/templates/swift/ViewInterface.swift

@@ -0,0 +1,14 @@
+//
+//  <%= @prefixed_module %>View.h
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+
+protocol <%= @prefixed_module %>ViewInterface
+{
+
+}

data/lib/boa/module/templates/swift/Wireframe.swift

@@ -0,0 +1,30 @@
+//
+//  <%= @prefixed_module %>Wireframe.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+import UIKit
+
+class <%= @prefixed_module %>Wireframe: NSObject
+{
+    var rootWireframe: RootWireframe?
+    var presenter: <%= @prefixed_module %>Presenter?
+    var viewController: <%= @prefixed_module %>ViewController?
+
+    func presentSelfFromViewController(viewController: UIViewController)
+    {
+        // save reference
+        self.viewController = <%= @prefixed_module %>ViewController(nibName: "<%= @prefixed_module %>ViewController", bundle: nil)
+
+        // view <-> presenter
+        self.presenter?.userInterface = self.viewController
+        self.viewController?.eventHandler = self.presenter
+
+        // present controller
+        // *** present self with RootViewController
+    }
+}

data/lib/boa/templates/swift/AppDelegate.swift

@@ -0,0 +1,33 @@
+//
+//  <%= @project %>AppDelegate.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import UIKit
+
+@UIApplicationMain
+class <%= @project %>AppDelegate: UIResponder, UIApplicationDelegate
+{
+    var window: UIWindow?
+    var dependencies: <%= @project %>AppDependencies?
+
+    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: NSDictionary?) -> Bool
+    {
+        // initialize window
+        self.window = UIWindow(frame: UIScreen.mainScreen().bounds)
+        self.window?.backgroundColor = UIColor.whiteColor()
+
+        // initialize dependencies
+        self.dependencies = <%= @project %>AppDependencies.initWithWindow(self.window!)
+
+        // adding RootViewController
+        self.dependencies?.installRootViewController()
+
+        self.window!.makeKeyAndVisible()
+
+        return true
+    }
+}

data/lib/boa/templates/swift/AppDependencies.swift

@@ -0,0 +1,38 @@
+//
+//  <%= @project %>AppDependencies.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+import UIKit
+
+class <%= @project %>AppDependencies: NSObject
+{
+
+    class func initWithWindow(window: UIWindow) -> <%= @project %>AppDependencies
+    {
+
+        let obj = <%= @project %>AppDependencies()
+        obj.configureDependencies(window)
+
+        return obj
+    }
+
+    func installRootViewController()
+    {
+        // *** present first wireframe here
+    }
+
+    func configureDependencies(window: UIWindow)
+    {
+        // -----
+        // root classes
+        let rootWireframe = RootWireframe.init(window: window)
+        // *** add datastore
+
+        // *** module initialization
+    }
+}

data/lib/boa/templates/swift/RootWireframe.swift

@@ -0,0 +1,19 @@
+//
+//  RootWireframe.swift
+//  <%= @project %>
+//
+//  Created by <%= @author %> on <%= @date %>.
+//
+//
+
+import Foundation
+import UIKit
+
+class RootWireframe: NSObject
+{
+    init(window: UIWindow)
+    {
+        super.init()
+        // custom initialization
+    }
+}

data/lib/boa/version.rb

@@ -1,3 +1,3 @@
 module Boa
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: boa
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-02 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,26 +77,38 @@ files:
 - lib/boa.rb
 - lib/boa/commands.rb
 - lib/boa/module/module.rb
-- lib/boa/module/templates/DataManager.h
-- lib/boa/module/templates/DataManager.m
-- lib/boa/module/templates/DependenciesBody.m
-- lib/boa/module/templates/DependenciesHead.m
-- lib/boa/module/templates/Interactor.h
-- lib/boa/module/templates/Interactor.m
-- lib/boa/module/templates/ModuleInterface.h
-- lib/boa/module/templates/Presenter.h
-- lib/boa/module/templates/Presenter.m
-- lib/boa/module/templates/ViewController.h
-- lib/boa/module/templates/ViewController.m
-- lib/boa/module/templates/ViewInterface.h
-- lib/boa/module/templates/Wireframe.h
-- lib/boa/module/templates/Wireframe.m
-- lib/boa/templates/AppDelegate.h
-- lib/boa/templates/AppDelegate.m
-- lib/boa/templates/AppDependencies.h
-- lib/boa/templates/AppDependencies.m
-- lib/boa/templates/RootWireframe.h
-- lib/boa/templates/RootWireframe.m
+- lib/boa/module/templates/objc/DataManager.h
+- lib/boa/module/templates/objc/DataManager.m
+- lib/boa/module/templates/objc/DependenciesBody.m
+- lib/boa/module/templates/objc/DependenciesHead.m
+- lib/boa/module/templates/objc/Interactor.h
+- lib/boa/module/templates/objc/Interactor.m
+- lib/boa/module/templates/objc/ModuleInterface.h
+- lib/boa/module/templates/objc/Presenter.h
+- lib/boa/module/templates/objc/Presenter.m
+- lib/boa/module/templates/objc/ViewController.h
+- lib/boa/module/templates/objc/ViewController.m
+- lib/boa/module/templates/objc/ViewInterface.h
+- lib/boa/module/templates/objc/Wireframe.h
+- lib/boa/module/templates/objc/Wireframe.m
+- lib/boa/module/templates/swift/DataManager.swift
+- lib/boa/module/templates/swift/DependenciesBody.swift
+- lib/boa/module/templates/swift/DependenciesHead.swift
+- lib/boa/module/templates/swift/Interactor.swift
+- lib/boa/module/templates/swift/ModuleInterface.swift
+- lib/boa/module/templates/swift/Presenter.swift
+- lib/boa/module/templates/swift/ViewController.swift
+- lib/boa/module/templates/swift/ViewInterface.swift
+- lib/boa/module/templates/swift/Wireframe.swift
+- lib/boa/templates/objc/AppDelegate.h
+- lib/boa/templates/objc/AppDelegate.m
+- lib/boa/templates/objc/AppDependencies.h
+- lib/boa/templates/objc/AppDependencies.m
+- lib/boa/templates/objc/RootWireframe.h
+- lib/boa/templates/objc/RootWireframe.m
+- lib/boa/templates/swift/AppDelegate.swift
+- lib/boa/templates/swift/AppDependencies.swift
+- lib/boa/templates/swift/RootWireframe.swift
 - lib/boa/version.rb
 homepage: https://github.com/jbslabs/boa
 licenses: