power_stencil 0.8.13 → 0.9.3

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/plugin_definition/psplugin_{entity}.gemspec

@@ -11,6 +11,8 @@ 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.}
+  # For official plugins
+  # spec.homepage      = "https://powerstencil.brizone.org/#plugins"
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
   spec.license       = 'MIT'
 

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,6 +1,7 @@
-require "bundler/setup"
+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,10 +1,30 @@
 RSpec.describe <%= plugin_module_name %> 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
+  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/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/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

@@ -17,8 +17,17 @@ module PowerStencil
             unless config[:property].nil?
               config[:property].each do |property_def|
                 if md = property_def.match(/^\s*(?<prop_name>[^:=]+)\s*[:=]\s*(?<prop_val>.*)\s*$/)
-                  logger.debug "Using extra properties from command line '#{md['prop_name']}' = '#{md['prop_val']}'"
-                  entity_as_hash[md['prop_name'].to_sym] = md['prop_val']
+                  property_value = md['prop_val']
+                  logger.debug "Using extra properties from command line '#{md['prop_name']}' = '#{property_value}'"
+                  if pmd =  property_value.match(/^\s*!entity\s+(?<entity_type>[^\/]+)\/(?<entity_name>.*)\s*$/)
+                    type = pmd['entity_type'].to_sym
+                    name = pmd['entity_name']
+                    referenced_entity = project.engine.entity(type, name)
+                    property_value = referenced_entity.to_reference unless referenced_entity.nil?
+                    puts_and_logs "Could not find entity '#{type.to_s}/#{name}' !", logs_as: :error, check_verbose: false if referenced_entity.nil?
+                  end
+
+                  entity_as_hash[md['prop_name'].to_sym] = property_value
                 else
                   raise PowerStencil::Error, "Invalid command line property definition: '#{property_def}'"
                 end
@@ -35,14 +44,16 @@ module PowerStencil
               new_entity = edit_before_save new_entity
             end
 
+            new_entity.resolve_fields_references!
+
             new_entity.valid? raise_error: true
             project.track_action_with_git("Created '#{new_entity.as_path}' (and potential dependencies).") do
               new_entity.save
             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
@@ -63,7 +74,6 @@ module PowerStencil
           modifications_valid? modified_path, entity
         end
         project.engine.root_universe.replace entity, modified_entity
-        modified_entity.resolve_fields_references!
         modified_entity
       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

data/lib/power_stencil/engine/base.rb

@@ -2,6 +2,7 @@ require 'power_stencil/engine/entities_definitions'
 require 'power_stencil/engine/directory_processor'
 
 require 'power_stencil/engine/renderers/erb'
+require 'power_stencil/engine/renderers/haml'
 require 'power_stencil/dsl/base'
 require 'power_stencil/dsl/plugin_generation'
 require 'power_stencil/dsl/completion'
@@ -18,6 +19,7 @@ module PowerStencil
       include PowerStencil::Engine::DirectoryProcessor
 
       include PowerStencil::Engine::Renderers::Erb
+      include PowerStencil::Engine::Renderers::Haml
 
       attr_accessor :dsl
       attr_reader :root_universe

data/lib/power_stencil/engine/directory_processor.rb

@@ -1,5 +1,7 @@
 require 'fileutils'
 require 'erb'
+require 'haml'
+
 
 module PowerStencil
   module Engine
@@ -30,10 +32,27 @@ module PowerStencil
           end
         end
       ensure
-        @rendering_context = nil
+        @files_not_to_rename = nil
         @files_not_to_render = nil
       end
 
+
+      def render_single_template_file(source_template, destination_file, main_entry_point: nil)
+        compiled_universe = root_universe.compile scenario: config[:scenario]
+        puts_and_logs 'Entities analysis completed.'
+
+        logger.info 'Generating target file...'
+
+        process_file source_template, destination_file,
+                     compiled_universe,
+                     overwrite_files: true,
+                     main_entry_point: main_entry_point
+      ensure
+        @files_not_to_rename = nil
+        @files_not_to_render = nil
+      end
+
+
       private
 
       def detemplatized_file_name(filename, replacement_text)

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/engine/renderers/haml.rb

@@ -0,0 +1,21 @@
+module PowerStencil
+  module Engine
+    module Renderers
+
+      module Haml
+
+        private
+
+        def render_haml_template(source, context)
+          logger.debug "Using HAML to render file '#{source}'"
+          ::Haml::Engine.new(File.read source).render(context)
+        rescue => e
+          logger.debug PowerStencil::Error.report_error(e)
+          raise PowerStencil::Error, "Error rendering '#{source}': '#{e.message}'"
+        end
+
+      end
+
+    end
+  end
+end

data/lib/power_stencil/initializer.rb

@@ -55,14 +55,19 @@ module PowerStencil
           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),
+        command = command_line_manager.command_by_alias(command_name)
+        command_line_manager.register_processor command,
                                                 processor.new
+        command.add_provider self
       end
     end
 
     def setup_climatic(cmd_line_args)
       mngr = Climatic::ConfigLayers::CommandLineLayer.build_command_line_manager base_commands_definition_file
       Climatic.bootstrap cmd_line_args: cmd_line_args, command_manager: mngr
+      mngr.commands.each do |command|
+        command.add_provider PowerStencil
+      end
       begin
         # Fix command line layer priority to allow a bigger number of plugins
         config.command_line_layer.priority = 999

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