power_stencil 0.3.1

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

@@ -0,0 +1,13 @@
+PowerStencil project templates
+==============================
+
+
+In this directory, you can define project specific templates for entities
+defined locally in this project. 
+
+Templates can be a whole tree structure in a directory named from the entity
+type of entities you defined in `entity_definitions` folder that are `buildable`.
+
+__It is strongly advised to keep this directory under source control__
+
+This should be the PowerStencil default behaviour. 

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

@@ -0,0 +1,12 @@
+PowerStencil user entities
+==========================
+
+
+In this directory, you will find all project entities locally defined by 
+the user (overrides but also entities not meant to be versioned)
+
+They are organized as `<entity_type>/<entity_name>.yaml`
+
+__It is strongly advised NOT to keep this directory under source control__
+
+This should be the default PowerStencil behaviour. 

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

@@ -0,0 +1,6 @@
+# This file has been generated on the <%= Time.now %> by the power stencil framework (v: <%= PowerStencil::VERSION %>)
+# THIS FILE *IS* MEANT TO BE VERSIONED (and is by default)
+# You can use it for any configuration you want to keep at repository level
+
+# If you want to ensure a minimal version number of PowerStencil
+:min_power_stencil_version: <%= PowerStencil::VERSION %>

data/etc/templates/simple_exec/main.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+# Generated on the <%= Time.now %>
+
+echo "Nothing to do... Easy task..."

data/exe/power_stencil

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'power_stencil'
+require 'climatic/script/base'
+
+PowerStencil.bootstrap
+
+module PowerStencil
+  class Script
+
+    include Climatic::Script::Base
+    include Climatic::Proxy
+
+    private
+
+    def display_help_and_exit
+      puts config.command_line_help
+      exit 0
+    end
+
+  end
+end
+
+PowerStencil::Script.start
+
+
+

data/lib/power_stencil.rb

@@ -0,0 +1,53 @@
+require 'power_stencil/version'
+
+require 'universe_compiler'
+require 'dir_glob_ignore'
+
+$DO_NOT_AUTOSTART_CLIMATIC=true
+require 'climatic'
+
+require 'power_stencil/error'
+require 'power_stencil/utils/semantic_version'
+require 'power_stencil/utils/file_helper'
+require 'power_stencil/utils/directory_processor'
+require 'power_stencil/utils/secure_require'
+require 'power_stencil/utils/gem_utils'
+require 'power_stencil/utils/file_edit'
+
+require 'climatic/script/unimplemented_processor'
+require 'power_stencil/project/proxy'
+
+require 'power_stencil/command_processors/trace_helper'
+require 'power_stencil/command_processors/entity_helper'
+require 'power_stencil/command_processors/root'
+require 'power_stencil/command_processors/init'
+require 'power_stencil/command_processors/info'
+require 'power_stencil/command_processors/get'
+require 'power_stencil/command_processors/check'
+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/build'
+
+
+module PowerStencil
+
+  # Module for plugins
+  module Plugin; end
+
+end
+
+require 'power_stencil/engine/base'
+require 'power_stencil/plugins/base'
+require 'power_stencil/project/base'
+
+require 'power_stencil/initializer'
+
+
+module PowerStencil
+
+  extend PowerStencil::Initializer
+
+end

data/lib/power_stencil/command_processors/build.rb

@@ -0,0 +1,43 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Build
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::CommandProcessors::EntityHelper
+
+
+
+      def execute
+        if config.command_line_layer.extra_parameters.empty?
+          raise PowerStencil::Error, 'Please specify something to build'
+        end
+
+        if config[:'supported-builds']
+          project.engine.available_entities_hash.select do |_, klass|
+            klass.respond_to?(:buildable?) and klass.buildable?
+          end .each do |entity_type, _|
+            puts " - '#{entity_type}'"
+          end
+          return
+        end
+
+        targets = targets_from_criteria analyse_extra_params, project.engine.root_universe
+        raise PowerStencil::Error, 'No valid entity specified' if targets.empty?
+        project.engine.build targets, fail_on_error: config[:'fail-on-error'], parallelized: config[:parallelized]
+        project.engine.last_build_report.each do |entity_full_name, entity_report|
+          if entity_report == ['Ok']
+            puts " - '#{entity_full_name}' has been correctly built"
+          else
+            puts " - Failed to build '#{entity_full_name}' because ", entity_report
+          end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/command_processors/check.rb

