power_stencil 0.5.1 → 0.7.0

data/lib/power_stencil/command_processors/edit.rb

@@ -12,8 +12,10 @@ module PowerStencil
       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
+          project.track_action_with_git("Edited entity '#{target.as_path}'.") do
+            securely_edit_file target.source_uri do |modified_path, _|
+              modifications_valid? modified_path, target
+            end
           end
         end
       end

data/lib/power_stencil/command_processors/init.rb

@@ -15,9 +15,9 @@ module PowerStencil
       def execute
         setup_project_path
         log_startup_context
-        puts_and_logs "Creating new project structure in '#{config[:'project-path']}'"
+        puts_and_logs "Creating new project structure in '#{config[:'project-path']}'", check_verbose: false
         PowerStencil::Project::Base.create_project_tree config[:'project-path']
-        puts_and_logs 'Done.'
+        puts_and_logs 'Done.', check_verbose: false
       end
 
       private

data/lib/power_stencil/command_processors/plugin.rb

@@ -8,6 +8,16 @@ module PowerStencil
       include PowerStencil::Project::Proxy
 
       def execute
+
+        if config[:install]
+          config[:project_plugins].each do |plugin_definition|
+            gem_name, gem_req = PowerStencil::Plugins::Base.plugin_definition_to_name_and_req plugin_definition
+            specs = PowerStencil::Plugins::Base.install_gem gem_name, gem_req
+            spec = specs.first
+            puts "Installed plugin '#{spec.name}' (version: #{spec.version})"
+          end
+          return
+        end
         
         if config[:list]
           if project.plugins.empty?
@@ -15,10 +25,10 @@ module PowerStencil
           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}')"
+          project.plugins.each do |_, plugin|
+            puts " - #{plugin.name} (in '#{plugin.plugin_path}')"
             if config[:verbose]
-              plugin_def.capabilities.each do |name, value|
+              plugin.capabilities.each do |name, value|
                 puts "   #{name}: #{value}"
               end
             end
@@ -33,9 +43,13 @@ module PowerStencil
           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}'"
+              target_path = File.join project.project_local_plugin_path(plugin_name)
+              msg = "Generated new local plugin '#{plugin_name}'."
+              project.track_action_with_git(msg) do
+                project.create_new_local_plugin_tree plugin_name, target_path
+                puts_and_logs msg, check_verbose: false
+              end
+
             rescue => e
               msg = "Could not create plugin '#{plugin_name}' because '#{e.message}'"
               puts msg

data/lib/power_stencil/command_processors/root.rb

@@ -18,7 +18,7 @@ module PowerStencil
         unless config.command_line_layer.extra_parameters.empty?
           raise PowerStencil::Error, "Invalid command '#{config.command_line_layer.extra_parameters.first}'"
         end
-        puts_and_logs 'No action specified. Exiting...'
+        puts_and_logs 'No action specified. Exiting...', check_verbose: false
       end
 
     end

data/lib/power_stencil/command_processors/shell.rb

@@ -8,6 +8,7 @@ module PowerStencil
       include Climatic::Proxy
       include PowerStencil::Project::Proxy
 
+
       def execute
 
         working_universe = if config[:compiled]
@@ -25,9 +26,15 @@ module PowerStencil
           puts config[:shell_dsl][:session_greetings]
         end
 
-        Pry.start context,
-                  prompt: [proc { config[:shell_dsl][:prompt_level_1] }, proc { config[:shell_dsl][:prompt_level_2] }],
-                  quiet: true
+        msg = 'Changes done in PowerStencil shell session.'
+        project.track_action_with_git(msg,
+                                      user_validation_required: true,
+                                      validation_message: 'Would you like to commit your changes ?',
+                                      show_files_to_commit: true) do
+          Pry.start context,
+                    prompt: [proc { config[:shell_dsl][:prompt_level_1] }, proc { config[:shell_dsl][:prompt_level_2] }],
+                    quiet: true
+        end
 
       end
 

