viperaptor 2.0.2 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05568a147ce6c94c0129756da124fbcdcccd0adadeda98470f8d74e7e6593e27'
-  data.tar.gz: c4e0440b2aa1cddafc1ca301ecb5097bef675bace8d3819bdd76f3e8d90766c1
+  metadata.gz: fd05a070a0f35fb5c85b83430e309bbc0c849f4d03b1b38a6967cbd2dc31552f
+  data.tar.gz: 146089e69493d6e98fabe7cac5a21c900a48802d5b909c5ab5544a3bc84f217d
 SHA512:
-  metadata.gz: 5208926beb1bab564491ddea68e61aa46a96091308491906e8df816a0da5b2f8709dbd1a86c10eaf26bc6c524d6df489198c5f1a9c1ea7f7928e2ee56116751d
-  data.tar.gz: 2ae41d53a65ae9066ef1fd2b47113cc68c52d2485a88709c27da64548eea5bee8249142deb4f775e6ce52629f1702162b544a4b211ed33a5b135c5743d4a9155
+  metadata.gz: 3ae0cfa9f2d4f0c9c7f1895f8f59b0f71cbdaa73f67c2776d58f4c3d72c88e734214cabfc66a95213c89bba5911d803d86b3c1d771926ff0a9335cc2289f03a2
+  data.tar.gz: 8438da43ccb0b05b12c0598ca64818161752cc1bfe6eb139f1096ed188716830ca12c2112dbae18f1b31e8f93c79290cea4db26ffaace4357dd1b9f57d4b75f8

data/lib/viperaptor/cli/gen_command.rb

@@ -1,40 +1,39 @@
-require 'thor'
+require "thor"
 require "tty-prompt"
-require 'set'
-require 'viperaptor/helpers/print_table.rb'
-require 'viperaptor/helpers/rambafile.rb'
-require 'viperaptor/helpers/xcodeproj_helper.rb'
-require 'viperaptor/helpers/dependency_checker.rb'
-require 'viperaptor/helpers/gen_command_table_parameters_formatter.rb'
-require 'viperaptor/helpers/module_validator.rb'
-require 'viperaptor/helpers/module_info_generator.rb'
+require "set"
+require "viperaptor/helpers/print_table.rb"
+require "viperaptor/helpers/rambafile.rb"
+require "viperaptor/helpers/xcodeproj_helper.rb"
+require "viperaptor/helpers/dependency_checker.rb"
+require "viperaptor/helpers/gen_command_table_parameters_formatter.rb"
+require "viperaptor/helpers/module_validator.rb"
+require "viperaptor/helpers/module_info_generator.rb"
 
 module Viperaptor::CLI
   class Application < Thor
-
     include Viperaptor
 
-    desc 'gen [MODULE_NAME] [TEMPLATE_NAME]', 'Creates a new VIPER module with a given name from a specific template'
-    method_option :description, :aliases => '-d', :desc => 'Provides a full description to the module'
-    method_option :author, :desc => 'Specifies the author name for generated module'
-    method_option :rambafile, :desc => 'Specifies Rambafile to use'
-    method_option :project_targets, :desc => 'Specifies project targets for adding new module files'
-    method_option :project_file_path, :desc => 'Specifies a location in the filesystem for new files'
-    method_option :project_group_path, :desc => 'Specifies a location in Xcode groups for new files'
-    method_option :module_path, :desc => 'Specifies a location (both in the filesystem and Xcode) for new files'
-    method_option :test_targets, :desc => 'Specifies project targets for adding new test files'
-    method_option :test_file_path, :desc => 'Specifies a location in the filesystem for new test files'
-    method_option :test_group_path, :desc => 'Specifies a location in Xcode groups for new test files'
-    method_option :test_path, :desc => 'Specifies a location (both in the filesystem and Xcode) for new test files'
-    method_option :custom_parameters, :type => :hash, :default => {}, :desc => 'Specifies extra parameters in format `key1:value1 key2:value2` for usage during code generation'
-    def gen(module_name = nil, template_name = nil)
+    desc "gen [MODULE_NAME] [TEMPLATE_NAME]", "Creates a new VIPER module with a given name from a specific template"
+    method_option :description, :aliases => "-d", :desc => "Provides a full description to the module"
+    method_option :author, :desc => "Specifies the author name for generated module"
+    method_option :rambafile, :desc => "Specifies Rambafile to use"
+    method_option :project_targets, :desc => "Specifies project targets for adding new module files"
+    method_option :project_file_path, :desc => "Specifies a location in the filesystem for new files"
+    method_option :project_group_path, :desc => "Specifies a location in Xcode groups for new files"
+    method_option :module_path, :desc => "Specifies a location (both in the filesystem and Xcode) for new files"
+    method_option :test_targets, :desc => "Specifies project targets for adding new test files"
+    method_option :test_file_path, :desc => "Specifies a location in the filesystem for new test files"
+    method_option :test_group_path, :desc => "Specifies a location in Xcode groups for new test files"
+    method_option :test_path, :desc => "Specifies a location (both in the filesystem and Xcode) for new test files"
+    method_option :custom_parameters, :type => :hash, :default => {}, :desc => "Specifies extra parameters in format `key1:value1 key2:value2` for usage during code generation"
 
