generamba 0.6.0

data/lib/generamba/cli/template/template_install_command.rb

@@ -0,0 +1,10 @@
+module Generamba::CLI
+  class Template < Thor
+
+    desc 'install', 'Installs all the templates specified in the Rambafile from the current directory'
+    def install
+      template_processor = Generamba::TemplateProcessor.new
+      template_processor.install_templates
+    end
+  end
+end

data/lib/generamba/cli/thor_extension.rb

@@ -0,0 +1,34 @@
+require 'thor'
+
+module Generamba::CLI
+  class ::Thor
+    no_commands do
+      def ask_index(message, array)
+        value_index = ask_with_validation(message,->(value){ (value.to_i >= 0 and value.to_i < array.count) },"Invalid selection. Please enter number from 0 to #{array.count-1}")
+        return array[value_index.to_i]
+      end
+
+      def ask_non_empty_string(message, description = 'Value should be nonempty string')
+        return ask_with_validation(message,->(value){value.length > 0 },description)
+      end
+
+      def ask_loop(message)
+        array = Array.new
+        loop do
+          value = ask(message)
+          break if value.empty?
+          array.push(value)
+        end
+        return array
+      end
+
+      def ask_with_validation(message, is_valid_value, description = 'Invalid value')
+        loop do
+          value = ask(message)
+          break if is_valid_value.call(value)
+          puts(description)
+        end
+      end
+    end
+  end
+end

data/lib/generamba/code_generation/Rambafile.liquid

@@ -0,0 +1,37 @@
+### Headers settings
+company: {{ company }}
+
+### Xcode project settings
+project_name: {{ project_name }}
+prefix: {{ prefix }}
+xcodeproj_path: {{ xcodeproj_path }}
+
+### Code generation settings section
+# The main project target name
+project_target: {{ project_target }}
+
+# The file path for new modules
+project_file_path: {{ project_file_path }}
+
+# The Xcode group path to new modules
+project_group_path: {{ project_group_path }}
+
+### Tests generation settings section
+# The tests target name
+test_target: {{ test_target }}
+
+# The file path for new tests
+test_file_path: {{ test_file_path }}
+
+# The Xcode group path to new tests
+test_group_path: {{ test_group_path }}
+
+### Dependencies settings section
+podfile_path: {{ podfile_path }}
+cartfile_path: {{ cartfile_path }}
+
+### Templates
+templates:
+#- {name: local_template_name, path: absolute/file/path}
+#- {name: remote_template_name, git: https://github.com/igrekde/remote_template}
+#- {name: catalog_template_name}

data/lib/generamba/code_generation/code_module.rb

@@ -0,0 +1,32 @@
+module Generamba
+
+  # Represents currently generating code module
+  class CodeModule
+    attr_reader :name, :description, :author, :company, :year, :prefix, :project_name
+
+    def initialize(name, description)
+      @name = name
+      @description = description
+    end
+
+    def author
+      Generamba::UserPreferences.obtain_username
+    end
+
+    def company
+      ProjectConfiguration.company
+    end
+
+    def year
+      Time.now.year.to_s
+    end
+
+    def prefix
+      ProjectConfiguration.prefix
+    end
+
+    def project_name
+      ProjectConfiguration.project_name
+    end
+  end
+end

data/lib/generamba/code_generation/content_generator.rb

@@ -0,0 +1,42 @@
+require 'liquid'
+require 'tilt'
+
+module Generamba
+
+  # Responsible for generating code using provided liquid templates
+	class ContentGenerator
+
+    # Generates and returns a body of a specific code file.
+    # @param file []Hash<String,String>] A hashmap with template's filename and filepath
+    # @param code_module [CodeModule] The model describing a generating module
+    # @param template [ModuleTemplate] The model describing a Generamba template used for code generation
+    #
+    # @return [String] The generated body
+		def self.create_file_content(file, code_module, template)
+			file_template = Tilt.new(template.template_path.join(file[TEMPLATE_FILE_PATH_KEY]))
+      file_name = File.basename(file[TEMPLATE_FILE_NAME_KEY])
+			module_info = {
+					'name' => code_module.name,
+					'file_name' => file_name,
+					'description' => code_module.description,
+          'project_name' => code_module.project_name
+			}
+
+			developer = {
+					'name' => code_module.author,
+					'company' => code_module.company
+			}
+
+			scope = {
+					'year' => code_module.year,
+					'date' => Time.now.strftime('%d/%m/%Y'),
+					'developer' => developer,
+					'module_info' => module_info,
+					'prefix' => code_module.prefix
+			}
+
+			output = file_template.render(scope)
+			return output
+		end
+	end
+end

data/lib/generamba/code_generation/module_template.rb

@@ -0,0 +1,20 @@
+require 'generamba/helpers/template_helper.rb'
+require 'settingslogic'
+
+module Generamba
+
+  # Represents a single Generamba module template
+  class ModuleTemplate
+    attr_reader :template_name, :template_path, :code_files, :test_files
+
+    def initialize(name)
+      spec_path = TemplateHelper.obtain_spec(name)
+      spec = Settingslogic.new(spec_path)
+
+      @code_files = spec[TEMPLATE_CODE_FILES_KEY]
+      @test_files = spec[TEMPLATE_TEST_FILES_KEY]
+      @template_name = spec.name
+      @template_path = TemplateHelper.obtain_path(name)
+    end
+  end
+end

