vipergeng 0.2.7

data/lib/templates/default/swift/WireFrame/VIPERWireFrame.swift

@@ -0,0 +1,29 @@
+//
+// Created by AUTHOR
+// Copyright (c) YEAR AUTHOR. All rights reserved.
+//
+
+import Foundation
+
+class VIPERWireFrame: VIPERWireFrameProtocol
+{
+    static func presentVIPERModule(fromView view: AnyObject)
+    {
+        // Generating module components
+        var view: VIPERViewProtocol = VIPERView()
+        var presenter: protocol<VIPERPresenterProtocol, VIPERInteractorOutputProtocol> = VIPERPresenter()
+        var interactor: VIPERInteractorInputProtocol = VIPERInteractor()
+        var APIDataManager: VIPERAPIDataManagerInputProtocol = VIPERAPIDataManager()
+        var localDataManager: VIPERLocalDataManagerInputProtocol = VIPERLocalDataManager()
+        var wireFrame: VIPERWireFrameProtocol = VIPERWireFrame()
+        
+        // Connecting
+        view.presenter = presenter
+        presenter.view = view
+        presenter.wireFrame = wireFrame
+        presenter.interactor = interactor
+        interactor.presenter = presenter
+        interactor.APIDataManager = APIDataManager
+        interactor.localDatamanager = localDataManager
+    }
+}

data/lib/templates/default/viperspec.yml

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

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

@@ -0,0 +1,17 @@
+//
+//  VIPERInteractor.swift
+//
+//  Created by AUTHOR.
+//  Copyright © YEAR COMPANY. All rights reserved.
+//
+
+import Foundation
+
+class VIPERInteractor: VIPERInteractorInputProtocol {
+    
+    // MARK: Properties
+    
+    weak var presenter: VIPERInteractorOutputProtocol?
+    
+    // MARK: VIPERInteractorInputProtocol    
+}

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

@@ -0,0 +1,21 @@
+//
+//  VIPERPresenter.swift
+//
+//  Created by AUTHOR.
+//  Copyright © YEAR COMPANY. All rights reserved.
+//
+
+import Foundation
+
+class VIPERPresenter: VIPERPresenterProtocol, VIPERInteractorOutputProtocol {
+    
+    // MARK: Properties
+    
+    weak var view: VIPERViewProtocol?
+    var interactor: VIPERInteractorInputProtocol?
+    var wireFrame: VIPERWireFrameProtocol?
+    
+    // MARK: VIPERPresenterProtocol
+    
+    // MARK: VIPERInteractorOutputProtocol
+}

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

@@ -0,0 +1,28 @@
+//
+//  VIPERProtocols.swift
+//
+//  Created by AUTHOR.
+//  Copyright © YEAR COMPANY. All rights reserved.
+//
+
+import Foundation
+
+protocol VIPERViewProtocol: class {
+
+}
+
+protocol VIPERPresenterProtocol: class {
+
+}
+
+protocol VIPERInteractorInputProtocol {
+
+}
+
+protocol VIPERInteractorOutputProtocol: class {
+
+}
+
+protocol VIPERWireFrameProtocol {
+
+}

data/lib/templates/naja/swift/Views/VIPERView.swift

@@ -0,0 +1,24 @@
+//
+//  VIPERView.swift
+//
+//  Created by AUTHOR.
+//  Copyright © YEAR COMPANY. All rights reserved.
+//
+
+import Foundation
+import UIKit
+
+class VIPERView: UIViewController, VIPERViewProtocol {
+    
+    // MARK: Properties
+
+    var presenter: VIPERPresenterProtocol?
+    
+    // MARK: UIViewController
+    
+    override func viewDidLoad() {
+        super.viewDidLoad()
+    }
+    
+    // MARK: VIPERViewProtocol
+}

data/lib/templates/naja/swift/WireFrame/VIPERWireFrame.swift

