power_stencil 0.3.0

data/lib/power_stencil/plugins/base.rb

@@ -0,0 +1,54 @@
+require 'power_stencil/plugins/dependencies'
+require 'power_stencil/plugins/config'
+require 'power_stencil/plugins/command_line'
+require 'power_stencil/plugins/templates'
+require 'power_stencil/plugins/require'
+require 'power_stencil/plugins/capabilities'
+require 'power_stencil/plugins/gem'
+
+module PowerStencil
+
+  module Plugins
+
+    class Base
+
+      extend PowerStencil::Plugins::Gem
+
+      include Climatic::Proxy
+      include PowerStencil::Plugins::Dependencies
+      include PowerStencil::Plugins::Config
+      include PowerStencil::Plugins::CommandLine
+      include PowerStencil::Plugins::Require
+      include PowerStencil::Plugins::Capabilities
+      include PowerStencil::Plugins::Templates
+
+      attr_reader :name, :version, :entry_point_path
+
+      def initialize(name, project)
+        @name = name
+        @project = project
+        @version = PowerStencil::Utils::SemanticVersion.new '0.0.0-not-specified'
+        logger.debug "Loading plugin '#{name}'..."
+        setup_plugin
+        logger.info "Plugin '#{name}' successfully available"
+        logger.debug "Plugin '#{name}' has following capabilities: #{capabilities.inspect}"
+      end
+
+      def path
+        project.project_plugin_path(name)
+      end
+
+      private
+
+      attr_reader :project
+
+      def setup_plugin
+        require_entry_point
+        load_plugin_specific_config
+        load_yaml_command_definition
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/capabilities.rb

@@ -0,0 +1,30 @@
+module PowerStencil
+  module Plugins
+
+    module Capabilities
+
+      DEFAULT_CAPABILITIES = {
+          command_line: false,
+          local_config: false,
+          processors: false,
+          build: false,
+          dsl: false,
+          entity_definitions: false,
+          code: false,
+          version: false,
+          templates: false
+      }.freeze
+
+      def capabilities
+        @capabilities ||= DEFAULT_CAPABILITIES.dup
+      end
+
+      def valid?
+        capabilities.keys.each {|cap_name| return true if capabilities[cap_name]}
+        false
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/command_line.rb

@@ -0,0 +1,27 @@
+module PowerStencil
+  module Plugins
+
+    module CommandLine
+
+      attr_reader :plugin_command_line_modifier
+
+      private
+
+      def load_yaml_command_definition
+        yaml_file = project.plugin_commands_line_definition_file name
+        if File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
+          logger.info "Adding extra command line definition for '#{name}' plugin..."
+          @plugin_command_line_modifier = project.yaml_file_to_hash yaml_file
+          command_line_manager.contribute_to_definition @plugin_command_line_modifier, layer_name: "Plugin: #{name}"
+          capabilities[:command_line] = true
+        else
+          logger.debug "There is no extra command line definition provided by plugin '#{name}'."
+        end
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.warn "Could not load yaml file '#{yaml_file}' because '#{e.message}'"
+      end
+    end
+
+  end
+end

data/lib/power_stencil/plugins/config.rb

@@ -0,0 +1,32 @@
+module PowerStencil
+  module Plugins
+
+    module Config
+
+      attr_reader :plugin_specific_config
+
+      def has_plugin_specific_config?
+        yaml_file = project.plugin_config_specific_file(name)
+        if File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
+          logger.info "Found plugin specific config to global config from '#{name}' plugin..."
+          return true
+        end
+        logger.debug "There is no extra command line definition provided by plugin '#{name}'."
+        false
+      end
+
+      def load_plugin_specific_config
+        yaml_file = project.plugin_config_specific_file(name)
+        if has_plugin_specific_config?
+          project.add_plugin_config(name)
+          capabilities[:local_config] = true
+        end
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.warn "Could not load yaml file '#{yaml_file}' because '#{e.message}'"
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/dependencies.rb

@@ -0,0 +1,32 @@
+module PowerStencil
+  module Plugins
+
+    module Dependencies
+
+      def has_dependencies?
+        not declared_dependencies.empty?
+      end
+
+      def declared_dependencies
+        if plugin_module.constants.include? :REQUIRED_PLUGINS
+          plugin_module::REQUIRED_PLUGINS
+        else
+          []
+        end
+      end
+
+      def check_plugin_dependencies
+        logger.info "Checking plugin '#{name}' dependencies !"
+        declared_dependencies.each do |dependency|
+          logger.debug "Checking dependency of plugin '#{name}' to plugin '#{dependency}'"
+          unless project.plugins.keys.include? dependency.to_s
+            raise PowerStencil::Error, "Unmatched dependency '#{dependency}' for plugin '#{name}' !"
+          end
+        end
+        logger.debug "Dependencies for plugin '#{name}' are Ok."
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/gem.rb