+    def gen(module_name = nil, template_name = nil)
       Rambafile.use(options[:rambafile])
 
       does_rambafile_exist = Rambafile.exist
 
       unless does_rambafile_exist
-        puts('Rambafile not found! Run `viperaptor setup` in the working directory instead!'.red)
+        puts("Rambafile not found! Run `viperaptor setup` in the working directory instead!".red)
         return
       end
 
@@ -55,15 +54,15 @@ module Viperaptor::CLI
       templates_as_set = Set.new(templates.map { |t| t["name"] })
       templates = templates.concat(TemplateHelper.global_templates.select { |t| !templates_as_set.include?(t) }.map { |name| { "name" => name } }).sort_by { |t| t["name"] }
 
-      filter = rambafile[TEMPLATES_FILTER_KEY] || ''
+      filter = rambafile[TEMPLATES_FILTER_KEY] || ""
 
       if !filter.kind_of?(Array)
         filter = [filter]
       end
 
       filter = filter.map { |f| f.strip }.select { |f| !f.empty? }
-      negative_filters = filter.select { |f| f.start_with?('!') }.map { |f| f[1...] }.map { |f| Regexp.new(f, Regexp::IGNORECASE) }
-      positive_filters = filter.select { |f| !f.start_with?('!') }.map { |f| Regexp.new(f, Regexp::IGNORECASE) }
+      negative_filters = filter.select { |f| f.start_with?("!") }.map { |f| f[1...] }.map { |f| Regexp.new(f, Regexp::IGNORECASE) }
+      positive_filters = filter.select { |f| !f.start_with?("!") }.map { |f| Regexp.new(f, Regexp::IGNORECASE) }
       original_templates = templates
 
       if original_templates.count == 0
@@ -72,7 +71,6 @@ module Viperaptor::CLI
       end
 
       templates = templates.select do |t|
-
         if filter.count == 0
           next true
         end
@@ -110,8 +108,8 @@ module Viperaptor::CLI
 
       parameters = GenCommandTableParametersFormatter.prepare_parameters_for_displaying(code_module, template_name)
       PrintTable.print_values(
-          values: parameters,
-          title: "Summary for gen #{module_name}"
+        values: parameters,
+        title: "Summary for gen #{module_name}",
       )
 
       DependencyChecker.check_all_required_dependencies_has_in_podfile(template.dependencies, code_module.podfile_path)
@@ -122,7 +120,7 @@ module Viperaptor::CLI
 
       if module_group_already_exists
         replace_exists_module = yes?("#{module_name} module already exists. Replace? (yes/no)")
-      
+
         unless replace_exists_module
           return
         end
@@ -131,6 +129,5 @@ module Viperaptor::CLI
       generator = Viperaptor::ModuleGenerator.new
       generator.generate_module(module_name, code_module, template)
     end
-
   end
-end
+end

data/lib/viperaptor/code_generation/content_generator.rb

@@ -9,9 +9,14 @@ module Viperaptor
     # @param file [Hash<String,String>] A hashmap with template's filename and filepath
     # @param scope [Hash<String,String>] A hashmap with module info
     # @param template [ModuleTemplate] The model describing a Viperaptor template used for code generation
+		# @param variables [Hash<String,String>] Custom variables of template
     #
     # @return [String], [String] The generated file_name and body
 		def self.create_file(file, scope, template)
