generamba-udf 2.0.1

data/lib/generamba/module_generator.rb

@@ -0,0 +1,148 @@
+require 'fileutils'
+
+require 'generamba/helpers/xcodeproj_helper.rb'
+require 'generamba/helpers/module_info_generator.rb'
+
+module Generamba
+
+	# Responsible for creating the whole code module using information from the CLI
+	class ModuleGenerator
+
+		def generate_module(name, code_module, template)
+			# Setting up Xcode objects
+			project = XcodeprojHelper.obtain_project(code_module.xcodeproj_path)
+
+            # Configuring file paths
+            if code_module.project_file_root && code_module.test_file_root
+                FileUtils.mkdir_p code_module.project_file_root if code_module.project_file_root
+                FileUtils.mkdir_p code_module.test_file_root if code_module.test_file_root
+            else
+                FileUtils.mkdir_p code_module.project_file_path if code_module.project_file_path
+                FileUtils.mkdir_p code_module.test_file_path if code_module.test_file_path
+            end
+
+			FileUtils.mkdir_p code_module.test_unit_path if code_module.test_unit_path
+			FileUtils.mkdir_p code_module.test_snapshot_path if code_module.test_snapshot_path			
+
+			# Creating code files
+			if code_module.project_targets && code_module.project_group_path && code_module.project_file_path
+				puts('Creating code files...')
+				process_files_if_needed(template.code_files,
+																code_module,
+																template,
+																project,
+																code_module.project_targets,
+																code_module.project_group_path,
+																code_module.project_file_path,
+																code_module.project_file_root)
+			end
+
+			# Creating test files
+			if code_module.test_targets && code_module.test_group_path && code_module.test_file_path
+				puts('Creating test files...')
+				process_files_if_needed(template.test_files,
+																code_module,
+																template,
+																project,
+																code_module.test_targets,
+																code_module.test_group_path,
+																code_module.test_file_path,
+																code_module.test_file_root,
+																[code_module.project_group_path])
+			end
+
+			# Creating unit test files
+			if code_module.test_unit_target && code_module.test_unit_path && code_module.test_unit_testable_import
+				puts('Creating unit test files...')
+				process_files_if_needed(template.test_unit_files,
+																code_module,
+																template,
+																project,
+																[code_module.test_unit_target],
+																code_module.test_unit_path,
+																code_module.test_unit_path,
+																code_module.test_unit_path,
+																[code_module.test_unit_path])
+			end
+
+			# Creating snapshot test files
+			if code_module.test_snapshot_target && code_module.test_snapshot_path && code_module.test_snapshot_testable_import
+				puts('Creating snapshot test files...')
+				process_files_if_needed(template.test_snapshot_files,
+																code_module,
+																template,
+																project,
+																[code_module.test_snapshot_target],
+																code_module.test_snapshot_path,
+																code_module.test_snapshot_path,
+																code_module.test_snapshot_path,
+																[code_module.test_snapshot_path])
+			end
+
+			# Saving the current changes in the Xcode project
+			project.save
+
+			puts 'Module successfully created!'
+			puts "Name: #{name}".green
+			puts "Project file path: #{code_module.project_file_path}".green if code_module.project_file_path
+			puts "Project group path: #{code_module.project_group_path}".green if code_module.project_group_path
+			puts "Test file path: #{code_module.test_file_path}".green if code_module.test_file_path
+			puts "Test group path: #{code_module.test_group_path}".green if code_module.test_group_path
+		end
+
+		def process_files_if_needed(files, code_module, template, project, targets, group_path, dir_path, root_path, processed_groups = [])
+			# It's possible that current project doesn't test targets configured, so it doesn't need to generate tests.
+			# The same is for files property - a template can have only test or project files
+			if targets.count == 0 || files == nil || files.count == 0 || dir_path == nil || group_path == nil
+				return
+			end
+
+			XcodeprojHelper.clear_group(project, targets, group_path, code_module.create_logical_groups) unless processed_groups.include? group_path
+			files.each do |file|
+				unless file[TEMPLATE_FILE_PATH_KEY]
+					directory_name = file[TEMPLATE_NAME_KEY].gsub(/^\/|\/$/, '')
+					file_group = dir_path.join(directory_name)
+
+					FileUtils.mkdir_p root_path
+					XcodeprojHelper.add_group_to_project(project, group_path, dir_path, directory_name, code_module.create_logical_groups)
+
+					next
+				end
+
+				file_group = File.dirname(file[TEMPLATE_NAME_KEY])
+				file_group = nil if file_group == '.'
+
+				module_info = ModuleInfoGenerator.new(code_module)
+
+				# Generating the content of the code file and it's name
+				file_name, file_content = ContentGenerator.create_file(file, module_info.scope, template)
+                if code_module.create_logical_groups
+                    file_path = root_path
+                else
+                    file_path = dir_path
+                    file_path = file_path.join(file_group) if file_group
+                end
+                
+				file_path = file_path.join(file_name) if file_name
+
+				# Creating the file in the filesystem
+                FileUtils.mkdir_p File.dirname(file_path) if !code_module.create_logical_groups
+				File.open(file_path, 'w+') do |f|
+					f.write(file_content)
+				end
+
+				file_is_resource = file[TEMPLATE_FILE_IS_RESOURCE_KEY]
+
+				# Creating the file in the Xcode project
+				XcodeprojHelper.add_file_to_project_and_targets(project,
+																												targets,
+																												group_path,
+																												dir_path,
+																												file_group,
+																												file_name,
+																												root_path,
+																												file_is_resource)
+			end
+		end
+	end
+end

