power_stencil 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26cb59d7fdc8d324704956de580c938d9fb22f80
-  data.tar.gz: 0ad6c0e26e6e47bbd7d37959f09e389056bd9094
+  metadata.gz: c36f08f7b3ad9a916e27a18e755af6794084b97f
+  data.tar.gz: 82104cf2bda5b15f57020b57ccf66b1e95ee241c
 SHA512:
-  metadata.gz: 7391eacdb19ef569ba482275c91f0d6cb048ad58a77de8f177fa6068577f1ba72ac83db11e56fa61da065de093141f50c62755cbe74104fc6e471e12fcd47512
-  data.tar.gz: 228e549dbc115c384b01e8b7d1f24398d3c833e10754a202d6e72d491e00d12d01b8c442fe897b827217d32015efdd9b41aa60fad9f7231eab256c3988c7171e
+  metadata.gz: 6d1db8dd8989c9299eea8fe869e527f7c86b93db49353962ecf2620a34614fb143a39b02e12480dd02929c57c5adce19ec53b35754e327e79c9620bff0d1708f
+  data.tar.gz: 8e1377704873ca6d8a8eb69c4ba7e41f3e2a9cb0af77b3c7d06ea5bb5fc3174b72dc3df81140dcbd4cb0c286b21bac3ebc7e15fff4ff44d82e4e08acc5925e31

data/etc/meta_templates/plugin_seed/.gitignore

@@ -7,5 +7,6 @@
 /spec/reports/
 /tmp/
 /.idea/
+Gemfile.lock
 # rspec failure tracking
 .rspec_status

data/etc/meta_templates/plugin_seed/README.md

@@ -2,7 +2,7 @@
 <%= plugin_title_name %>
 <%= '=' * plugin_title_name.size %>
 
