power_stencil 0.4.22 → 0.5.0

data/lib/power_stencil/plugins/config.rb

@@ -3,27 +3,23 @@ module PowerStencil
 
     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
+      def plugin_config_specific_file
+        project.plugin_config_specific_file self.name
       end
 
+      private
+
       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
+        yaml_file = plugin_config_specific_file
+        if File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
+          logger.info "Found plugin specific config in plugin '#{self.name}'. Attempting to load..."
+          project.add_plugin_config self.name
+          capabilities[:config] = true
         end
       rescue => e
         logger.debug PowerStencil::Error.report_error(e)
-        logger.warn "Could not load yaml file '#{yaml_file}' because '#{e.message}'"
+        logger.error "Could not load yaml file '#{yaml_file}' because '#{e.message}'"
+        raise e
       end
 
     end

data/lib/power_stencil/plugins/dsl.rb

@@ -0,0 +1,17 @@
+module PowerStencil
+  module Plugins
+
+    module Dsl
+
+      def require_plugin_dsl
+        return unless capabilities[:dsl]
+        logger.info "Requiring '#{self.name}' DSL addon definition..."
+        plugin_definition[:dsl].each do |dsl_definition_file_path|
+          securely_require dsl_definition_file_path, fail_on_error: true
+        end
+      end
+    end
+
+  end
+end
+

data/lib/power_stencil/plugins/entity_definitions.rb

@@ -0,0 +1,17 @@
+module PowerStencil
+  module Plugins
+
+    module EntityDefinitions
+
+      def require_plugin_entity_definitions
+        return unless capabilities[:entity_definitions]
+        logger.info "Requiring '#{self.name}' plugin entity definitions..."
+        plugin_definition[:entity_definitions].each do |entity_definition_file_path|
+          securely_require entity_definition_file_path, fail_on_error: true
+        end
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/require.rb

@@ -3,28 +3,11 @@ module PowerStencil
 
     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
@@ -41,9 +24,7 @@ module PowerStencil
           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
+            securely_require entry_point_path unless plugin_definition[:plugin_module].nil?
           rescue LoadError => e
             logger.warn "As plugin '#{name}' code is invalid, removing '#{plugin_root_path}' from LOAD_PATH"
             $LOAD_PATH.delete plugin_root_path
@@ -52,17 +33,6 @@ module PowerStencil
         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

data/lib/power_stencil/plugins/templates.rb

@@ -3,15 +3,17 @@ module PowerStencil
 
     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."
+        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
+          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
+            end
+          end
         end
       end
 

data/lib/power_stencil/plugins/type.rb

@@ -0,0 +1,13 @@
+module PowerStencil
+  module Plugins
+
+    module Type
+
+      PLUGIN_TYPES = %i(local gem)
+
+      attr_reader :type
+
+    end
+
+  end
+end

data/lib/power_stencil/project/config.rb

@@ -29,7 +29,7 @@ module PowerStencil
                      plugin_priority_count + 1
                    end
         raise PowerStencil::Error, 'Too many plugins !!' if priority >= PROJECT_CONFIG_PRIORITY
-        add_optional_config_layer yaml_file, "'#{plugin_name}' plugin specific config", priority
+        raise PowerStencil::Error, "Invalid config for plugin '#{plugin_name}'" unless add_optional_config_layer yaml_file, "'#{plugin_name}' plugin specific config", priority
         @plugin_priority_count ||= 0
         @plugin_priority_count += 1
       end
@@ -46,8 +46,8 @@ module PowerStencil
             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)
+            logger.error "The #{layer_name} '#{yaml_file}' is invalid and has been ignored !"
             false
           end
         else

data/lib/power_stencil/project/paths.rb

@@ -51,6 +51,9 @@ module PowerStencil
         File.join project_plugins_path, plugin_name
       end
 
+      def plugin_capabilities_definition_file(plugin_name)
+        File.join project_plugin_path(plugin_name), 'etc', 'plugin_capabilities.yaml'
+      end
 
       def plugin_commands_line_definition_file(plugin_name)
         File.join project_plugin_path(plugin_name), 'etc', 'command_line.yaml'

data/lib/power_stencil/project/plugins.rb

@@ -23,25 +23,14 @@ module PowerStencil
       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|
+        plugins.each do |_, plugin|
           if plugin.capabilities[:processors]
-            plugin.plugin_module.send PowerStencil::Plugins::Require::SETUP_PROCESSOR_CALLBACK
+            plugin.register_processors
           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...'
@@ -78,7 +67,7 @@ module PowerStencil
             plugins[candidate] = PowerStencil::Plugins::Base.new(candidate, self)
           rescue PowerStencil::Error => pse
             PowerStencil.logger.debug pse.message
