power_stencil 0.3.0

data/lib/power_stencil/system_entity_definitions/entity_override.rb

@@ -0,0 +1,8 @@
+class UniverseCompiler::Entity::Override
+
+  extend PowerStencil::SystemEntityDefinitions::Buildable
+  include PowerStencil::SystemEntityDefinitions::EntityProjectCommon
+
+  field :description
+
+end

data/lib/power_stencil/system_entity_definitions/entity_project_common.rb

@@ -0,0 +1,33 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    module EntityProjectCommon
+
+      def save(uri = source_uri, force_files_generation: false)
+        super(uri)
+        unless PowerStencil.project.entity_type_templates[type].nil?
+          PowerStencil.project.generate_entity_dir_for_entity self, force: force_files_generation
+        end
+        self
+      end
+
+      def delete(force_files_deletion: false)
+        unless PowerStencil.project.entity_type_templates[type].nil?
+          PowerStencil.project.delete_entity_dir_for_entity self, force: force_files_deletion
+        end
+        super()
+        self
+      end
+
+      def buildable_by
+        self.class.buildable_by
+      end
+
+      def buildable?
+        self.class.buildable?
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/has_associated_files.rb

@@ -0,0 +1,13 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    module HasAssociatedFiles
+
+      def templates_path
+        File.join PowerStencil.project.project_root, type.to_s, name
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/non_persistent.rb

@@ -0,0 +1,14 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    module NonPersistent
+
+      def save(uri = source_uri)
+        PowerStencil.logger.debug "Won't save '#{self.class.to_s}' because defined as non persistent"
+        self
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/plugin.rb

@@ -0,0 +1,17 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    class Plugin < PowerStencil::SystemEntityDefinitions::ProjectEntity
+
+      include PowerStencil::SystemEntityDefinitions::NonPersistent
+
+      DOC = 'A system class not to be used'
+
+      entity_type :plugin_definition
+
+    end
+
+
+  end
+end
+

data/lib/power_stencil/system_entity_definitions/process_descriptor.rb

@@ -0,0 +1,15 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    class ProcessDescriptor < PowerStencil::SystemEntityDefinitions::ProjectEntity
+
+      DOC = 'Generic description of a process'
+
+      entity_type :process_descriptor
+
+      field :process, :not_null
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/project_config.rb

@@ -0,0 +1,24 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    class ProjectConfig < PowerStencil::SystemEntityDefinitions::ProjectEntity
+
+      include PowerStencil::SystemEntityDefinitions::NonPersistent
+
+      DOC = 'A system singleton read-only entity holding runtime PowerStencil configuration'
+
+      entity_type :project_config
+
+      field_reader :simulate, :debug
+
+      def initialize(fields: {}, universe: nil)
+        super
+        self.name = 'Project Config'
+      end
+
+    end
+
+
+  end
+end
+

data/lib/power_stencil/system_entity_definitions/project_entity.rb

@@ -0,0 +1,16 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    class ProjectEntity < UniverseCompiler::Entity::Base
+
+      extend PowerStencil::SystemEntityDefinitions::Buildable
+      include PowerStencil::SystemEntityDefinitions::EntityProjectCommon
+
+      entity_type :base_entity
+
+      field :description
+
+    end
+
+  end
+end

data/lib/power_stencil/system_entity_definitions/simple_exec.rb

@@ -0,0 +1,47 @@
+module PowerStencil
+  module SystemEntityDefinitions
+
+    class SimpleExec < PowerStencil::SystemEntityDefinitions::ProjectEntity
+
+      include PowerStencil::SystemEntityDefinitions::HasAssociatedFiles
+
+      DOC = 'Describes a simple process to be called after source files have been rendered'.freeze
+
+      entity_type :simple_exec
+
+      buildable_by ''
+
+      has_one :process_descriptor, name: :post_process
+      not_null :post_process
+
+      def valid?(raise_error: false)
+        unless super(raise_error: false)
+          if self.post_process.nil?
+            self.post_process = PowerStencil.project.engine.new_entity universe, :process_descriptor, fields: {
+                name: "simple_exec_#{name}.process",
+                process: './main.sh'
+            }
+          end
+        end
+        super(raise_error: raise_error)
+      end
+
+      def save(uri = source_uri, force_files_generation: false)
+        valid?
+        self.post_process.save
+        super(uri, force_files_generation: force_files_generation)
+      end
+
+      def delete(force_files_deletion: false)
+        super
+        if self.post_process.name == "simple_exec_#{name}.process"
+          self.post_process.delete
+        end
+        self
+      end
+
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/directory_processor.rb

