power_stencil 0.3.0

data/lib/power_stencil/project/create.rb

@@ -0,0 +1,30 @@
+require 'fileutils'
+
+module PowerStencil
+  module Project
+
+    module Create
+
+      include Climatic::Proxy
+
+      def create_project_tree(path, config_directory_name = PowerStencil.config[:default_config_directory_name])
+        path = File.expand_path path
+        config_path = File.join path, config_directory_name
+        if Dir.exists? config_path
+          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)
+      end
+
+      private
+
+      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
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/info.rb

@@ -0,0 +1,72 @@
+module PowerStencil
+  module Project
+
+    module Info
+
+      def paths_report
+        report = []
+        report << "Project root path: '#{project_root}'"
+        report << "Project configuration path: '#{project_config_root}'"
+        report << if File.exist? project_personal_config_file
+                    "Local user configuration file: '#{project_personal_config_file}'"
+                  else
+                    'No personal project config file found'
+                  end
+        report << if File.exist? project_versioned_config_file
+                    "Project (versioned) configuration file: '#{project_versioned_config_file}'"
+                  else
+                    'No versioned project config file found'
+                  end
+        report << "Project entities: '#{project_entities_path}'"
+        report << "User (unversioned) entities: '#{user_entities_path}'"
+        txt = "Project specific entity definitions: '#{project_entity_definitions_path}'"
+        txt << ' (missing)' unless Dir.exist? project_entity_definitions_path
+        report << txt
+      end
+
+      def general_report
+        report = []
+        report << "Project required version: #{config[:min_power_stencil_version]}" unless config[:min_power_stencil_version].nil?
+        report << "PowerStencil version: #{PowerStencil::VERSION}"
+      end
+
+      def plugin_report(plugin_name, plugin)
+        report = []
+        # report << "Plugin '#{plugin_name}'"
+        plugin.capabilities.each {|name, status| report << "#{name.to_s}: #{status}"}
+        report
+      end
+
+      def entities_report
+        report = []
+        used_types = {}
+        report << "Contains #{engine.root_universe.get_entities.count} entities."
+        engine.root_universe.get_entities
+            .sort{ |a,b| a.type <=> b.type }
+            .each do |entity|
+          used_types[entity.type] ||= 0
+          used_types[entity.type] += 1
+        end
+        used_types.each do |type, count|
+          report << " #{type}: #{count}"
+        end
+        report
+      end
+
+      def entity_types_report
+        report = []
+        PowerStencil::Engine::EntitiesHandling.all_types
+            .select { |type, _| type.is_a? Symbol}
+            .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?
+          report << msg
+        end
+        report
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/paths.rb

@@ -0,0 +1,119 @@
+module PowerStencil
+  module Project
+
+    module Paths
+
+      include PowerStencil::Utils::FileHelper
+
+      attr_reader :project_config_root, :started_from
+
+      def self.system_templates_path
+        File.expand_path File.join('..', '..', '..', '..', 'etc', 'templates'), __FILE__
+      end
+
+      def self.project_system_template_path
+        File.join system_templates_path, 'project'
+      end
+
+      def build_run_path(seed)
+        File.join build_root_path, timestamped_uniq_dir(seed, Time.now)
+      end
+
+      def build_root_path
+        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
+      end
+
+      def project_plugins_path
+        File.join project_config_root, PowerStencil.config[:project_plugins_directory_name]
+      end
+
+      def project_templates_path
+        File.join project_config_root, PowerStencil.config[:project_templates_directory_name]
+      end
+
+      def project_entity_definitions_path
+        File.join project_config_root, PowerStencil.config[:project_entity_definitions_directory_name]
+      end
+
+      def project_plugin_path(plugin_name)
+        File.join project_plugins_path, plugin_name
+      end
+
+
+      def plugin_commands_line_definition_file(plugin_name)
+        File.join project_plugin_path(plugin_name), 'etc', 'command_line.yaml'
+      end
+
+      def plugin_config_specific_file(plugin_name)
+        File.join project_plugin_path(plugin_name), 'etc', 'plugin_config.yaml'
+      end
+
+      def plugin_processors_dir(plugin_name)
+        File.join project_plugin_path(plugin_name), 'lib', plugin_name, 'processors'
+      end
+
+      def plugin_entities_definitions_dir(plugin_name)
+        File.join project_plugin_path(plugin_name), 'etc',  plugin_name, 'entities_definitions'
+      end
+
+      def project_entity_path(entity)
+        File.join project_entities_path, entity.type.to_s, "#{entity.name}.yaml"
+      end
+
+      def user_entity_path(entity)
+        File.join user_entities_path, entity.type.to_s, "#{entity.name}.yaml"
+      end
+
+      def project_entities_path
+        File.join project_config_root, PowerStencil.config[:project_entities_directory_name]
+      end
+
+      def user_entities_path
+        File.join project_config_root, PowerStencil.config[:user_entities_directory_name]
+      end
+
+      def project_root_setup?
+        not project_config_root.nil?
+      end
+
+      def project_root
+        File.expand_path '..', project_config_root
+      end
+
+      def project_versioned_config_file
+        File.join project_config_root, PowerStencil.config[:versioned_project_config_file_name]
+      end
+
+      def project_personal_config_file
+        File.join project_config_root, PowerStencil.config[:unversioned_user_project_config_file_name]
+      end
+
+      def config_directory_name
+        @config_directory_name ||= PowerStencil.config[:default_config_directory_name]
+      end
+
+      def config_directory_name=(new_name)
+        @config_directory_name = new_name
+        initialize_paths started_from unless started_from.nil?
+      end
+
+      def initialize_paths(from_path)
+        from_path = File.expand_path from_path
+        @project_config_root = find_project_root from_path
+        raise PowerStencil::Error, "Cannot find a project in '#{from_path}' !" unless project_root_setup?
+        @started_from = project_config_root.nil? ? nil : from_path
+        project_root
+      end
+
+      def find_project_root(from_path)
+        find_recursively_in_path config_directory_name, from_path
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/plugins.rb

