power_stencil 0.6.1 → 0.7.2

data/lib/power_stencil/engine/entities_definitions.rb

@@ -7,7 +7,7 @@ module PowerStencil
 
       include PowerStencil::Utils::SecureRequire
 
-      def require_definition_files(files_or_dirs)
+      def require_definition_files(files_or_dirs, source)
         required_files = []
         files_or_dirs.each do |file_or_dir|
           if File.directory? file_or_dir and File.readable? file_or_dir
@@ -21,21 +21,30 @@ module PowerStencil
             next
           end
           # This is a ruby library or there is something wrong
-          securely_require file_or_dir
-          # unless securely_require file_or_dir
-          #   logger.warn "While trying to load definition files, found that '#{file_or_dir}' has a problem. Ignored..."
-          # end
+          securely_require_with_entity_class_detection file_or_dir, source
+
         end
-        required_files.sort!.each {|file| securely_require file, fail_on_error: true}
+        required_files.sort!.each { |file| securely_require_with_entity_class_detection file, source }
         required_files
       end
 
       private
 
       def load_system_entities_definition
-        require_definition_files [SYSTEM_ENTITY_DEFINITION_ENTRY_POINT]
+        require_definition_files [SYSTEM_ENTITY_DEFINITION_ENTRY_POINT], PowerStencil
       end
 
+      def securely_require_with_entity_class_detection(entity_definition_file_path, source)
+        before = PowerStencil::Engine::EntitiesHandling.all_types
+        securely_require entity_definition_file_path, fail_on_error: true
+        after = PowerStencil::Engine::EntitiesHandling.all_types
+        after.reject { |k, _| before.keys.include? k }
+            .each do |_, plugin_entity_class|
+          plugin_entity_class.instance_eval do
+            @entity_type_source_provider = source
+          end
+        end
+      end
     end
 
   end

data/lib/power_stencil/engine/entities_handling.rb

@@ -59,7 +59,7 @@ module PowerStencil
           raise PowerStencil::Error, "Unknown entity type: '#{type}'"
         end
         fields[:name] = fields[:name].to_s
-        res = @available_entities_hash[type.to_sym].new fields: fields, universe: work_universe
+        res = @available_entities_hash[type.to_sym].new fields: fields, universe: work_universe, user: user
         logger.debug "Created new '#{type}': \n#{fields.to_yaml}"
         work_universe.add res
         if work_universe == PowerStencil.project.engine.root_universe

data/lib/power_stencil/engine/project_engine.rb

@@ -36,7 +36,7 @@ module PowerStencil
         if Dir.exist? dir and File.readable? dir
           logger.info 'Loading project specific entity definitions.'
           $LOAD_PATH << dir
-          require_definition_files [dir]
+          require_definition_files [dir], project
         end
       end
 
@@ -62,24 +62,20 @@ module PowerStencil
       end
 
       def load_project_entities
-        logger.debug 'Loading project entities - NOT IMPLEMENTED'
         root_universe.import project.project_entities_path, stop_on_error: false do |new_entity|
-          process_entity new_entity
+          logger.debug "Loaded entity: '#{new_entity.as_path}'"
         end
       end
 
       def load_user_entities
-        logger.debug 'Loading user entities - NOT IMPLEMENTED'
         root_universe.import project.user_entities_path, stop_on_error: false do |new_entity|
-          process_entity new_entity
+          logger.debug "Loaded unversioned entity: '#{new_entity.as_path}'"
+          new_entity.instance_eval do
+            @is_versioned_entity = false
+          end
         end
       end
 
-      def process_entity(entity)
-        logger.debug "New entity: '#{entity.name}' (#{entity.type})"
-      end
-
-
     end
 
   end

data/lib/power_stencil/initializer.rb

@@ -8,17 +8,15 @@ module PowerStencil
 
     include Climatic::Proxy
 
+    def name
+      'PowerStencil core'
+    end
+
     def bootstrap(cmd_line_args = ARGV.dup)
       setup_climatic cmd_line_args
       logger.debug 'Starting PowerStencil initialization...'
       setup_system_processors
       setup_universe_compiler_logger
-      # @project = try_to_load_project fail_on_error: false
-      begin
-        project.setup_templates_for_entities # unless project.nil?
-      rescue => e
-        logger.debug PowerStencil::Error.report_error e
-      end
       logger.debug 'PowerStencil initialization complete'
     end
 
@@ -32,7 +30,6 @@ module PowerStencil
 
     def try_to_load_project(fail_on_error: true)
       PowerStencil::Project::Base.instantiate_from_config config
-
     end
 
     def setup_system_processors

data/lib/power_stencil/plugins/entity_definitions.rb

@@ -6,9 +6,24 @@ module PowerStencil
       def require_plugin_entity_definitions
         return unless capabilities[:entity_definitions]
         logger.info "Requiring '#{self.name}' plugin entity definitions..."
