power_stencil 0.7.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95861a9f7061eee1367aa870964780c2ad23fb5e
-  data.tar.gz: 9d2d32a782fec326071ef7ddb253fc1a7a7aa9e2
+  metadata.gz: 1eacfe087b69afd2c0255a513247426d5698b6e3
+  data.tar.gz: 037422841a5061473c73166e299dd643fa8e46af
 SHA512:
-  metadata.gz: bdf296b43d659a3f562741802367abd4eb0675ae0b11aa7da41c47c8f7b3ff284a205fe98c96f77474e4acd0a9ca97704277b2806c45dd4d781ac2ade8e8a581
-  data.tar.gz: 4677edb152c96a92753ed2a1b6f64b8b05a4af9e7f52eee1c7dc2c9351c73af20b4c5da1f37da9feff0776fa0e18ec8cb6c3d6df56521ce9ca5aeed584c3f9bc
+  metadata.gz: 09a9753d65ad28ce0bd068dceed0da1a9351c7680f81de4d02180577ebbc08373297819fa471870531a6402de115c524d576fc355248e0a045d867b5586fab3e
+  data.tar.gz: fc3831ccc82144c7a4a80efd05ec8b78dc03c82a5bb4380ec1e290e2d59b441740ae8b298b28ba4c04148893719d8f63b95f55060554bfaf781f6d8828504b18

data/README.md