data/lib/generamba/template/creator/new_template/Code/Service/service.h.liquid

@@ -0,0 +1,11 @@
+//
+//  {{ prefix }}{{ module_info.name }}{{ module_info.file_name }}
+//  {{ module_info.project_name }}
+//
+//  Created by {{ developer.name }} on {{ date }}.
+//  Copyright {{ year }} {{ developer.company }}. All rights reserved.
+//
+
+@interface {{ prefix }}{{ module_info.name }}Service : NSObject
+
+@end

data/lib/generamba/template/creator/new_template/Code/Service/service.m.liquid

@@ -0,0 +1,13 @@
+//
+//  {{ prefix }}{{ module_info.name }}{{ module_info.file_name }}
+//  {{ module_info.project_name }}
+//
+//  Created by {{ developer.name }} on {{ date }}.
+//  Copyright {{ year }} {{ developer.company }}. All rights reserved.
+//
+
+#import "{{ prefix }}{{ module_info.name }}Service.h"
+
+@implementation {{ prefix }}{{ module_info.name }}Service
+
+@end

data/lib/generamba/template/creator/new_template/Tests/Service/service_tests.m.liquid

@@ -0,0 +1,35 @@
+//
+//  {{ prefix }}{{ module_info.name }}{{ module_info.file_name }}
+//  {{ module_info.project_name }}
+//
+//  Created by {{ developer.name }} on {{ date }}.
+//  Copyright {{ year }} {{ developer.company }}. All rights reserved.
+//
+
+#import <XCTest/XCTest.h>
+
+#import "{{ prefix }}{{ module_info.name }}Service.h"
+
+@interface {{ prefix }}{{ module_info.name }}ServiceTests : XCTestCase
+
+@property (strong, nonatomic) {{ prefix }}{{ module_info.name }}Service *service;
+
+@end
+
+@implementation {{ prefix }}{{ module_info.name }}ServiceTests
+
+#pragma mark - Test environment setup
+
+- (void)setUp {
+    [super setUp];
+
+    self.service = [[{{ prefix }}{{ module_info.name }}Service alloc] init];
+}
+
+- (void)tearDown {
+    self.service = nil;
+
+    [super tearDown];
+}
+
+@end

data/lib/generamba/template/creator/new_template/template.rambaspec.liquid