@@ -0,0 +1,54 @@
+module PowerStencil
+  module Utils
+
+    module DirectoryProcessor
+
+      def process_directory(source: nil,
+                            destination: nil,
+                            ignore_files_pattern: DirGlobIgnore::IgnoreFileLists::DEFAULT_FILE_NAME)
+        raise PowerStencil::Error, 'Source and destination have to be different' if source == destination
+        source = check_source_dir source
+        destination = check_destination_dir destination
+        # Dir.glob_with_ignore_file ignore_file, base_dir, *glob_args, &block
+        file_pattern = "#{source}/**/*"
+        res = {}
+        Dir.glob_with_ignore_file ignore_files_pattern, source, file_pattern, File::FNM_DOTMATCH do |original_file|
+          logger.debug "Processing '#{original_file}'"
+          res[original_file] = destination_file(original_file, source, destination)
+          if block_given?
+            yield original_file, destination_file(original_file, source, destination)
+          end
+        end
+        res
+      end
+
+      private
+
+      def destination_file(original_file, source, destination)
+        original_file.gsub /^#{source}/, destination
+      end
+
+      def check_source_dir(source)
+        raise PowerStencil::Error, 'Please specify a source directory !' if source.nil?
+        source = File.expand_path source
+        raise PowerStencil::Error, "Source directory '#{source}' does not exist !" unless File.exist? source
+        source
+      end
+
+      def check_destination_dir(destination)
+        raise PowerStencil::Error, 'Please specify a destination directory !' if destination.nil?
+        destination = File.expand_path destination
+        if File.exist? destination
+          raise PowerStencil::Error, "Destination '#{destination}' is not a directory !" unless File.directory? destination
+        end
+        # raise PowerStencil::Error, "Destination '#{destination}' is not a directory !" unless File.directory? destination
+        # raise PowerStencil::Error, "Destination directory '#{destination}' already exists !" if File.exist? destination
+        destination
+
+      end
+
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/file_edit.rb

