power_stencil 0.4.17 → 0.4.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 090721c55ffc99653d0be5a9b923c45c175cd538
-  data.tar.gz: 80ba7636a39ceed4f6403cef1170206ca33ee8d4
+  metadata.gz: 80af1c57689a2ba89246da59fb373577dd48a31b
+  data.tar.gz: 1c91918d21e15a9730929db9d58309b415c6098d
 SHA512:
-  metadata.gz: 601aa0ba6a72326dc3dab22ecc0304ac26c33046dd0f208c1bd2e045d0767c4624a69027389dc76b2dc154f38eb55750e7229fffcbaee853aa891b77368d2e08
-  data.tar.gz: 87f465b799e7802715383c226e8acd57c4eb0cc50ff336b7666eb22802b876662554b43d0e482a2f0fc84b15f4323e047484dc19543413dd47463024c2bb99d8
+  metadata.gz: f4ee7f37502473381418bc6184c6436f5ab05d159ed819d4bfbd4cc39554130cddd9a2d0742db82db7f7103738d7b7614df3cd1753e0d29a9713fc98608d5999
+  data.tar.gz: bd212747f02e36cc2d3d93f37246152c34ba7552af969757cada09122063ca1633e05b47a549abd9d703bb7bff3e9a8f8bc380f53b767475b0477cc4a745e5e5

data/README.md

@@ -112,7 +112,7 @@ PowerStencil is the Swiss-army knife templating workflow for developers and ops.
 --------------------------------------------------------------------------------
  * init: Initializes a PowerStencil repository ...
  * info: Generic information about the repository ...
- * new-plugin: Generates the skeleton for a plugin ...
+ * plugin: Manipulates plugins ...
  * get: Query entities from repository ...
  * shell: Opens a shell to interact with entities ...
  * check: Check repository entities consistency ...

data/doc/plugins.md

@@ -52,7 +52,7 @@ The normal process would be to begin with a plugin within the project and once y
 The is a command provided for that, that will create a whole plugin skeleton.
 
 ```shell
-$ power_stencil new-plugin myplugin
+$ power_stencil plugin --create myplugin
 Generated new plugin 'myplugin'
 
 $ ll .ps_project/plugins/myplugin
@@ -96,7 +96,35 @@ If you do a `power_stencil info` you see a new part appeared in the report
 ```
 Each of the lines correspond to what is called a _plugin capability_.
 
-Obviously by default the plugin does nothing, but it defined some placeholders. For example in the ouput here above it says `command_line: true`. What could it mean ?
+You can get the same information by issuing:
+
+    $ power_stencil plugin --list
+    
+```
+1 plugin found to be used in this project.
+ - myplugin (in '/tmp/tst project/.ps_project/plugins/myplugin/lib/myplugin.rb')
+```
+
+Or with the capabilities information:
+
+    $ power_stencil plugin --list -v
+
+```
+1 plugin found to be used in this project.
+ - myplugin (in '/tmp/tst project/.ps_project/plugins/myplugin/lib/myplugin.rb')
+   command_line: true
+   local_config: true
+   processors: true
+   build: false
+   dsl: false
+   entity_definitions: true
+   code: true
+   version: true
+   templates: true
+```
+   
+
+Obviously by default the plugin does nothing useful, yet it defined some placeholders. For example in the output here above it says `command_line: true`. What could it mean ?
 
 Let's try to see to help:
 
@@ -122,7 +150,7 @@ PowerStencil is the Swiss-army knife templating workflow for developers and ops.
 --------------------------------------------------------------------------------
  * init: Initializes a PowerStencil repository ...
  * info: Generic information about the repository ...
- * new-plugin: Generates the skeleton for a plugin ...
+ * plugin: Manipulates plugins ...
  * get: Query entities from repository ...
  * shell: Opens a shell to interact with entities ...
  * check: Check repository entities consistency ...

data/etc/base_commands_definition.yml

@@ -93,14 +93,24 @@
         info [options]
 
       Displays information about the repository.
-  new-plugin:
+  plugin:
     :banner: |
-      Generates the skeleton for a plugin.
+      Manipulates plugins.
 
       Usage:
-        new-plugin [options]
+        plugin [options]
 
-      Generates a fully working although useless plugin skeleton.
+      Manipulates plugins.
+    :options:
+      create:
+        :type: bool
+        :summary: Generates a fully working although useless plugin skeleton.
+        :long_aliases:
+          - new
+          - scaffold
+      list:
+        :type: bool
+        :summary: List currently used plugins in this project.
   get:
     :banner: |
       Query entities from repository.

data/etc/power_stencil.yaml

@@ -46,11 +46,11 @@
 :shell_dsl:
   :prompt_level_1: 'PowerStencil DSL> '
   :prompt_level_2: 'PowerStencil DSL --> '
-  :session_greetings: |
+  :session_greetings: |+
     -------------------------------------------------------------------------------
      Welcome to the PowerStencil shell session
      In this shell you have access to anything the templating engine has access to.