@@ -0,0 +1,57 @@
+require 'rubygems/commands/install_command'
+
+module PowerStencil
+  module Plugins
+
+    module Gem
+
+      NO_DOC = %w(--no-ri --no-rdoc).freeze
+
+      def gem_locally_installed?(plugin_name, plugin_requirements)
+        get_spec(plugin_name, plugin_requirements).nil? ? false : true
+      end
+
+
+      def install_gem(plugin_name, plugin_requirements)
+        cmd = ::Gem::Commands::InstallCommand.new
+        opts = [plugin_name]
+        opts << plugin_requirements unless plugin_requirements.empty?
+        opts.concat NO_DOC
+        cmd.handle_options opts
+        PowerStencil.logger.debug "Installing plugin '#{plugin_name}'..."
+        cmd.execute
+        PowerStencil.logger.debug "Plugin '#{plugin_name}' successfully installed."
+      rescue ::Gem::SystemExitException => e
+        PowerStencil.logger.warn PowerStencil::Error.report_error(e)
+      end
+
+
+
+      private
+
+      def get_spec(plugin_name, plugin_requirements)
+        candidates = ::Gem::Specification.find_all_by_name plugin_name
+        if candidates.empty?
+          PowerStencil.logger.debug "Could not find required plugin '#{plugin_name}'"
+          return nil
+        end
+
+        req = if plugin_requirements.nil? or plugin_requirements.empty?
+                ::Gem::Requirement::DefaultRequirement
+              else
+                ::Gem::Requirement.create plugin_requirements
+              end
+
+        selected = candidates.select {|candidate| req.satisfied_by? candidate.version}.sort {|a, b| a.version <=> b.version}
+        if candidates.empty?
+          PowerStencil.logger.debug "Could not find required plugin '#{plugin_name}'"
+          return nil
+        end
+        selected.last
+
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/require.rb

@@ -0,0 +1,77 @@
+module PowerStencil
+  module Plugins
+
+    module Require
+
+      PLUGINS_NAMESPACE = PowerStencil::Plugin
+      SETUP_PROCESSOR_CALLBACK = :setup_processors
+      SETUP_DSL_CALLBACK = :setup_dsl
+      SETUP_ENTITY_DEFINITIONS_CALLBACK = :setup_entity_definitions
+      POST_BUILD_HOOK = :post_build_hook
+
+      include PowerStencil::Utils::SecureRequire
+      include PowerStencil::Utils::GemUtils
+
+      def plugin_module
+        if PLUGINS_NAMESPACE.constants.include? module_short_name
+          PLUGINS_NAMESPACE.const_get module_short_name
+        else
+          module_name = if respond_to? :name
+                          name.nil? ? 'Unknown' : module_short_name
+                        else
+                          __DIR__
+                        end
+          raise PowerStencil::Error, "Invalid plugin '#{module_name}'"
+        end
+      end
+
+      private
+
+      def module_short_name
+        name.split(/[-_]+/).map(&:capitalize).join.to_sym
+      end
+
+      def require_entry_point
+        if is_available_gem? name
+          logger.debug "Plugin '#{name}' is actually a Ruby Gem."
+          raise "Plugin (#{name}) provided as a Ruby gem is not yet supported !"
+        else
+          @entry_point_path = File.join project.project_plugin_path(name), 'lib', "#{name.underscore}.rb"
+          logger.debug "Plugin '#{name}' is provided locally: '#{entry_point_path}'"
+          plugin_root_path = File.dirname(entry_point_path)
+          begin
+            $LOAD_PATH << plugin_root_path
+            securely_require entry_point_path do
+              check_plugin_module_capabilities
+            end
+          rescue LoadError => e
+            logger.warn "As plugin '#{name}' code is invalid, removing '#{plugin_root_path}' from LOAD_PATH"
+            $LOAD_PATH.delete plugin_root_path
+          end
+
+        end
+      end
+
+      def check_plugin_module_capabilities
+        unless plugin_module.nil?
+          capabilities[:code] = true
+          setup_version
+        end
+        capabilities[:processors] = plugin_module.respond_to? SETUP_PROCESSOR_CALLBACK
+        capabilities[:dsl] = plugin_module.respond_to? SETUP_DSL_CALLBACK
+        capabilities[:entity_definitions] = plugin_module.respond_to? SETUP_ENTITY_DEFINITIONS_CALLBACK
+        capabilities[:build] = plugin_module.respond_to? POST_BUILD_HOOK
+      end
+
+      def setup_version
+        @version = PowerStencil::Utils::SemanticVersion.new plugin_module::VERSION
+        capabilities[:version] = true
+        logger.debug "Plugin '#{name}' is in version: #{version}"
+      rescue
+        logger.warn "No version specified for plugin '#{name}'."
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/templates.rb