@@ -0,0 +1,87 @@
+require 'tempfile'
+require 'fileutils'
+
+module PowerStencil
+  module Utils
+
+    module FileEdit
+      
+      include Climatic::Proxy
+
+      EDITOR_ENVIRONMENT_VARIABLE = 'EDITOR'
+      LAST_EDITED_FILE = '/tmp/last-failed-edit.yaml'
+
+      attr_writer :editor, :nb_max_edit_retries
+
+      def editor
+        default = config[:editor] || ENV[EDITOR_ENVIRONMENT_VARIABLE]
+        @editor ||= default
+      end
+
+      def nb_max_edit_retries
+        @nb_max_edit_retries ||= config[:max_file_edit_retry_times]
+      end
+
+      def securely_edit_entity(entity, &modifications_validation_block)
+        initial_uri = entity.source_uri
+        modified_entity = nil
+        Tempfile.create([entity.type.to_s, entity.name.to_s]) do |tmpfile|
+          tmpfile.puts entity.to_yaml
+          tmpfile.flush
+          securely_edit_file(tmpfile, &modifications_validation_block)
+          modified_entity = UniverseCompiler::Entity::Persistence.load tmpfile
+          modified_entity.source_uri = initial_uri
+        end
+        return modified_entity
+      end
+
+      def securely_edit_file(file, &modifications_validation_block)
+        unless File.exists? file and File.writable? file
+          raise PowerStencil::Error, "Cannot edit file '#{file}' !"
+        end
+        ext = File.extname file
+        base = File.basename file, ext
+        tmp_file_path = Tempfile.new([base, ext]).path
+        retry_count = 1
+        begin
+          FileUtils.copy file, tmp_file_path if retry_count == 1
+          edit_file tmp_file_path
+          if block_given?
+            unless modifications_validation_block.call tmp_file_path, file
+              raise PowerStencil::Error, "Your modifications to '#{file}' are invalid !"
+            end
+          end
+          FileUtils.copy tmp_file_path, file
+          logger.info "File '#{file}' updated successfully."
+          file
+        rescue StandardError => e
+          retry_count += 1
+          if retry_count > nb_max_edit_retries
+            logger.error "Your modifications are kept in '#{LAST_EDITED_FILE}' as it was invalid !"
+            begin
+              FileUtils.copy tmp_file_path, LAST_EDITED_FILE
+            rescue => ue
+              logger.error 'Cannot keep your modifications !'
+              logger.debug PowerStencil::Error.report_error(ue)
+            end
+          else
+            retry
+          end
+          raise e
+        ensure
+          File.unlink tmp_file_path
+        end
+      end
+
+      private
+
+      def edit_file(file)
+        raise PowerStencil::Error, 'No editor specified' if editor.nil?
+        logger.debug "Editing file '#{file}', using editor '#{editor}'"
+        system "#{editor} '#{file}'"
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/file_helper.rb

@@ -0,0 +1,56 @@
+module PowerStencil
+  module Utils
+
+    module FileHelper
+
+      def find_recursively_in_path(dir_or_file, from_dir)
+        raise PowerStencil::Error, "Invalid directory '#{from_dir}'" unless Dir.exist?(from_dir) and File.readable?(from_dir)
+
+        candidate = File.join from_dir, dir_or_file
+
+        if Dir.exists? candidate or File.exist? candidate
+          if File.readable? candidate and File.writable? candidate
+            candidate
+          else
+            PowerStencil.logger.warn "Humm, found something: '#{candidate}', but with wrong access rights."
+            nil
+          end
+        else
+          next_dir = File.expand_path '..', from_dir
+          if next_dir == from_dir
+            PowerStencil.logger.info "Didn't find any trace of '#{dir_or_file}'... :("
+            nil
+          else
+            find_recursively_in_path dir_or_file, next_dir
+          end
+        end
+
+      end
+
+      def yaml_file_to_hash(file_name)
+        raw_content = File.read file_name
+        res = YAML.load raw_content
+        if res
+          Hash[res.map { |k, v| [k, v] }]
+        else
+          raise PowerStencil::Error, "Invalid file content for '#{file_name}'" unless raw_content.empty?
+          []
+        end
+      end
+
+      def timestamped_uniq_dir(seed, start_time)
+        uniq_dir = timestamp start_time
+        uniq_dir += "-#{seed}" unless seed.nil?
+        uniq_dir
+      end
+
+      def timestamp(timedate)
+        timedate.strftime '%Y%m%d-%H%M-%S%L'
+      end
+
+
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/gem_utils.rb

@@ -0,0 +1,13 @@
+module PowerStencil
+  module Utils
+
+    module GemUtils
+
+      def is_available_gem?(gem_name)
+        false
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/utils/secure_require.rb

@@ -0,0 +1,26 @@
+module PowerStencil
+  module Utils
+
+    module SecureRequire
+
+      def securely_require(ruby_source_file, fail_on_error: false)
+        PowerStencil.logger.debug "Securely requiring Ruby source file '#{ruby_source_file}'..."
+        require ruby_source_file
+        yield if block_given?
+      rescue => e
+        PowerStencil.logger.debug PowerStencil::Error.report_error(e)
+        msg = "Could not require Ruby source file '#{ruby_source_file}' !"
+        if fail_on_error
+          msg << ' Aborting !'
+          PowerStencil.logger.error msg
+          raise PowerStencil::Error, "Invalid Ruby source file: '#{ruby_source_file}' !"
+        else
+          msg << " (#{e.message})"
+          msg << ' Ignoring...'
+          PowerStencil.logger.warn msg
+        end
+      end
+
+    end
+  end
+end