@@ -0,0 +1,35 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Check
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::CommandProcessors::EntityHelper
+
+      def execute
+        puts 'RAW ENTITIES'
+        targets = targets_from_criteria analyse_extra_params, project.engine.root_universe
+        targets.sort {|a,b| a.as_path <=> b.as_path }
+            .map do |entity|
+          entity_info = [" '#{entity.as_path}':"]
+          entity_info << "  - Storage path   : '#{entity.source_uri}'"
+          entity_info << "  - Templates path : '#{entity.templates_path}'" if entity.respond_to? :templates_path
+          entity_info << "  - Status         : #{entity.valid? ? 'Valid' : 'INVALID !'} "
+          entity_info << "  - Buildable      : #{entity.buildable?}"
+          entity_info
+        end .each { |l| puts l }
+
+
+        #
+        # targets.map do |entity|
+        #   " - '#{entity.as_path}': '#{entity.source_uri}'"
+        # end .sort.each { |l| puts l }
+      end
+
+
+    end
+
+  end
+end

data/lib/power_stencil/command_processors/create.rb

@@ -0,0 +1,70 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Create
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::CommandProcessors::EntityHelper
+      include PowerStencil::Utils::FileEdit
+
+      def execute
+        analyse_extra_params.each do |search_criterion|
+          begin
+            puts_and_logs "Creating new entity '#{search_criterion.as_path}'"
+            entity_as_hash = {name: search_criterion.name}
+            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']
+                else
+                  raise PowerStencil::Error, "Invalid command line property definition: '#{property_def}'"
+                end
+              end
+            end
+
+            new_entity = project.engine.new_entity project.engine.root_universe,
+                                                   search_criterion.type,
+                                                   fields: entity_as_hash,
+                                                   user: config[:user]
+
+            if config[:edit]
+              logger.debug "Edit mode for entity #{new_entity.to_composite_key} in #{new_entity.source_uri}"
+              new_entity = edit_before_save new_entity
+            end
+
+            new_entity.valid? raise_error: true
+            new_entity.save
+
+            puts "Created '#{new_entity.as_path}'"
+          rescue => e
+            puts "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'."
+            logger.debug PowerStencil::Error.report_error(e)
+          end
+        end
+      end
+
+      private
+
+      def modifications_valid?(modified_path, original_entity)
+        test_entity = UniverseCompiler::Entity::Persistence.load modified_path
+        test_entity.valid?
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.debug "Modifications applied to '#{original_entity.as_path}' are invalid !"
+        false
+      end
+
+      def edit_before_save(entity)
+        securely_edit_entity entity do |modified_path, _|
+          modifications_valid? modified_path, entity
+        end
+      end
+
+
+    end
+
+  end
+end

data/lib/power_stencil/command_processors/delete.rb

@@ -0,0 +1,38 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Delete
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::CommandProcessors::EntityHelper
+
+      def execute
+        analyse_extra_params.each do |search_criterion|
+          begin
+            unless project.engine.entity *search_criterion.to_a, project.engine.root_universe
+              puts "Skipping '#{search_criterion.as_path}'. Entity not found."
+              next
+            end
+            puts_and_logs "Deleting entity '#{search_criterion.as_path}'"
+            if project.engine.delete_entity project.engine.root_universe,
+                                            *search_criterion.to_a,
+                                            delete_files: config[:'delete-files']
+              msg = "Deleted '#{search_criterion.as_path}'"
+              msg << ' and associated files.' if config[:'delete-files']
+              puts msg
+            else
+              puts 'Cancelled by user input.'
+            end
+          rescue => e
+            puts "Failed to delete '#{search_criterion.as_path}' with message '#{e.message}'."
+            logger.debug PowerStencil::Error.report_error(e)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/command_processors/edit.rb

