generamba-mp 0.0.2

data/lib/generamba/cli/version_command.rb

@@ -0,0 +1,25 @@
+require 'thor'
+require 'generamba/version.rb'
+
+module Generamba::CLI
+  class Application < Thor
+    include Generamba
+
+    desc 'version', 'Prints out Generamba current version'
+    def version
+      options = {}
+      options['Version'] = Generamba::VERSION.green
+      options['Release date'] = Generamba::RELEASE_DATE.green
+      options['Change notes'] = Generamba::RELEASE_LINK.green
+
+      values = []
+
+      options.each do |title, value|
+        values.push("#{title}: #{value}")
+      end
+
+      output = values.join("\n")
+      puts(output)
+    end
+  end
+end

data/lib/generamba/code_generation/Rambafile.liquid

@@ -0,0 +1,41 @@
+### Headers settings
+company: {{ company }}
+
+### Xcode project settings
+project_name: {{ project_name }}
+xcodeproj_path: {{ xcodeproj_path }}
+{% if prefix != "" %}prefix: {{ prefix }}{% endif %}
+
+{% if (project_target != nil and project_target != "") or (project_file_path != nil and project_file_path != "") or (project_group_path != nil and project_group_path != "") %}### Code generation settings section
+{% if project_target != nil and project_target != "" %}# The main project target name
+project_target: {{ project_target }}{% endif %}
+
+{% if project_file_path != nil and project_file_path != "" %}# The file path for new modules
+project_file_path: {{ project_file_path }}{% endif %}
+
+{% if project_group_path != nil and project_group_path != "" %}# The Xcode group path to new modules
+project_group_path: {{ project_group_path }}{% endif %}
+{% endif %}
+
+{% if (test_target != nil and test_target != "") or (test_file_path != nil and test_file_path != "") or (test_group_path != nil and test_group_path != "") %}### Tests generation settings section
+{% if test_target != nil and test_target != "" %}# The tests target name
+test_target: {{ test_target }}{% endif %}
+
+{% if test_file_path != nil and test_file_path != "" %}# The file path for new tests
+test_file_path: {{ test_file_path }}{% endif %}
+
+{% if test_group_path != nil and test_group_path != "" %}# The Xcode group path to new tests
+test_group_path: {{ test_group_path }}{% endif %}
+{% endif %}
+
+{% if podfile_path != nil or cartfile_path != nil %}### Dependencies settings section{% endif %}
+{% if podfile_path != nil %}podfile_path: {{ podfile_path }}{% endif %}
+{% if cartfile_path != nil %}cartfile_path: {{ cartfile_path }}{% endif %}
+
+### Templates
+templates:
+{% if templates.size > 0 %}{% for item in templates %}- {{ item }}
+{% endfor %}{% else %}#- {name: local_template_name, local: 'absolute/file/path'}
+#- {name: remote_template_name, git: 'https://github.com/igrekde/remote_template'}
+#- {name: catalog_template_name}
+{% endif %}

data/lib/generamba/code_generation/code_module.rb