@@ -0,0 +1,89 @@
+module PowerStencil
+  module Project
+
+    module Plugins
+
+      def plugins
+        @plugins ||= {}
+      end
+
+      def create_plugin_tree(plugin_name, new_plugin_path, overwrite_files: false)
+        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],
+                                    new_plugin_path,
+                                    overwrite_files: overwrite_files,
+                                    main_entry_point: plugin_name
+
+      end
+
+      private
+
+      def bootstrap_plugins
+        initialize_gem_plugins
+        initialize_local_plugins
+        check_plugins_dependencies
+        command_line_manager.definition_hash_to_commands
+        plugins.each do |plugin_name, plugin|
+          if plugin.capabilities[:processors]
+            plugin.plugin_module.send PowerStencil::Plugins::Require::SETUP_PROCESSOR_CALLBACK
+          end
+        end
+      end
+
+      def check_plugins_dependencies
+        plugins.each do |plugin_name, plugin|
+          begin
+            plugin.check_plugin_dependencies
+          rescue PowerStencil::Error => pse
+            PowerStencil.logger.debug pse.message
+            PowerStencil.logger.warn "Discarding invalid plugin '#{plugin_name}'."
+          end
+        end
+      end
+
+      def initialize_gem_plugins
+        # PowerStencil::logger.warn 'Gem plugins not yet supported ! Skipping...'
+        if config[:project_plugins].empty?
+          PowerStencil.logger.info "No gem plugin found in '#{project_plugins_path}'"
+          return
+        end
+        config[:project_plugins].each do |plugin_definition|
+          plugin_name, plugin_requirements = case plugin_definition
+                                             when String
+                                               [plugin_definition, '']
+                                             when Hash
+                                               [plugin_definition.keys.first, plugin_definition.values.first]
+                                             end
+          unless PowerStencil::Plugins::Base.gem_locally_installed? plugin_name, plugin_requirements
+            PowerStencil::Plugins::Base.install_gem plugin_name, plugin_requirements
+          end
+        end
+      end
+
+      def initialize_local_plugins
+        unless File.directory? project_plugins_path
+          PowerStencil.logger.info "No local plugin found in '#{project_plugins_path}'"
+          return
+        end
+
+        candidates = Dir.entries(project_plugins_path)
+                         .select { |e| File.directory? File.join(project_plugins_path, e) }
+                         .reject { |d| %w(. ..).include? d }
+        @plugins = {}
+        candidates.each do |candidate|
+          begin
+            raise PowerStencil::Error, "Plugin '#{candidate}' already exists !" unless plugins[candidate].nil?
+            plugins[candidate] = PowerStencil::Plugins::Base.new(candidate, self)
+          rescue PowerStencil::Error => pse
+            PowerStencil.logger.debug pse.message
+            PowerStencil.logger.warn "Discarding invalid plugin '#{candidate}'."
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/proxy.rb

@@ -0,0 +1,13 @@
+module PowerStencil
+  module Project
+
+    module Proxy
+
+      def project
+        PowerStencil.project
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/templates.rb

@@ -0,0 +1,56 @@
+module PowerStencil
+  module Project
+
+    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 ||= {}
+      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]}'."
+        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
+      end
+
+      def generate_entity_dir_for_entity(entity, force: false)
+        unless entity_type_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
+        end
+      end
+
+      def delete_entity_dir_for_entity(entity, force: false)
+        return unless force
+        unless entity_type_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
+          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],
+                                    entity_dir_path,
+                                    overwrite_files: force,
+                                    main_entry_point: entity.name
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/versioning.rb

@@ -0,0 +1,29 @@
+module PowerStencil
+  module Project
+
+    module Versioning
+
+      def check_project_version
+        return if project_version_valid?
+        raise PowerStencil::Error, msg
+      end
+
+      private
+
+      def project_version_valid?
+        unless config[:min_power_stencil_version].nil?
+          framework_version = PowerStencil::Utils::SemanticVersion.new PowerStencil::VERSION
+          is_valid = framework_version >= config[:min_power_stencil_version]
+          if is_valid
+            logger.debug "PowerStencil version (v: #{framework_version}) is advanced enough to handle project required version (v: #{config[:min_power_stencil_version]})"
+          end
+          return is_valid
+        end
+        logger.debug 'Project does not require any specific PowerStencil version'
+        true
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/all.rb

@@ -0,0 +1,14 @@
+# This file is required by the engine but not from the gem
+# 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/buildable'
+require 'power_stencil/system_entity_definitions/entity_project_common'
+
+require 'power_stencil/system_entity_definitions/project_entity'
+require 'power_stencil/system_entity_definitions/project_config'
+require 'power_stencil/system_entity_definitions/plugin'
+require 'power_stencil/system_entity_definitions/process_descriptor'
+require 'power_stencil/system_entity_definitions/simple_exec'
+require 'power_stencil/system_entity_definitions/entity_override'

data/lib/power_stencil/system_entity_definitions/buildable.rb

@@ -0,0 +1,23 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    module Buildable
+
+      def buildable
+        buildable_by ''
+      end
+
+      def buildable_by(plugin_name = nil)
+        return @build_plugin_name if plugin_name.nil?
+        @build_plugin_name = plugin_name
+        self.include PowerStencil::SystemEntityDefinitions::HasAssociatedFiles
+      end
+
+      def buildable?
+        not @build_plugin_name.nil?
+      end
+
+    end
+
+  end
+end