power_stencil 0.6.3 → 0.7.0

data/lib/power_stencil/project/create.rb

@@ -5,6 +5,8 @@ module PowerStencil
 
     module Create
 
+      INITIAL_REPOSITORY_COMMIT_MESSAGE = 'Initial commit for project "%s".'
+
       include Climatic::Proxy
 
       def create_project_tree(path, config_directory_name = PowerStencil.config[:default_config_directory_name])
@@ -14,14 +16,33 @@ module PowerStencil
           raise PowerStencil::Error, "The directory '#{path}' already contains a PowerStencil project !" unless config[:force]
         end
         logger.info "Creating project in '#{path}'..."
-        render_project_template_in(path)
+        render_project_template_in path
+        initialize_git_repository path
       end
 
       private
 
+      def initialize_git_repository(repo_path)
+        if config[:'no-git']
+          puts_and_logs 'Do not initialize project git repository as per config request.', logs_as: :debug
+          return
+        end
+        if Dir.exists? File.join(repo_path, '.git')
+          puts_and_logs 'Git repository already exists. Skipping.', logs_as: :debug, check_verbose: false
+          return
+        end
+        puts_and_logs 'Initializing git repository...', logs_as: :debug
+        git = ::Git.init repo_path
+        logger.debug 'Adding all files.'
+        git.add repo_path
+        logger.debug 'Committing initial status'
+        commit_msg = INITIAL_REPOSITORY_COMMIT_MESSAGE % [File.basename(repo_path)]
+        git.commit_all commit_msg
+      end
+
       def render_project_template_in(new_project_config_path)
         engine = PowerStencil::Engine::InitEngine.new
-        engine.render_source PowerStencil::Project::Paths.project_system_template_path, new_project_config_path
+        engine.render_source PowerStencil::Project::Paths.project_system_template_template_path, new_project_config_path
       end
 
     end

data/lib/power_stencil/project/git.rb

@@ -0,0 +1,75 @@
+module PowerStencil
+  module Project
+
+    module Git
+
+      include Climatic::Utils::Input
+
+      def track_action_with_git(action_message,
+                                user_validation_required: false,
+                                validation_message: 'Commit changes ?',
+                                show_files_to_commit: false,
+                                &block)
+        return yield if git.nil?
+
+        status_before_action = git.status
+        yield
+        status_after_action = git.status
+
+        files_introduced_by_action = status_after_action.untracked.reject { |f| status_before_action.untracked.keys.include? f}
+        files_deleted_by_action = status_after_action.deleted.reject { |f| status_before_action.deleted.keys.include? f}
+        files_modified_by_action = status_after_action.changed.reject { |f| status_before_action.changed.keys.include? f}
+        files_to_commit = [files_introduced_by_action, files_deleted_by_action, files_modified_by_action].map(&:keys).flatten.sort.uniq
+
+        if files_to_commit.empty?
+          puts_and_logs 'Nothing to commit.'
+          return
+        end
+
+        if show_files_to_commit
+          header = 'Following file'
+          header << 's' if files_to_commit.count > 1
+          header << ' will be committed:'
+          puts header
+          puts files_to_commit.map { |filename| " - '#{filename}'" }
+        end
+
+        if user_validation_required
+          unless get_user_confirmation(default_choice: 'Yes', prompt: validation_message)
+            puts_and_logs 'Commit cancelled by user.', check_verbose: false
+            return
+          end
+        end
+
+        files_to_commit.each { |filename| git.add filename }
+
+        # Verify files to be committed really are
+        files_really_to_be_committed = git.diff.stats[:files].keys.select { |filename| files_to_commit.include? filename }
+        return if files_really_to_be_committed.empty?
+        files_really_to_be_committed.each { |filename| logger.info "File '#{filename}' will be committed" }
+
+        git.commit action_message
+        puts_and_logs 'All changes introduced have been committed.'
+      end
+
+      private
+
+      attr_reader :git
+
+      def setup_git_tracking
+        @git = nil
+        if config[:'no-git']
+          logger.debug "Won't track any changes with git as per config request!"
+          return
+        end
+        @git = ::Git.open(self.project_root, :log => PowerStencil.logger)
+        logger.debug 'Following project changes with git'
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.warn 'This project is not managed by git'
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/info.rb

