viperaptor 2.0.0

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

@@ -0,0 +1,107 @@
+require 'git'
+require 'fileutils'
+
+module Viperaptor
+
+  # Provides the functionality to download template catalogs from the remote repository
+  class CatalogDownloader
+
+    def external_catalogs_filepaths
+
+      catalogs_path = Pathname.new(ENV['HOME'])
+                              .join(APP_HOME_DIR)
+                              .join(CATALOGS_DIR)
+
+      return [] unless catalogs_path.exist?
+
+      catalogs_path.children.select { |child|
+        child.directory? && child.split.last.to_s[0] != '.'
+      }
+    end
+
+    # 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(throttled = false)
+      does_rambafile_exist = Rambafile.exist
+
+      if does_rambafile_exist
+        rambafile = Rambafile.rambafile
+        catalogs = rambafile[CATALOGS_KEY]
+      end
+
+      # terminator = CatalogTerminator.new
+      # terminator.remove_all_catalogs
+
+      repos = (Viperaptor::UserPreferences.obtain_custom_catalogs_repos || []) + PREDEFINED_CATALOG_REPOS
+
+      catalog_paths = repos.map do |repo|
+        name = repo.split('/').last
+
+        catalogs_local_path = Pathname.new(ENV['HOME'])
+                                      .join(APP_HOME_DIR)
+                                      .join(CATALOGS_DIR)
+        current_catalog_path = catalogs_local_path
+                                 .join(name)
+
+        if !current_catalog_path.exist? || !throttled || (Time.now - current_catalog_path.mtime) > 3600.0 * 12.0
+          download_catalog(name, repo)
+        end
+
+        current_catalog_path
+      end
+
+      if catalogs != nil && catalogs.count > 0
+        catalogs.each do |catalog_url|
+
+          name = catalog_url.split('://').last
+          name = name.gsub('/', '-');
+
+          catalogs_local_path = Pathname.new(ENV['HOME'])
+                                        .join(APP_HOME_DIR)
+                                        .join(CATALOGS_DIR)
+          current_catalog_path = catalogs_local_path
+                                   .join(name)
+
+          if !current_catalog_path.exist? || !throttled || (Time.now - current_catalog_path.mtime) > 3600.0 * 12.0
+            download_catalog(name, catalog_url)
+          end
+
+          catalog_paths.push(current_catalog_path)
+        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(APP_HOME_DIR)
+                               .join(CATALOGS_DIR)
+      current_catalog_path = catalogs_local_path
+                                 .join(name)
+
+      puts("Updating #{name} specs (#{url})...")
+
+      git_dir = current_catalog_path.join('.git')
+
+      if File.directory?(git_dir)
+        g = Git.open(current_catalog_path)
+        g.pull
+        FileUtils.touch current_catalog_path
+      else
+        FileUtils.rm_rf current_catalog_path
+        Git.clone(url, name, :path => catalogs_local_path)
+      end
+
+      return current_catalog_path
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+module Viperaptor
+
+  # 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)
+
+      return [] unless catalog_path.exist?
+
+      contains_specs = catalog_path.children.count { |c|
+        c.extname == RAMBASPEC_EXTENSION
+      } > 0
+
+      skip_testable = ENV['RACK_ENV'] != 'test'
+
+      if contains_specs
+
+        if !skip_testable || catalog_path.split.last.to_s.start_with?("test-")
+          return []
+        end
+
+        return catalog_path.children
+                           .map { |child| child.split.last.to_s }
+                           .select { |i| /^[a-z0-9_]+\.rambaspec$/.match(i) }
+                           .map { |i| i.gsub RAMBASPEC_EXTENSION, '' }
+      else
+        return catalog_path.children
+                        .select {|child| child.directory? && child.split.last.to_s[0] != '.' }
+                        .select {|child| !skip_testable || !child.split.last.to_s.start_with?("test-") }
+                        .select {|child|
+                          child.join(child.split.last.to_s.gsub('/','') + RAMBASPEC_EXTENSION).exist? }
+                        .map { |child| child.split.last.to_s }
+      end
+    end
+
+    def template_path(catalog_path, template_name)
+      contains_specs = catalog_path.children.count { |c|
+        c.extname == RAMBASPEC_EXTENSION
+      } > 0
+
+      if contains_specs
+        return catalog_path
+      else
+        return catalog_path.join(template_name)
+      end
+    end
+
+  end
+
+end

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

@@ -0,0 +1,27 @@
+module Viperaptor
+
+  # 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/viperaptor/template/helpers/catalog_terminator.rb