@@ -0,0 +1,20 @@
+# Template information section
+name: {{ name }}
+summary: {{ summary }}
+author: {{ author }}
+version: 1.0.0
+license: {{ license }}
+
+# The declarations for code files
+code_files:
+- {name: Service/Service.h, path: Code/Service/service.h.liquid}
+- {name: Service/Service.m, path: Code/Service/service.m.liquid}
+
+# The declarations for test files
+test_files:
+- {name: Service/ServiceTests.m, path: Tests/Service/service_tests.m.liquid}
+
+# Template dependencies
+dependencies:
+{% for dependency in dependencies %}- {{ dependency }}
+{% endfor %}

data/lib/generamba/template/creator/template_creator.rb

@@ -0,0 +1,39 @@
+module Generamba
+
+  # Responsible for generating new .rambaspec files
+  class TemplateCreator
+
+    NEW_TEMPLATE_FOLDER = 'new_template'
+    RAMBASPEC_TEMPLATE_NAME = 'template.rambaspec.liquid'
+    CODE_FOLDER = 'Code'
+    TESTS_FOLDER = 'Tests'
+
+    # Generates and saves to filesystem a new template with a .rambaspec file and sample code and tests files
+    # @param properties [Hash] User-inputted template properties
+    #
+    # @return [Void]
+    def create_template(properties)
+      template_dir_path = Pathname.new(File.dirname(__FILE__)).join(NEW_TEMPLATE_FOLDER)
+      rambaspec_template_file_path = template_dir_path.join(RAMBASPEC_TEMPLATE_NAME)
+      code_file_path = template_dir_path.join(CODE_FOLDER)
+      tests_file_path = template_dir_path.join(TESTS_FOLDER)
+
+      file_source = IO.read(rambaspec_template_file_path)
+
+      template = Liquid::Template.parse(file_source)
+      output = template.render(properties)
+
+      result_name = properties[TEMPLATE_NAME_KEY] + RAMBASPEC_EXTENSION
+      result_dir_path = Pathname.new(properties[TEMPLATE_NAME_KEY])
+
+      FileUtils.mkdir_p result_dir_path
+      FileUtils.cp_r(code_file_path, result_dir_path)
+      FileUtils.cp_r(tests_file_path, result_dir_path)
+
+      File.open(result_dir_path.join(result_name), 'w+') {|f|
+        f.write(output)
+      }
+    end
+
+  end
+end

data/lib/generamba/template/helpers/catalog_downloader.rb

@@ -0,0 +1,58 @@
+require 'git'
+
+module Generamba
+
+  # Provides the functionality to download template catalogs from the remote repository
+  class CatalogDownloader
+
+    # Updates all of the template catalogs and returns their filepaths.
+    # If there is a Rambafile in the current directory, it also updates all of the catalogs specified there.
+    #
+    # @return [Array] An array of filepaths to downloaded catalogs
+    def update_all_catalogs_and_return_filepaths
+      does_rambafile_exist = Dir[RAMBAFILE_NAME].count > 0
+
+      if does_rambafile_exist
+        rambafile = YAML.load_file(RAMBAFILE_NAME)
+        catalogs = rambafile[CATALOGS_KEY]
+      end
+
+      terminator = CatalogTerminator.new
+      terminator.remove_all_catalogs
+
+      catalog_paths = [download_catalog(GENERAMBA_CATALOG_NAME, RAMBLER_CATALOG_REPO)]
+
+      if catalogs != nil && catalogs.count > 0
+        catalogs.each do |catalog_url|
+          catalog_name = catalog_url.split('://').last
+          catalog_name = catalog_name.gsub('/', '-');
+          catalog_paths.push(download_catalog(catalog_name, catalog_url))
+        end
+      end
+      return catalog_paths
+    end
+
+    # Clones a template catalog from a remote repository
+    #
+    # @param name [String] The name of the template catalog
+    # @param url [String] The url of the repository
+    #
+    # @return [Pathname] A filepath to the downloaded catalog
+    def download_catalog(name, url)
+      catalogs_local_path = Pathname.new(ENV['HOME'])
+                               .join(GENERAMBA_HOME_DIR)
+                               .join(CATALOGS_DIR)
+      current_catalog_path = catalogs_local_path
+                                 .join(name)
+
+      if File.exists?(current_catalog_path)
+        g = Git.open(current_catalog_path)
+        g.pull
+      else
+        Git.clone(url, name, :path => catalogs_local_path)
+      end
+
+      return current_catalog_path
+    end
+  end
+end

