power_stencil 0.5.0 → 0.6.3

data/lib/power_stencil/plugins/paths.rb

@@ -0,0 +1,38 @@
+module PowerStencil
+  module Plugins
+
+    module Paths
+
+      def plugin_path
+        case self.type
+        when :local
+          project.project_local_plugin_path self.name
+        when :gem
+          gem_spec.gem_dir
+        end
+      end
+
+      def plugin_command_line_definition_file
+        File.join plugin_path, 'etc', 'command_line.yaml'
+      end
+
+      def plugin_capabilities_definition_file
+        File.join plugin_path, 'etc', 'plugin_capabilities.yaml'
+      end
+
+      def plugin_config_specific_file
+        File.join plugin_path, 'etc', 'plugin_config.yaml'
+      end
+
+      def plugin_processors_dir
+        File.join plugin_path, 'lib', plugin_name, 'processors'
+      end
+
+      def plugin_entities_definitions_dir
+        File.join plugin_path, 'etc',  plugin_name, 'entities_definitions'
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/require.rb

@@ -6,7 +6,6 @@ module PowerStencil
       POST_BUILD_HOOK = :post_build_hook
 
       include PowerStencil::Utils::SecureRequire
-      include PowerStencil::Utils::GemUtils
 
       private
 
@@ -15,21 +14,16 @@ module PowerStencil
       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 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
-          end
-
+        @entry_point_path = File.join plugin_path, 'lib', "#{name.underscore}.rb"
+        logger.debug "Plugin '#{name}' entry point: '#{entry_point_path}'"
+        plugin_root_path = File.dirname(entry_point_path)
+        begin
+          $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
       end
 

data/lib/power_stencil/plugins/templates.rb

@@ -7,7 +7,7 @@ module PowerStencil
         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

data/lib/power_stencil/project/base.rb

@@ -34,6 +34,10 @@ module PowerStencil
 
       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
@@ -41,11 +45,19 @@ module PowerStencil
         bootstrap_plugins
         build_engines
         register_system_templates
+        register_plugins_templates
         register_project_templates
       end
 
       private
 
+      def register_plugins_templates
+        plugins.each do |_, plugin|
+          plugin.register_plugin_templates
+        end
+      end
+
+
       def register_project_templates
         dir = project_templates_path
         if Dir.exist? dir and File.readable? dir

data/lib/power_stencil/project/config.rb

@@ -21,8 +21,9 @@ module PowerStencil
       end
 
 
-      def add_plugin_config(plugin_name)
-        yaml_file = plugin_config_specific_file plugin_name
+      def add_plugin_config(plugin)
+        plugin_name = plugin.name
+        yaml_file = plugin.plugin_config_specific_file
         priority = if priority.nil?
                      PLUGIN_CONFIG_PRIORITY_MIN
                    else

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[type]}'" unless entity_type_templates[type].nil?
           report << msg
         end
         report

data/lib/power_stencil/project/paths.rb

@@ -35,10 +35,14 @@ module PowerStencil
         File.join PowerStencil::Project::Paths.system_templates_path, entity_type.to_s
       end
 
-      def project_plugins_path
+      def project_local_plugins_path
         File.join project_config_root, PowerStencil.config[:project_plugins_directory_name]
       end
 
+      def project_local_plugin_path(plugin_name)
+        File.join project_local_plugins_path, plugin_name
+      end
+
       def project_templates_path
         File.join project_config_root, PowerStencil.config[:project_templates_directory_name]
       end
@@ -47,30 +51,6 @@ module PowerStencil
         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_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'
-      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

data/lib/power_stencil/project/plugins.rb

@@ -7,7 +7,7 @@ module PowerStencil
         @plugins ||= {}
       end
 
-      def create_plugin_tree(plugin_name, new_plugin_path, overwrite_files: false)
+      def create_new_local_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
@@ -21,6 +21,7 @@ module PowerStencil
       private
 
       def bootstrap_plugins
+        @plugins = {}
         initialize_gem_plugins
         initialize_local_plugins
         command_line_manager.definition_hash_to_commands
@@ -31,45 +32,39 @@ module PowerStencil
         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}'"
+          PowerStencil.logger.info 'No gem plugin found in project'
           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
+
+          (gem_name, gem_req) = PowerStencil::Plugins::Base.plugin_definition_to_name_and_req plugin_definition
+          raise PowerStencil::Error, "Plugin '#{gem_name}' already exists !" unless plugins[gem_name].nil?
+
+          plugins[gem_name] = PowerStencil::Plugins::Base.new(gem_name, self, type: :gem, gem_req: gem_req)
         end
       end
 
       def initialize_local_plugins
-        unless File.directory? project_plugins_path
-          PowerStencil.logger.info "No local plugin found in '#{project_plugins_path}'"
+        unless File.directory? project_local_plugins_path
+          PowerStencil.logger.info "No local plugin found in '#{project_local_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|
+        Dir.entries(project_local_plugins_path)
+            .select { |e| File.directory? File.join(project_local_plugins_path, e) }
+            .reject { |d| %w(. ..).include? d }
+            .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.error "Discarding invalid plugin '#{candidate}'."
+            logger.puts_and_logs pse.message, logs_as: :error
+            logger.puts_and_logs "Discarding invalid plugin '#{candidate}'.", logs_as: :error
           end
         end