+
+			custom_parameters = template.custom_parameters || {}
+			scope['custom_parameters'] = (scope['custom_parameters'] || {}).merge(custom_parameters)
+
 			file_source = IO.read(template.template_path.join(file[TEMPLATE_FILE_PATH_KEY]))
 			Liquid::Template.file_system = Liquid::LocalFileSystem.new(template.template_path.join('snippets'), '%s.liquid')
 
@@ -21,7 +26,7 @@ module Viperaptor
 			file_basename = File.basename(file[TEMPLATE_FILE_NAME_KEY])
 
 			module_info = scope['module_info']
-			
+
 			module_info['file_basename'] = file_basename
 
 			file_name = filename_template.render(scope)

data/lib/viperaptor/code_generation/module_template.rb

@@ -1,10 +1,81 @@
-require 'viperaptor/helpers/template_helper.rb'
+require "viperaptor/helpers/template_helper.rb"
+require "tty-prompt"
 
 module Viperaptor
 
   # Represents a single Viperaptor module template
   class ModuleTemplate
-    attr_reader :template_name, :template_path, :code_files, :test_files, :dependencies
+    attr_reader :template_name, :template_path, :code_files, :test_files, :dependencies, :custom_parameters
+
+    def load_custom_parameters_from_spec(spec)
+      custom_parameters = spec[TEMPLATE_CUSTOM_PARAMETERS_KEY]
+      result = {}
+      unless custom_parameters.nil?
+        custom_parameters.sort_by { |a| (a["order"] || 0) }.each do |desc|
+          skip = false
+
+          if !desc["only_if"].nil? && desc["only_if"].is_a?(Hash)
+            desc["only_if"].each do |key, value|
+              if value.is_a?(Array)
+                if result[key].nil?
+                  puts("ERROR: Required custom_parameter '#{key}' not defined".red)
+                  exit(1)
+                end
+
+                if !value.include?(result[key])
+                  skip = true
+                  break
+                end
+              end
+            end
+          end
+
+          if !skip
+            if !desc["only_if"].nil? && desc["only_if_not"].is_a?(Hash)
+              desc["only_if"].each do |key, value|
+                if value.is_a?(Array)
+                  if result[key].nil?
+                    break
+                  end
+
+                  if value.include?(result[key])
+                    skip = true
+                    break
+                  end
+                end
+              end
+            end
+          end
+
+          if !skip
+            if desc["options"].instance_of?(Array)
+              prompt = TTY::Prompt.new
+              choices = desc["options"]
+              value = prompt.select("#{desc["description"]}?", choices, per_page: choices.count)
+
+              case value
+              when "yes"
+                value = "true"
+              when "no"
+                value = "false"
+              else
+                #
+              end
+
+              result[desc["name"]] = value
+            elsif desc["options"].nil?
+              prompt = TTY::Prompt.new
+              value = prompt.ask("#{desc["description"]}?")
+              result[desc["name"]] = value
+            else
+              puts("ERROR: Invalid variable 'options' of template custom parameter '#{desc["name"]}'".red)
+              exit(1)
+            end
+          end
+        end
+      end
+      return result
+    end
 
     def initialize(name, options = nil)
       spec_path = TemplateHelper.obtain_spec(name)
@@ -18,6 +89,33 @@ module Viperaptor
         spec = YAML.load(spec_content)
       end
 
+      viperaptor = spec[TEMPLATE_VIPERAPTOR_KEY]
+      if !viperaptor.nil? && Gem::Version.new(Viperaptor::VERSION) < Gem::Version.new(viperaptor)
+        puts("ERROR: Your viperaptor version is '#{Viperaptor::VERSION}' template requires '#{viperaptor}'. Please update it.".red)
+        exit(1)
+      end
+
+      custom_parameters = load_custom_parameters_from_spec(spec)
+
+      if !custom_parameters.empty? && !options.nil?
+        spec_source = IO.read(spec_path)
+        spec_template = Liquid::Template.parse(spec_source)
+
+        if options["custom_parameters"].nil?
+          options["custom_parameters"] = {}
+        end
+
+        new_options = options["custom_parameters"].merge(custom_parameters)
+
+        new_options.each_key do |k|
+          options["custom_parameters"][k] = new_options[k]
+        end
+
+        spec_content = spec_template.render(options)
+        spec = YAML.load(spec_content)
+      end
+
+      @custom_parameters = options["custom_parameters"]
       @code_files = spec[TEMPLATE_CODE_FILES_KEY]
       @test_files = spec[TEMPLATE_TEST_FILES_KEY]
       @template_name = spec[TEMPLATE_NAME_KEY]
