generamba 1.0.0 → 1.1.0

data/lib/generamba/constants/rambaspec_constants.rb

@@ -10,9 +10,9 @@ module Generamba
   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_FILENAME_KEY = 'file_name'
-  TEMPLATE_FILE_FILETYPE_KEY = 'file_type'
+  TEMPLATE_FILE_IS_RESOURCE_KEY = 'is_resource'
 
   TEMPLATE_DEPENDENCIES_KEY = 'dependencies'
 end

data/lib/generamba/helpers/dependency_checker.rb

@@ -1,17 +1,15 @@
 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 or dependencies.count == 0 or !podfile_path
+      return if !dependencies || dependencies.count == 0 || !podfile_path
 
       dependencies_names = []
       Pod::Podfile.from_file(Pathname.new(podfile_path)).dependencies.each do |dependency|
@@ -37,7 +35,7 @@ module Generamba
     #
     # @return [void]
     def self.check_all_required_dependencies_has_in_cartfile(dependencies, cartfile_path)
-      return if !dependencies or dependencies.count == 0 or !cartfile_path
+      return if !dependencies || dependencies.count == 0 || !cartfile_path
 
       cartfile_string = File.read(cartfile_path)
 
@@ -52,7 +50,5 @@ module Generamba
         puts "[Warning] Dependencies #{not_existing_dependency} missed in Cartfile".yellow
       end
     end
-
   end
-
-end
+end

data/lib/generamba/helpers/gen_command_table_parameters_formatter.rb

@@ -1,23 +1,33 @@
 module Generamba
-
   # Provides methods for prepare parameters for displaying in table.
   class GenCommandTableParametersFormatter
+    require 'json'
 
     # This method prepared parameter for displaying
-    def self.prepare_parameters_for_displaying(parameters)
-      params = parameters.clone
+    def self.prepare_parameters_for_displaying(code_module, template_name)
+      params = {}
 
-      templates = []
+      params['Targets'] = code_module.project_targets.join(',')
+      params['Module path'] = code_module.module_file_path
 
-      params['templates'].each do |param|
-        templates.push(param['name'])
+      if code_module.module_file_path != code_module.module_group_path
+        params['Module group path'] = code_module.module_group_path
       end
 
-      params['templates'] = templates.join("\n")
+      params['Test targets'] = code_module.test_targets.join(',') if code_module.test_targets
+      params['Test file path'] = code_module.test_file_path if code_module.test_file_path
 
-      return params
-    end
+      if code_module.test_file_path != code_module.test_group_path
+        params['Test group path'] = code_module.test_group_path
+      end
 
-  end
+      params['Template'] = template_name
 
+      if code_module.custom_parameters
+        params['Custom parameters'] = code_module.custom_parameters.to_json
+      end
+
+      params
+    end
+  end
 end

data/lib/generamba/helpers/module_info_generator.rb

@@ -0,0 +1,32 @@
+module Generamba
+
+  class ModuleInfoGenerator
+    attr_reader :scope
+
+    def initialize(code_module)
+      module_info = {
+          'name' => code_module.name,
+          'description' => code_module.description,
+          'project_name' => code_module.project_name,
+          'project_targets' => code_module.project_targets,
+          'test_targets' => code_module.test_targets
+      }
+
+      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,
+          'custom_parameters' => code_module.custom_parameters
+      }
+    end
+
+  end
+
+end

data/lib/generamba/helpers/module_validator.rb

@@ -0,0 +1,27 @@
+module Generamba
+  # Provides methods for validating module
+  class ModuleValidator
+
+    # Method validates module
+    # @param code_module [CodeModule] The instance of CodeModule
+    #
+    # @return [Void]
+    def validate(code_module)
+      mandatory_fields = [COMPANY_KEY,
+                          PROJECT_PREFIX_KEY,
+                          PROJECT_NAME_KEY,
+                          XCODEPROJ_PATH_KEY,
+                          PROJECT_TARGETS_KEY,
+                          'module_file_path',
+                          'module_group_path']
+
+      mandatory_fields.each do |field|
+        unless code_module.instance_variable_get("@#{field}")
+          puts "Module is broken! *#{field}* field cannot be empty, because it is mandatory.".red
+          exit
+        end
+      end
+    end
+
+  end
+end