@@ -0,0 +1,41 @@
+//
+//  VIPERWireFrame.swift
+//
+//  Created by AUTHOR.
+//  Copyright © YEAR COMPANY. All rights reserved.
+//
+
+import UIKit
+
+public class VIPERWireFrame: VIPERWireFrameProtocol {
+
+    // MARK: Properties
+    
+    weak var navigationController: UINavigationController?
+    
+    // MARK: Factory
+    
+    public static func presentVIPERFromViewController(source: UIViewController) {
+        let presenter = VIPERPresenter()
+        let view = VIPERView()
+        /*
+            If using UIStoryboard use:
+            let storyboard = UIStoryboard(name: "Main", bundle: NSBundle.mainBundle())
+            view = storyboard.instantiateViewControllerWithIdentifier("VIPERView") as! VIPERView
+        */
+        let interactor = VIPERInteractor()
+        let wireFrame = VIPERWireFrame()
+        
+        view.presenter = presenter
+        interactor.presenter = presenter
+        presenter.view = view
+        presenter.interactor = interactor
+        presenter.wireFrame = wireFrame
+        
+        let navigationController = UINavigationController(rootViewController: view)
+        wireFrame.navigationController = navigationController
+        source.presentViewController(navigationController, animated: true, completion: nil)
+    }
+    
+    // MARK: VIPERWireFrameProtocol
+}

data/lib/templates/naja/viperspec.yml

@@ -0,0 +1,4 @@
+author: Raphael Oliveira 
+author_email: raphaelfpoliveira@gmail.com
+template_description: Yet another Swift VIPER template 
+updated_at: 2015-12-15

data/lib/vipergen/dirutils.rb

@@ -0,0 +1,17 @@
+module Vipergen
+	class DirUtils
+		# Return a directory with the project libraries.
+	    def self.gem_libdir
+	      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{Vipergen::NAME}",
+	           "#{Gem.dir}/gems/#{Vipergen::NAME}-#{Vipergen::VERSION}/lib/#{Vipergen::NAME}"]
+	      t.each {|i| return i if File.readable?(i) }
+	      raise "both paths are invalid: #{t}"
+	    end
+
+	    # Returns the directories inside a given one
+	    def self.directories_in(directory)
+	    	expanded_dir = File.expand_path(directory)
+	    	return Dir.glob(File.join(expanded_dir,'*')).select {|f| File.directory? f}
+	    end
+	end
+end

data/lib/vipergen/filemanager.rb

@@ -0,0 +1,51 @@
+module Vipergen
+	# File manager class
+	class FileManager
+
+		# Returns if the template is valid by the VIPER generator 
+		def self.is_template_valid(template)
+			return Vipergen::TemplateManager.templates.include? template
+		end
+
+		# Returns if the language is valid by the VIPER generator
+		def self.is_language_valid(language)
+			return (Vipergen::Generator::LANGUAGES).include? language
+		end
+
+		# Return the path if valid template and language
+		# @return String with valid path 
+		def self.path_from(template, language)
+			return nil if !is_language_valid(language) || !is_template_valid(template)
+			return File.join(Vipergen::TemplateManager.templates_dir, template, language)
+		end
+
+		# Returns an array with files in a given path
+		# @return Array with the files in a given path
+		def self.files_in_path(path)
+			return Dir[File.join("#{path}","/**/*")].select {|f| File.file?(f)}
+		end
+
+		# Returns the destination viper path 
+		# @return Destination root path
+		def self.destination_viper_path(path, name)
+			expand_path = File.expand_path(path)
+			return File.join(expand_path,name)
+		end
+
+		# Copy a system item to another place
+		def self.copy(from, to)
+			to_expand_path = File.expand_path(to)
+			from_expand_path = File.expand_path(from)
+			FileUtils.mkdir_p (to_expand_path)
+			FileUtils.copy_entry(from_expand_path, to_expand_path)	
+		end
+
+		# Move a system item to another place
+		def self.move(from, to)
+			to_expand_path = File.expand_path(to)
+			from_expand_path = File.expand_path(from)
+			FileUtils.move(from_expand_path, to_expand_path)
+		end
+
+	end
+end