-     You can view, edit, save entities.
+     On top of this, you can view, edit, save and delete entities.
 
      - Retrieve and manipulate entities using the `entities` hash.
      - Persist your changes using the `save` method on each entity.
@@ -63,8 +63,6 @@
      Type `exit` to end your session.
     -------------------------------------------------------------------------------
 
-
-
 # TEMPLATING ENGINE
 
 # Map to define which kind of template engine for which type of file. Be careful if you
@@ -75,7 +73,8 @@
 
 # Files matching particular patterns can be changed on the fly
 :file_renaming_patterns:
-  # Specific .gitignore file for Windows
+  # Specific .gitignore hack for `power_stencil init` as .gitignore should be processed
+  # *after* .ps_project
   ^(.+)\.zzzgitignore\.erb$: '\1.gitignore'
   # Erb files
   ^(.+)\.erb$: '\1'

data/etc/templates/project/.ps_project/plugins/README.md

@@ -5,7 +5,7 @@ PowerStencil plugins
 In this directory, you can define project specific local plugins.
 You should create them using the `PowerStencil` command-line.
 
-    $ power_stencil new-plugin myplugin 
+    $ power_stencil plugin --create myplugin 
 
 __It is strongly advised to keep this directory under source control__
 

data/lib/power_stencil.rb

@@ -30,7 +30,7 @@ require 'power_stencil/command_processors/create'
 require 'power_stencil/command_processors/edit'
 require 'power_stencil/command_processors/delete'
 require 'power_stencil/command_processors/shell'
-require 'power_stencil/command_processors/new_plugin'
+require 'power_stencil/command_processors/plugin'
 require 'power_stencil/command_processors/build'
 
 

data/lib/power_stencil/command_processors/plugin.rb

@@ -0,0 +1,56 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Plugin
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+
+      def execute
+        
+        if config[:list]
+          if project.plugins.empty?
+            puts 'No plugin used in this project.'
+          else
+            puts "#{project.plugins.size} plugin#{project.plugins.size == 1 ? '' : 's'} found to be used in this project."
+          end
+          project.plugins.each do |plugin_name, plugin_def|
+            puts " - #{plugin_name} (in '#{plugin_def.entry_point_path}')"
+            if config[:verbose]
+              plugin_def.capabilities.each do |name, value|
+                puts "   #{name}: #{value}"
+              end
+            end
+          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_plugin_path(plugin_name)
+              project.create_plugin_tree plugin_name, target_path
+              puts "Generated new plugin '#{plugin_name}'"
+            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
+          end
+          return
+        end
+
+        raise PowerStencil::Error, 'You should specify an option'
+
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/initializer.rb

@@ -47,7 +47,7 @@ module PowerStencil
           edit: PowerStencil::CommandProcessors::Edit,
           delete: PowerStencil::CommandProcessors::Delete,
           shell: PowerStencil::CommandProcessors::Shell,
-          :'new-plugin' => PowerStencil::CommandProcessors::NewPlugin,
+          plugin: PowerStencil::CommandProcessors::Plugin,
           build: PowerStencil::CommandProcessors::Build
       }.each do |command_name, processor|
         command_line_manager.register_processor command_line_manager.command_by_alias(command_name),

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.4.17'.freeze
+  VERSION = '0.4.18'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.4.17
+  version: 0.4.18
 platform: ruby
 authors:
 - Laurent Briais
@@ -196,7 +196,7 @@ files:
 - lib/power_stencil/command_processors/get.rb
 - lib/power_stencil/command_processors/info.rb
 - lib/power_stencil/command_processors/init.rb
-- lib/power_stencil/command_processors/new_plugin.rb
+- lib/power_stencil/command_processors/plugin.rb
 - lib/power_stencil/command_processors/root.rb
 - lib/power_stencil/command_processors/shell.rb
 - lib/power_stencil/command_processors/trace_helper.rb
@@ -260,7 +260,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.4.17 !\nFrom the
+post_install_message: "\nThank you for installing PowerStencil 0.4.18 !\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   :

data/lib/power_stencil/command_processors/new_plugin.rb

@@ -1,31 +0,0 @@
-module PowerStencil
-  module CommandProcessors
-
-    class NewPlugin
-
-      include Climatic::Script::UnimplementedProcessor
-      include Climatic::Proxy
-      include PowerStencil::Project::Proxy
-
-      def execute
-        if config.command_line_layer.extra_parameters.empty?
-          raise PowerStencil::Error, 'Please specify a plugin name!'
-        end
-        config.command_line_layer.extra_parameters.each do |plugin_name|
-          begin
-            target_path = File.join project.project_plugin_path(plugin_name)
-            project.create_plugin_tree plugin_name, target_path
-            puts "Generated new plugin '#{plugin_name}'"
-          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
-        end
-      end
-
-    end
-
-  end
-end