data/lib/generamba/helpers/print_table.rb

@@ -1,8 +1,6 @@
 module Generamba
-
   # Provides methods for print parameters in nice table.
   class PrintTable
-
     # This method prints out all the user inputs in a nice table.
     def self.print_values(values: nil, title: nil)
       require 'terminal-table'
@@ -15,7 +13,5 @@ module Generamba
       puts Terminal::Table.new(params)
       puts ''
     end
-
   end
-
-end
+end

data/lib/generamba/helpers/rambafile_validator.rb

@@ -1,8 +1,6 @@
 module Generamba
-
   # Provides methods for validating Rambafile contents
   class RambafileValidator
-
     # Method validates Rambafile contents
     # @param path [String] The path to a Rambafile
     #
@@ -44,7 +42,12 @@ module Generamba
     #
     # @return [Array]
     def all_project_failure_fields(preferences)
-      return all_nil_mandatory_fields_for_target_type("project", preferences)
+      file_path = preferences[PROJECT_FILE_PATH_KEY]
+      group_path = preferences[PROJECT_GROUP_PATH_KEY]
+
+      return [] if !file_path || !group_path
+
+      all_nil_mandatory_fields_for_target_type('project', preferences)
     end
 
     # Method which return all test failure fields
@@ -59,23 +62,21 @@ module Generamba
 
       has_test_fields = target || targets || file_path || group_path
 
-      unless has_test_fields
-        return []
-      end
-      
-      return all_nil_mandatory_fields_for_target_type("test", preferences)
+      return [] unless has_test_fields
+
+      all_nil_mandatory_fields_for_target_type('test', preferences)
     end
 
     # Method which return all failure fields for target_type
     # @param target_type [String] "project" or "test"
     # @param preferences [Hash] Converted Rambafile
-    # 
+    #
     # @return [Array]
     def all_nil_mandatory_fields_for_target_type(target_type, preferences)
       target_type = target_type.upcase
 
-      target_const_value = Generamba.const_get(target_type + "_TARGET_KEY")
-      targets_const_value = Generamba.const_get(target_type + "_TARGETS_KEY")
+      target_const_value = Generamba.const_get(target_type + '_TARGET_KEY')
+      targets_const_value = Generamba.const_get(target_type + '_TARGETS_KEY')
 
       target = preferences[target_const_value]
       targets = preferences[targets_const_value]
@@ -86,20 +87,19 @@ module Generamba
         fields.push(target_const_value)
       end
 
-      file_path_const_value = Generamba.const_get(target_type + "_FILE_PATH_KEY")      
+      file_path_const_value = Generamba.const_get(target_type + '_FILE_PATH_KEY')
 
       unless preferences[file_path_const_value]
         fields.push(file_path_const_value)
-      end 
+      end
 
-      group_path_const_value = Generamba.const_get(target_type + "_GROUP_PATH_KEY")
+      group_path_const_value = Generamba.const_get(target_type + '_GROUP_PATH_KEY')
 
       unless preferences[group_path_const_value]
         fields.push(group_path_const_value)
       end
 
-      return fields
+      fields
     end
-
   end
-end
+end

data/lib/generamba/helpers/template_helper.rb

@@ -1,8 +1,6 @@
 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
     #
@@ -11,7 +9,7 @@ module Generamba
       template_path = self.obtain_path(template_name)
       spec_path = template_path.join(template_name + RAMBASPEC_EXTENSION)
 
-      return spec_path
+      spec_path
     end
 
     # Returns a file path for a specific template folder
@@ -20,13 +18,13 @@ module Generamba
     # @return [Pathname]
     def self.obtain_path(template_name)
       path = Pathname.new(Dir.getwd)
-                 .join(TEMPLATES_FOLDER)
-                 .join(template_name)
+                     .join(TEMPLATES_FOLDER)
+                     .join(template_name)
 
       error_description = "Cannot find template named #{template_name}! Add it to the Rambafile and run *generamba template install*".red
-      raise StandardError.new(error_description) unless path.exist?
+      raise StandardError, error_description unless path.exist?
 
-      return path
+      path
     end
   end
-end
+end

data/lib/generamba/helpers/xcodeproj_helper.rb

@@ -1,8 +1,6 @@
 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
     #