+
       end
 
     end

data/lib/power_stencil/system_entity_definitions/all.rb

@@ -3,6 +3,7 @@
 
 require 'power_stencil/system_entity_definitions/non_persistent'
 require 'power_stencil/system_entity_definitions/has_associated_files'
+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/entity_override.rb

@@ -1,5 +1,6 @@
 class UniverseCompiler::Entity::Override
 
+  extend PowerStencil::SystemEntityDefinitions::SourceProvider
   extend PowerStencil::SystemEntityDefinitions::Buildable
   include PowerStencil::SystemEntityDefinitions::EntityProjectCommon
 

data/lib/power_stencil/system_entity_definitions/entity_project_common.rb

@@ -3,7 +3,7 @@ module PowerStencil
 
     module EntityProjectCommon
 
-        def save(uri = source_uri, raise_error: true, force_save: false, force_files_generation: false )
+      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

data/lib/power_stencil/system_entity_definitions/project_entity.rb

@@ -3,6 +3,7 @@ module PowerStencil
 
     class ProjectEntity < UniverseCompiler::Entity::Base
 
+      extend PowerStencil::SystemEntityDefinitions::SourceProvider
       extend PowerStencil::SystemEntityDefinitions::Buildable
       include PowerStencil::SystemEntityDefinitions::EntityProjectCommon
 

data/lib/power_stencil/system_entity_definitions/simple_exec.rb

@@ -9,7 +9,7 @@ module PowerStencil
 
       entity_type :simple_exec
 
-      buildable_by ''
+      buildable
 
       has_one :process_descriptor, name: :post_process
       not_null :post_process

data/lib/power_stencil/system_entity_definitions/source_provider.rb

@@ -0,0 +1,15 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    module SourceProvider
+
+      DEFAULT_PROVIDER = PowerStencil
+
+      def entity_type_source_provider
+        @entity_type_source_provider ||= DEFAULT_PROVIDER
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/gem_utils.rb

@@ -3,8 +3,28 @@ module PowerStencil
 
     module GemUtils
 
-      def is_available_gem?(gem_name)
-        false
+      def plugin_definition_to_name_and_req(plugin_definition)
+        md = plugin_definition.match /^\s*([^\s]+)\s*,?\s*(.+)?\s*$/
+        if md.nil?
+          raise PowerStencil::Error, "Invalid plugin_definition '#{plugin_definition}'"
+        end
+        gem_name = md[1]
+        gem_req = if md[2].nil? or md[2].empty?
+                    ::Gem::Requirement.default
+                  else
+                    ::Gem::Requirement.create md[2]
+                  end
+        [gem_name, gem_req]
+      end
+
+      def find_gemspec_manually(gem_name)
+        gem_spec_files = []
+        ::Gem::Specification.dirs.each do |dir|
+          Dir.glob(File.join(dir,  "#{gem_name}-*.*.*.gemspec")) do |file|
+            gem_spec_files << file
+          end
+        end
+        gem_spec_files.map { |file| ::Gem::Specification.load file }
       end
 
     end

data/lib/power_stencil/version.rb

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

data/power_stencil.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_dependency 'climatic', '~> 0.2.29'
+  spec.add_dependency 'climatic', '~> 0.2.30'
   spec.add_dependency 'dir_glob_ignore', '~> 0.3'
   spec.add_dependency 'universe_compiler', '~> 0.5.1'
   spec.add_dependency 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-24 00:00:00.000000000 Z
+date: 2019-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.29
+        version: 0.2.30
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.29
+        version: 0.2.30
 - !ruby/object:Gem::Dependency
   name: dir_glob_ignore
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +233,7 @@ files:
 - lib/power_stencil/plugins/dsl.rb
 - lib/power_stencil/plugins/entity_definitions.rb
 - lib/power_stencil/plugins/gem.rb
+- lib/power_stencil/plugins/paths.rb
 - lib/power_stencil/plugins/require.rb
 - lib/power_stencil/plugins/templates.rb
 - lib/power_stencil/plugins/type.rb
@@ -256,6 +257,7 @@ files:
 - lib/power_stencil/system_entity_definitions/project_config.rb
 - lib/power_stencil/system_entity_definitions/project_entity.rb
 - lib/power_stencil/system_entity_definitions/simple_exec.rb
+- lib/power_stencil/system_entity_definitions/source_provider.rb
 - lib/power_stencil/utils/directory_processor.rb
 - lib/power_stencil/utils/file_edit.rb
 - lib/power_stencil/utils/file_helper.rb
@@ -274,7 +276,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.5.0 !\nFrom the command
+post_install_message: "\nThank you for installing PowerStencil 0.6.3 !\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