@@ -0,0 +1,21 @@
+module PowerStencil
+  module Plugins
+
+    module Templates
+
+      SETUP_PLUGIN_TEMPLATES = :setup_plugin_templates
+
+      def register_plugin_templates
+        if plugin_module.respond_to? SETUP_PLUGIN_TEMPLATES
+          logger.debug "Plugin '#{name}' declares to have template(s)."
+          capabilities[:templates] = true
+          plugin_module.send SETUP_PLUGIN_TEMPLATES
+        else
+          logger.debug "Plugin '#{name}' declares to have no template."
+        end
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/base.rb

@@ -0,0 +1,79 @@
+require 'power_stencil/project/paths'
+require 'power_stencil/project/create'
+require 'power_stencil/project/config'
+require 'power_stencil/project/versioning'
+require 'power_stencil/project/info'
+require 'power_stencil/project/templates'
+require 'power_stencil/project/plugins'
+
+require 'power_stencil/engine/project_engine'
+require 'power_stencil/engine/entity_engine'
+
+module PowerStencil
+  module Project
+
+    class Base
+
+      class << self
+
+        def instantiate_from_config(config)
+          path = config[:'project-path'] || Dir.pwd
+          new search_from_path: path
+        end
+
+      end
+
+      include Climatic::Proxy
+      include PowerStencil::Project::Paths
+      include PowerStencil::Project::Config
+      include PowerStencil::Project::Versioning
+      include PowerStencil::Project::Templates
+      include PowerStencil::Project::Plugins
+      include PowerStencil::Project::Info
+      extend PowerStencil::Project::Create
+
+      attr_reader :engine, :entity_engine
+
+      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
+      end
+
+      private
+
+      def register_project_templates
+        dir = project_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
+          end
+        end
+      end
+
+      def register_system_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
+        end
+      end
+
+
+      def build_engines
+        @engine = PowerStencil::Engine::ProjectEngine.new self
+        @entity_engine = PowerStencil::Engine::EntityEngine.new
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/config.rb

@@ -0,0 +1,54 @@
+module PowerStencil
+  module Project
+
+    module Config
+
+      include PowerStencil::Project::Paths
+
+      attr_reader :plugin_priority_count
+
+      def load_project_specific_config
+        # Optional config files should have less priority than the command line layer
+        add_optional_config_layer project_versioned_config_file, 'versioned project config file', 70
+        add_optional_config_layer project_personal_config_file, 'personal project config file', 900
+      end
+
+      def add_plugin_config(plugin_name)
+        yaml_file = plugin_config_specific_file plugin_name
+        priority = if priority.nil?
+                     200
+                   else
+                     plugin_priority_count + 1
+                   end
+
+        add_optional_config_layer yaml_file, "'#{plugin_name}' plugin specific config", priority
+        @plugin_priority_count ||= 0
+        @plugin_priority_count += 1
+      end
+
+      private
+
+      def add_optional_config_layer(yaml_file, layer_name, layer_priority)
+        if File.readable? yaml_file
+          logger.debug "Loading #{layer_name}: '#{yaml_file}'..."
+          begin
+            new_config_layer = SuperStack::Layer.new.load yaml_file
+            new_config_layer.name = layer_name
+            new_config_layer.priority = layer_priority
+            config << new_config_layer
+            new_config_layer
+          rescue => e
+            logger.error "The #{layer_name} '#{yaml_file}' is invalid and has been ignored !"
+            logger.debug PowerStencil::Error.report_error(e)
+            false
+          end
+        else
+          logger.debug "No #{layer_name} found."
+          false
+        end
+      end
+
+    end
+
+  end
+end