data/lib/generamba/template/helpers/catalog_template_list_helper.rb

@@ -0,0 +1,23 @@
+module Generamba
+
+  # Provides the functionality to list all of the templates, available in the catalog
+  class CatalogTemplateListHelper
+
+    # Finds out all of the templates located in a catalog
+    #
+    # @param catalog_path [Pathname] The path to a template catalog
+    #
+    # @return [Array] An array with template names
+    def obtain_all_templates_from_a_catalog(catalog_path)
+      template_names = []
+      catalog_path.children.select { |child|
+        File.directory?(child) && child.split.last.to_s[0] != '.'
+      }.map { |template_path|
+        template_path.split.last.to_s
+      }.each { |template_name|
+        template_names.push(template_name)
+      }
+      return template_names
+    end
+  end
+end

data/lib/generamba/template/helpers/catalog_template_search_helper.rb

@@ -0,0 +1,27 @@
+module Generamba
+
+  # Provides the functionality to search templates, in catalogs
+  class CatalogTemplateSearchHelper
+
+    # Finds out all of the templates located in a catalog
+    #
+    # @param catalog_path [Pathname] The path to a template catalog
+    #
+    # @return [Array] An array with template names
+    def search_templates_in_a_catalog(catalog_path, search_term)
+      template_names = []
+
+      catalog_path.children.select { |child|
+        File.directory?(child) && child.split.last.to_s[0] != '.'
+      }.map { |template_path|
+        template_path.split.last.to_s
+      }.select { |template_name|
+        template_name.include?(search_term)
+      }.each { |template_name|
+        template_names.push(template_name)
+      }
+
+      return template_names
+    end
+  end
+end

data/lib/generamba/template/helpers/catalog_terminator.rb

@@ -0,0 +1,21 @@
+module Generamba
+
+  # Provides a functionality to terminate all previously installed catalogs
+  #
+  # @return [Void]
+  class CatalogTerminator
+    def remove_all_catalogs
+      catalogs_path = Pathname.new(ENV['HOME'])
+                          .join(GENERAMBA_HOME_DIR)
+                          .join(CATALOGS_DIR)
+      if Dir.exist?(catalogs_path) == false
+        FileUtils.mkdir_p catalogs_path
+      end
+      catalogs_path.children.select { |child|
+        child.directory? && child.split.last.to_s[0] != '.'
+      }.each { |catalog_path|
+        FileUtils.rm_rf(catalog_path)
+      }
+    end
+  end
+end

data/lib/generamba/template/helpers/rambaspec_validator.rb

@@ -0,0 +1,52 @@
+module Generamba
+
+  # Provides methods that validate .rambaspec file existance and structure
+  class RambaspecValidator
+
+    # Validates the existance of a .rambaspec file for a given template
+    #
+    # @param template_name [String] The name of the template
+    # @param template_path [String] The local filepath to the template
+    #
+    # @return [Bool]
+    def self.validate_spec_existance(template_name, template_path)
+      local_spec_path = self.obtain_spec_path(template_name, template_path)
+      File.file?(local_spec_path)
+    end
+
+    # Validates the structure of a .rambaspec file for a given template
+    #
+    # @param template_name [String] The name of the template
+    # @param template_path [String] The local filepath to the template
+    #
+    # @return [Bool]
+    def self.validate_spec(template_name, template_path)
+      spec_path = self.obtain_spec_path(template_name, template_path)
+
+      spec_source = IO.read(spec_path)
+      spec_template = Liquid::Template.parse(spec_source)
+      spec_content = spec_template.render
+      spec = YAML.load(spec_content)
+
+      is_spec_valid =
+          spec[TEMPLATE_NAME_KEY] != nil &&
+          spec[TEMPLATE_AUTHOR_KEY] != nil &&
+          spec[TEMPLATE_VERSION_KEY] != nil &&
+          (spec[TEMPLATE_CODE_FILES_KEY] != nil || spec[TEMPLATE_TEST_FILES_KEY] != nil)
+      return is_spec_valid
+    end
+
+    private
+
+    # Returns a filepath for a given .rambaspec filename
+    #
+    # @param template_name [String] The name of the template
+    # @param template_path [String] The local filepath to the template
+    #
+    # @return [Bool]
+    def self.obtain_spec_path(template_name, template_path)
+      spec_filename = template_name + RAMBASPEC_EXTENSION
+      Pathname.new(template_path).join(spec_filename)
+    end
+  end
+end