@@ -0,0 +1,100 @@
+module Generamba
+
+  SLASH_REGEX = /^\/|\/$/
+  C99IDENTIFIER = /[^\w]/
+
+  PATH_TYPE_PROJECT = 'project'
+  PATH_TYPE_TEST = 'test'
+
+  # Represents currently generating code module
+  class CodeModule
+    attr_reader :name,
+                :description,
+                :author,
+                :company,
+                :year,
+                :prefix,
+                :project_name,
+                :product_module_name,
+                :xcodeproj_path,
+                :project_file_path,
+                :project_group_path,
+                :test_file_path,
+                :test_group_path,
+                :project_targets,
+                :test_targets,
+                :podfile_path,
+                :cartfile_path,
+                :custom_parameters
+
+    def initialize(name, rambafile, options)
+      # Base initialization
+      @name = name
+      @description = options[:description] ? options[:description] : "#{name} module"
+      @author = rambafile[AUTHOR_NAME_KEY] ? rambafile[AUTHOR_NAME_KEY] : UserPreferences.obtain_username
+      @company = rambafile[COMPANY_KEY]
+      @year = Time.now.year.to_s
+
+      @prefix = rambafile[PROJECT_PREFIX_KEY]
+      @project_name = rambafile[PROJECT_NAME_KEY]
+
+      @product_module_name = rambafile[PRODUCT_MODULE_NAME_KEY]
+      @product_module_name = @project_name.gsub(C99IDENTIFIER, '_') if !@product_module_name && @project_name
+
+      @xcodeproj_path = rambafile[XCODEPROJ_PATH_KEY]
+
+      setup_file_and_group_paths(rambafile[PROJECT_FILE_PATH_KEY], rambafile[PROJECT_GROUP_PATH_KEY], PATH_TYPE_PROJECT)
+      setup_file_and_group_paths(rambafile[TEST_FILE_PATH_KEY], rambafile[TEST_GROUP_PATH_KEY], PATH_TYPE_TEST)
+
+      @project_targets = [rambafile[PROJECT_TARGET_KEY]] if rambafile[PROJECT_TARGET_KEY]
+      @project_targets = rambafile[PROJECT_TARGETS_KEY] if rambafile[PROJECT_TARGETS_KEY]
+
+      @test_targets = [rambafile[TEST_TARGET_KEY]] if rambafile[TEST_TARGET_KEY]
+      @test_targets = rambafile[TEST_TARGETS_KEY] if rambafile[TEST_TARGETS_KEY]
+
+      # Custom parameters
+      @custom_parameters = options[:custom_parameters]
+
+      # Options adaptation
+      @author = options[:author] if options[:author]
+      @project_targets = options[:project_targets].split(',') if options[:project_targets]
+      @test_targets = options[:test_targets].split(',') if options[:test_targets]
+      
+      setup_file_and_group_paths(options[:project_file_path], options[:project_group_path], PATH_TYPE_PROJECT)
+      setup_file_and_group_paths(options[:test_file_path], options[:test_group_path], PATH_TYPE_TEST)
+
+      # The priority is given to `module_path` and 'test_path' options
+      setup_file_and_group_paths(options[:module_path], options[:module_path], PATH_TYPE_PROJECT)
+      setup_file_and_group_paths(options[:test_path], options[:test_path], PATH_TYPE_TEST)
+
+      @podfile_path = rambafile[PODFILE_PATH_KEY] if rambafile[PODFILE_PATH_KEY]
+      @cartfile_path = rambafile[CARTFILE_PATH_KEY] if rambafile[CARTFILE_PATH_KEY]
+    end
+
+    private
+
+    def setup_file_and_group_paths(file_path, group_path, path_type)
+      if file_path || group_path
+        variable_name = "#{path_type}_file_path"
+
+        if file_path || !instance_variable_get("@#{variable_name}")
+          file_path = group_path unless file_path
+
+          variable_value = file_path.gsub(SLASH_REGEX, '')
+          variable_value = Pathname.new(variable_value).join(@name)
+          instance_variable_set("@#{variable_name}", variable_value)
+        end
+
+        variable_name = "#{path_type}_group_path"
+
+        if group_path || !instance_variable_get("@#{variable_name}")
+          group_path = file_path unless group_path
+
+          variable_value = group_path.gsub(SLASH_REGEX, '')
+          variable_value = Pathname.new(variable_value).join(@name)
+          instance_variable_set("@#{variable_name}", variable_value)
+        end
+      end
+    end
+  end
+end

data/lib/generamba/code_generation/content_generator.rb

@@ -0,0 +1,43 @@
+require 'liquid'
+
+module Generamba
+
+  # Responsible for generating code using provided liquid templates
+	class ContentGenerator
+
+    # Generates and returns a filename and a body of a specific code file.
+    # @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 Generamba template used for code generation
+    #
+    # @return [String], [String] The generated file_name and body
+		def self.create_file(file, scope, template)
+			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')
+
+			template = Liquid::Template.parse(file_source)
+			filename_template = self.file_name_template(file)
+      
+			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)
+
+			module_info['file_name'] = file_name
+			module_info.delete('file_basename')
+
+			content = template.render(scope)
+
+			return file_name, content
+		end
+    
+		def self.file_name_template(file)
+			template_default_text = '{{ prefix }}{{ module_info.name }}{{ module_info.file_basename }}'
+			template_text = file[TEMPLATE_FILE_CUSTOM_NAME_KEY] || template_default_text
+			return Liquid::Template.parse(template_text)
+		end
+	end
+end