-            PowerStencil.logger.warn "Discarding invalid plugin '#{candidate}'."
+            PowerStencil.logger.error "Discarding invalid plugin '#{candidate}'."
           end
         end
       end

data/lib/power_stencil/utils/secure_require.rb

@@ -7,7 +7,7 @@ module PowerStencil
         PowerStencil.logger.debug "Securely requiring Ruby source file '#{ruby_source_file}'..."
         require ruby_source_file
         yield if block_given?
-      rescue => e
+      rescue StandardError, SyntaxError => e
         PowerStencil.logger.debug PowerStencil::Error.report_error(e)
         msg = "Could not require Ruby source file '#{ruby_source_file}' !"
         if fail_on_error

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.4.22'.freeze
+  VERSION = '0.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.4.22
+  version: 0.5.0
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-21 00:00:00.000000000 Z
+date: 2019-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,9 +140,14 @@ files:
 - doc/templates.md
 - etc/base_commands_definition.yml
 - etc/meta_templates/plugin_seed/etc/command_line.yaml
+- etc/meta_templates/plugin_seed/etc/plugin_capabilities.yaml
 - etc/meta_templates/plugin_seed/etc/plugin_config.yaml
 - etc/meta_templates/plugin_seed/etc/templates/.git_keep
+- etc/meta_templates/plugin_seed/etc/templates/{entity}_entity/.copy_ignore
+- etc/meta_templates/plugin_seed/etc/templates/{entity}_entity/.subst_ignore
+- etc/meta_templates/plugin_seed/etc/templates/{entity}_entity/message.txt
 - etc/meta_templates/plugin_seed/lib/{entity}.rb.erb
+- etc/meta_templates/plugin_seed/lib/{entity}/dsl/{entity}_dsl.rb.erb
 - etc/meta_templates/plugin_seed/lib/{entity}/entity_definitions/{entity}_entity.rb.erb
 - etc/meta_templates/plugin_seed/lib/{entity}/plugin_helper.rb.erb
 - etc/meta_templates/plugin_seed/lib/{entity}/version.rb.erb
@@ -160,9 +165,14 @@ files:
 - etc/templates/plugin_definition/bin/console
 - etc/templates/plugin_definition/bin/setup
 - etc/templates/plugin_definition/etc/command_line.yaml
+- etc/templates/plugin_definition/etc/plugin_capabilities.yaml
 - etc/templates/plugin_definition/etc/plugin_config.yaml
 - etc/templates/plugin_definition/etc/templates/.git_keep
+- etc/templates/plugin_definition/etc/templates/{entity}_entity/.copy_ignore
+- etc/templates/plugin_definition/etc/templates/{entity}_entity/.subst_ignore
+- etc/templates/plugin_definition/etc/templates/{entity}_entity/message.txt
 - etc/templates/plugin_definition/lib/{entity}.rb.erb
+- etc/templates/plugin_definition/lib/{entity}/dsl/{entity}_dsl.rb.erb
 - etc/templates/plugin_definition/lib/{entity}/entity_definitions/{entity}_entity.rb.erb
 - etc/templates/plugin_definition/lib/{entity}/plugin_helper.rb.erb
 - etc/templates/plugin_definition/lib/{entity}/version.rb.erb
@@ -216,13 +226,16 @@ files:
 - lib/power_stencil/error.rb
 - lib/power_stencil/initializer.rb
 - lib/power_stencil/plugins/base.rb
+- lib/power_stencil/plugins/build.rb
 - lib/power_stencil/plugins/capabilities.rb
 - lib/power_stencil/plugins/command_line.rb
 - lib/power_stencil/plugins/config.rb
-- lib/power_stencil/plugins/dependencies.rb
+- lib/power_stencil/plugins/dsl.rb
+- lib/power_stencil/plugins/entity_definitions.rb
 - lib/power_stencil/plugins/gem.rb
 - lib/power_stencil/plugins/require.rb
 - lib/power_stencil/plugins/templates.rb
+- lib/power_stencil/plugins/type.rb
 - lib/power_stencil/project/base.rb
 - lib/power_stencil/project/config.rb
 - lib/power_stencil/project/create.rb
@@ -261,12 +274,11 @@ 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.4.22 !\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 free to
-  report issues: https://gitlab.com/tools4devops/power_stencil/issues\n  "
+post_install_message: "\nThank you for installing PowerStencil 0.5.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
+  free to report issues: https://gitlab.com/tools4devops/power_stencil/issues\n  "
 rdoc_options: []
 require_paths:
 - lib

data/lib/power_stencil/plugins/dependencies.rb

@@ -1,32 +0,0 @@
-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