+        securely_require_with_entity_class_detection
+      end
+
+
+      private
+
+      def securely_require_with_entity_class_detection
+        before = PowerStencil::Engine::EntitiesHandling.all_types
         plugin_definition[:entity_definitions].each do |entity_definition_file_path|
           securely_require entity_definition_file_path, fail_on_error: true
         end
+        after = PowerStencil::Engine::EntitiesHandling.all_types
+        after.reject { |k, _| before.keys.include? k }.each do |_, plugin_entity_class|
+          plugin = self
+          plugin_entity_class.instance_eval do
+            @entity_type_source_provider = plugin
+          end
+        end
       end
 
     end

data/lib/power_stencil/plugins/require.rb

@@ -21,6 +21,7 @@ module PowerStencil
           $LOAD_PATH << plugin_root_path
           securely_require entry_point_path unless plugin_definition[:plugin_module].nil?
         rescue LoadError => e
+          @entry_point_path = nil
           logger.warn "As plugin '#{name}' code is invalid, removing '#{plugin_root_path}' from LOAD_PATH"
           $LOAD_PATH.delete plugin_root_path
         end

data/lib/power_stencil/plugins/templates.rb

@@ -3,15 +3,15 @@ module PowerStencil
 
     module Templates
 
-      def register_plugin_templates
+      def register_plugin_templates_templates
         return unless capabilities[:templates]
         logger.info "Loading '#{self.name}' plugin templates..."
         plugin_definition[:templates].each do |templates_path|
-          plugin_templates_path = File.join self.path, templates_path
+          plugin_templates_path = File.join self.plugin_path, templates_path
           Dir.entries(plugin_templates_path).reject { |e| %w(. ..).include? e }.each do |entry|
             template_path = File.join(plugin_templates_path, entry)
             if Dir.exist? template_path
-              project.register_template_path_for_type entry.to_sym, template_path
+              project.register_template_template_path_for_type entry.to_sym, template_path
             end
           end
         end

data/lib/power_stencil/project/base.rb

@@ -5,6 +5,7 @@ require 'power_stencil/project/versioning'
 require 'power_stencil/project/info'
 require 'power_stencil/project/templates'
 require 'power_stencil/project/plugins'
+require 'power_stencil/project/git'
 
 require 'power_stencil/engine/project_engine'
 require 'power_stencil/engine/entity_engine'
@@ -30,40 +31,54 @@ module PowerStencil
       include PowerStencil::Project::Templates
       include PowerStencil::Project::Plugins
       include PowerStencil::Project::Info
+      include PowerStencil::Project::Git
       extend PowerStencil::Project::Create
 
       attr_reader :engine, :entity_engine
 
+      def name
+        File.dirname project_config_root
+      end
+
       def initialize(search_from_path: Dir.pwd)
         initialize_paths search_from_path
         load_project_specific_config
         check_project_version
         bootstrap_plugins
         build_engines
-        register_system_templates
-        register_project_templates
+        register_system_templates_templates
+        register_plugins_templates_templates
+        register_project_templates_templates
+        setup_git_tracking
       end
 
       private
 
-      def register_project_templates
-        dir = project_templates_path
+      def register_plugins_templates_templates
+        plugins.each do |_, plugin|
+          plugin.register_plugin_templates_templates
+        end
+      end
+
+
+      def register_project_templates_templates
+        dir = project_templates_templates_path
         if Dir.exist? dir and File.readable? dir
           logger.info 'Registering project specific templates.'
           Dir.entries(dir).each do |potential_entity_type|
             next if potential_entity_type.match /^\./
             template_dir = File.join(dir, potential_entity_type)
             next unless File.directory? template_dir
-            register_template_path_for_type potential_entity_type.to_sym, template_dir
+            register_template_template_path_for_type potential_entity_type.to_sym, template_dir
           end
         end
       end
 
-      def register_system_templates
+      def register_system_templates_templates
         logger.debug 'Registering system templates'
         %i(plugin_definition simple_exec).each do |template_name|
-          template_path = template_path template_name
-          register_template_path_for_type template_name, template_path
+          template_path = system_template_template_path template_name
+          register_template_template_path_for_type template_name, template_path
         end
       end
 
@@ -76,4 +91,4 @@ module PowerStencil
     end
 
   end
-end
+end

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

@@ -60,7 +60,20 @@ module PowerStencil
             .sort{ |a,b| a.first <=> b.first }
             .each do |type, klass|
           msg = "Type '#{type}' --> #{klass}"
-          msg << " (template-template path: '#{entity_type_templates[type]}')" unless entity_type_templates[type].nil?
+
+          source_provider = klass.entity_type_source_provider
+          source_provider_display = if source_provider == PowerStencil
+                                      "'#{source_provider.name}'"
+                                    elsif source_provider == self
+                                      "project '#{source_provider.name}'"
+                                    elsif source_provider.is_a? PowerStencil::Plugins::Base
+                                      "plugin '#{source_provider.name}'"
+                                    else
+                                      raise PowerStencil::Error, "Unidentified source provider for #{klass} !"
+                                    end
+
+          msg << " (provided by #{source_provider_display})"
+          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