vipergen-xctestable 0.2.9

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"
+        SWIFT_MODULE_REPLACEMENT_KEY = "SWIFT_MODULE"
+
+		# Main method that generate the VIPER files structure
+		def self.generate_viper(template, language, name, path, author, swift_module)
+			puts "Generating VIPER-Module"
+			puts "Template: #{template}"
+			puts "Language: #{language}"
+			puts "Name: #{name}"
+			puts "Path: #{path}"
+			puts "Author: #{author}"
+            puts "Module: #{swift_module}"
+			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, swift_module)
+		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, swift_module)
+			files.each do |file|
+				raise SyntaxError unless file.include? (Vipergen::Generator::REPLACEMENT_KEY)
+				rename_file(file, name, author, swift_module)
+			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, swift_module)
+			new_path = file.gsub((Vipergen::Generator::REPLACEMENT_KEY), name)
+			Vipergen::FileManager.move(file, new_path)
+			rename_file_content(new_path, name, author, swift_module)
+		end
+
+		# Rename the file content
+		# @return: An String with the every VIPER replaced by 'name'
+		def self.rename_file_content(filename, name, author, swift_module)
+			# 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::SWIFT_MODULE_REPLACEMENT_KEY), swift_module)
+			content = content.gsub((Vipergen::Generator::YEAR_REPLACEMENT_KEY), "#{Time.new.year}")
+
+			# 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 = "vipergen"
+  VERSION = "0.2.9"
+end

data/lib/vipergen/viperthor.rb