@@ -73,7 +73,7 @@ module PowerStencil
                                     end
 
           msg << " (provided by #{source_provider_display})"
-          msg << " template-template path: '#{entity_type_templates[type]}'" unless entity_type_templates[type].nil?
+          msg << " template-template path: '#{entity_type_templates_templates[type]}'" unless entity_type_templates_templates[type].nil?
           report << msg
         end
         report

data/lib/power_stencil/project/paths.rb

@@ -7,12 +7,12 @@ module PowerStencil
 
       attr_reader :project_config_root, :started_from
 
-      def self.system_templates_path
+      def self.system_templates_templates_path
         File.expand_path File.join('..', '..', '..', '..', 'etc', 'templates'), __FILE__
       end
 
-      def self.project_system_template_path
-        File.join system_templates_path, 'project'
+      def self.project_system_template_template_path
+        File.join system_templates_templates_path, 'project'
       end
 
       def build_run_path(seed)
@@ -31,8 +31,8 @@ module PowerStencil
         File.join project_root, PowerStencil.config[:project_build_root_directory_name]
       end
 
-      def template_path(entity_type)
-        File.join PowerStencil::Project::Paths.system_templates_path, entity_type.to_s
+      def system_template_template_path(entity_type)
+        File.join PowerStencil::Project::Paths.system_templates_templates_path, entity_type.to_s
       end
 
       def project_local_plugins_path
@@ -43,10 +43,26 @@ module PowerStencil
         File.join project_local_plugins_path, plugin_name
       end
 
-      def project_templates_path
+      def project_templates_templates_path
         File.join project_config_root, PowerStencil.config[:project_templates_directory_name]
       end
 
+      def entities_template_path
+        File.join project_root, PowerStencil.config[:versioned_entities_templates_directory_name]
+      end
+
+      def user_entities_template_path
+        File.join project_root, PowerStencil.config[:unversioned_user_entities_templates_directory_name]
+      end
+
+      def entity_template_path(entity)
+        if entity.is_versioned_entity?
+          File.join entities_template_path, entity.type.to_s, entity.name
+        else
+          File.join user_entities_template_path, entity.type.to_s, entity.name
+        end
+      end
+
       def project_entity_definitions_path
         File.join project_config_root, PowerStencil.config[:project_entity_definitions_directory_name]
       end

data/lib/power_stencil/project/plugins.rb

@@ -11,7 +11,7 @@ module PowerStencil
         raise PowerStencil::Error, "Plugin '#{plugin_name}' already exists !" if plugins.keys.include? plugin_name
         raise PowerStencil::Error, "Invalid plugin name '#{plugin_name}'" if (plugin_name.underscore =~ /^[_[:lower:]][_[:alnum:]]*$/).nil?
         entity_engine.dsl = PowerStencil::Dsl::PluginGeneration
-        entity_engine.render_source entity_type_templates[:plugin_definition],
+        entity_engine.render_source entity_type_templates_templates[:plugin_definition],
                                     new_plugin_path,
                                     overwrite_files: overwrite_files,
                                     main_entry_point: plugin_name

data/lib/power_stencil/project/templates.rb

@@ -3,48 +3,41 @@ module PowerStencil
 
     module Templates
 
-      def setup_templates_for_entities
-        plugins.each do |plugin_name, plugin|
-          logger.debug "Checking if plugin '#{plugin_name}' declares some templates..."
-          plugin.register_plugin_templates
-        end
-      end
-
-      def entity_type_templates
-        @entity_type_templates ||= {}
+      def entity_type_templates_templates
+        @entity_type_templates_templates ||= {}
       end
 
-      def register_template_path_for_type(entity_type, path)
-        if entity_type_templates.include? entity_type
-          logger.warn "There is already a template-template path registered for entity type '#{entity_type}': '#{entity_type_templates[entity_type]}'."
+      def register_template_template_path_for_type(entity_type, path)
+        if entity_type_templates_templates.include? entity_type
+          logger.warn "There is already a template-template path registered for entity type '#{entity_type}': '#{entity_type_templates_templates[entity_type]}'."
         end
         raise PowerStencil::Error, "There is no template in path: '#{path}'" unless Dir.exist? path and File.readable? path
         raise PowerStencil::Error, "Trying to register a template for non existing type '#{entity_type}'" unless engine.available_entity_types.include? entity_type
         logger.debug "Registering '#{path}' as template for type '#{entity_type}'."