data/lib/generamba/code_generation/module_template.rb

@@ -0,0 +1,28 @@
+require 'generamba/helpers/template_helper.rb'
+
+module Generamba
+
+  # Represents a single Generamba module template
+  class ModuleTemplate
+    attr_reader :template_name, :template_path, :code_files, :test_files, :dependencies
+
+    def initialize(name, options = nil)
+      spec_path = TemplateHelper.obtain_spec(name)
+
+      unless options
+        spec = YAML.load_file(spec_path)
+      else
+        spec_source = IO.read(spec_path)
+        spec_template = Liquid::Template.parse(spec_source)
+        spec_content = spec_template.render(options)
+        spec = YAML.load(spec_content)
+      end
+
+      @code_files = spec[TEMPLATE_CODE_FILES_KEY]
+      @test_files = spec[TEMPLATE_TEST_FILES_KEY]
+      @template_name = spec[TEMPLATE_NAME_KEY]
+      @template_path = TemplateHelper.obtain_path(name)
+      @dependencies = spec[TEMPLATE_DEPENDENCIES_KEY]
+    end
+  end
+end

data/lib/generamba/code_generation/rambafile_generator.rb

@@ -0,0 +1,23 @@
+require 'liquid'
+
+module Generamba
+
+  # Responsible for creating Generamba configs
+  class RambafileGenerator
+
+    # Creates a Rambafile using the provided properties hashmap
+    # @param properties Rambafile properties
+    #
+    # @return void
+    def self.create_rambafile(properties)
+      file_source = IO.read(File.dirname(__FILE__) + '/Rambafile.liquid')
+
+      template = Liquid::Template.parse(file_source)
+      output = template.render(properties).gsub!(/[\n]{3,}/, "\n\n");
+
+      File.open(RAMBAFILE_NAME, 'w+') {|f|
+        f.write(output)
+      }
+    end
+  end
+end

data/lib/generamba/configuration/user_preferences.rb

@@ -0,0 +1,50 @@
+require 'generamba/constants/user_preferences_constants.rb'
+
+module Generamba
+
+  # A class that provides methods for working with user-specific information.
+  # Currently it has methods for obtaining and saving username, later it may be improved to something more general.
+  class UserPreferences
+
+    def self.obtain_username
+      path = obtain_user_preferences_path
+
+      file_contents = open(path).read
+      preferences = file_contents.empty? ? {} : YAML.load(file_contents).to_hash
+
+      return preferences[USERNAME_KEY]
+    end
+
+    def self.save_username(username)
+      path = obtain_user_preferences_path
+
+      file_contents = open(path).read
+      preferences = file_contents.empty? ? {} : YAML.load(file_contents).to_hash
+
+      preferences[USERNAME_KEY] = username
+      File.open(path, 'w+') { |f| f.write(preferences.to_yaml) }
+    end
+
+    private
+
+    def self.obtain_user_preferences_path
+      home_path = Pathname.new(ENV['HOME'])
+                 .join(GENERAMBA_HOME_DIR)
+
+      path_exists = Dir.exist?(home_path)
+
+      unless path_exists
+        FileUtils.mkdir_p home_path
+      end
+
+      preferences_path = home_path.join(USER_PREFERENCES_FILE)
+      preferences_exist = File.file?(preferences_path)
+
+      unless preferences_exist
+        File.open(preferences_path, 'w+') { |f| f.write('') }
+      end
+
+      return preferences_path
+    end
+  end
+end

data/lib/generamba/constants/constants.rb

@@ -0,0 +1,12 @@
+module Generamba
+
+  # General constants
+  RAMBAFILE_NAME = 'Rambafile'
+  RAMBASPEC_EXTENSION = '.rambaspec'
+  TEMPLATES_FOLDER = 'Templates'
+  RAMBLER_CATALOG_REPO = 'https://github.com/rambler-digital-solutions/generamba-catalog'
+  GENERAMBA_CATALOG_NAME = 'generamba-catalog'
+  GENERAMBA_HOME_DIR = '.generamba'
+  CATALOGS_DIR = 'catalogs'
+  USER_PREFERENCES_FILE = 'user_preferences.yml'
+end