data/lib/power_stencil/dsl/entities.rb

@@ -31,22 +31,6 @@ module PowerStencil
         PowerStencil.project.engine.entity type, name, @universe
       end
 
-      # Need to implement a `replace` method which would rename files before...
-      # def edit_entity(type, name)
-      #   tmp = Object.new
-      #   tmp.extend PowerStencil::Utils::FileEdit
-      #   org = entity(type, name)
-      #   unless org.nil?
-      #     mod = tmp.securely_edit_entity entity(type, name)
-      #     raise PowerStencil::Error "You cannot "
-      #
-      #
-      #     universe = org.universe
-      #     universe.delete org
-      #     universe.add mod
-      #   end
-      # end
-
       def entities(criterion: nil, value: nil, &filter_block)
         PowerStencil.project.engine.entities @universe, criterion: criterion, value: value, &filter_block
       end

data/lib/power_stencil/engine/build_handling.rb

@@ -39,8 +39,7 @@ module PowerStencil
             build_entity entity_to_build, build_entity_target_path
 
             entity_build_report << 'Ok'
-          rescue => e
-            logger.error "Failed building '#{entity_to_build.as_path}' because '#{e.message}' !"
+          rescue SyntaxError, StandardError => e
             entity_build_report << e.message
             if fail_on_error
               raise e

data/lib/power_stencil/engine/directory_processor.rb

@@ -97,7 +97,12 @@ module PowerStencil
               raise PowerStencil::Error, "File '#{source}' is supposed to be rendered using '#{engine_name}', but seems not to be supported !"
             end
             context = running_context universe, main_entry_point: main_entry_point
-            return send templating_engine_method_name, source, context
+            begin
+              return send templating_engine_method_name, source, context
+            rescue StandardError, SyntaxError => e
+              logger.puts_and_logs "Error rendering #{engine_name} template '#{source}'", logs_as: :error, check_verbose: false
+              raise e
+            end
           end
         end
         logger.warn "File '#{source}' was supposed to be processed but there is no template engine defined ! Applying simple copy."

data/lib/power_stencil/engine/entities_definitions.rb

@@ -7,7 +7,7 @@ module PowerStencil
 
       include PowerStencil::Utils::SecureRequire
 
-      def require_definition_files(files_or_dirs)
+      def require_definition_files(files_or_dirs, source)
         required_files = []
         files_or_dirs.each do |file_or_dir|
           if File.directory? file_or_dir and File.readable? file_or_dir
@@ -21,21 +21,30 @@ module PowerStencil
             next
           end
           # This is a ruby library or there is something wrong
-          securely_require file_or_dir
-          # unless securely_require file_or_dir
-          #   logger.warn "While trying to load definition files, found that '#{file_or_dir}' has a problem. Ignored..."
-          # end
+          securely_require_with_entity_class_detection file_or_dir, source
+
         end
-        required_files.sort!.each {|file| securely_require file, fail_on_error: true}
+        required_files.sort!.each { |file| securely_require_with_entity_class_detection file, source }
         required_files
       end
 
       private
 
       def load_system_entities_definition
-        require_definition_files [SYSTEM_ENTITY_DEFINITION_ENTRY_POINT]
+        require_definition_files [SYSTEM_ENTITY_DEFINITION_ENTRY_POINT], PowerStencil
       end
 
+      def securely_require_with_entity_class_detection(entity_definition_file_path, source)
+        before = PowerStencil::Engine::EntitiesHandling.all_types
+        securely_require entity_definition_file_path, fail_on_error: true
+        after = PowerStencil::Engine::EntitiesHandling.all_types
+        after.reject { |k, _| before.keys.include? k }
+            .each do |_, plugin_entity_class|
+          plugin_entity_class.instance_eval do
+            @entity_type_source_provider = source
+          end
+        end
+      end
     end
 
   end