-        entity_type_templates[entity_type] = path
+        entity_type_templates_templates[entity_type] = path
       end
 
-      def generate_entity_dir_for_entity(entity, force: false)
-        unless entity_type_templates[entity.type].nil?
+      def generate_template_dir_for_entity(entity, force: false)
+        unless entity_type_templates_templates[entity.type].nil?
           logger.debug "Generating entity dir for entity '#{entity.as_path}'"
-          target_path = File.join project_root, entity.type.to_s, entity.name.to_s
-          render_entity_template_in entity, target_path, force: force
+          target_path = entity.templates_path
+          render_entity_template_template_in entity, target_path, force: force
         end
       end
 
-      def delete_entity_dir_for_entity(entity, force: false)
+      def delete_template_dir_for_entity(entity, force: false)
         return unless force
-        unless entity_type_templates[entity.type].nil?
+        unless entity_type_templates_templates[entity.type].nil?
           logger.debug "Deleting entity files for entity '#{entity.as_path}'"
-          target_path = File.join project_root, entity.type.to_s, entity.name.to_s
+          target_path = entity.templates_path
           FileUtils.rmtree target_path unless target_path.nil? or target_path.empty?
         end
       end
 
       private
 
-      def render_entity_template_in(entity, entity_dir_path, force: false)
-        entity_engine.render_source entity_type_templates[entity.type],
+      def render_entity_template_template_in(entity, entity_dir_path, force: false)
+        entity_engine.render_source entity_type_templates_templates[entity.type],
                                     entity_dir_path,
                                     overwrite_files: force,
                                     main_entry_point: entity.name

data/lib/power_stencil/system_entity_definitions/all.rb

@@ -2,7 +2,7 @@
 # So it is safe to declare files in the order you need.
 
 require 'power_stencil/system_entity_definitions/non_persistent'
-require 'power_stencil/system_entity_definitions/has_associated_files'
+require 'power_stencil/system_entity_definitions/entity_templates'
 require 'power_stencil/system_entity_definitions/source_provider'
 require 'power_stencil/system_entity_definitions/buildable'
 require 'power_stencil/system_entity_definitions/entity_project_common'

data/lib/power_stencil/system_entity_definitions/buildable.rb

@@ -10,7 +10,7 @@ module PowerStencil
       def buildable_by(plugin_name = nil)
         return @build_plugin_name if plugin_name.nil?
         @build_plugin_name = plugin_name
-        self.include PowerStencil::SystemEntityDefinitions::HasAssociatedFiles
+        self.include PowerStencil::SystemEntityDefinitions::EntityTemplates
       end
 
       def buildable?

data/lib/power_stencil/system_entity_definitions/entity_override.rb

@@ -6,4 +6,9 @@ class UniverseCompiler::Entity::Override
 
   field :description
 
+  def initialize(fields: {}, universe: nil, user: false)
+    @is_versioned_entity = not(user)
+    super(fields: fields, universe: universe)
+  end
+
 end

data/lib/power_stencil/system_entity_definitions/entity_project_common.rb

@@ -3,17 +3,25 @@ module PowerStencil
 
     module EntityProjectCommon
 
+      def is_versioned_entity?
+        @is_versioned_entity
+      end
+
+      def is_user_entity?
+        not(@is_versioned_entity)
+      end
+
       def save(uri = source_uri, raise_error: true, force_save: false, force_files_generation: false )
         super(source_uri, raise_error: raise_error, force_save: force_save)
-        unless PowerStencil.project.entity_type_templates[type].nil?
-          PowerStencil.project.generate_entity_dir_for_entity self, force: force_files_generation
+        unless PowerStencil.project.entity_type_templates_templates[type].nil?
+          PowerStencil.project.generate_template_dir_for_entity self, force: force_files_generation
         end
         self
       end
 
       def delete(force_files_deletion: false)
-        unless PowerStencil.project.entity_type_templates[type].nil?
-          PowerStencil.project.delete_entity_dir_for_entity self, force: force_files_deletion
+        unless PowerStencil.project.entity_type_templates_templates[type].nil?
+          PowerStencil.project.delete_template_dir_for_entity self, force: force_files_deletion
         end
         super()
         self