data/lib/generamba/template/installer/abstract_installer.rb

@@ -0,0 +1,9 @@
+module Generamba
+
+  # Abstract template installer class
+  class AbstractInstaller
+    def install_template(template_declaration)
+      raise 'Abstract Method - you should implement it in the concrete subclass'
+    end
+  end
+end

data/lib/generamba/template/installer/catalog_installer.rb

@@ -0,0 +1,73 @@
+require 'generamba/template/installer/abstract_installer.rb'
+require 'generamba/template/helpers/rambaspec_validator.rb'
+require 'fileutils'
+require 'tmpdir'
+
+module Generamba
+
+  # Incapsulates the logic of installing Generamba templates from the template catalog
+  class CatalogInstaller < AbstractInstaller
+    def install_template(template_declaration)
+      template_name = template_declaration.name
+      puts("Installing #{template_name}...")
+
+      template_name = template_declaration.name
+      catalogs_path = Pathname.new(ENV['HOME'])
+                         .join(GENERAMBA_HOME_DIR)
+                         .join(CATALOGS_DIR)
+
+      catalog_path = catalogs_path.children.select { |child|
+        child.directory? && child.split.last.to_s[0] != '.'
+      }.select { |catalog_path|
+        template_path = browse_catalog_for_a_template(catalog_path, template_name)
+        template_path != nil
+      }.first
+
+      if catalog_path == nil
+        error_description = "Cannot find #{template_name} in any catalog. Try another name.".red
+        puts(error_description)
+        return
+      end
+
+      template_path = catalog_path.join(template_name)
+      rambaspec_exist = Generamba::RambaspecValidator.validate_spec_existance(template_name, template_path)
+      unless rambaspec_exist
+        error_description = "Cannot find #{template_name + RAMBASPEC_EXTENSION} in the template catalog #{catalog_path}. Try another name.".red
+        puts(error_description)
+        return
+      end
+
+      rambaspec_valid = Generamba::RambaspecValidator.validate_spec(template_name, template_path)
+      unless rambaspec_valid
+        error_description = "#{template_name + RAMBASPEC_EXTENSION} is not valid.".red
+        puts(error_description)
+        return
+      end
+
+      install_path = Pathname.new(TEMPLATES_FOLDER)
+                         .join(template_name)
+      FileUtils.mkdir_p install_path
+
+      src = template_path.to_s + '/.'
+      FileUtils.cp_r(src, install_path)
+    end
+
+    private
+
+    # Browses a given catalog and returns a template path
+    #
+    # @param catalog_path [Pathname] A path to a catalog
+    # @param template_name [String] A name of the template
+    #
+    # @return [Pathname] A path to a template, if found
+    def browse_catalog_for_a_template(catalog_path, template_name)
+      template_path = catalog_path.join(template_name)
+
+      if Dir.exist?(template_path)
+        return template_path
+      end
+
+      return nil
+    end
+  end
+end

data/lib/generamba/template/installer/local_installer.rb