data/lib/generamba/constants/rambafile_constants.rb

@@ -0,0 +1,31 @@
+module Generamba
+
+  # Keys of Rambafile files
+  COMPANY_KEY = 'company'
+  AUTHOR_NAME_KEY = 'author'
+  PROJECT_NAME_KEY = 'project_name'
+  PROJECT_PREFIX_KEY = 'prefix'
+  XCODEPROJ_PATH_KEY = 'xcodeproj_path'
+
+  PROJECT_TARGET_KEY = 'project_target'
+  PROJECT_TARGETS_KEY = 'project_targets'
+  PROJECT_FILE_PATH_KEY = 'project_file_path'
+  PROJECT_GROUP_PATH_KEY = 'project_group_path'
+
+  PRODUCT_MODULE_NAME_KEY = 'product_module_name'
+
+  TEST_TARGET_KEY = 'test_target'
+  TEST_TARGETS_KEY = 'test_targets'
+  TEST_FILE_PATH_KEY = 'test_file_path'
+  TEST_GROUP_PATH_KEY = 'test_group_path'
+
+  PODFILE_PATH_KEY = 'podfile_path'
+  CARTFILE_PATH_KEY = 'cartfile_path'
+
+  CATALOGS_KEY = 'catalogs'
+  TEMPLATES_KEY = 'templates'
+  TEMPLATE_DECLARATION_NAME_KEY = 'name'
+  TEMPLATE_DECLARATION_LOCAL_KEY = 'local'
+  TEMPLATE_DECLARATION_GIT_KEY = 'git'
+  TEMPLATE_DECLARATION_BRANCH_KEY = 'branch'
+end

data/lib/generamba/constants/rambaspec_constants.rb

@@ -0,0 +1,18 @@
+module Generamba
+
+  # 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_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_DEPENDENCIES_KEY = 'dependencies'
+end

data/lib/generamba/constants/user_preferences_constants.rb

@@ -0,0 +1,5 @@
+module Generamba
+
+  # Keys of file user_preferences.yml
+  USERNAME_KEY = 'username'
+end

data/lib/generamba/helpers/dependency_checker.rb

@@ -0,0 +1,54 @@
+require 'cocoapods-core'
+
+module Generamba
+  # Provides methods for check dependencies from rambaspec in podfile
+  class DependencyChecker
+    # Check Podfile for dependencies
+    # @param dependencies [Array] Array of dependencies name
+    # @param podfile_path [String] String of Podfile path
+    #
+    # @return [void]
+    def self.check_all_required_dependencies_has_in_podfile(dependencies, podfile_path)
+      return if !dependencies || dependencies.count == 0 || !podfile_path
+
+      dependencies_names = []
+      Pod::Podfile.from_file(Pathname.new(podfile_path)).dependencies.each do |dependency|
+        dependencies_names.push(dependency.name.gsub(/ .*/, ''))
+      end
+
+      not_existing_dependency = []
+
+      dependencies.each do |dependency_name|
+        unless dependencies_names.include?(dependency_name)
+          not_existing_dependency.push(dependency_name)
+        end
+      end
+
+      if not_existing_dependency.count > 0
+        puts "[Warning] Dependencies #{not_existing_dependency} missed in Podfile".yellow
+      end
+    end
+
+    # Check Cartfile for dependencies
+    # @param dependencies [Array] Array of dependencies name
+    # @param cartfile_path [String] String of Podfile path
+    #
+    # @return [void]
+    def self.check_all_required_dependencies_has_in_cartfile(dependencies, cartfile_path)
+      return if !dependencies || dependencies.count == 0 || !cartfile_path
+
+      cartfile_string = File.read(cartfile_path)
+
+      not_existing_dependency = []
+      dependencies.each do |dependency_name|
+        unless cartfile_string.include?(dependency_name)
+          not_existing_dependency.push(dependency_name)
+        end
+      end
+
+      if not_existing_dependency.count > 0
+        puts "[Warning] Dependencies #{not_existing_dependency} missed in Cartfile".yellow
+      end
+    end
+  end
+end