data/lib/power_stencil/engine/entities_handling.rb

@@ -59,7 +59,7 @@ module PowerStencil
           raise PowerStencil::Error, "Unknown entity type: '#{type}'"
         end
         fields[:name] = fields[:name].to_s
-        res = @available_entities_hash[type.to_sym].new fields: fields, universe: work_universe
+        res = @available_entities_hash[type.to_sym].new fields: fields, universe: work_universe, user: user
         logger.debug "Created new '#{type}': \n#{fields.to_yaml}"
         work_universe.add res
         if work_universe == PowerStencil.project.engine.root_universe

data/lib/power_stencil/engine/project_engine.rb

@@ -36,7 +36,7 @@ module PowerStencil
         if Dir.exist? dir and File.readable? dir
           logger.info 'Loading project specific entity definitions.'
           $LOAD_PATH << dir
-          require_definition_files [dir]
+          require_definition_files [dir], project
         end
       end
 
@@ -62,24 +62,20 @@ module PowerStencil
       end
 
       def load_project_entities
-        logger.debug 'Loading project entities - NOT IMPLEMENTED'
         root_universe.import project.project_entities_path, stop_on_error: false do |new_entity|
-          process_entity new_entity
+          logger.debug "Loaded entity: '#{new_entity.as_path}'"
         end
       end
 
       def load_user_entities
-        logger.debug 'Loading user entities - NOT IMPLEMENTED'
         root_universe.import project.user_entities_path, stop_on_error: false do |new_entity|
-          process_entity new_entity
+          logger.debug "Loaded unversioned entity: '#{new_entity.as_path}'"
+          new_entity.instance_eval do
+            @is_versioned_entity = false
+          end
         end
       end
 
-      def process_entity(entity)
-        logger.debug "New entity: '#{entity.name}' (#{entity.type})"
-      end
-
-
     end
 
   end

data/lib/power_stencil/initializer.rb

@@ -8,17 +8,15 @@ module PowerStencil
 
     include Climatic::Proxy
 
+    def name
+      'PowerStencil core'
+    end
+
     def bootstrap(cmd_line_args = ARGV.dup)
       setup_climatic cmd_line_args
       logger.debug 'Starting PowerStencil initialization...'
       setup_system_processors
       setup_universe_compiler_logger
-      # @project = try_to_load_project fail_on_error: false
-      begin
-        project.setup_templates_for_entities # unless project.nil?
-      rescue => e
-        logger.debug PowerStencil::Error.report_error e
-      end
       logger.debug 'PowerStencil initialization complete'
     end
 
@@ -32,7 +30,6 @@ module PowerStencil
 
     def try_to_load_project(fail_on_error: true)
       PowerStencil::Project::Base.instantiate_from_config config
-
     end
 
     def setup_system_processors

data/lib/power_stencil/plugins/base.rb

@@ -1,3 +1,4 @@
+require 'power_stencil/plugins/paths'
 require 'power_stencil/plugins/type'
 require 'power_stencil/plugins/config'
 require 'power_stencil/plugins/command_line'
@@ -19,6 +20,7 @@ module PowerStencil
 
       include Climatic::Proxy
       include PowerStencil::Plugins::Type
+      include PowerStencil::Plugins::Paths
       include PowerStencil::Plugins::Config
       include PowerStencil::Plugins::CommandLine
       include PowerStencil::Plugins::Require
@@ -28,27 +30,34 @@ module PowerStencil
       include PowerStencil::Plugins::Build
       include PowerStencil::Plugins::Dsl
 
-      attr_reader :name, :version, :entry_point_path
+      attr_reader :name, :version, :entry_point_path, :gem_spec
 
-      def initialize(name, project, type = :local)
+      def initialize(name, project, type: :local, gem_req: nil)
         @name = name
         @project = project
         @version = PowerStencil::Utils::SemanticVersion.new '0.0.0-not-specified'
         raise PowerStencil::Error, "Invalid plugin type (#{type}) for plugin '#{name}'" unless PLUGIN_TYPES.include? type
         @type = type
