viperaptor 2.0.0

data/lib/viperaptor/helpers/rambafile.rb

@@ -0,0 +1,75 @@
+require "tty-prompt"
+
+module Viperaptor
+
+  # Provides methods for validating Rambafile contents
+  class RambafileValidator
+    # Method validates Rambafile contents
+    # @param path [String] The path to a Rambafile
+    #
+    # @return [Void]
+    def validate(path)
+      file_contents = open(path).read
+      preferences = file_contents.empty? ? {} : YAML.load(file_contents).to_hash
+    end
+  end
+
+  class Rambafile
+
+    def self.exist
+      Dir[RAMBAFILE_NAME + "*"].count > 0
+    end
+
+    def self.suffix(name)
+      self.rambafile
+      name + @@rambafile_name_suffix
+    end
+
+    def self.rambafile
+
+      if @@rambafile == nil
+
+        files = Dir[RAMBAFILE_NAME + "*"]
+
+        if files.count == 0
+          puts("No Rambafile found".red)
+          exit
+        end
+
+        if files.count == 1
+          @@rambafile_name = files[0]
+        else
+          prompt = TTY::Prompt.new
+          choices = files.sort
+          @@rambafile_name = prompt.select("Select Rambafile?", choices, per_page: choices.count)
+        end
+
+        @@rambafile_name_suffix = @@rambafile_name[RAMBAFILE_NAME.length..-1]
+
+        self.validate
+        @@rambafile = YAML.load_file(@@rambafile_name)
+        self.load_defaults
+      end
+
+      @@rambafile
+    end
+
+    private
+
+    def self.validate
+      rambafile_validator = Viperaptor::RambafileValidator.new
+      rambafile_validator.validate(@@rambafile_name)
+    end
+
+    def self.load_defaults
+      @@rambafile[CATALOGS_KEY] = rambafile[CATALOGS_KEY] || []
+      @@rambafile[TEMPLATES_KEY] = rambafile[TEMPLATES_KEY] || []
+      @@rambafile[COMPANY_KEY] = @@rambafile[COMPANY_KEY] || ''
+    end
+
+    @@rambafile_name = nil
+    @@rambafile = nil
+
+  end
+
+end

data/lib/viperaptor/helpers/template_helper.rb

@@ -0,0 +1,76 @@
+module Viperaptor
+  # Provides a number of helper methods for manipulating Viperaptor template files
+  class TemplateHelper
+
+    def self.detect_template_location(template_name)
+
+      catalogs_path = Pathname.new(ENV['HOME'])
+                              .join(APP_HOME_DIR)
+                              .join(CATALOGS_DIR)
+
+      catalog_template_list_helper = CatalogTemplateListHelper.new
+
+      catalogs = catalogs_path.children.select { |child|
+        child.directory? && child.split.last.to_s[0] != '.'
+      }
+
+      catalog = ([
+        Pathname.new(Dir.getwd).join(Rambafile.suffix(TEMPLATES_FOLDER)),
+      ] + catalogs)
+       .detect do |catalog_path|
+        next if !catalog_path.exist?
+        templates = catalog_template_list_helper.obtain_all_templates_from_a_catalog(catalog_path)
+        templates.include?(template_name)
+      end
+
+      return nil if catalog == nil
+
+      path = catalog_template_list_helper.template_path(catalog, template_name)
+
+      error_description = "Cannot find template named '#{template_name}'! Add it to the Rambafile and run *viperaptor template install*".red
+      raise StandardError, error_description if path.nil?
+
+      path
+    end
+
+    # Returns a file path for a specific template .rambaspec file
+    # @param template_name [String] The Viperaptor template name
+    #
+    # @return [Pathname]
+    def self.obtain_spec(template_name)
+      template_path = self.obtain_path(template_name)
+      spec_path = template_path.join(template_name + RAMBASPEC_EXTENSION)
+
+      spec_path
+    end
+
+    # Returns a file path for a specific template folder
+    # @param template_name [String] The Viperaptor template name
+    #
+    # @return [Pathname]
+    def self.obtain_path(template_name)
+      path = self.detect_template_location(template_name)
+
+      error_description = "Cannot find template named #{template_name}! Add it to the Rambafile and run *viperaptor template install*".red
+      raise StandardError, error_description unless path != nil && path.exist?
+
+      path
+    end
+
+    def self.global_templates
+
+      downloader = CatalogDownloader.new
+      catalog_template_list_helper = CatalogTemplateListHelper.new
+
+      templates = []
+      catalog_paths = downloader.update_all_catalogs_and_return_filepaths(true)
+      catalog_paths.each do |path|
+        templates += catalog_template_list_helper.obtain_all_templates_from_a_catalog(path)
+        templates = templates.uniq
+      end
+
+      templates.sort
+    end
+
+  end
+end