data/lib/generamba/code_generation/rambafile_generator.rb

@@ -0,0 +1,22 @@
+require 'liquid'
+require 'tilt'
+
+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)
+      template = Tilt.new(File.dirname(__FILE__) + '/Rambafile.liquid')
+      output = template.render(properties)
+
+      File.open(RAMBAFILE_NAME, 'w+') {|f|
+        f.write(output)
+      }
+    end
+  end
+end

data/lib/generamba/configuration/project_configuration.rb

@@ -0,0 +1,9 @@
+require 'settingslogic'
+
+module Generamba
+
+  # A singletone class representing a Rambafile of the current project
+  class ProjectConfiguration < Settingslogic
+    source Dir.getwd + '/' + RAMBAFILE_NAME
+  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)
+
+      if path_exists == false
+        FileUtils.mkdir_p home_path
+      end
+
+      preferences_path = home_path.join(USER_PREFERENCES_FILE)
+      preferences_exist = File.file?(preferences_path)
+
+      if preferences_exist == false
+        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-ios/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,24 @@
+module Generamba
+
+  # Keys of Rambafile files
+  COMPANY_KEY = 'company'
+  PROJECT_NAME_KEY = 'project_name'
+  PROJECT_PREFIX_KEY = 'prefix'
+  XCODEPROJ_PATH_KEY = 'xcodeproj_path'
+
+  PROJECT_TARGET_KEY = 'project_target'
+  PROJECT_FILE_PATH_KEY = 'project_file_path'
+  PROJECT_GROUP_PATH_KEY = 'project_group_path'
+
+  TEST_TARGET_KEY = 'test_target'
+  TEST_FILE_PATH_KEY = 'test_file_path'
+  TEST_GROUP_PATH_KEY = 'test_group_path'
+
+  PODFILE_PATH_KEY = 'podfile_path'
+  CARTFILE_PATH_KEY = 'cartfile_path'
+
+  TEMPLATES_KEY = 'templates'
+  TEMPLATE_DECLARATION_NAME_KEY = 'name'
+  TEMPLATE_DECLARATION_LOCAL_KEY = 'local'
+  TEMPLATE_DECLARATION_GIT_KEY = 'git'
+end

data/lib/generamba/constants/rambaspec_constants.rb

@@ -0,0 +1,16 @@
+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_PATH_KEY = 'path'
+
+  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/template_helper.rb

@@ -0,0 +1,32 @@
+module Generamba
+
+  # Provides a number of helper methods for manipulating Generamba template files
+  class TemplateHelper
+
+    # Returns a file path for a specific template .rambaspec file
+    # @param template_name [String] The Generamba 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)
+
+      return spec_path
+    end
+
+    # Returns a file path for a specific template folder
+    # @param template_name [String] The Generamba template name
+    #
+    # @return [Pathname]
+    def self.obtain_path(template_name)
+      path = Pathname.new(Dir.getwd)
+                 .join(TEMPLATES_FOLDER)
+                 .join(template_name)
+
+      error_description = "Cannot find #{template_name}! Add it to the Rambafile and run *generamba template install*"
+      raise StandardError.new(error_description) if path.exist? == false
+
+      return path
+    end
+  end
+end

data/lib/generamba/helpers/xcodeproj_helper.rb

@@ -0,0 +1,87 @@
+module Generamba
+
+  # 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
+
+    # 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 { |target|
+        if target.name == target_name
+          return target
+        end
+      }
+    end
+
+    # Adds a provided file to a specific Project and Target
+    # @param project [Xcodeproj::Project] The target xcodeproj file
+    # @param target [AbstractTarget] The target for a file
+    # @param group_path [Pathname] The Xcode group path for current file
+    # @param file_path [Pathname] The file path for current file
+    #
+    # @return [void]
+    def self.add_file_to_project_and_target(project, target, group_path, file_path)
+      module_group = self.retreive_or_create_group(group_path, project)
+      xcode_file = module_group.new_file(File.absolute_path(file_path))
+
+      file_name = File.basename(file_path)
+      if File.extname(file_name) == '.m'
+        target.add_file_references([xcode_file])
+      end
+    end
+
+    # Recursively clears children of te 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, group_path)
+      module_group = self.retreive_or_create_group(group_path, project)
+      module_group.clear
+    end
+
+    private
+
+    # Finds or creates a group in a xcodeproj file with a given path
+    # @param group_path [Pathname] The full group path
+    # @param project [Xcodeproj::Project] The working Xcode project file
+    #
+    # @return [PBXGroup]
+    def self.retreive_or_create_group(group_path, project)
+      group_names = group_names_from_group_path(group_path)
+
+      final_group = project
+
+      group_names.each do |group_name|
+        next_group = final_group[group_name]
+        if (next_group == nil)
+          next_group = final_group.new_group(group_name)
+        end
+
+        final_group = next_group
+      end
+
+      return final_group
+    end
+
+    # Splits the provided Xcode group path to an array of separate groups
+    # @param group_path The full group path
+    #
+    # @return [[String]]
+    def self.group_names_from_group_path(group_path)
+      groups = group_path.to_s.split('/')
+      return groups
+    end
+  end
+end