@@ -0,0 +1,32 @@
+require 'generamba/template/installer/abstract_installer.rb'
+require 'generamba/template/helpers/rambaspec_validator.rb'
+
+module Generamba
+
+  # Incapsulates the logic of verifying and installing local templates
+  class LocalInstaller < AbstractInstaller
+    def install_template(template_declaration)
+      template_name = template_declaration.name
+      puts("Installing #{template_name}...")
+
+      local_path = template_declaration.local
+      rambaspec_exist = Generamba::RambaspecValidator.validate_spec_existance(template_name, local_path)
+
+      unless rambaspec_exist
+        error_description = "Cannot find #{template_name + RAMBASPEC_EXTENSION} in the specified directory. Try another path or name.".red
+        raise StandardError.new(error_description)
+      end
+
+      rambaspec_valid = Generamba::RambaspecValidator.validate_spec(template_name, local_path)
+      unless rambaspec_valid
+        error_description = "#{template_name + RAMBASPEC_EXTENSION} is not valid.".red
+        raise StandardError.new(error_description)
+      end
+
+      install_path = Pathname.new(TEMPLATES_FOLDER)
+                         .join(template_name)
+      FileUtils.mkdir_p install_path
+      FileUtils.copy_entry(local_path, install_path)
+    end
+  end
+end

data/lib/generamba/template/installer/remote_installer.rb

@@ -0,0 +1,50 @@
+require 'generamba/template/installer/abstract_installer.rb'
+require 'generamba/template/helpers/rambaspec_validator.rb'
+require 'git'
+require 'fileutils'
+require 'tmpdir'
+
+module Generamba
+
+  # Incapsulates the logic of fetching remote templates, verifying and installing them
+  class RemoteInstaller < AbstractInstaller
+    def install_template(template_declaration)
+      template_name = template_declaration.name
+      puts("Installing #{template_name}...")
+
+      repo_url = template_declaration.git
+      repo_branch = template_declaration.branch
+
+      temp_path = Dir.tmpdir()
+      template_dir = Pathname.new(temp_path).join(template_name)
+
+      if repo_branch != nil
+        Git.export(repo_url, template_name, :branch => repo_branch, :path => temp_path)
+      else
+        Git.clone(repo_url, template_name, :path => temp_path)
+      end
+
+      template_path = "#{template_dir}"
+
+      rambaspec_exist = Generamba::RambaspecValidator.validate_spec_existance(template_name, template_path)
+      unless rambaspec_exist
+        FileUtils.rm_rf(temp_path)
+        error_description = "Cannot find #{template_name + RAMBASPEC_EXTENSION} in the root directory of specified repository.".red
+        raise StandardError.new(error_description)
+      end
+
+      rambaspec_valid = Generamba::RambaspecValidator.validate_spec(template_name, template_path)
+      unless rambaspec_valid
+        error_description = "#{template_name + RAMBASPEC_EXTENSION} is not valid.".red
+        raise StandardError.new(error_description)
+      end
+
+      install_path = Pathname.new(TEMPLATES_FOLDER)
+                         .join(template_name)
+      FileUtils.mkdir_p install_path
+      FileUtils.copy_entry(template_path, install_path)
+
+      FileUtils.rm_rf(temp_path)
+    end
+  end
+end

data/lib/generamba/template/installer/template_installer_factory.rb

@@ -0,0 +1,22 @@
+require 'generamba/template/processor/template_declaration'
+
+module Generamba
+
+  # Factory that creates a proper installer for a given template type
+  class TemplateInstallerFactory
+
+    # Provides the appropriate strategy for a given template type
+    def installer_for_type(type)
+      case type
+        when TemplateDeclarationType::LOCAL_TEMPLATE
+          return Generamba::LocalInstaller.new
+        when TemplateDeclarationType::REMOTE_TEMPLATE
+          return Generamba::RemoteInstaller.new
+        when TemplateDeclarationType::CATALOG_TEMPLATE
+          return Generamba::CatalogInstaller.new
+        else
+          return nil
+      end
+    end
+  end
+end