data/lib/viperaptor/helpers/xcodeproj_helper.rb

@@ -0,0 +1,256 @@
+module Viperaptor
+  # Provides a number of helper methods for working with xcodeproj gem
+  class XcodeprojHelper
+    # Returns a PBXProject class for a given name
+    # @param project_name [String] The name of the project file
+    #
+    # @return [Xcodeproj::Project]
+    def self.obtain_project(project_name)
+      Xcodeproj::Project.open(project_name)
+    end
+
+    # Adds a provided file to a specific Project and Target
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    # @param targets_name [String] Array of targets name
+    # @param group_path [Pathname] The Xcode group path for current file
+    # @param dir_path [Pathname] The directory path for current file
+    # @param file_group_path [String] Directory path
+    # @param file_name [String] Current file name
+    # @param file_is_resource [TrueClass or FalseClass] If true then file is resource
+    #
+    # @return [void]
+    def self.add_file_to_project_and_targets(project, targets_name, group_path, dir_path, file_group_path, file_name, file_is_resource = false)
+      file_path = dir_path
+      file_path = file_path.join(file_group_path) if file_group_path
+      file_path = file_path.join(file_name) if file_name
+
+      module_group = self.retrieve_group_or_create_if_needed(group_path, dir_path, file_group_path, project, true)
+      xcode_file = module_group.new_file(File.absolute_path(file_path))
+
+      targets_name.each do |target|
+        xcode_target = obtain_target(target, project)
+
+        if file_is_resource || self.is_bundle_resource?(file_name)
+          xcode_target.add_resources([xcode_file])
+        elsif self.is_compile_source?(file_name)
+          xcode_target.add_file_references([xcode_file])
+        end
+      end
+    end
+
+    # Adds a provided directory to a specific Project
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    # @param group_path [Pathname] The Xcode group path for current directory
+    # @param dir_path [Pathname] The directory path for current directory
+    # @param directory_name [String] Current directory name
+    #
+    # @return [void]
+    def self.add_group_to_project(project, group_path, dir_path, directory_name)
+      self.retrieve_group_or_create_if_needed(group_path, dir_path, directory_name, project, true)
+    end
+
+    # File is a compiled source
+    # @param file_name [String] String of file name
+    #
+    # @return [TrueClass or FalseClass]
+    def self.is_compile_source?(file_name)
+      File.extname(file_name) == '.m' || File.extname(file_name) == '.swift' || File.extname(file_name) == '.mm'
+    end
+
+    # File is a resource
+    # @param resource_name [String] String of resource name
+    #
+    # @return [TrueClass or FalseClass]
+    def self.is_bundle_resource?(resource_name)
+      File.extname(resource_name) == '.xib' || File.extname(resource_name) == '.storyboard'
+    end
+
+    # Recursively clears children of the given group
+    # @param project [Xcodeproj::Project] The working Xcode project file
+    # @param group_path [Pathname] The full group path
+    #
+    # @return [Void]
+    def self.clear_group(project, targets_name, group_path)
+      module_group = self.retrieve_group_or_create_if_needed(group_path, nil, nil, project, false)
+      return unless module_group
+
+      files_path = self.files_path_from_group(module_group, project)
+      return unless files_path
+
+      files_path.each do |file_path|
+        self.remove_file_by_file_path(file_path, targets_name, project)
+      end
+
+      module_group.clear
+    end
+
+    # Finds a group in a xcodeproj file with a given path
+    # @param project [Xcodeproj::Project] The working Xcode project file
+    # @param group_path [Pathname] The full group path
+    #
+    # @return [TrueClass or FalseClass]
+    def self.module_with_group_path_already_exists(project, group_path)
+      module_group = self.retrieve_group_or_create_if_needed(group_path, nil, nil, project, false)
+      module_group.nil? ? false : true
+    end
+
+    private
+
+    # Finds or creates a group in a xcodeproj file with a given path
+    # @param group_path [Pathname] The Xcode group path for module
+    # @param dir_path [Pathname] The directory path for module
+    # @param file_group_path [String] Directory path
+    # @param project [Xcodeproj::Project] The working Xcode project file
+    # @param create_group_if_not_exists [TrueClass or FalseClass] If true nonexistent group will be created
+    #
+    # @return [PBXGroup]
+    def self.retrieve_group_or_create_if_needed(group_path, dir_path, file_group_path, project, create_group_if_not_exists)
+      group_names = path_names_from_path(group_path)
+      group_components_count = group_names.count
+      group_names += path_names_from_path(file_group_path) if file_group_path
+
+      final_group = project
+
+      group_names.each_with_index do |group_name, index|
+        next_group = final_group[group_name]
+
+        unless next_group
+          return nil unless create_group_if_not_exists
+
+          if group_path != dir_path && index == group_components_count-1
+            next_group = final_group.new_group(group_name, dir_path, :project)
+          else
+            next_group = final_group.new_group(group_name, group_name)
+          end
+        end
+
+        final_group = next_group
+      end
+
+      final_group
+    end
+
+    # Returns an AbstractTarget class for a given name
+    # @param target_name [String] The name of the target
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    #
+    # @return [Xcodeproj::AbstractTarget]
+    def self.obtain_target(target_name, project)
+      project.targets.each do |target|
+        return target if target.name == target_name
+      end
+
+      error_description = "Cannot find a target with name #{target_name} in Xcode project".red
+      raise StandardError, error_description
+    end
+
+    # Splits the provided Xcode path to an array of separate paths
+    # @param path The full group or file path
+    #
+    # @return [[String]]
+    def self.path_names_from_path(path)
+      path.to_s.split('/')
+    end
+
+    # Remove build file from target build phase
+    # @param file_path [String] The path of the file
+    # @param targets_name [String] Array of targets
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    #
+    # @return [Void]
+    def self.remove_file_by_file_path(file_path, targets_name, project)
+      file_names = path_names_from_path(file_path)
+
+      build_phases = nil
+
+      if self.is_compile_source?(file_names.last)
+        build_phases = self.build_phases_from_targets(targets_name, project)
+      elsif self.is_bundle_resource?(file_names.last)
+        build_phases = self.resources_build_phase_from_targets(targets_name, project)
+      end
+
+      self.remove_file_from_build_phases(file_path, build_phases)
+    end
+
+    def self.remove_file_from_build_phases(file_path, build_phases)
+      return if build_phases.nil?
+
+      build_phases.each do |build_phase|
+        build_phase.files.each do |build_file|
+          next if build_file.nil? || build_file.file_ref.nil?
+
+          build_file_path = self.configure_file_ref_path(build_file.file_ref)
+
+          if build_file_path == file_path
+            build_phase.remove_build_file(build_file)
+          end
+        end
+      end
+    end
+
+    # Find and return target build phases
+    # @param targets_name [String] Array of targets
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    #
+    # @return [[PBXSourcesBuildPhase]]
+    def self.build_phases_from_targets(targets_name, project)
+      build_phases = []
+
+      targets_name.each do |target_name|
+        xcode_target = self.obtain_target(target_name, project)
+        xcode_target.build_phases.each do |build_phase|
+          if build_phase.isa == 'PBXSourcesBuildPhase'
+            build_phases.push(build_phase)
+          end
+        end
+      end
+
+      build_phases
+    end
+
+    # Find and return target resources build phase
+    # @param targets_name [String] Array of targets
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    #
+    # @return [[PBXResourcesBuildPhase]]
+    def self.resources_build_phase_from_targets(targets_name, project)
+      resource_build_phase = []
+
+      targets_name.each do |target_name|
+        xcode_target = self.obtain_target(target_name, project)
+        resource_build_phase.push(xcode_target.resources_build_phase)
+      end
+
+      resource_build_phase
+    end
+
+    # Get configure file full path
+    # @param file_ref [PBXFileReference] Build file
+    #
+    # @return [String]
+    def self.configure_file_ref_path(file_ref)
+      build_file_ref_path = file_ref.hierarchy_path.to_s
+      build_file_ref_path[0] = ''
+
+      build_file_ref_path
+    end
+
+    # Get all files path from group path
+    # @param module_group [PBXGroup] The module group
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    #
+    # @return [[String]]
+    def self.files_path_from_group(module_group, _project)
+      files_path = []
+
+      module_group.recursive_children.each do |file_ref|
+        if file_ref.isa == 'PBXFileReference'
+          file_ref_path = configure_file_ref_path(file_ref)
+          files_path.push(file_ref_path)
+        end
+      end
+
+      files_path
+    end
+  end
+end

data/lib/viperaptor/module_generator.rb

@@ -0,0 +1,104 @@
+require 'fileutils'
+
+require 'viperaptor/helpers/xcodeproj_helper.rb'
+require 'viperaptor/helpers/module_info_generator.rb'
+
+module Viperaptor
+
+	# 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
+			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
+
+			# 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)
+			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.project_group_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, 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) 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 file_group
+					XcodeprojHelper.add_group_to_project(project, group_path, dir_path, directory_name)
+
+					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)
+				file_path = dir_path
+				file_path = file_path.join(file_group) if file_group
+				file_path = file_path.join(file_name) if file_name
+
+				# Creating the file in the filesystem
+				FileUtils.mkdir_p File.dirname(file_path)
+				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,
+																												file_is_resource)
+			end
+		end
+	end
+end

data/lib/viperaptor/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/viperaptor/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/viperaptor/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/viperaptor/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/viperaptor/template/creator/template_creator.rb

@@ -0,0 +1,39 @@
+module Viperaptor
+
+  # 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