data/lib/power_stencil/utils/semantic_version.rb

@@ -0,0 +1,128 @@
+module PowerStencil
+  module Utils
+
+    class SemanticVersion
+
+      include Comparable
+
+      MANDATORY_LEVELS = %i(major minor patch).freeze
+      OPTIONAL_LEVEL = :extra
+
+      class << self
+        def valid_version?(version, raise_error: false)
+          new version
+          true
+        rescue => e
+          raise e if raise_error
+          false
+        end
+      end
+
+      def initialize(semantic_version)
+        @version = analyze_semantic_version semantic_version
+      end
+
+      def <=>(other)
+        other_hash = analyze_semantic_version other
+        MANDATORY_LEVELS.each do |level|
+          r = @version[level] <=> other_hash[level]
+          return r unless r == 0
+        end
+        if @version[OPTIONAL_LEVEL].nil? and other_hash[OPTIONAL_LEVEL]
+          return 1
+        end
+        unless @version[OPTIONAL_LEVEL].nil?
+          return -1 if other_hash[OPTIONAL_LEVEL].nil?
+          return @version[OPTIONAL_LEVEL] <=> other_hash[OPTIONAL_LEVEL]
+        end
+        0
+      end
+
+      def increment(level = :patch)
+        raise PowerStencil::Error, "'#{level}' is not a valid level !" unless MANDATORY_LEVELS.include? level
+        h = self.to_hash
+        increment_hash(h, level)
+        self.class.new h
+      end
+      alias :succ :increment
+
+
+      def increment!(level = :patch)
+        raise PowerStencil::Error, "'#{level}' is not a valid level !" unless MANDATORY_LEVELS.include? level
+        increment_hash(@version, level)
+        self
+      end
+      alias :succ! :increment!
+
+      def to_s
+        hash_to_version_string @version
+      end
+
+      def to_hash
+        @version.dup
+      end
+
+      private
+
+      def increment_hash(hash, level)
+        hash[level] = hash[level].succ
+        hash[:patch] = 0 if level == :minor
+        if level == :major
+          hash[:minor] = 0
+          hash[:patch] = 0
+        end
+      end
+
+      def analyze_semantic_version(semantic_version)
+        case semantic_version
+        when String
+          version_string_to_hash semantic_version
+        when SemanticVersion
+          semantic_version.to_hash
+        when Hash
+          MANDATORY_LEVELS.each do |level|
+            raise_analysis_error semantic_version unless semantic_version.keys.include? level
+            raise_analysis_error semantic_version unless semantic_version[level].is_a? Fixnum
+          end
+          semantic_version.dup
+        else
+          raise_analysis_error semantic_version
+        end
+      end
+
+      def raise_analysis_error(obj)
+        raise PowerStencil::Error, "#{obj.class} cannot be used as semantic version !"
+      end
+
+
+      def hash_to_version_string(hash)
+        version_string = MANDATORY_LEVELS.map {|l| hash[l]}.join '.'
+        unless hash[OPTIONAL_LEVEL].nil?
+          version_string << "-#{hash[OPTIONAL_LEVEL]}"
+        end
+        version_string
+      end
+
+      def version_string_to_hash(version_string)
+        res = {}
+        begin
+          version_string.match(/^(?<major>\d+)\.(?<minor>\d+)\.(?<patch>\d+)(?:-(?<extra>.*))*$/) do |md|
+            res = {
+                major: md['major'].to_i,
+                minor: md['minor'].to_i,
+                patch: md['patch'].to_i,
+                extra: md['extra'],
+            }
+            return res
+          end
+          raise
+        rescue
+          raise PowerStencil::Error, "Invalid semantic version '#{version_string}' !"
+        end
+        res
+      end
+
+    end
+
+  end
+end