@@ -15,28 +13,24 @@ module Generamba
     # @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 file_path [Pathname] The file path for current file
-    # @param file_type is either 'source' or 'resource' - it affects on where file will be added. Put nil for autodetect
+    # @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, file_path, file_type = nil)
-      module_group = self.retrieve_group_or_create_if_needed(group_path, project, true)
+    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.join(file_group_path).join(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))
 
-      file_name = File.basename(file_path)
       targets_name.each do |target|
-        xcode_target = self.obtain_target(target, project)
+        xcode_target = obtain_target(target, project)
 
-        unless file_type
-          if self.is_compile_source?(file_name)
-            file_type = 'source'
-          elsif self.is_bundle_resource?(file_name)
-            file_type = 'resource'
-          end
-        end
-
-        if file_type != nil
-          self.add_file_to_target(xcode_target, xcode_file, file_type)
+        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
@@ -44,26 +38,12 @@ module Generamba
     # 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)
-      self.retrieve_group_or_create_if_needed(group_path, project, true)
-    end
-    
-    # Adds xcode file to target based on it's type
-    # @param target [Xcodeproj::AbstractTarget] xcode target to use
-    # @param file [Xcodeproj::PBXFileReference] file reference to add
-    # @param type [String] is either 'source' or 'resource'
-    #
-    def self.add_file_to_target(target, file, type)
-      case type
-        when 'source'
-          target.add_file_references([file])
-        when 'resource'
-          target.add_resources([file])
-        else
-          puts "Can't add file with type #{type}. Only 'source' and 'resource' are acceptable"
-      end
+    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
@@ -88,7 +68,7 @@ module Generamba
     #
     # @return [Void]
     def self.clear_group(project, targets_name, group_path)
-      module_group = self.retrieve_group_or_create_if_needed(group_path, project, false)
+      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)
@@ -97,7 +77,7 @@ module Generamba
       files_path.each do |file_path|
         self.remove_file_by_file_path(file_path, targets_name, project)
       end
-      
+
       module_group.clear
     end
 
@@ -107,39 +87,44 @@ module Generamba
     #
     # @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, project, false)
-      return module_group == nil ? false : true
+      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 full group 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 notexistent group will be created
+    # @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, project, create_group_if_not_exists)
+    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 do |group_name|
+      group_names.each_with_index do |group_name, index|
         next_group = final_group[group_name]
 
         unless next_group
-          unless create_group_if_not_exists
-            return nil
-          end
+          return nil unless create_group_if_not_exists
 
-          new_group_path = group_name
-          next_group = final_group.new_group(group_name, new_group_path)
+          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
 
-      return final_group
+      final_group
     end
 
     # Returns an AbstractTarget class for a given name
@@ -149,13 +134,11 @@ module Generamba
     # @return [Xcodeproj::AbstractTarget]
     def self.obtain_target(target_name, project)
       project.targets.each do |target|
-        if target.name == target_name
-          return target
-        end
+        return target if target.name == target_name
       end
 
       error_description = "Cannot find a target with name #{target_name} in Xcode project".red
-      raise StandardError.new(error_description)
+      raise StandardError, error_description
     end
 
     # Splits the provided Xcode path to an array of separate paths
@@ -163,8 +146,7 @@ module Generamba
     #
     # @return [[String]]
     def self.path_names_from_path(path)
-      paths = path.to_s.split('/')
-      return paths
+      path.to_s.split('/')
     end
 
     # Remove build file from target build phase
@@ -188,7 +170,7 @@ module Generamba
     end
 
     def self.remove_file_from_build_phases(file_path, build_phases)
-      return if build_phases == nil
+      return if build_phases.nil?
 
       build_phases.each do |build_phase|
         build_phase.files.each do |build_file|
@@ -220,7 +202,7 @@ module Generamba
         end
       end
 
-      return build_phases
+      build_phases
     end
 
     # Find and return target resources build phase
@@ -236,7 +218,7 @@ module Generamba
         resource_build_phase.push(xcode_target.resources_build_phase)
       end
 
-      return resource_build_phase
+      resource_build_phase
     end
 
     # Get configure file full path
@@ -247,7 +229,7 @@ module Generamba
       build_file_ref_path = file_ref.hierarchy_path.to_s
       build_file_ref_path[0] = ''
 