data/lib/vipergen/generator.rb

@@ -0,0 +1,66 @@
+module Vipergen
+	# Cosntants
+	class Generator
+		# Constants
+		LANGUAGES = ["swift", "objc"]
+		REPLACEMENT_KEY = "VIPER"
+		AUTHOR_REPLACEMENT_KEY = "AUTHOR"
+		YEAR_REPLACEMENT_KEY = "YEAR"
+	        COMPANY_REPLACEMENT_KEY = "COMPANY"
+
+		# Main method that generate the VIPER files structure
+		def self.generate_viper(template, language, name, path, author, company)
+			puts "Generating VIPER-Module"
+			puts "Template: #{template}"
+			puts "Language: #{language}"
+			puts "Name: #{name}"
+			puts "Path: #{path}"
+			puts "Author: #{author}"
+        		puts "Company: #{company}"
+			path_from = Vipergen::FileManager.path_from(template, language)
+			path_to = Vipergen::FileManager.destination_viper_path(path, name)
+			Vipergen::FileManager.copy(path_from, path_to)
+			files = Vipergen::FileManager.files_in_path(path_to)
+			rename_files(files, name, author, company)
+		end
+
+		# Rename all the files in the files array
+		# - It renames the name of the file 
+		# - It renames the content of the file
+		def self.rename_files(files, name, author, company)
+			files.each do |file|
+				raise SyntaxError unless file.include? (Vipergen::Generator::REPLACEMENT_KEY)
+				rename_file(file, name, author, company)
+			end
+		end
+
+		# Rename a given file
+		# - It renames the name of the file
+		# - It renames the content of the file
+		def self.rename_file(file, name, author, company)
+			new_path = file.gsub((Vipergen::Generator::REPLACEMENT_KEY), name)
+			Vipergen::FileManager.move(file, new_path)
+			rename_file_content(new_path, name, author, company)
+		end
+
+		# Rename the file content
+		# @return: An String with the every VIPER replaced by 'name'
+		def self.rename_file_content(filename, name, author, company)
+			# Reading content
+			file = File.open(filename, "rb")
+			content = file.read
+			file.close
+
+			# Replacing content
+			content = content.gsub((Vipergen::Generator::REPLACEMENT_KEY), name)
+			content = content.gsub((Vipergen::Generator::AUTHOR_REPLACEMENT_KEY), author)
+			content = content.gsub((Vipergen::Generator::YEAR_REPLACEMENT_KEY), "#{Time.new.year}")
+			content = content.gsub((Vipergen::Generator::COMPANY_REPLACEMENT_KEY), company)
+
+			# Saving content with replaced string
+			File.open(filename, "w+") do |file|
+   				file.write(content)
+			end
+		end
+	end
+end

data/lib/vipergen/templatemanager.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+module Vipergen
+	class TemplateManager
+
+		# Returns the templates dir
+	    def self.templates_dir
+	      t = "#{File.expand_path File.dirname(__FILE__)}/../templates"
+	    end
+
+		# Get the available templates paths
+		# @return Array[String] with available templates paths
+		def self.templates_paths()
+			template_dir = Vipergen::TemplateManager.templates_dir
+			return Vipergen::DirUtils.directories_in(template_dir)
+		end
+
+		# Get the templates names
+		# @return Array[String] with templates names (got from the folder)
+		def self.templates()
+			templates_paths.map{|template_path| template_name_from_path(template_path)}
+		end
+
+		# Returns the template name from a given template_path
+		# @return String with the template name
+		def self.template_name_from_path(template_path)
+			return template_path.split("/").last
+		end
+
+		# Returns the description of all the templates available
+		# @return String with the entire description
+		def self.templates_description()
+			description = "\nAvailable templates \n"
+			description += "------------------- \n"
+			self.templates_paths.each do |template_path|
+				description += "> #{template_description(template_path)} \n"
+			end
+			return description
+		end
+
+		# Returns the description of a given template
+		# @param template String with the template path whose description is going to be returned
+		# @return String with the template description
+		def self.template_description(template_path)
+			template_description = ""
+
+			# Reading yaml
+			template_content = YAML.load_file(File.join(template_path,'viperspec.yml'))
+
+			# Generating string
+			template_description+= "| #{template_name_from_path(template_path)} by #{template_content["author"]} |: #{template_content["template_description"]}"
+		end
+	end
+end