@@ -0,0 +1,21 @@
+require 'thor'
+require 'vipergen'
+
+module Vipergen
+  class ViperThor < Thor
+	desc "generate", "Generate a VIPER module"
+	option :language, :required => false, :default => 'objc', :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 :swift_module, :required => false, :default => 'VIPER', :type => :string , :desc => "Swift module name to be specified on the @testable directive. Otherwise VIPER will be used"
+	def generate(name)
+        Vipergen::Generator.generate_viper(options[:template], options[:language], name, options[:path], options[:author], options[:swift_module])
+	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,133 @@
+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} 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")
+			file = File.open("test.txt", "rb")
+			content = file.read
+			expect(content).to eq("I'm a RENAMED file by pepito 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")
+		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")}.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"
+			Vipergen::Generator.rename_file(file, name, author)
+			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"
+			expect(Vipergen::Generator).to receive(:rename_file_content)
+			Vipergen::Generator.rename_file(file, name, author)
+		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

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: vipergen-xctestable
+version: !ruby/object:Gem::Version
+  version: 0.2.9
+platform: ruby
+authors:
+- Pedro Piñera
+- Michal Wojtysiak
+- Hasan Huseyin Topcu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Based on the objc.io post about VIPER. It saves time in the implementation
+  generating the controllers and adding interactions between them (in Swift or Objective-C)
+email: hhtopcu@gmail.com
+executables:
+- vipergen
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- lib/templates/default/objc/DataManager/API/VIPERAPIDataManager.h
+- lib/templates/default/objc/DataManager/API/VIPERAPIDataManager.m
+- lib/templates/default/objc/DataManager/Local/VIPERLocalDataManager.h
+- lib/templates/default/objc/DataManager/Local/VIPERLocalDataManager.m
+- lib/templates/default/objc/Interactor/VIPERInteractor.h
+- lib/templates/default/objc/Interactor/VIPERInteractor.m
+- lib/templates/default/objc/Interactor/VIPERItem.h
+- lib/templates/default/objc/Interactor/VIPERItem.m
+- lib/templates/default/objc/Presenter/VIPERPresenter.h
+- lib/templates/default/objc/Presenter/VIPERPresenter.m
+- lib/templates/default/objc/Protocols/VIPERProtocols.h
+- lib/templates/default/objc/View/VIPERView.h
+- lib/templates/default/objc/View/VIPERView.m
+- lib/templates/default/objc/WireFrame/VIPERWireFrame.h
+- lib/templates/default/objc/WireFrame/VIPERWireFrame.m
+- lib/templates/default/swift/DataManager/API/VIPERAPIDataManager.swift
+- lib/templates/default/swift/DataManager/Local/VIPERLocalDataManager.swift
+- lib/templates/default/swift/Interactor/VIPERInteractor.swift
+- lib/templates/default/swift/Interactor/VIPERItem.swift
+- lib/templates/default/swift/Presenter/VIPERPresenter.swift
+- lib/templates/default/swift/Protocols/VIPERProtocols.swift
+- lib/templates/default/swift/View/VIPERView.swift
+- lib/templates/default/swift/WireFrame/VIPERWireFrame.swift
+- lib/templates/default/viperspec.yml
+- lib/templates/testable/objc/DataManager/VIPERDataManager.h
+- lib/templates/testable/objc/DataManager/VIPERDataManager.m
+- lib/templates/testable/objc/Interactor/VIPERInteractor.h
+- lib/templates/testable/objc/Interactor/VIPERInteractor.m
+- lib/templates/testable/objc/Interactor/VIPERInteractorSpec.m
+- lib/templates/testable/objc/Presenter/VIPERPresenter.h
+- lib/templates/testable/objc/Presenter/VIPERPresenter.m
+- lib/templates/testable/objc/Presenter/VIPERPresenterSpec.m
+- lib/templates/testable/objc/Protocols/VIPERProtocols.h
+- lib/templates/testable/objc/ViewController/VIPERViewController.h
+- lib/templates/testable/objc/ViewController/VIPERViewController.m
+- lib/templates/testable/objc/ViewController/VIPERViewControllerSpec.m
+- lib/templates/testable/objc/WireFrame/VIPERWireFrame.h
+- lib/templates/testable/objc/WireFrame/VIPERWireFrame.m
+- lib/templates/testable/swift/DataManager/API/VIPERAPIDataManager.swift
+- lib/templates/testable/swift/DataManager/Local/VIPERLocalDataManager.swift
+- lib/templates/testable/swift/Interactor/VIPERInteractor.swift
+- lib/templates/testable/swift/Interactor/VIPERInteractorSpec.swift
+- lib/templates/testable/swift/Presenter/VIPERPresenter.swift
+- lib/templates/testable/swift/Presenter/VIPERPresenterSpec.swift
+- lib/templates/testable/swift/Protocols/VIPERProtocols.swift
+- lib/templates/testable/swift/View/VIPERView.swift
+- lib/templates/testable/swift/View/VIPERViewSpec.swift
+- lib/templates/testable/swift/WireFrame/VIPERWireFrame.swift
+- lib/templates/testable/viperspec.yml
+- lib/templates/xctestable/objc/DataManager/VIPERDataManager.h
+- lib/templates/xctestable/objc/DataManager/VIPERDataManager.m
+- lib/templates/xctestable/objc/Interactor/VIPERInteractor.h
+- lib/templates/xctestable/objc/Interactor/VIPERInteractor.m
+- lib/templates/xctestable/objc/Interactor/VIPERInteractorSpec.m
+- lib/templates/xctestable/objc/Presenter/VIPERPresenter.h
+- lib/templates/xctestable/objc/Presenter/VIPERPresenter.m
+- lib/templates/xctestable/objc/Presenter/VIPERPresenterSpec.m
+- lib/templates/xctestable/objc/Protocols/VIPERProtocols.h
+- lib/templates/xctestable/objc/ViewController/VIPERViewController.h
+- lib/templates/xctestable/objc/ViewController/VIPERViewController.m
+- lib/templates/xctestable/objc/ViewController/VIPERViewControllerSpec.m
+- lib/templates/xctestable/objc/WireFrame/VIPERWireFrame.h
+- lib/templates/xctestable/objc/WireFrame/VIPERWireFrame.m
+- lib/templates/xctestable/swift/DataManager/API/VIPERAPIDataManager.swift
+- lib/templates/xctestable/swift/DataManager/Local/VIPERLocalDataManager.swift
+- lib/templates/xctestable/swift/Interactor/VIPERInteractor.swift
+- lib/templates/xctestable/swift/Interactor/VIPERInteractorTests.swift
+- lib/templates/xctestable/swift/Presenter/VIPERPresenter.swift
+- lib/templates/xctestable/swift/Presenter/VIPERPresenterTests.swift
+- lib/templates/xctestable/swift/Protocols/VIPERProtocols.swift
+- lib/templates/xctestable/swift/View/VIPERView.swift
+- lib/templates/xctestable/swift/View/VIPERViewTests.swift
+- lib/templates/xctestable/swift/WireFrame/VIPERWireFrame.swift
+- lib/templates/xctestable/viperspec.yml
+- lib/vipergen/dirutils.rb
+- lib/vipergen/filemanager.rb
+- lib/vipergen/generator.rb
+- lib/vipergen/templatemanager.rb
+- lib/vipergen/version.rb
+- lib/vipergen/viperthor.rb
+- lib/vipergen.rb
+- spec/spec_helper.rb
+- spec/vipergen/vipergen_spec.rb
+- bin/vipergen
+homepage: https://github.com/hhtopcu/viper-module-generator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14.1
+signing_key: 
+specification_version: 4
+summary: Generates XCode VIPER module controllers structure
+test_files:
+- spec/spec_helper.rb
+- spec/vipergen/vipergen_spec.rb