data/lib/power_stencil/system_entity_definitions/{has_associated_files.rb → entity_templates.rb}

@@ -1,10 +1,10 @@
 module PowerStencil
   module SystemEntityDefinitions
 
-    module HasAssociatedFiles
+    module EntityTemplates
 
       def templates_path
-        File.join PowerStencil.project.project_root, type.to_s, name
+        PowerStencil.project.entity_template_path self
       end
 
     end

data/lib/power_stencil/system_entity_definitions/project_config.rb

@@ -11,7 +11,7 @@ module PowerStencil
 
       field_reader :simulate, :debug
 
-      def initialize(fields: {}, universe: nil)
+      def initialize(fields: {}, universe: nil, user: false)
         super
         self.name = 'Project Config'
       end

data/lib/power_stencil/system_entity_definitions/project_entity.rb

@@ -11,6 +11,12 @@ module PowerStencil
 
       field :description
 
+      def initialize(fields: {}, universe: nil, user: false)
+        @is_versioned_entity = not(user)
+        super(fields: fields, universe: universe)
+      end
+
+
     end
 
   end

data/lib/power_stencil/system_entity_definitions/simple_exec.rb

@@ -3,7 +3,7 @@ module PowerStencil
 
     class SimpleExec < PowerStencil::SystemEntityDefinitions::ProjectEntity
 
-      include PowerStencil::SystemEntityDefinitions::HasAssociatedFiles
+      include PowerStencil::SystemEntityDefinitions::EntityTemplates
 
       DOC = 'Describes a simple process to be called after source files have been rendered'.freeze
 
@@ -20,7 +20,7 @@ module PowerStencil
             self.post_process = PowerStencil.project.engine.new_entity universe, :process_descriptor, fields: {
                 name: "simple_exec_#{name}.process",
                 process: './main.sh'
-            }
+            }, user: is_user_entity?
           end
         end
         super(raise_error: raise_error)

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.6.3'.freeze
+  VERSION = '0.7.0'.freeze
 end

data/power_stencil.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dir_glob_ignore', '~> 0.3'
   spec.add_dependency 'universe_compiler', '~> 0.5.1'
   spec.add_dependency 'pry'
+  spec.add_dependency 'git'
 
   source_code_uri = 'https://gitlab.com/tools4devops/power_stencil'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-29 00:00:00.000000000 Z
+date: 2019-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: PowerStencil is the Swiss-army knife templating workflow for developers
   and ops.
 email:
@@ -240,6 +254,7 @@ files:
 - lib/power_stencil/project/base.rb
 - lib/power_stencil/project/config.rb
 - lib/power_stencil/project/create.rb
+- lib/power_stencil/project/git.rb
 - lib/power_stencil/project/info.rb
 - lib/power_stencil/project/paths.rb
 - lib/power_stencil/project/plugins.rb
@@ -250,7 +265,7 @@ files:
 - lib/power_stencil/system_entity_definitions/buildable.rb
 - lib/power_stencil/system_entity_definitions/entity_override.rb
 - lib/power_stencil/system_entity_definitions/entity_project_common.rb
-- lib/power_stencil/system_entity_definitions/has_associated_files.rb
+- lib/power_stencil/system_entity_definitions/entity_templates.rb
 - lib/power_stencil/system_entity_definitions/non_persistent.rb
 - lib/power_stencil/system_entity_definitions/plugin.rb
 - lib/power_stencil/system_entity_definitions/process_descriptor.rb
@@ -276,7 +291,7 @@ metadata:
   documentation_uri: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md
   source_code_uri: https://gitlab.com/tools4devops/power_stencil
   homepage_uri: https://powerstencil.brizone.org/
-post_install_message: "\nThank you for installing PowerStencil 0.6.3 !\nFrom the command
+post_install_message: "\nThank you for installing PowerStencil 0.7.0 !\nFrom the command
   line you can run `power_stencil --help`\nIf your shell is not completing the command:\n
   \ If you use rbenv: `rbenv rehash`\n  If you use zsh  : `rehash`\n\nOfficial Website
   \         : https://powerstencil.brizone.org/\nFull documentation here   : https://gitlab.com/tools4devops/power_stencil/blob/master/README.md\nFeel