data/lib/vipergen/version.rb

@@ -0,0 +1,4 @@
+module Vipergen
+  NAME = "vipergeng"
+  VERSION = "0.2.7"
+end

data/lib/vipergen/viperthor.rb

@@ -0,0 +1,21 @@
+require 'thor'
+require 'vipergen'
+
+module Vipergen
+  class ViperThor < Thor
+	desc "generate MODULE", "Generate a VIPER module"
+	option :language, :required => false, :default => 'swift', :type => :string, :desc => "The language of the generated module (swift, objc)"
+	option :template, :required => false, :default => 'default', :type => :string , :desc => "Template for the generation"
+	option :path, :required => true, :type => :string , :desc => "Path where the output module is going to be saved"
+	option :author, :required => false, :default => 'VIPER', :type => :string , :desc => "Author to be specified on the file's header. Otherwise VIPER will be used"
+	option :company, :required => false, :default => 'Company', :type => :string, :desc => "Company to be specified on the file's header. Otherwise Company will be used"
+	def generate(name)
+	   Vipergen::Generator.generate_viper(options[:template], options[:language], name, options[:path], options[:author], options[:company])
+	end
+
+	desc "templates", "Get a list of available templates"
+	def templates()
+		puts Vipergen::TemplateManager.templates_description()
+	end
+  end
+end

data/lib/vipergen.rb

@@ -0,0 +1,6 @@
+require 'vipergen/generator'
+require 'vipergen/filemanager'
+require 'vipergen/dirutils'
+require 'vipergen/version'
+require 'vipergen/viperthor'
+require 'vipergen/templatemanager'

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'vipergen'
+require "codeclimate-test-reporter"
+
+CodeClimate::TestReporter.start