+        case type
+        when :gem
+          logger.debug "Plugin '#{name}' is provided as a Gem."
+          @gem_spec = PowerStencil::Plugins::Base.find_locally_installed_gem_spec name, gem_req
+          raise PowerStencil::Error, "Cannot find plugin '#{name}'. Try 'power_stencil plugin --install'" if gem_spec.nil?
+          raise PowerStencil::Error, "Invalid plugin '#{name}' ! Missing metadata 'plugin_name' in spec !" if gem_spec.metadata['plugin_name'].nil?
+          logger.debug "Plugin '#{name}' real name is '#{gem_spec.metadata['plugin_name']}'."
+          @name = gem_spec.metadata['plugin_name']
+        when :local
+          logger.debug "Plugin '#{name}' is provided locally by the project."
+        else
+          raise PowerStencil::Error, "Unsupported plugin type (#{type}) for plugin '#{name}' !"
+        end
+
         logger.debug "Loading plugin '#{name}'..."
         setup_plugin
         logger.info "Plugin '#{name}' successfully available"
         logger.debug "Plugin '#{name}' has following capabilities: #{capabilities.inspect}"
       end
 
-      def path
-        case type
-        when :local
-          project.project_plugin_path(name)
-        end
-      end
-
       def plugin_module
         Object.const_get plugin_definition[:plugin_module]
       end

data/lib/power_stencil/plugins/capabilities.rb

@@ -9,10 +9,6 @@ module PowerStencil
 
       attr_reader :plugin_definition
 
-      def plugin_capabilities_definition_file
-        project.plugin_capabilities_definition_file self.name
-      end
-
       def capabilities
         @capabilities ||= CAPABILITIES.dup.zip([false] * CAPABILITIES.size).to_h
       end
@@ -24,11 +20,17 @@ module PowerStencil
         unless File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
           raise PowerStencil::Error, "Plugin '#{self.name}' has no definition file !"
         end
-        @plugin_definition = yaml_file_to_hash yaml_file
-        %i(processors entity_definitions templates build dsl).each do |capability|
-          unless plugin_definition[capability].nil? or plugin_definition[capability].empty?
-            capabilities[capability] = true
+        logger.debug "Loading plugin '#{self.name}' capabilities..."
+        begin
+          @plugin_definition = yaml_file_to_hash yaml_file
+          %i(processors entity_definitions templates build dsl).each do |capability|
+            unless plugin_definition[capability].nil? or plugin_definition[capability].empty?
+              capabilities[capability] = true
+            end
           end
+        rescue => e
+          logger.debug PowerStencil::Error.report_error(e)
+          raise PowerStencil::Error, "Invalid plugin capabilities file '#{yaml_file}' for plugin '#{self.name}'"
         end
 
       end

data/lib/power_stencil/plugins/command_line.rb

@@ -5,9 +5,6 @@ module PowerStencil
 
       attr_reader :plugin_command_line_modifier
 
-      def plugin_commands_line_definition_file
-        project.plugin_commands_line_definition_file self.name
-      end
 
       def register_processors
         plugin_definition[:processors].each do |processors_name, processor|
@@ -20,7 +17,7 @@ module PowerStencil
       private
 
       def load_yaml_command_definition
-        yaml_file = plugin_commands_line_definition_file
+        yaml_file = plugin_command_line_definition_file
         if File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
           logger.info "Adding extra command line definition for '#{name}' plugin..."
           @plugin_command_line_modifier = project.yaml_file_to_hash yaml_file

data/lib/power_stencil/plugins/config.rb

@@ -3,17 +3,13 @@ module PowerStencil
 
     module Config
 