@@ -0,0 +1,35 @@
+module PowerStencil
+  module CommandProcessors
+
+    class Edit
+
+      include Climatic::Script::UnimplementedProcessor
+      include Climatic::Proxy
+      include PowerStencil::Project::Proxy
+      include PowerStencil::CommandProcessors::EntityHelper
+      include PowerStencil::Utils::FileEdit
+
+      def execute
+        targets = targets_from_criteria analyse_extra_params, project.engine.root_universe
+        targets.each do |target|
+          securely_edit_file target.source_uri do |modified_path, _|
+            modifications_valid? modified_path, target
+          end
+        end
+      end
+
+      private
+
+      def modifications_valid?(modified_path, original_entity)
+        test_entity = UniverseCompiler::Entity::Persistence.load modified_path
+        test_entity.valid?
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.debug "Modifications applied to '#{original_entity.as_path}' are invalid !"
+        false
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/command_processors/entity_helper.rb

@@ -0,0 +1,105 @@
+module PowerStencil
+  module CommandProcessors
+
+    module EntityHelper
+
+      EntitySearchReference = Struct.new(:type, :name) do
+        def as_path
+          [type, name].map(&:to_s).join '/'
+        end
+      end
+
+      def display_entity(entity)
+        puts_and_logs "# Entity '#{entity.name}' (#{entity.type})"
+        if config[:'names-only']
+          puts "- #{entity.name}"
+        else
+          if config[:raw]
+            puts entity.to_yaml
+          else
+            puts entity.to_hash.to_yaml
+          end
+        end
+      end
+
+      def targets_from_criteria(search_criteria, universe)
+        target_universe = if config[:compiled]
+                            universe.compile scenario: config[:scenario]
+                          else
+                            universe
+                          end
+
+        if config[:regexp]
+          target_universe.get_entities do |entity|
+            id = entity.as_path
+            keep = false
+            search_criteria.each do |criterion|
+              if md = id.match(/#{criterion}/i)
+                keep = true
+                break
+              end
+            end
+            keep
+          end
+        else
+          search_criteria.inject([]) do |res, criterion|
+            res.concat target_universe.get_entities(criterion: :by_uniq_key, value: criterion.to_a)
+          end
+        end
+      end
+
+      def extra_params_to_entity_search_criteria(params)
+        criteria = []
+        next_entity_reference = EntitySearchReference.new
+        stack = params.dup
+        if config[:regexp]
+          criteria = stack
+        else
+          stack.each do |param|
+            if md = param.match(/^\s*(?<type>[^\/]+)\/(?<name>.+)\s*$/)
+              next_entity_reference.type = md[:type].to_sym
+              next_entity_reference.name = md[:name]
+            else
+              if next_entity_reference.type.nil? or next_entity_reference.type.empty?
+                next_entity_reference.type =  param.to_sym
+              else
+                next_entity_reference.name = param
+              end
+            end
+
+            next unless reference_complete? next_entity_reference
+            logger.debug "Found entity search pattern in params: #{next_entity_reference.inspect}"
+            criteria << next_entity_reference
+            next_entity_reference = EntitySearchReference.new
+          end
+          unless next_entity_reference.type.nil?
+            raise PowerStencil::Error, "Invalid parameter '#{next_entity_reference.type}' !"
+          end
+        end
+
+        criteria
+      end
+
+      private
+
+
+      def analyse_extra_params(extra_params = config.command_line_layer.extra_parameters, default: [''])
+        params_to_check = if extra_params.empty? then
+                            config[:regexp] = true
+                            default
+                          else
+                            extra_params
+                          end
+        extra_params_to_entity_search_criteria params_to_check
+      end
+
+      def reference_complete?(reference)
+        return false if (reference.type.nil? or reference.name.nil?)
+        return false if (reference.type.empty? or reference.name.empty?)
+        true
+      end
+
+    end
+
+  end
+end