@@ -25,4 +123,4 @@ module Viperaptor
       @dependencies = spec[TEMPLATE_DEPENDENCIES_KEY]
     end
   end
-end
+end

data/lib/viperaptor/constants/rambaspec_constants.rb

@@ -1,18 +1,20 @@
 module Viperaptor
 
   # Keys of .rambaspec files
-  TEMPLATE_NAME_KEY = 'name'
-  TEMPLATE_SUMMARY_KEY = 'summary'
-  TEMPLATE_AUTHOR_KEY = 'author'
-  TEMPLATE_VERSION_KEY = 'version'
-  TEMPLATE_LICENSE_KEY = 'license'
+  TEMPLATE_NAME_KEY = "name"
+  TEMPLATE_SUMMARY_KEY = "summary"
+  TEMPLATE_AUTHOR_KEY = "author"
+  TEMPLATE_VERSION_KEY = "version"
+  TEMPLATE_LICENSE_KEY = "license"
 
-  TEMPLATE_CODE_FILES_KEY = 'code_files'
-  TEMPLATE_TEST_FILES_KEY = 'test_files'
-  TEMPLATE_FILE_NAME_KEY = 'name'
-  TEMPLATE_FILE_CUSTOM_NAME_KEY = 'custom_name'
-  TEMPLATE_FILE_PATH_KEY = 'path'
-  TEMPLATE_FILE_IS_RESOURCE_KEY = 'is_resource'
+  TEMPLATE_CODE_FILES_KEY = "code_files"
+  TEMPLATE_TEST_FILES_KEY = "test_files"
+  TEMPLATE_FILE_NAME_KEY = "name"
+  TEMPLATE_FILE_CUSTOM_NAME_KEY = "custom_name"
+  TEMPLATE_FILE_PATH_KEY = "path"
+  TEMPLATE_FILE_IS_RESOURCE_KEY = "is_resource"
+  TEMPLATE_CUSTOM_PARAMETERS_KEY = "custom_parameters"
 
-  TEMPLATE_DEPENDENCIES_KEY = 'dependencies'
-end
+  TEMPLATE_DEPENDENCIES_KEY = "dependencies"
+  TEMPLATE_VIPERAPTOR_KEY = "viperaptor"
+end

data/lib/viperaptor/module_generator.rb

@@ -9,6 +9,7 @@ module Viperaptor
 	class ModuleGenerator
 
 		def generate_module(name, code_module, template)
+
 			# Setting up Xcode objects
 			project = XcodeprojHelper.obtain_project(code_module.xcodeproj_path)
 

data/lib/viperaptor/version.rb

@@ -1,5 +1,5 @@
 module Viperaptor
-  VERSION = '2.0.2'
-  RELEASE_DATE = '29.01.2021'
+  VERSION = "2.2.1"
+  RELEASE_DATE = "23.02.2022"
   RELEASE_LINK = "https://github.com/ladeiko/Viperaptor/releases/tag/#{VERSION}"
 end

data/viperaptor.gemspec

@@ -20,13 +20,13 @@ Gem::Specification.new do |spec|
 
   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_runtime_dependency 'thor', '1.2.1'
+  spec.add_runtime_dependency 'xcodeproj', '1.21.0'
+  spec.add_runtime_dependency 'liquid', '5.1.0'
+  spec.add_runtime_dependency 'git', '1.10.2'
+  spec.add_runtime_dependency 'cocoapods-core', '1.11.2'
+  spec.add_runtime_dependency 'terminal-table', '3.0.2'
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.23.1'
 
   spec.add_development_dependency 'bundler', '>= 1.16'
   spec.add_development_dependency 'rake', '~> 13.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: viperaptor
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.1
 platform: ruby
 authors:
 - Siarhei Ladzeika
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-29 00:00:00.000000000 Z
+date: 2022-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,98 +16,98 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: xcodeproj
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.19.0
+        version: 1.21.0
 - !ruby/object:Gem::Dependency
   name: liquid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.3
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.3
+        version: 5.1.0
 - !ruby/object:Gem::Dependency
   name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.10.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.10.2
 - !ruby/object:Gem::Dependency
   name: cocoapods-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 1.11.2
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 3.0.2
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.23.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: 0.23.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Advanced code generator for Xcode projects with a nice and flexible template