data/spec/vipergen/vipergen_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Vipergen do
+	context "when generating path" do
+		it "should return nil if no valid template" do
+			valid_template = Vipergen::FileManager.is_template_valid("asdgas")
+			expect(valid_template).to be(false)
+		end
+		it "should return nil if no valid language" do
+			valid_template = Vipergen::FileManager.is_template_valid("asdgas")
+			expect(valid_template).to be(false)
+		end
+		it "should return nil if no valid language when getting path" do
+			path = Vipergen::FileManager.path_from("default", "asgass")
+			expect(path).to be(nil)
+		end
+		it "should return nil if no valid template when getting path" do
+			path = Vipergen::FileManager.path_from("asga", "swift")
+			expect(path).to be(nil)
+		end
+		it "should append the name to the given user path" do
+			to_path = Vipergen::FileManager.destination_viper_path("path/", "pepito")
+			expect(to_path).to eq(File.join(File.expand_path("path/"),"pepito"))
+		end
+	end
+	context "copying a folder to a diferent place" do
+		before (:each) do
+			Dir.mkdir 'foo'
+			Dir.mkdir 'foo/subfoo'
+		end
+
+		it "should copy a given folder properly" do
+			Vipergen::FileManager.copy('foo','test_foo')
+			expect(File.directory?('test_foo/subfoo')).to eq(true)
+		end
+
+		after (:each) do
+			FileUtils.rm_rf('foo')
+			FileUtils.rm_rf('test_foo')
+		end
+	end
+end
+
+describe Vipergen::Generator do
+	context "when renaming file content" do 
+		before (:each) do
+			File.open("test.txt", 'w') {|f| f.write("I'm a #{Vipergen::Generator::REPLACEMENT_KEY} file by #{Vipergen::Generator::AUTHOR_REPLACEMENT_KEY} @ #{Vipergen::Generator::COMPANY_REPLACEMENT_KEY} on #{Vipergen::Generator::YEAR_REPLACEMENT_KEY}") }
+		end
+
+		it "should rename every VIPER word to the given name" do
+			Vipergen::Generator.rename_file_content("test.txt","RENAMED", "pepito", "ViperGen")
+			file = File.open("test.txt", "rb")
+			content = file.read
+			expect(content).to eq("I'm a RENAMED file by pepito @ ViperGen on #{Time.new.year}")
+		end
+
+		after (:each) do
+			FileUtils.rm('test.txt')
+		end
+	end
+
+	context "when renaming file" do
+		before (:each) do
+			File.open("#{Vipergen::Generator::REPLACEMENT_KEY}test.txt", 'w') {|f| f.write("I'm a #{Vipergen::Generator::REPLACEMENT_KEY} file") }
+		end
+
+		it "every file should be renamed in rename_files" do
+			expect(Vipergen::Generator).to receive(:rename_file)
+			Vipergen::Generator.rename_files(["#{Vipergen::Generator::REPLACEMENT_KEY}file.txt"], "MyModule", "Pepi", "ViperGen")
+		end
+
+		it "should raise a SyntaxError exeption if there's a file in the template without the proper name" do
+			expect{Vipergen::Generator.rename_files(["asgasgs.txt"], "MyModule", "Pepi", "ViperGen")}.to raise_error
+		end
+
+		it "should rename the VIPER in name to the given name" do
+			file = "#{Vipergen::Generator::REPLACEMENT_KEY}test.txt"
+			name = "RENAMED"
+			author = "PEPI"
+                        company = "ViperGen"
+			Vipergen::Generator.rename_file(file, name, author, company)
+			expect(File.exist? "RENAMEDtest.txt").to eq(true)
+		end
+
+		it "should rename the file content after the file name rename" do
+			file = "#{Vipergen::Generator::REPLACEMENT_KEY}test.txt"
+			name = "RENAMED"
+			author = "PEPI"
+                        company = "ViperGen"
+			expect(Vipergen::Generator).to receive(:rename_file_content)
+			Vipergen::Generator.rename_file(file, name, author, company)
+		end
+
+		after (:each) do
+			File.delete "#{Vipergen::Generator::REPLACEMENT_KEY}test.txt" if File.exist? "#{Vipergen::Generator::REPLACEMENT_KEY}test.txt"
+			File.delete "RENAMEDtest.txt" if File.exist? "RENAMEDtest.txt"
+		end
+	end
+end
+
+describe Vipergen::DirUtils do
+	context "getting directories" do
+		before (:each) do
+			Dir.mkdir 'foo'
+			Dir.mkdir 'foo/subfoo'
+		end
+
+		it "should return the directories inside a given one" do
+			expect(Vipergen::DirUtils.directories_in('foo').count).to eq(1)
+		end
+
+		after (:each) do
+			FileUtils.rm_rf('foo')
+		end
+	end
+end
+
+describe Vipergen::TemplateManager do
+	context "getting templates" do
+		before (:each) do
+			Dir.mkdir 'foo'
+			Dir.mkdir 'foo/subfoo'
+			Dir.mkdir 'foo/subfoo2'
+		end
+
+		it "should return the proper templates in templates directory" do
+			Vipergen::TemplateManager.stub(:templates_dir).and_return('foo/')
+			expect(Vipergen::TemplateManager.templates_paths.count).to eq(2)
+		end
+
+		after (:each) do
+			FileUtils.rm_rf('foo')
+		end
+	end
+end