mvcgen 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 171c12fa910bd62024c0a177a336b7a2a2817045
+  data.tar.gz: 6a3e967271ab52b634c8704691783e7b237d1141
+SHA512:
+  metadata.gz: 9b8ef45ef1a1b94816abde42829e607f402a70be323e35fb9191deea1c78c538d9501ca939cb17956f34346367163b9d1cf903f9e417ca043d59510e603c3bcf
+  data.tar.gz: 69fa37c0dc1bc63aeb2f5ddc845679716c0986868f1bb8ac13bd1717f24e8660399b08ee327b0537dfa7e05d6710a173aa6d05a460e9a2d53cb33be2a188f6ee

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,115 @@
+MVC Module Generator
+======================
+
+<!-- ## :warning: This project is no longer maintained.
+
+Gem to generate MVC modules to use them in your 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)
+- [MVC files structure](#mvc-files-structure)
+- [How to install mvcgen](#how-to-install-vipergen)
+- [How to generate a MVC 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
+
+### Expected in version 0.2
+- Example project of Redbooth login with notifications
+- FetchedResultsController template
+- Default template in Swift
+- Login template
+- 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
++-- Presenter
+|   +-- VIPERPresenter.h
+|   +-- VIPERPresenter.m
++-- ViewController
+|   +-- VIPERViewController.h
+|   +-- VIPERViewController.m
++-- WireFrame
+|   +-- VIPERWireFrame.h
+|   +-- VIPERWireFrame.m
++-- Protocols
+|   +-- VIPERProtocols.h
+.swift
++-- DataManager
+|   +-- VIPERDataManager.swift
++-- Interactor
+|   +-- VIPERInteractor.swift
++-- Presenter
+|   +-- VIPERPresenter.swift
++-- ViewController
+|   +-- VIPERViewController.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
+```
+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
+
+## 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.
+
+## Resources
+- 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/ -->

data/bin/mvcgen

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+#require 'rubygems'
+require 'mvcgen/mvcthor'
+
+puts "------- MVC GENERATOR---------\n"
+puts ARGV
+MVCgen::MVCThor.start(ARGV)
+puts "--------------------------------\n"

data/lib/mvcgen.rb

@@ -0,0 +1,6 @@
+require 'mvcgen/generator'
+require 'mvcgen/filemanager'
+require 'mvcgen/dirutils'
+require 'mvcgen/version'
+require 'mvcgen/mvcthor'
+require 'mvcgen/templatemanager'

data/lib/mvcgen/dirutils.rb

@@ -0,0 +1,17 @@
+module MVCgen
+	class DirUtils
+		# Return a directory with the project libraries.
+	    def self.gem_libdir
+	      t = ["#{File.dirname(File.expand_path($0))}/../lib/#{MVCgen::NAME}",
+	           "#{Gem.dir}/gems/#{MVCgen::NAME}-#{MVCgen::VERSION}/lib/#{MVCgen::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/mvcgen/filemanager.rb

@@ -0,0 +1,51 @@
+module MVCgen
+	# File manager class
+	class FileManager
+
+		# Returns if the template is valid by the MVC generator 
+		def self.is_template_valid(template)
+			return MVCgen::TemplateManager.templates.include? template
+		end
+
+		# Returns if the language is valid by the MVC generator
+		def self.is_language_valid(language)
+			return (MVCgen::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(MVCgen::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 mvc path 
+		# @return Destination root path
+		def self.destination_mvc_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/mvcgen/generator.rb

@@ -0,0 +1,58 @@
+module MVCgen
+	# Cosntants
+	class Generator
+		# Constants
+		LANGUAGES = ["swift"]
+		REPLACEMENT_KEY = "MVC"
+
+		# Main method that generate the MVC files structure
+		def self.generate_mvc(template, language, name, path)
+			puts "Generating MVC-Module"
+			puts "Template: #{template}"
+			puts "Language: #{language}"
+			puts "Name: #{name}"
+			puts "Path: #{path}"
+			path_from = MVCgen::FileManager.path_from(template, language)
+			path_to = MVCgen::FileManager.destination_mvc_path(path, name)
+			MVCgen::FileManager.copy(path_from, path_to)
+			files = MVCgen::FileManager.files_in_path(path_to)
+			rename_files(files,name)
+		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)
+			files.each do |file|
+				raise SyntaxError unless file.include? (MVCgen::Generator::REPLACEMENT_KEY)
+				rename_file(file, name)
+			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)
+			new_path = file.gsub((MVCgen::Generator::REPLACEMENT_KEY), name)
+			MVCgen::FileManager.move(file, new_path)
+			rename_file_content(new_path, name)
+		end
+
+		# Rename the file content
+		# @return: An String with the every MVC replaced by 'name'
+		def self.rename_file_content(filename, name)
+			# Reading content
+			file = File.open(filename, "rb")
+			content = file.read
+			file.close
+
+			# Replacing content
+			content = content.gsub((MVCgen::Generator::REPLACEMENT_KEY), name)
+
+			# Saving content with replaced string
+			File.open(filename, "w+") do |file|
+   				file.write(content)
+			end
+		end
+	end
+end

data/lib/mvcgen/mvcthor.rb

@@ -0,0 +1,19 @@
+require 'thor'
+require 'mvcgen'
+
+module MVCgen
+  class MVCThor < Thor
+	desc "generate", "Generate a MVC 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"
+	def generate(name)
+		MVCgen::Generator.generate_mvc(options[:template], options[:language], name, options[:path])
+	end
+
+	desc "templates", "Get a list of available templates"
+	def templates()
+		puts MVCgen::TemplateManager.templates_description()
+	end
+  end
+end

data/lib/mvcgen/templatemanager.rb

@@ -0,0 +1,53 @@
+require 'yaml'
+module MVCgen
+	class TemplateManager
+
+		# Returns the templates dir
+	    def self.templates_dir
+	      t = "#{Gem.dir}/gems/#{MVCgen::NAME}-#{MVCgen::VERSION}/lib/templates"
+	    end
+
+		# Get the available templates paths
+		# @return Array[String] with available templates paths
+		def self.templates_paths()
+			template_dir = MVCgen::TemplateManager.templates_dir
+			return MVCgen::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,'mvcspec.yml'))
+
+			# Generating string
+			template_description+= "| #{template_name_from_path(template_path)} by #{template_content["author"]} |: #{template_content["template_description"]}"
+		end
+	end
+end

data/lib/mvcgen/version.rb

@@ -0,0 +1,4 @@
+module MVCgen
+  NAME = "mvcgen"
+  VERSION = "0.1.2"
+end

data/lib/templates/default/mvcspec.yml

@@ -0,0 +1,4 @@
+author: daniel
+author_email: daniel.martinezcg@gmail.com
+template_description: Default template with the simplest structure using MVC
+updated_at: 2018-07-23

data/lib/templates/default/objc/DataManager/VIPERDataManager.h

@@ -0,0 +1,15 @@
+//
+// Created by Pedro Piñera Buendía on 2014.
+// Copyright (c) 2014 Redbooth. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+
+@interface VIPERDataManager : NSObject <VIPERDataManagerInputProtocol>
+
+// Properties
+@property (nonatomic, weak) id <VIPERDataManagerOutputProtocol> interactor;
+
+@end

data/lib/templates/default/objc/DataManager/VIPERDataManager.m

@@ -0,0 +1,11 @@
+//
+// Created by Pedro Piñera Buendía on 2014.
+// Copyright (c) 2014 Redbooth. All rights reserved.
+//
+
+#import "VIPERDataManager.h"
+
+
+@implementation VIPERDataManager
+
+@end

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

@@ -0,0 +1,16 @@
+//
+// Created by Pedro Piñera Buendía on 2014.
+// Copyright (c) 2014 Redbooth. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+
+@interface VIPERInteractor : NSObject <VIPERInteractorInputProtocol, VIPERDataManagerOutputProtocol>
+
+// Properties
+@property (nonatomic, weak) id <VIPERInteractorOutputProtocol> presenter;
+@property (nonatomic, strong) id <VIPERDataManagerInputProtocol> dataManager;
+
+@end

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

@@ -0,0 +1,10 @@
+//
+// Created by Pedro Piñera Buendía on 2014.
+// Copyright (c) 2014 Redbooth. All rights reserved.
+//
+
+#import "VIPERInteractor.h"
+
+@implementation VIPERInteractor
+
+@end

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

@@ -0,0 +1,18 @@
+//
+// Created by Pedro Piñera Buendía on 2014.
+// Copyright (c) 2014 Redbooth. All rights reserved.
+//
+
+#import <Foundation/Foundation.h>
+#import "VIPERProtocols.h"
+
+@class VIPERWireFrame;
+
+@interface VIPERPresenter : NSObject <VIPERPresenterProtocol, VIPERInteractorOutputProtocol>
+
+// Properties
+@property (nonatomic, weak) id <VIPERViewProtocol> view;
+@property (nonatomic, strong) id <VIPERInteractorInputProtocol> interactor;
+@property (nonatomic, strong) VIPERWireFrame *wireFrame;
+
+@end