power_stencil 0.8.11 → 0.9.1

data/etc/power_stencil.yaml

@@ -72,7 +72,9 @@
 # Map to define which kind of template engine for which type of file. Be careful if you
 # overlap two definitions. Warning, it is ruby Regex not shell pattern !
 :templating_engines_map:
-  # Currently all files are rendered using ERB engine
+  # Haml for .haml files
+  :haml: '\.haml$'
+  # All the rest with ERB
   :erb: '.*'
 
 # Files matching particular patterns can be changed on the fly
@@ -82,6 +84,8 @@
   ^(.+)\.zzzgitignore\.erb$: '\1.gitignore'
   # Erb files
   ^(.+)\.erb$: '\1'
+  # Haml files
+  ^(.+)\.haml$: '\1'
 
 
 # PLUGINS
@@ -110,6 +114,7 @@
 :completion_target:
   :zsh:
     :completion_dir: ~/.zsh/completion
+    :project_completion_filename: .zsh_project_completion
 
 
 

data/etc/templates/plugin_definition/README.md

@@ -1,43 +1,133 @@
-# <%= plugin_module_name %>
+<% gem_name = "psplugin_#{ plugin_name}" -%>
+<%= plugin_title_name %>
+<%= '=' * plugin_title_name.size %>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%= plugin_module_name %>`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![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)
 
-TODO: Delete this and the text above, and describe your gem
+[PowerStencil] is the Swiss-army knife templating workflow for developers and ops.
 
-## Installation
+`<%= plugin_title_name %>` is a [PowerStencil] plugin.
 
-Add this line to your application's Gemfile:
+See [official website][PowerStencil site].
 
-```ruby
-gem '<%= plugin_module_name %>'
+
+<!-- TOC -->
+
+- [What is a PowerStencil plugin ?](#what-is-a-powerstencil-plugin-)
+- [Using this plugin in your `PowerStencil` projects](#using-this-plugin-in-your-powerstencil-projects)
+- [Goal of this plugin](#goal-of-this-plugin)
+- [Plugin dependencies](#plugin-dependencies)
+    - [Standard gems dependencies](#standard-gems-dependencies)
+    - [Dependency to other plugins](#dependency-to-other-plugins)
+- [Plugin capabilities](#plugin-capabilities)
+    - [Config](#config)
+    - [Subcommands and options](#subcommands-and-options)
+    - [Post-build actions](#post-build-actions)
+    - [DSL in templates and in `power_stencil shell`](#dsl-in-templates-and-in-power_stencil-shell)
+    - [Entity types](#entity-types)
+    - [Templates-templates](#templates-templates)
+- [Contributing](#contributing)
+    - [License](#license)
+    - [Code of Conduct](#code-of-conduct)
+
+<!-- /TOC -->
+
+# What is a PowerStencil plugin ?
+
+A `PowerStencil` plugin can be used in the context of a `PowerStencil` project and bring extra features to a standard project.
+
+If you don't know what `PowerStencil` is made for, you may read [the documentation][PowerStencil] first.
+
+Features provided by a plugin can be:
+
+* Extra config.
+* Extra subcommands or options added to the `power_stencil` command-line.
+* Extra post-build actions.
+* Extra DSL methods available in templates and in `power_stencil shell`.
+* Extra entity types.
+* Extra templates-templates.
+
+# Using this plugin in your `PowerStencil` projects
+
+To use this plugin within your `PowerStencil` project, you need to:
+
+* be within a `PowerStencil` project :wink:.
+* declare this plugin in the project configuration (from the root of your project in the `.ps_project/versioned-config.yaml` file).
+
+In this yaml configuration file, you just have to add a new entry in the `:project_plugins` array or simply create it if it is not yet existing:
+
+```yaml
+:project_plugins:
+  - <%= gem_name %>
 ```
+If this plugin is not already present on your machine, you may have to download it:
+
+    $ power_stencil plugin --install
 
-And then execute:
+And then you may see information about the plugin by running:
 
-    $ bundle
+* `power_stencil info` in the plugins section.
+* `power_stencil plugin --list -v`
 
-Or install it yourself as:
+# Goal of this plugin
 
-    $ gem install <%= plugin_module_name %>
+# Plugin dependencies
 
-## Usage
+## Standard gems dependencies
 
-TODO: Write usage instructions here
+Standard dependencies are declared normally in the _gemspec file_. They are automatically installed when installing the plugin with `power_stencil plugin --install`.
 
-## Development
+## Dependency to other plugins
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+For development purpose, dependency to other plugins are declared in the _gemspec file_ as _development dependency_. 
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+But within a project, dependencies have to be added to the `:project_plugins` array in the project configuration file (`.ps_project/versioned-config.yaml`).
 
-## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/<%= plugin_module_name %>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+# Plugin capabilities
+
+This plugin provides the following features:
+
+## Config
+
+## Subcommands and options
+
+## Post-build actions
+
+## DSL in templates and in `power_stencil shell`
+
+## Entity types
+
+## Templates-templates
+
+# Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
 
 ## Code of Conduct
 
-Everyone interacting in the <%= plugin_module_name %> project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/<%= plugin_module_name %>/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PowerStencil project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct].
+
+<!-- End of Document -->
+
+<!-- Pages -->
+[code of conduct]: CODE_OF_CONDUCT.md
+
+<!-- Code links -->
+
+<!-- Illustrations -->
+[simple-flow-image]: doc/images/power-stencil-simple-flow.svg
+
+<!-- External links -->
+[MIT License]: http://opensource.org/licenses/MIT "The MIT license"
+[ERB]: https://ruby-doc.org/stdlib-2.6.3/libdoc/erb/rdoc/ERB.html "Quick ERB description"
+[Haml]: http://haml.info/ "The templating engine for XML-like documents"
+[Ruby]: https://www.ruby-lang.org "The powerful Ruby language"
+[Rails]: https://rubyonrails.org/ "The Ruby on Rails framework"
+[PowerStencil site]: https://powerstencil.brizone.org "Official PowerStencil website"
+[PowerStencil]: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md "PowerStencil documentation"
+[PowerStencil plugins]: https://gitlab.com/tools4devops/power_stencil/blob/master/doc/plugins.md "PowerStencil plugins documentation"

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

@@ -12,13 +12,27 @@ Gem::Specification.new do |spec|
   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"
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # Change this and following metadata if you don't want your plugin to be an "official" PowerStencil plugin.
+  # ie deployed to https://gitlab.com/tools4devops/psplugins
+  source_code_uri = 'https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>'
+
+  # Gem metadata
   if spec.respond_to?(:metadata)
+    # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+    # to allow pushing to a single host or delete this line to allow pushing to any host.
     spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-    # This metadata is mandatory for PowerStencil !!
+
+    # Nice link to your home page on rubygems.org
+    spec.metadata['homepage_uri'] = spec.homepage
+
+    # You have to probably change this if you don't deploy to gitlab
+    spec.metadata['bug_tracker_uri'] = "#{source_code_uri}/issues"
+    spec.metadata['documentation_uri'] = "#{source_code_uri}/blob/master/README.md"
+    spec.metadata['source_code_uri'] = source_code_uri
+
+    # This metadata is mandatory for a PowerStencil plugin !!
     spec.metadata['plugin_name'] = '<%= plugin_name %>'
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes and PowerStencil plugin mechanism !'
@@ -31,8 +45,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'power_stencil', "~> <%= PowerStencil::VERSION %>"
+
 end

data/etc/templates/plugin_definition/spec/project_helper.rb

@@ -0,0 +1,50 @@
+module PowerStencilTests
+
+  module Project
+
+    TEMP_DIR_PREFIX = 'PS_TESTS_'
+
+    module ClassMethods
+
+
+      def temporary_project(project_name, with_git_support: false, scope: :all)
+        self.instance_eval do
+          puts scope
+          around(scope) do |execution|
+            Dir.mktmpdir(TEMP_DIR_PREFIX) do |tests_root_dir|
+              tmp_project_path = File.join tests_root_dir, project_name
+              create_project_including_this_plugin tmp_project_path, with_git_support: with_git_support
+              execution.run
+              @tmp_project_path = nil
+            end
+          end
+        end
+      end
+
+      def plugin_path
+        File.expand_path File.join('..', '..'), __FILE__
+      end
+
+    end
+
+    attr_reader :tmp_project_path
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def create_project_including_this_plugin(project_path, with_git_support: false)
+      cmd = "power_stencil init --project-path '#{project_path}'"
+      cmd << ' --no-git' unless with_git_support
+      `#{cmd}`
+      project_plugin_path = File.join project_path, '.ps_project', 'plugins'
+      `ln -s '#{self.class.plugin_path}' '#{project_plugin_path}'`
+      @tmp_project_path = project_path
+    end
+
+    def temporary_project_cmd(params)
+      "power_stencil #{params} --project-path '#{tmp_project_path}'"
+    end
+
+  end
+end

data/etc/templates/plugin_definition/spec/spec_helper.rb

@@ -1,5 +1,7 @@
-require "bundler/setup"
-require "<%= plugin_module_name %>"
+require 'bundler/setup'
+require 'power_stencil'
+require "<%= plugin_name %>"
+require 'project_helper'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

data/etc/templates/plugin_definition/spec/{entity}_spec.rb

@@ -1,9 +1,30 @@
 RSpec.describe <%= plugin_module_name %> do
-  it "has a version number" do
+
+  include PowerStencilTests::Project
+  temporary_project 'test_project', scope: :all
+
+  let(:plugin_list) { 'plugin --list' }
+  let(:test_entity) { '<%= plugin_name %>_entity/test_<%= plugin_name %>' }
+  let(:create_<%= plugin_name %>) { "create #{test_entity}" }
+  let(:get_<%= plugin_name %>) { "get #{test_entity}" }
+
+  it 'has a version number' do
     expect(<%= plugin_module_name %>::VERSION).not_to be nil
   end
 
-  it "does something useful" do
-    expect(false).to eq(true)
+  it 'should add a "<%= plugin_name %>" sub-command' do
+    expect(`#{temporary_project_cmd plugin_list}`).to match '- <%= plugin_name %>'
+  end
+
+  it 'should be possible to create a "<%= plugin_name %>_entity"' do
+    `#{temporary_project_cmd create_<%= plugin_name %>}`
+    expect($?.success?).to be_truthy
+    expect(`#{temporary_project_cmd get_<%= plugin_name %>}`).not_to be_empty
+  end
+
+  it 'should do something useful' do
+    pending 'Tests implementation'
+    RSpec.fail
   end
+
 end

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

@@ -2,10 +2,10 @@
 
 # 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 %>
+# Generated<%= timestamp %> by <%= script_name %> v<%= PowerStencil::VERSION %>
 
-<% commands = PowerStencil.command_line_manager.commands -%>
-_<%= script_name %>() {
+<% commands = context_commands -%>
+_<%= script_name %>_first_level() {
     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 ' ' %>)
@@ -21,7 +21,7 @@ _<%= script_name %>() {
   	    (( $+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) %>
+<%= continued_multilines(context_options(root_command commands).sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}, number_spaces: 10) %>
   	  fi
     else
 	    _values : \
@@ -33,7 +33,7 @@ _<%= script_name %>() {
 <% 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) %>
+<%= continued_multilines(context_options(root_command).sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}, number_spaces: 8) %>
     fi
 }
 
@@ -46,7 +46,7 @@ _<%= 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 = context_options(command).sort { |a,b| a.name <=> b.name }.map {|o| option_representation o}
 options_lines << command_param unless command_param.empty?
 -%>
 <%= continued_multilines(options_lines) %>
@@ -124,5 +124,15 @@ _power_stencil_do_nothing() {
   return 1
 }
 
-# Let's rock
-_<%= script_name %> "$@"
+
+_<%= script_name %>() {
+  if $( _within_power_stencil_project ); then
+    local project_root=$( _power_stencil_project_root )
+    if [ -f "${project_root}/.ps_project/<%= PowerStencil.config[:completion_target][:zsh][:project_completion_filename] %>" ]; then
+      . "${project_root}/.ps_project/<%= PowerStencil.config[:completion_target][:zsh][:project_completion_filename] %>"
+    fi
+  else
+    . "<%= File.expand_path(File.join PowerStencil.config[:completion_target][:zsh][:completion_dir],  "_#{script_name}") %>"
+  fi
+   _<%= script_name %>_first_level "$@"
+}

data/lib/power_stencil.rb

@@ -5,6 +5,10 @@ require 'dir_glob_ignore'
 
 $DO_NOT_AUTOSTART_CLIMATIC=true
 require 'climatic'
+require 'power_stencil/ultra_command_line/command_line_manager'
+require 'power_stencil/ultra_command_line/providers_manager'
+require 'power_stencil/ultra_command_line/option_definition'
+require 'power_stencil/ultra_command_line/sub_command'
 
 require 'power_stencil/error'
 require 'power_stencil/utils/os'

data/lib/power_stencil/command_processors/adm.rb

@@ -12,7 +12,35 @@ module PowerStencil
       def execute
 
         if config[:'zsh-completion']
-          generate_zsh_completion 'power_stencil'
+          target_dir = File.expand_path config[:completion_target][:zsh][:completion_dir]
+          script_name = 'power_stencil'
+          user_completion_script = File.join target_dir, "_#{script_name}"
+          begin
+            current_dir = Dir.pwd
+            Dir.mktmpdir 'completion_generation' do |tmpdir|
+              Dir.chdir tmpdir
+              generate_zsh_completion script_name, user_completion_script, false
+            end
+          ensure
+            Dir.chdir current_dir
+          end
+
+          begin
+            project
+            shortname_project_completion_script = File.join config[:default_config_directory_name], config[:completion_target][:zsh][:project_completion_filename]
+            project.track_action_with_git("Adding project specific zsh completion file: '#{ shortname_project_completion_script }'.") do
+              project_completion_script = File.join project.project_config_root, config[:completion_target][:zsh][:project_completion_filename]
+              generate_zsh_completion script_name, project_completion_script, true
+              puts_and_logs "A specific completion has been generated for this project in '#{project_completion_script}'.", check_verbose: false
+            end
+          rescue
+            # Do not check errors. This is just to load project config...
+            logger.debug "Outside of a PowerStencil project... Not generating zsh project completion."
+          end
+          puts_and_logs "zsh global auto_completion has been installed in '#{user_completion_script}'.", check_verbose: false
+          puts
+          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.'
           return
         end
 

data/lib/power_stencil/command_processors/create.rb

@@ -41,8 +41,8 @@ module PowerStencil
             end
             puts_and_logs "Generated templates in '#{new_entity.templates_path}'.", check_verbose: false if new_entity.buildable?
           rescue => e
-            puts_and_logs "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'.", logs_as: :error, check_verbose: false
             logger.debug PowerStencil::Error.report_error(e)
+            raise PowerStencil::Error, "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'."
           end
         end
       end

data/lib/power_stencil/dsl/completion.rb

@@ -5,15 +5,52 @@ module PowerStencil
 
       class << self
         attr_accessor :script_name
+        attr_accessor :generating_project_completion
       end
 
       attr_reader :encountered_types
 
+      def timestamp
+        if generating_user_completion?
+          " on the #{Time.now}"
+        else
+          ''
+        end
+      end
+
       def initialize(universe)
         super
         @encountered_types = {}
       end
 
+      def generating_project_completion?
+        self.class.generating_project_completion
+      end
+
+      def generating_user_completion?
+        !self.class.generating_project_completion
+      end
+
+      def context_commands
+        if generating_user_completion?
+          PowerStencil.command_line_manager.commands.select do |command|
+            command.providers.include? PowerStencil
+          end
+        else
+          PowerStencil.command_line_manager.commands
+        end
+      end
+
+      def context_options(command)
+        if generating_user_completion?
+          command.options.select do |option|
+            option.providers.include? PowerStencil
+          end
+        else
+          command.options
+        end
+      end
+
       def script_name
         self.class.script_name
       end