-      return build_file_ref_path
+      build_file_ref_path
     end
 
     # Get all files path from group path
@@ -255,18 +237,17 @@ module Generamba
     # @param project [Xcodeproj::Project] The target xcodeproj file
     #
     # @return [[String]]
-    def self.files_path_from_group(module_group, project)
+    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 = self.configure_file_ref_path(file_ref)
+          file_ref_path = configure_file_ref_path(file_ref)
           files_path.push(file_ref_path)
         end
       end
 
-      return files_path
+      files_path
     end
-
   end
-end
+end

data/lib/generamba/module_generator.rb

@@ -1,6 +1,7 @@
 require 'fileutils'
 
 require 'generamba/helpers/xcodeproj_helper.rb'
+require 'generamba/helpers/module_info_generator.rb'
 
 module Generamba
 
@@ -47,15 +48,12 @@ module Generamba
 			# Saving the current changes in the Xcode project
 			project.save
 
-			test_file_path_created_message = !code_module.test_file_path ? "" : "Test file path: #{code_module.test_file_path}".green + "\n"
-			test_group_path_created_message = !code_module.test_group_path ? "" : "Test group path: #{code_module.test_group_path}".green
-
-			puts("Module successfully created!\n" +
-				 "Name: #{name}".green + "\n" +
-				 "Module file path: #{code_module.module_file_path}".green + "\n" +
-				 "Module group path: #{code_module.module_group_path}".green + "\n" +
-				 test_file_path_created_message +
-				 test_group_path_created_message)
+			puts 'Module successfully created!'
+			puts "Name: #{name}".green
+			puts "Module file path: #{code_module.module_file_path}".green
+			puts "Module group path: #{code_module.module_group_path}".green
+			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, name, code_module, template, project, targets, group_path, dir_path)
@@ -72,25 +70,35 @@ module Generamba
 					file_group = dir_path.join(directory_name)
 
 					FileUtils.mkdir_p file_group
-					XcodeprojHelper.add_group_to_project(project, file_group)
-				else
-					file_group = File.dirname(file[TEMPLATE_NAME_KEY])
+					XcodeprojHelper.add_group_to_project(project, group_path, dir_path, directory_name)
+
+					next
+				end
 
-					# Generating the content of the code file and it's name
-					file_name, file_content = ContentGenerator.create_file(file, code_module, template)
-					file_path = dir_path.join(file_group).join(file_name)
+				file_group = File.dirname(file[TEMPLATE_NAME_KEY])
 
-					# 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
+				module_info = ModuleInfoGenerator.new(code_module)
 
-					file_type = file[TEMPLATE_FILE_FILETYPE_KEY]
+				# 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.join(file_group).join(file_name)
 
-					# Creating the file in the Xcode project
-					XcodeprojHelper.add_file_to_project_and_targets(project, targets, group_path.join(file_group), file_path, file_type)
+				# 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

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

@@ -24,7 +24,7 @@ module Generamba
         Git.clone(repo_url, template_name, :path => temp_path)
       end
 
-      template_path = "#{template_dir}/#{template_name}"
+      template_path = "#{template_dir}"
 
       rambaspec_exist = Generamba::RambaspecValidator.validate_spec_existance(template_name, template_path)
       unless rambaspec_exist

data/lib/generamba/version.rb

@@ -1,5 +1,5 @@
 module Generamba
-  VERSION = '1.0.0'
-  RELEASE_DATE = '23.07.2016'
+  VERSION = '1.1.0'
+  RELEASE_DATE = '05.09.2016'
   RELEASE_LINK = "https://github.com/rambler-ios/Generamba/releases/tag/#{VERSION}"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: generamba
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Egor Tolstoy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-23 00:00:00.000000000 Z
+date: 2016-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -175,6 +175,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -211,6 +212,8 @@ files:
 - lib/generamba/constants/user_preferences_constants.rb
 - lib/generamba/helpers/dependency_checker.rb
 - lib/generamba/helpers/gen_command_table_parameters_formatter.rb
+- lib/generamba/helpers/module_info_generator.rb
+- lib/generamba/helpers/module_validator.rb
 - lib/generamba/helpers/print_table.rb
 - lib/generamba/helpers/rambafile_validator.rb
 - lib/generamba/helpers/template_helper.rb