-      def plugin_config_specific_file
-        project.plugin_config_specific_file self.name
-      end
-
       private
 
       def load_plugin_specific_config
         yaml_file = plugin_config_specific_file
         if File.exists? yaml_file and File.file? yaml_file and File.readable? yaml_file
           logger.info "Found plugin specific config in plugin '#{self.name}'. Attempting to load..."
-          project.add_plugin_config self.name
+          project.add_plugin_config self
           capabilities[:config] = true
         end
       rescue => e

data/lib/power_stencil/plugins/entity_definitions.rb

@@ -6,9 +6,24 @@ module PowerStencil
       def require_plugin_entity_definitions
         return unless capabilities[:entity_definitions]
         logger.info "Requiring '#{self.name}' plugin entity definitions..."
+        securely_require_with_entity_class_detection
+      end
+
+
+      private
+
+      def securely_require_with_entity_class_detection
+        before = PowerStencil::Engine::EntitiesHandling.all_types
         plugin_definition[:entity_definitions].each do |entity_definition_file_path|
           securely_require entity_definition_file_path, fail_on_error: true
         end
+        after = PowerStencil::Engine::EntitiesHandling.all_types
+        after.reject { |k, _| before.keys.include? k }.each do |_, plugin_entity_class|
+          plugin = self
+          plugin_entity_class.instance_eval do
+            @entity_type_source_provider = plugin
+          end
+        end
       end
 
     end

data/lib/power_stencil/plugins/gem.rb

@@ -5,50 +5,29 @@ module PowerStencil
 
     module Gem
 
+      include PowerStencil::Utils::GemUtils
+
       NO_DOC = %w(--no-document).freeze
 
-      def gem_locally_installed?(plugin_name, plugin_requirements)
-        get_spec(plugin_name, plugin_requirements).nil? ? false : true
-      end
 
+      def is_available_gem?(gem_name)
 
-      def install_gem(plugin_name, plugin_requirements)
-        cmd = ::Gem::Commands::InstallCommand.new
-        opts = [plugin_name]
-        opts << plugin_requirements unless plugin_requirements.empty?
-        opts.concat NO_DOC
-        cmd.handle_options opts
-        PowerStencil.logger.debug "Installing plugin '#{plugin_name}'..."
-        cmd.execute
-        PowerStencil.logger.debug "Plugin '#{plugin_name}' successfully installed."
-      rescue ::Gem::SystemExitException => e
-        PowerStencil.logger.warn PowerStencil::Error.report_error(e)
       end
 
+      def install_gem(plugin_name, plugin_requirements)
+        ::Gem.install plugin_name, plugin_requirements
+      end
 
 
-      private
-
-      def get_spec(plugin_name, plugin_requirements)
-        candidates = ::Gem::Specification.find_all_by_name plugin_name
-        if candidates.empty?
-          PowerStencil.logger.debug "Could not find required plugin '#{plugin_name}'"
-          return nil
-        end
-
-        req = if plugin_requirements.nil? or plugin_requirements.empty?
-                ::Gem::Requirement::DefaultRequirement
-              else
-                ::Gem::Requirement.create plugin_requirements
-              end
-
-        selected = candidates.select {|candidate| req.satisfied_by? candidate.version}.sort {|a, b| a.version <=> b.version}
-        if candidates.empty?
-          PowerStencil.logger.debug "Could not find required plugin '#{plugin_name}'"
-          return nil
-        end
-        selected.last
 
+      def find_locally_installed_gem_spec(gem_name, gem_requirements = ::Gem::Requirement.default)
+        # Normal method to find gem_spec doesn't work in the context of bundler !!
+        # candidates = ::Gem::Specification.find_all_by_name gem_name
+        candidates = find_gemspec_manually(gem_name)
+                         .select {|candidate| gem_requirements.satisfied_by? candidate.version}
+                         .sort {|a, b| a.version <=> b.version}
+        PowerStencil.logger.error "Could not find required plugin '#{gem_name}'" if candidates.empty?
+        candidates.last
       end
 
     end