-[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
+[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
 
 [PowerStencil] is the Swiss-army knife templating workflow for developers and ops.
 

data/etc/meta_templates/plugin_seed/etc/plugin_capabilities.yaml

@@ -32,3 +32,6 @@
 :templates:
   - etc/templates
 
+# Plugin dependencies to other plugins. Use the plugin name and NOT the plugin
+# gem name (in the case of a gem plugin). Declare as well dependencies to local plugins.
+:dependencies: []

data/etc/templates/plugin_definition/.gitignore

@@ -7,5 +7,6 @@
 /spec/reports/
 /tmp/
 /.idea/
+Gemfile.lock
 # rspec failure tracking
 .rspec_status

data/etc/templates/plugin_definition/README.md

@@ -2,7 +2,7 @@
 <%= plugin_title_name %>
 <%= '=' * plugin_title_name.size %>
 
-[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
+[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
 
 [PowerStencil] is the Swiss-army knife templating workflow for developers and ops.
 

data/etc/templates/plugin_definition/etc/plugin_capabilities.yaml

@@ -32,3 +32,6 @@
 :templates:
   - etc/templates
 
+# Plugin dependencies to other plugins. Use the plugin name and NOT the plugin
+# gem name (in the case of a gem plugin). Declare as well dependencies to local plugins.
+:dependencies: []

data/etc/templates/project/.ps_project/versioned-config.yaml

@@ -7,6 +7,7 @@
 
 # Project plugins gems
 # List of plugins, provided as real Ruby gems (outside of this project), that you want to use in this project.
+# Here declare the gem name, not the plugin name.
 # :project_plugins: []
 
 # Graphviz configuration

data/lib/power_stencil/engine/project_engine.rb

@@ -50,7 +50,7 @@ module PowerStencil
       private
 
       def load_plugins_entities_definition
-        project.plugins.each do |_, plugin|
+        project.plugins_sorted_by_dependency.each do |plugin|
           plugin.require_plugin_entity_definitions
         end
       end

data/lib/power_stencil/plugins/base.rb

@@ -70,7 +70,6 @@ module PowerStencil
         load_capabilities
         load_plugin_specific_config
         load_yaml_command_definition
-        require_entry_point
       end
 
     end

data/lib/power_stencil/plugins/capabilities.rb

@@ -13,6 +13,10 @@ module PowerStencil
         @capabilities ||= CAPABILITIES.dup.zip([false] * CAPABILITIES.size).to_h
       end
 
+      def dependencies
+        plugin_definition[:dependencies]
+      end
+
       private
 
       def load_capabilities

data/lib/power_stencil/plugins/require.rb

@@ -7,12 +7,6 @@ module PowerStencil
 
       include PowerStencil::Utils::SecureRequire
 
-      private
-
-      def module_short_name
-        name.split(/[-_]+/).map(&:capitalize).join.to_sym
-      end
-
       def require_entry_point
         @entry_point_path = File.join plugin_path, 'lib', "#{name.underscore}.rb"
         logger.debug "Plugin '#{name}' entry point: '#{entry_point_path}'"
@@ -27,6 +21,12 @@ module PowerStencil
         end
       end
 
+      private
+
+      def module_short_name
+        name.split(/[-_]+/).map(&:capitalize).join.to_sym
+      end
+
       def setup_version
         @version = PowerStencil::Utils::SemanticVersion.new plugin_module::VERSION
         capabilities[:version] = true

data/lib/power_stencil/project/base.rb

@@ -1,3 +1,5 @@
+require 'power_stencil/utils/dependency_solver'
+
 require 'power_stencil/project/paths'
 require 'power_stencil/project/create'
 require 'power_stencil/project/config'

data/lib/power_stencil/project/plugins.rb

@@ -18,13 +18,37 @@ module PowerStencil
 
       end
 
+      def plugins_sorted_by_dependency
+        solver = PowerStencil::Utils::DependencySolver.new
+        plugin_names = plugins.keys
+
+        plugins.each do |_, plugin|
+          unless plugin.dependencies.nil?
+            plugin.dependencies.each do |dependency_name|
+              raise PowerStencil::Error, "Invalid dependency '#{dependency_name}'declared for plugin '#{plugin.name}' !" unless plugin_names.include? dependency_name
+            end
+          end
+          solver[plugin.name] = plugin.dependencies.nil? ? [] : plugin.dependencies
+        end
+        solver.tsort.map { |plugin_name| plugins[plugin_name] }
+      rescue TSort::Cyclic => e
+        PowerStencil::Error.report_error e
+        raise PowerStencil::Error, 'Plugins cyclical dependency error !'
+      end
+
+
       private
 
       def bootstrap_plugins
         @plugins = {}
         initialize_gem_plugins
         initialize_local_plugins
+        require_plugins_entry_points
         command_line_manager.definition_hash_to_commands
+        register_plugins_processors
+      end
+
+      def register_plugins_processors
         plugins.each do |_, plugin|
           if plugin.capabilities[:processors]
             plugin.register_processors
@@ -32,6 +56,12 @@ module PowerStencil
         end
       end
 
+      def require_plugins_entry_points
+        plugins_sorted_by_dependency.each do |plugin|
+          plugin.require_entry_point
+        end
+      end
+
       def initialize_gem_plugins
         if config[:project_plugins].empty?
           PowerStencil.logger.info 'No gem plugin found in project'
@@ -42,7 +72,8 @@ module PowerStencil
           (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)
+          plugin = PowerStencil::Plugins::Base.new(gem_name, self, type: :gem, gem_req: gem_req)
+          plugins[plugin.name] = plugin
         end
       end
 
@@ -55,10 +86,12 @@ module PowerStencil
         Dir.entries(project_local_plugins_path)
             .select { |e| File.directory? File.join(project_local_plugins_path, e) }
             .reject { |d| %w(. ..).include? d }
+            .sort
             .each do |candidate|
           begin
             raise PowerStencil::Error, "Plugin '#{candidate}' already exists !" unless plugins[candidate].nil?
-            plugins[candidate] = PowerStencil::Plugins::Base.new(candidate, self)
+            plugin = PowerStencil::Plugins::Base.new(candidate, self)
+            plugins[plugin.name] = plugin
           rescue PowerStencil::Error => pse
             logger.puts_and_logs pse.message, logs_as: :error
             logger.puts_and_logs "Discarding invalid plugin '#{candidate}'.", logs_as: :error

data/lib/power_stencil/utils/dependency_solver.rb

@@ -0,0 +1,19 @@
+require 'tsort'
+
+module PowerStencil
+  module Utils
+
+    class DependencySolver < Hash
+
+      include TSort
+
+      alias tsort_each_node each_key
+
+      def tsort_each_child(node, &block)
+        fetch(node).each(&block)
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.9.2'.freeze
+  VERSION = '0.9.3'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Laurent Briais
@@ -307,6 +307,7 @@ files:
 - lib/power_stencil/ultra_command_line/providers_manager.rb
 - lib/power_stencil/ultra_command_line/sub_command.rb
 - lib/power_stencil/utils/completion.rb
+- lib/power_stencil/utils/dependency_solver.rb
 - lib/power_stencil/utils/directory_processor.rb
 - lib/power_stencil/utils/file_edit.rb
 - lib/power_stencil/utils/file_helper.rb
@@ -326,7 +327,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.9.2 !\nFrom the command
+post_install_message: "\nThank you for installing PowerStencil 0.9.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