@@ -15,6 +15,7 @@ See [official website][PowerStencil site].
 - [Installation](#installation)
 - [Usage](#usage)
     - [Help](#help)
+    - [Command line auto-completion](#command-line-auto-completion)
     - [Creating a `PowerStencil` project](#creating-a-powerstencil-project)
     - [`PowerStencil` project structure](#powerstencil-project-structure)
     - [Getting started](#getting-started)
@@ -117,6 +118,7 @@ PowerStencil is the Swiss-army knife templating workflow for developers and ops.
  * plugin: Manipulates plugins ...
  * get: Query entities from repository ...
  * shell: Opens a shell to interact with entities ...
+ * adm: Administrative commands ...
  * check: Check repository entities consistency ...
  * create: Creates entities in the repository ...
  * edit: Edit entities from repository ...
@@ -131,6 +133,16 @@ The program uses the standard paradigm of sub-commands (à-la-git), and each can
 
 [Plugins] may bring extra subcommands and/or options, so depending on the project you are working in, the output of `--help` may differ...
 
+## Command line auto-completion
+
+`PowerStencil` comes with a command-line auto-completion feature for `zsh`. It is not yet available for `bash`.
+
+You can install it by running:
+
+    $ power_stencil adm --zsh-completion
+
+It provides a very useful auto-completion for sub-commands, options as well as parameters...
+
 ## Creating a `PowerStencil` project
 
 To create a new project, use the `init` sub-command. It works as you would expect. If you run it in an existing directory it will create the project here but you can specify the directory where you want the project to be created (the path will be created provided you have enough rights on the filesystem):

data/doc/plugins.md

@@ -15,6 +15,8 @@ Plugins
     - [Providing entity types and templates](#providing-entity-types-and-templates)
     - [Providing custom build process](#providing-custom-build-process)
 - [Plugin capabilities and structure](#plugin-capabilities-and-structure)
+    - [Proposed default plugin structure and life-cycle](#proposed-default-plugin-structure-and-life-cycle)
+    - [Fully manually created plugin](#fully-manually-created-plugin)
 - [Using plugins available as gems](#using-plugins-available-as-gems)
 - [Conclusion](#conclusion)
 
@@ -46,12 +48,12 @@ If you want to have new custom sub-commands or options available.
 
 Plugins are actually Ruby Gems with a specific structure. Plugins can be part of the project or provided as a separated stand-alone Gem.
 
-The normal process would be to begin with a plugin within the project and once you're ok with its features you may release it as a standalone Ruby Gem.
+The normal process would be to begin with a plugin within the project (under `.ps_project/plugins` directory) and once you're ok with its features you may release it as a standalone Ruby Gem.
 
 - Plugins local to the project are automatically taken in account.
-- To use plugins provided as Gems you have to set the `:plugins:` array property in the `.ps_project/versioned-config.yaml`
+- To use plugins provided as Gems you have to set the `:project_plugins:` array property in the `.ps_project/versioned-config.yaml`
 
-:warning: Plugins provided as standalone Gems are not thoroughly tested, for the time being, you may use plugins local to the project.
+See [using plugins gems](#using-plugins-available-as-gems) for more information.
 
 
 # Creating plugin local to the project
@@ -160,10 +162,12 @@ PowerStencil is the Swiss-army knife templating workflow for developers and ops.
  * plugin: Manipulates plugins ...
  * get: Query entities from repository ...
  * shell: Opens a shell to interact with entities ...
+ * adm: Administrative commands ...
  * check: Check repository entities consistency ...
  * create: Creates entities in the repository ...
  * edit: Edit entities from repository ...
  * delete: Delete entities from repository ...
+ * describe: Detailed information about entity types ...
  * build: Builds entities ...
  * myplugin: Does nothing useful Added by plugin myplugin
 ```
@@ -310,11 +314,23 @@ Here the code simply reads the generated `message.txt` file and displays it...
 
 # Plugin capabilities and structure
 
-So the `power_stencil plugin --create` generated a fully working plugin, implementing all the features (actually for the time being only custom dsl is not yet implemented) you could define in a template.
+## Proposed default plugin structure and life-cycle
 
-The generated plugin has the structure of a legit ruby gem, and this is not by chance, this is to prepare the fact that you may want to create a stand-alone plugin gem that you you may want to re-use in different projects.
+So the `power_stencil plugin --create` generated a fully working plugin, implementing all the features you could define in a plugin.
 
-But this is not mandatory. Actually the only mandatory file for a plugin to be valid is the file `etc/plugin_capabilities.yaml` in the plugin directory. This file declares what the plugin is able to do. For the `myplugin` we just created it contains:
+The generated plugin has the structure of a legit ruby gem, and this is not by chance, this is to prepare the fact that you may want to create a _stand-alone plugin gem_ that you you may want to re-use accross different projects.
+
+So, the default structure of a generated plugin is a very good starting point to develop your own plugins. You may remove manually some of the features, add some... and then eventually decide to separate it from your project repository, give it its own life and release it as a `PowerStencil` gem plugin. :champagne: :stars:
+
+**:information_source:This is by far the easiest and safest way to create and make evolve plugins of your own and the recommended way.**
+
+
+## Fully manually created plugin
+
+
+Nevertheless and in order to further understand the concepts behind `PowerStencil` plugins, here under you will find a way to do everything manually. 
+
+Using the provided plugin template is not mandatory. Actually the only mandatory file for a plugin to be valid is the file `etc/plugin_capabilities.yaml` in the plugin directory. This file declares what the plugin is able to do. For the `myplugin` we just created it contains:
 
 ```yaml
 ---
@@ -362,7 +378,7 @@ Let's create a plugin fully manually instead of using the `power_stencil plugin
 
     $ mkdir -p .ps_project/plugins/minimal/etc
 
-(of course the command to create the directory may be different on your system). Then here let's create a `plugin_capabilities.yaml` file with the following content:
+(of course the command to create the directory may be different on your system). Then here let's create a `plugin_capabilities.yaml` file in this `etc` subdirectory of the plugin directory  with the following content:
 
 ```yaml
 ---
@@ -426,13 +442,13 @@ MinimalPlugin::Minimal:
     :name: test
 ```
 
-All of this to demonstrate that a plugin can be almost anything, even something very minimalistic, but nevertheless you should keep on using the `power_stencil plugin --create` command and benefit from the structure it brings, as well as the possibility to become a stand-alone plugin gem...
+All of this to demonstrate that a plugin can be almost anything, even something very minimalistic, but nevertheless **you should keep on using the `power_stencil plugin --create` command and benefit from the structure it brings, as well as the possibility to become so easily a stand-alone plugin gem**...
 
 # Using plugins available as gems
 
-Any plugin you have created using the `power_stencil plugin --create` command is directly eligible to become a gem.
+Any plugin you have created using the `power_stencil plugin --create` command is directly eligible to become a plugin gem.
 
-**If you release a plugin you created within a project as a gem (by doing `bundle exec rake release` from within the plugin directory, like for any standard gem :+1:), you can then re-use your plugin from any other `PowerStencil` project !**
+**If you release a plugin you created within a project as a gem (by doing `bundle exec rake release` from within the plugin directory, like for any standard gem :+1:), you can then re-use your plugin accross any other `PowerStencil` project !**
 
 All you have to do for that is to declare it in the `.ps_project/versioned-config.yaml` config file by adding an array `:project_plugins`:
 
@@ -473,7 +489,7 @@ Installed plugin 'my_awesome_plugin2' (version: 0.1.1)
 Installed plugin 'my_awesome_plugin3' (version: 1.2.3)
 ```
 
-**:star2: ::+1: You can now verify using `power_stencil info` or `power_stencil plugin --list`, that the plugins have been installed and that any feature they provide is now available to your project.**
+**:star2: ::+1: You can now verify using `power_stencil info` or `power_stencil plugin --list -v`, that the plugins have been installed and that any feature they provide is now available to your project.**
 
 # Conclusion
 

data/etc/base_commands_definition.yml

@@ -40,7 +40,7 @@
     :global: true
     :dependencies:
       - debug
-    :type: integer
+    :type: log_level
     :summary: Defines the level of logging (0 to 5)
   log-file:
     :global: true
@@ -48,7 +48,7 @@
       - debug
     :incompatibilities:
       - debug-on-stderr
-    :type: string
+    :type: file
     :summary: Specifies a file to log into
   truncate-log-file:
     :global: true
@@ -58,7 +58,7 @@
     :summary: Truncates the log file (appends by default)
   project-path:
     :global: true
-    :type: string
+    :type: path
     :summary: Specifies a startup path to use instead of '.'
   auto:
     :global: true
@@ -79,6 +79,7 @@
       Default is initializing the PowerStencil repository in current directory. If
       specified, will initialize a repository in project_path (global option
       project_path can be used too).
+    :type: path
     :options:
       force:
         :type: bool
@@ -107,9 +108,10 @@
         plugin [options]
 
       Manipulates plugins.
+    :type: bool
     :options:
       create:
-        :type: bool
+        :type: string
         :summary: Scaffolds a fully working plugin skeleton.
         :long_aliases:
           - new
@@ -151,6 +153,7 @@
       "type/name" or two consecutive parameters "type name". If in
       "regexp" mode then each criterion is considered as a regular
       expression (be careful, not a file pattern alike)
+    :type: entity
     :options:
       regexp: &REGEXPOPT
         :type: bool
@@ -173,7 +176,7 @@
         :type: bool
         :summary: Entities as used by susbstitution engine.
       scenario: &SCENARIOOPT
-        :type: string
+        :type: scenario
         :summary: Applies overrides defined for this scenario.
         :dependencies:
           - compiled
@@ -186,7 +189,7 @@
         :short_aliases:
           - g
       graph-file:
-        :type: string
+        :type: file
         :summary: Displays the query result as a graph in the specified file.
         :long_aliases:
           - gf
@@ -204,6 +207,20 @@
         <<: *COMPILEDOPT
       scenario:
         <<: *SCENARIOOPT
+  adm:
+    :banner: |
+      Administrative commands.
+
+      Usage:
+
+        adm [options]
+    :options:
+      zsh-completion:
+        :type: bool
+        :summary: Generates power_stencil completion script for zsh shell.
+      query-for-completion:
+        :type: completion_query_type
+        :summary: Internal. Used by the auto-completion system.
   check:
     :banner: |
       Check repository entities consistency.
@@ -213,11 +230,12 @@
         check [entity_type[[/ ]entity_name]] [options]
 
       Check entities consistency. By default will check all entities.
+    :type: entity
     :options:
       regexp:
         <<: *REGEXPOPT
       invalid-only:
-        :type: boolean
+        :type: bool
         :summary: Show invalid entities only.
         :long_aliases:
           - invalid
@@ -232,6 +250,7 @@
         create entity_type[/ ]entity_name [options]
 
       Creates repository entities. Both type and name have to be provided
+    :type: entity_type
     :options:
       property:
         :type: array
@@ -246,7 +265,7 @@
         :long_aliases:
           - edit-after-create
       editor:
-        :type: string
+        :type: file
         :summary: Specifies an editor to use.
         :dependencies:
           - edit
@@ -267,10 +286,11 @@
         edit [entity_type[[/ ]entity_name]] [options]
 
       Edits repository entities. Parameters are used the same way as in 'get'.
+    :type: entity
     :options:
       regexp: *REGEXPOPT
       editor:
-        :type: string
+        :type: file
         :summary: Specifies an editor to use.
         :short_aliases:
           - e
@@ -283,6 +303,7 @@
         delete [entity_type[[/ ]entity_name]] [options]
 
       Deletes repository entities. Parameters are used the same way as in 'get'.
+    :type: entity
     :options:
       regexp: *REGEXPOPT
       delete-files:
@@ -298,6 +319,7 @@
 
       Displays information about core properties of given entity types.
       By default will describe all entity types.
+    :type: entity_type
   build:
     :banner: |
       Builds entities.
@@ -307,6 +329,7 @@
         build [entity_type[[/ ]entity_name]]+ [options]
 
       Builds repository entities. Parameters are used the same way as in 'get'.
+    :type: entity
     :options:
       regexp: *REGEXPOPT
       supported-builds:
@@ -330,7 +353,7 @@
         :short_aliases:
           - t
       target-path:
-        :type: string
+        :type: path
         :summary: Build into specified directory
         :long_aliases:
           - path

data/etc/meta_templates/plugin_seed/psplugin_{entity}.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Your name']
   spec.email         = ['you@somewhere']
 
-  spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.summary       = %q{<%= plugin_name %> is a plugin for the PowerStencil framework.}
   spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
   spec.license       = "MIT"

data/etc/power_stencil.yaml

@@ -106,6 +106,13 @@
     :fillcolor: grey95
   :customizations: {}
 
+# COMPLETION
+:completion_target:
+  :zsh:
+    :completion_dir: ~/.zsh/completion
+
+
+
 # MISC
 
 # Default log level (warn)

data/etc/templates/plugin_definition/psplugin_{entity}.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Your name']
   spec.email         = ['you@somewhere']
 
-  spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.summary       = %q{<%= plugin_name %> is a plugin for the PowerStencil framework.}
   spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
   spec.license       = "MIT"

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

@@ -5,6 +5,10 @@
 # If you want to ensure a minimal version number of PowerStencil
 :min_power_stencil_version: <%= PowerStencil::VERSION %>
 
+# Project plugins gems
+# List of plugins, provided as real Ruby gems (outside of this project), that you want to use in this project.
+# :project_plugins: []
+
 # Graphviz configuration
 #
 # If you are under Gnome, chances are that you have 'eog' installed

data/etc/templates/zsh_command_line_completion/.copy_ignore

@@ -0,0 +1,2 @@
+.copy_ignore
+*.ignore.sh

data/etc/templates/zsh_command_line_completion/_power_stencil.sh.erb

@@ -0,0 +1,117 @@
+#compdef <%= script_name %>
+
+# zsh shell completion script for <%= script_name %>
+# To regenerate this file: '<%= script_name %> adm --zsh-completion'
+# Generated on the <%= Time.now %> by <%= script_name %> v<%= PowerStencil::VERSION %>
+
+<% commands = PowerStencil.command_line_manager.commands -%>
+_<%= script_name %>() {
+    local cmd
+    local <%= script_name %>_sub_commands
+    <%= script_name %>_sub_commands=(<%= commands.reject { |c| c.name.empty? }.sort { |a,b| a.name <=> b.name }.map(&:name).join ' ' %>)
+    if (( CURRENT > 2)); then
+	    cmd=${words[2]}
+	    # Set the context for the subcommand.
+	    curcontext="${curcontext%:*:*}:power_stencil-$cmd"
+	    # Narrow the range of words we are looking at to exclude `<%= script_name %>'
+	    (( CURRENT-- ))
+	    shift words
+	    # Run the completion for the subcommand
+	    if (($<%= script_name %>_sub_commands[(Ie)$cmd])); then
+  	    (( $+functions[_<%= script_name %>_cmd_$cmd] )) && _<%= script_name %>_cmd_$cmd
+  	  else
+  	    _values : \
+<%= continued_multilines(root_command(commands).options.sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}, number_spaces: 10) %>
+  	  fi
+    else
+	    _values : \
+<% root_command = nil -%>
+<% commands.sort { |a,b| a.name <=> b.name }.each do |command| -%>
+<% if command.root_command? -%>
+<%   root_command = command -%>
+<%   next -%>
+<% end -%>
+	      <%= command_representation command %> \
+<% end -%>
+<%= continued_multilines(root_command.options.sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}, number_spaces: 8) %>
+    fi
+}
+
+###############################################################################
+# Sub-commands
+
+<% commands.reject { |c| c.name.empty? }.sort { |a,b| a.name <=> b.name }.each do |command| -%>
+# <%= command.name %> sub-command
+_<%= script_name %>_cmd_<%= command.name %>() {
+  _arguments -s : \
+<%
+command_param = default_command_param_type command
+options_lines = command.options.sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}
+options_lines << command_param unless command_param.empty?
+-%>
+<%= continued_multilines(options_lines) %>
+}
+
+<% end %>
+
+###############################################################################
+# Type handlers
+
+_get_completion_info() {
+  local cmd="$@"
+  res=$( eval ${cmd} 2>/dev/null )
+  echo ${res}
+}
+
+_power_stencil_project_root() {
+  cur_dir=`pwd`
+  psdir=".ps_project"
+  while [[ "${cur_dir}" != "" && ! -e "${cur_dir}/${psdir}" ]]; do
+    cur_dir=${cur_dir%/*}
+  done
+  echo "${cur_dir}"
+}
+
+_within_power_stencil_project() {
+  local res=$( _power_stencil_project_root )
+  if [ -z "${res#"${res%%[! ]*}"}" ]; then
+    return 1
+  fi
+  return 0
+}
+
+# Type entity
+_power_stencil_entity() {
+  $( _within_power_stencil_project ) || return 'YOU_ARE_NOT_WITHIN_A_POWER_STENCIL_PROJECT'
+  _values : $( _get_completion_info power_stencil adm --query-for-completion entities )
+}
+
+# Type entity_type
+_power_stencil_entity_type() {
+  $( _within_power_stencil_project ) || return 'YOU_ARE_NOT_WITHIN_A_POWER_STENCIL_PROJECT'
+  _values : $( _get_completion_info power_stencil adm --query-for-completion entity-types )
+}
+
+# Type scenario
+_power_stencil_scenario() {
+  $( _within_power_stencil_project ) || return 'YOU_ARE_NOT_WITHIN_A_POWER_STENCIL_PROJECT'
+  _values : $( _get_completion_info power_stencil adm --query-for-completion scenario )
+}
+
+# Type log_level
+_power_stencil_log_level() {
+  _values : $( echo 0 1 2 3 4 5 )
+}
+
+# Type completion_query_type
+_power_stencil_completion_query_type() {
+  _values : $( echo entities entity-types scenario )
+}
+
+# Type array and string
+_power_stencil_do_nothing() {
+  return 1
+}
+
+# Let's rock
+_<%= script_name %> "$@"

data/lib/power_stencil.rb

@@ -9,6 +9,7 @@ require 'climatic'
 
 require 'power_stencil/error'
 require 'power_stencil/utils/os'
+require 'power_stencil/utils/slop_extra_option_types'
 require 'power_stencil/utils/semantic_version'
 require 'power_stencil/utils/file_helper'
 require 'power_stencil/utils/directory_processor'
@@ -16,6 +17,7 @@ require 'power_stencil/utils/secure_require'
 require 'power_stencil/utils/gem_utils'
 require 'power_stencil/utils/file_edit'
 require 'power_stencil/utils/graphviz'
+require 'power_stencil/utils/completion'
 
 require 'climatic/script/unimplemented_processor'
 require 'power_stencil/project/proxy'
@@ -34,6 +36,7 @@ require 'power_stencil/command_processors/shell'
 require 'power_stencil/command_processors/plugin'
 require 'power_stencil/command_processors/build'
 require 'power_stencil/command_processors/describe'
+require 'power_stencil/command_processors/adm'
 
 
 module PowerStencil
@@ -55,3 +58,4 @@ module PowerStencil
   extend PowerStencil::Initializer
 
 end
+

data/lib/power_stencil/command_processors/adm.rb

@@ -0,0 +1,29 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Adm
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::Utils::Completion
+
+
+      def execute
+
+        if config[:'zsh-completion']
+          generate_zsh_completion 'power_stencil'
+          return
+        end
+
+        if config[:'query-for-completion']
+          puts project.query_for_completion config[:'query-for-completion'].to_sym
+        end
+
+      end
+
+    end
+
+  end
+end
+

data/lib/power_stencil/command_processors/plugin.rb

@@ -29,7 +29,7 @@ module PowerStencil
           end
           return
         end
-        
+
         if config[:list]
           if project.plugins.empty?
             puts 'No plugin used in this project.'
@@ -46,28 +46,23 @@ module PowerStencil
           end
           return
         end
-        
 
         if config[:create]
-          if config.command_line_layer.extra_parameters.empty?
-            raise PowerStencil::Error, 'Please specify at least one plugin name !'
-          end
-          config.command_line_layer.extra_parameters.each do |plugin_name|
-            begin
-              target_path = File.join project.project_local_plugin_path(plugin_name)
-              msg = "Generated new local plugin '#{plugin_name}'."
-              project.track_action_with_git(msg) do
-                project.create_new_local_plugin_tree plugin_name, target_path
-                puts_and_logs msg, check_verbose: false
-              end
-
-            rescue => e
-              msg = "Could not create plugin '#{plugin_name}' because '#{e.message}'"
-              puts msg
-              logger.error "Could not create plugin '#{plugin_name}' because '#{e.message}'"
-              logger.debug PowerStencil::Error.report_error(e)
+          plugin_name = config[:create]
+          begin
+            target_path = File.join project.project_local_plugin_path(plugin_name)
+            msg = "Generated new local plugin '#{plugin_name}'."
+            project.track_action_with_git(msg) do
+              project.create_new_local_plugin_tree plugin_name, target_path
+              puts_and_logs msg, check_verbose: false
             end
+          rescue => e
+            msg = "Could not create plugin '#{plugin_name}' because '#{e.message}'"
+            puts msg
+            logger.error "Could not create plugin '#{plugin_name}' because '#{e.message}'"
+            logger.debug PowerStencil::Error.report_error(e)
           end
+
           return
         end
 

data/lib/power_stencil/dsl/completion.rb

@@ -0,0 +1,94 @@
+module PowerStencil
+  module Dsl
+
+    class Completion < PowerStencil::Dsl::Base
+
+      class << self
+        attr_accessor :script_name
+      end
+
+      attr_reader :encountered_types
+
+      def initialize(universe)
+        super
+        @encountered_types = {}
+      end
+
+      def script_name
+        self.class.script_name
+      end
+
+      def root_command(commands)
+        commands.select { |c| c.name.empty? }.first
+      end
+
+      def command_summary(command)
+        text = command.help[0][0,60].tr("\n", ' ')
+        text.match(/^\s*(?<sentence>[^\s][^\.]+)\./) do |md|
+          return "#{md['sentence']} ..."
+        end
+        text
+      end
+
+      def command_representation(command, enclosing_dquote: true)
+        cr = "#{command.name}[#{command_summary command}]"
+        enclosing_dquote ? "\"#{cr}\"" : cr
+      end
+
+      def default_command_param_type(command, enclosing_dquote: true)
+        return '' if %i(bool boolean).include? command.type
+        default_cpt = "*:#{command.type}:_#{script_name}_#{command.type} "
+        type = command.type
+
+        encountered_types[type] ||=[]
+        encountered_types[type] << command unless encountered_types[type].include? command
+        enclosing_dquote ? "\"#{default_cpt}\"" : default_cpt
+      end
+
+      def option_representation(option, enclosing_dquote: true)
+        opr = "--#{option.name}[#{option.summary}]"
+        opr = if option.type.nil? or option.type.empty?
+                opr
+              else
+                if %i(bool boolean).include? option.type
+                  opr
+                else
+                  encountered_types[option.type] ||=[]
+                  encountered_types[option.type] << option unless encountered_types[option.type].include? option
+                  "#{opr}:#{option.type}:_#{ zsh_completion_from_type option.type} "
+                end
+              end
+        enclosing_dquote ? "\"#{opr}\"" : opr
+      end
+
+      def continued_multilines(lines, number_spaces: 4, cr: "\n", spaces_in_first_line: true, str_cont: ' \\')
+        return '' if lines.empty?
+        spaces = ' ' * number_spaces
+        first_line = true
+        res = lines.map do |line|
+          if first_line
+            fline = if spaces_in_first_line
+                      "#{spaces}#{line}"
+                    else
+                      line
+                    end
+            first_line = false
+            fline
+          else
+            "#{spaces}#{line}"
+          end
+        end
+        eol = str_cont + cr
+        res.join eol
+      end
+
+      def zsh_completion_from_type(type)
+        slop_class = type.to_s.split('_').map(&:capitalize).join + 'Option'
+        klass = Slop.const_get slop_class
+        klass::ZSH_TYPE
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/engine/base.rb

@@ -4,6 +4,7 @@ require 'power_stencil/engine/directory_processor'
 require 'power_stencil/engine/renderers/erb'
 require 'power_stencil/dsl/base'
 require 'power_stencil/dsl/plugin_generation'
+require 'power_stencil/dsl/completion'
 
 module PowerStencil
   module Engine

data/lib/power_stencil/initializer.rb

@@ -46,7 +46,8 @@ module PowerStencil
           shell: PowerStencil::CommandProcessors::Shell,
           plugin: PowerStencil::CommandProcessors::Plugin,
           build: PowerStencil::CommandProcessors::Build,
-          describe: PowerStencil::CommandProcessors::Describe
+          describe: PowerStencil::CommandProcessors::Describe,
+          adm: PowerStencil::CommandProcessors::Adm
       }.each do |command_name, processor|
         command_line_manager.register_processor command_line_manager.command_by_alias(command_name),
                                                 processor.new

data/lib/power_stencil/plugins/command_line.rb

@@ -7,8 +7,8 @@ module PowerStencil
 
 
       def register_processors
+        clm = PowerStencil.command_line_manager
         plugin_definition[:processors].each do |processors_name, processor|
-          clm = PowerStencil.command_line_manager
           processor_class = Object.const_get processor
           clm.register_processor clm.command_by_alias(processors_name), processor_class.new
         end

data/lib/power_stencil/project/base.rb

@@ -6,6 +6,7 @@ require 'power_stencil/project/info'
 require 'power_stencil/project/templates'
 require 'power_stencil/project/plugins'
 require 'power_stencil/project/git'
+require 'power_stencil/project/completion'
 
 require 'power_stencil/engine/project_engine'
 require 'power_stencil/engine/entity_engine'
@@ -32,6 +33,7 @@ module PowerStencil
       include PowerStencil::Project::Plugins
       include PowerStencil::Project::Info
       include PowerStencil::Project::Git
+      include PowerStencil::Project::Completion
       extend PowerStencil::Project::Create
 
       attr_reader :engine, :entity_engine

data/lib/power_stencil/project/completion.rb

@@ -0,0 +1,25 @@
+module PowerStencil
+  module Project
+
+    module Completion
+
+      def query_for_completion(query_type)
+        case query_type
+        when :entities
+          engine.entities(engine.root_universe).map(&:as_path).sort
+        when :'entity-types'
+          engine.available_entity_types.sort
+        when :scenario
+          engine.entities(engine.root_universe, criterion: :by_type, value: :entity_override) do |entity|
+            !entity.scenario.nil? and !entity.scenario.empty?
+          end.map(&:scenario).sort.uniq
+        else
+          raise PowerStencil::Error, "'#{query_type}' is not a valid query type for completion !"
+        end
+      end
+
+    end
+
+  end
+end
+

data/lib/power_stencil/utils/completion.rb

@@ -0,0 +1,29 @@
+module PowerStencil
+  module Utils
+
+    module Completion
+
+      include PowerStencil::Utils::DirectoryProcessor
+
+      def generate_zsh_completion(script_name)
+
+        # Dirty hack
+        config.executable_gem_layer[:file_renaming_patterns] = {'(.+)_power_stencil.sh.erb' => '\1_power_stencil' }
+
+        target_dir = File.expand_path config[:completion_target][:zsh][:completion_dir]
+        source_dir = File.join PowerStencil::Project::Paths.system_templates_templates_path, 'zsh_command_line_completion'
+
+        engine = PowerStencil::Engine::InitEngine.new
+        engine.dsl = PowerStencil::Dsl::Completion
+        engine.dsl.script_name = script_name
+        engine.render_source source_dir, target_dir, overwrite_files: true
+
+        puts_and_logs "zsh auto_completion has been installed in '#{File.join target_dir, "_#{script_name}"}'.", check_verbose: false
+        puts "You should ensure you have something like 'fpath=(#{target_dir} $fpath)' in your ~/.zshrc file..."
+        puts 'You may have to relog for changes to be applied.'
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/slop_extra_option_types.rb

@@ -0,0 +1,40 @@
+module Slop
+
+  # :file, :path, :log_level, :string, :array, :entity_type, :scenario
+
+  class StringOption
+    ZSH_TYPE = :power_stencil_do_nothing
+  end
+
+  class ArrayOption
+    ZSH_TYPE = :power_stencil_do_nothing
+  end
+
+  class LogLevelOption < IntegerOption
+    ZSH_TYPE = :power_stencil_log_level
+  end
+
+  class PathOption < StringOption
+    ZSH_TYPE = :path_files
+  end
+  class FileOption < StringOption
+    ZSH_TYPE = :files
+  end
+
+  class EntityOption < StringOption
+    ZSH_TYPE = :power_stencil_entity
+  end
+
+  class EntityTYpeOption < StringOption
+    ZSH_TYPE = :power_stencil_entity_type
+  end
+
+  class ScenarioOption < StringOption
+    ZSH_TYPE = :power_stencil_scenario
+  end
+
+  class CompletionQueryTypeOption < StringOption
+    ZSH_TYPE = :power_stencil_completion_query_type
+  end
+
+end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.7.4'.freeze
+  VERSION = '0.8.0'.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.30'
+  spec.add_dependency 'climatic', '~> 0.2.32'
   spec.add_dependency 'dir_glob_ignore', '~> 0.3'
   spec.add_dependency 'universe_compiler', '~> 0.5.1'
   spec.add_dependency 'pry'
@@ -50,5 +50,8 @@ If your shell is not completing the command:
 Official Website          : #{spec.homepage}
 Full documentation here   : #{spec.metadata['source_code_uri']}/blob/master/README.md
 Feel free to report issues: #{spec.metadata['source_code_uri']}/issues
+
+Type 'power_stencil adm --zsh-completion' to install auto-completion for zsh.
+
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.8.0
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-31 00:00:00.000000000 Z
+date: 2019-11-02 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.30
+        version: 0.2.32
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.30
+        version: 0.2.32
 - !ruby/object:Gem::Dependency
   name: dir_glob_ignore
   requirement: !ruby/object:Gem::Requirement
@@ -209,8 +209,11 @@ files:
 - etc/templates/project/.ps_project/versioned-config.yaml
 - etc/templates/project/.zzzgitignore.erb
 - etc/templates/simple_exec/main.sh
+- etc/templates/zsh_command_line_completion/.copy_ignore
+- etc/templates/zsh_command_line_completion/_power_stencil.sh.erb
 - exe/power_stencil
 - lib/power_stencil.rb
+- lib/power_stencil/command_processors/adm.rb
 - lib/power_stencil/command_processors/build.rb
 - lib/power_stencil/command_processors/check.rb
 - lib/power_stencil/command_processors/create.rb
@@ -226,6 +229,7 @@ files:
 - lib/power_stencil/command_processors/shell.rb
 - lib/power_stencil/command_processors/trace_helper.rb
 - lib/power_stencil/dsl/base.rb
+- lib/power_stencil/dsl/completion.rb
 - lib/power_stencil/dsl/entities.rb
 - lib/power_stencil/dsl/plugin_generation.rb
 - lib/power_stencil/engine/base.rb
@@ -252,6 +256,7 @@ files:
 - lib/power_stencil/plugins/templates.rb
 - lib/power_stencil/plugins/type.rb
 - lib/power_stencil/project/base.rb
+- lib/power_stencil/project/completion.rb
 - lib/power_stencil/project/config.rb
 - lib/power_stencil/project/create.rb
 - lib/power_stencil/project/git.rb
@@ -273,6 +278,7 @@ files:
 - 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/completion.rb
 - lib/power_stencil/utils/directory_processor.rb
 - lib/power_stencil/utils/file_edit.rb
 - lib/power_stencil/utils/file_helper.rb
@@ -281,6 +287,7 @@ files:
 - lib/power_stencil/utils/os.rb
 - lib/power_stencil/utils/secure_require.rb
 - lib/power_stencil/utils/semantic_version.rb
+- lib/power_stencil/utils/slop_extra_option_types.rb
 - lib/power_stencil/version.rb
 - power_stencil.gemspec
 homepage: https://powerstencil.brizone.org/
@@ -291,11 +298,12 @@ 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.7.4 !\nFrom the command
+post_install_message: "\nThank you for installing PowerStencil 0.8.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  "
+  free to report issues: https://gitlab.com/tools4devops/power_stencil/issues\n\nType
+  'power_stencil adm --zsh-completion' to install auto-completion for zsh.\n\n  "
 rdoc_options: []
 require_paths:
 - lib