@@ -0,0 +1,21 @@
+module Viperaptor
+
+  # Provides a functionality to terminate all previously installed catalogs
+  #
+  # @return [Void]
+  class CatalogTerminator
+    def remove_all_catalogs
+      catalogs_path = Pathname.new(ENV['HOME'])
+                          .join(APP_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/viperaptor/template/helpers/rambaspec_validator.rb

@@ -0,0 +1,52 @@
+module Viperaptor
+
+  # 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/viperaptor/template/installer/abstract_installer.rb

@@ -0,0 +1,9 @@
+module Viperaptor
+
+  # 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/viperaptor/template/installer/catalog_installer.rb

@@ -0,0 +1,78 @@
+require 'viperaptor/template/installer/abstract_installer.rb'
+require 'viperaptor/template/helpers/rambaspec_validator.rb'
+require 'fileutils'
+require 'tmpdir'
+
+module Viperaptor
+
+  # Incapsulates the logic of installing Viperaptor 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(APP_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 = Viperaptor::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 = Viperaptor::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(Rambafile.suffix(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_as_folder = catalog_path.join(template_name)
+      template_path_as_spec = catalog_path.join(template_name + RAMBASPEC_EXTENSION)
+
+      if File.exist?(template_path_as_spec)
+        return catalog_path
+      end
+
+      if Dir.exist?(template_path_as_folder)
+        return template_path_as_folder
+      end
+
+      return nil
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+require 'viperaptor/template/installer/abstract_installer.rb'
+require 'viperaptor/template/helpers/rambaspec_validator.rb'
+
+module Viperaptor
+
+  # 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 = Viperaptor::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 = Viperaptor::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(Rambafile.suffix(TEMPLATES_FOLDER))
+                         .join(template_name)
+      FileUtils.mkdir_p install_path
+      FileUtils.copy_entry(local_path, install_path)
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+require 'viperaptor/template/installer/abstract_installer.rb'
+require 'viperaptor/template/helpers/rambaspec_validator.rb'
+require 'git'
+require 'fileutils'
+require 'tmpdir'
+
+module Viperaptor
+
+  # 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
+
+      Dir.mktmpdir do |temp_path|
+        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 = Viperaptor::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 = Viperaptor::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(Rambafile.suffix(TEMPLATES_FOLDER))
+                          .join(template_name)
+        FileUtils.mkdir_p install_path
+        FileUtils.copy_entry(template_path, install_path)
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+require 'viperaptor/template/processor/template_declaration'
+
+module Viperaptor
+
+  # 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 Viperaptor::LocalInstaller.new
+        when TemplateDeclarationType::REMOTE_TEMPLATE
+          return Viperaptor::RemoteInstaller.new
+        when TemplateDeclarationType::CATALOG_TEMPLATE
+          return Viperaptor::CatalogInstaller.new
+        else
+          return nil
+      end
+    end
+  end
+end

data/lib/viperaptor/template/processor/template_declaration.rb

@@ -0,0 +1,36 @@
+module Viperaptor
+
+  # This class acts as an Enumeration for TemplateDeclaration types
+  class TemplateDeclarationType
+    # A local template - usually it's stored somewhere outside the current project directory
+    LOCAL_TEMPLATE = 0
+
+    # A remote template - it's stored in a remote Git repository
+    REMOTE_TEMPLATE = 1
+
+    # A template from our shared catalog
+    CATALOG_TEMPLATE = 2
+  end
+
+  # Describes a Viperaptor template declaration model
+  class TemplateDeclaration
+
+    attr_reader :name, :local, :git, :branch, :type
+
+    def initialize(template_hash)
+      @name = template_hash[TEMPLATE_DECLARATION_NAME_KEY]
+      @local = template_hash[TEMPLATE_DECLARATION_LOCAL_KEY]
+      @git = template_hash[TEMPLATE_DECLARATION_GIT_KEY]
+      @branch = template_hash[TEMPLATE_DECLARATION_BRANCH_KEY]
+
+      @type = TemplateDeclarationType::LOCAL_TEMPLATE if @local
+      @type = TemplateDeclarationType::REMOTE_TEMPLATE if @git
+      @type = TemplateDeclarationType::CATALOG_TEMPLATE if @git == nil && @local == nil
+    end
+
+    def install(strategy)
+      strategy.install_template(self)
+    end
+
+  end
+end

data/lib/viperaptor/template/processor/template_processor.rb

@@ -0,0 +1,73 @@
+require 'viperaptor/template/processor/template_declaration.rb'
+require 'viperaptor/template/installer/local_installer.rb'
+require 'viperaptor/template/installer/remote_installer.rb'
+require 'viperaptor/template/installer/catalog_installer.rb'
+require 'viperaptor/template/helpers/catalog_downloader.rb'
+require 'viperaptor/template/helpers/catalog_terminator'
+require 'git'
+
+module Viperaptor
+
+  # Incapsulates logic of processing templates declaration section from Rambafile
+  class TemplateProcessor
+
+    def initialize(catalog_downloader, installer_factory)
+      @catalog_downloader = catalog_downloader
+      @installer_factory = installer_factory
+    end
+
+    # This method parses Rambafile, serializes templates hashes into model objects and install them
+    def install_templates(rambafile)
+      # We always clear previously installed templates to avoid conflicts in different versions
+      clear_installed_templates
+
+      templates = rambafile[TEMPLATES_KEY] || []
+
+      # Mapping hashes to model objects
+      templates = templates.map { |template_hash|
+        Viperaptor::TemplateDeclaration.new(template_hash)
+      }
+
+      catalogs = rambafile[CATALOGS_KEY] || []
+
+      # If there is at least one template from catalogs, we should update our local copy of the catalog
+      update_catalogs_if_needed(catalogs, templates)
+
+      templates.each do |template_declaration|
+        strategy = @installer_factory.installer_for_type(template_declaration.type)
+        template_declaration.install(strategy)
+      end
+    end
+
+    private
+
+    # Clears all of the currently installed templates
+    def clear_installed_templates
+      install_path = Pathname.new(Rambafile.suffix(TEMPLATES_FOLDER))
+      FileUtils.rm_rf(Dir.glob(install_path))
+    end
+
+    # Clones remote template catalogs to the local directory
+    def update_catalogs_if_needed(catalogs, templates)
+      needs_update = templates.any? {|template| template.type == TemplateDeclarationType::CATALOG_TEMPLATE}
+
+      return unless needs_update
+
+      terminator = CatalogTerminator.new
+      terminator.remove_all_catalogs
+      puts('Updating shared catalogs specs...')
+
+      catalogs.each do |catalog_url|
+        @catalog_downloader.download_catalog(catalog_url.split('/').last, catalog_url)
+      end
+
+      return unless catalogs != nil && catalogs.count > 0
+
+      catalogs.each do |catalog_url|
+        catalog_name = catalog_url.split('://').last
+        catalog_name = catalog_name.gsub('/', '-');
+        @catalog_downloader.download_catalog(catalog_name, catalog_url)
+      end
+    end
+  end
+end

data/lib/viperaptor/tools/string-colorize.rb

@@ -0,0 +1,23 @@
+# Adds a number of methods for colorizing output strings
+class String
+
+  def colorize(color_code)
+    "\e[#{color_code}m#{self}\e[0m"
+  end
+
+  def red
+    colorize(31)
+  end
+
+  def green
+    colorize(32)
+  end
+
+  def yellow
+    colorize(33)
+  end
+
+  def blue
+    colorize(34)
+  end
+end

data/lib/viperaptor/version.rb

@@ -0,0 +1,5 @@
+module Viperaptor
+  VERSION = '2.0.0'
+  RELEASE_DATE = '11.01.2021'
+  RELEASE_LINK = "https://github.com/ladeiko/Viperaptor/releases/tag/#{VERSION}"
+end

data/lib/viperaptor.rb

@@ -0,0 +1,16 @@
+module Viperaptor
+  require 'viperaptor/constants/constants.rb'
+  require 'viperaptor/constants/rambafile_constants.rb'
+  require 'viperaptor/constants/rambaspec_constants.rb'
+  require 'viperaptor/cli/cli.rb'
+  require 'viperaptor/code_generation/code_module.rb'
+  require 'viperaptor/code_generation/module_template.rb'
+  require 'viperaptor/code_generation/content_generator.rb'
+  require 'viperaptor/code_generation/rambafile_generator.rb'
+  require 'viperaptor/module_generator.rb'
+  require 'viperaptor/template/processor/template_processor.rb'
+  require 'viperaptor/template/installer/template_installer_factory'
+  require 'viperaptor/configuration/user_preferences.rb'
+  require 'viperaptor/template/creator/template_creator.rb'
+  require 'viperaptor/tools/string-colorize.rb'
+end

data/viperaptor.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'viperaptor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'viperaptor'
+  spec.version       = Viperaptor::VERSION
+  spec.authors       = ['Siarhei Ladzeika']
+  spec.email         = 'sergey.ladeiko@gmail.com'
+
+  spec.summary       = 'Advanced code generator for Xcode projects with a nice and flexible template system.'
+  spec.description   = 'New reincarnation of Rambler Generamba tool (original code got from Generamba)'
+  spec.homepage      = 'https://github.com/ladeiko/Viperaptor'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = ['viperaptor']
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.3'
+
+  spec.add_runtime_dependency 'thor', '1.0.1'
+  spec.add_runtime_dependency 'xcodeproj', '1.19.0'
+  spec.add_runtime_dependency 'liquid', '4.0.3'
+  spec.add_runtime_dependency 'git', '1.7.0'
+  spec.add_runtime_dependency 'cocoapods-core', '1.10.0'
+  spec.add_runtime_dependency 'terminal-table', '2.0.0'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.23.0'
+
+  spec.add_development_dependency 'bundler', '>= 1.16'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+  spec.add_development_dependency 'fakefs', '~> 1.3'
+  spec.add_development_dependency 'activesupport', '~> 5.2'
+end