power_stencil 0.5.1 → 0.7.0

data/lib/power_stencil/plugins/paths.rb

@@ -0,0 +1,38 @@
+module PowerStencil
+  module Plugins
+
+    module Paths
+
+      def plugin_path
+        case self.type
+        when :local
+          project.project_local_plugin_path self.name
+        when :gem
+          gem_spec.gem_dir
+        end
+      end
+
+      def plugin_command_line_definition_file
+        File.join plugin_path, 'etc', 'command_line.yaml'
+      end
+
+      def plugin_capabilities_definition_file
+        File.join plugin_path, 'etc', 'plugin_capabilities.yaml'
+      end
+
+      def plugin_config_specific_file
+        File.join plugin_path, 'etc', 'plugin_config.yaml'
+      end
+
+      def plugin_processors_dir
+        File.join plugin_path, 'lib', plugin_name, 'processors'
+      end
+
+      def plugin_entities_definitions_dir
+        File.join plugin_path, 'etc',  plugin_name, 'entities_definitions'
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/plugins/require.rb

@@ -6,7 +6,6 @@ module PowerStencil
       POST_BUILD_HOOK = :post_build_hook
 
       include PowerStencil::Utils::SecureRequire
-      include PowerStencil::Utils::GemUtils
 
       private
 
@@ -15,21 +14,16 @@ module PowerStencil
       end
 
       def require_entry_point
-        if is_available_gem? name
-          logger.debug "Plugin '#{name}' is actually a Ruby Gem."
-          raise "Plugin (#{name}) provided as a Ruby gem is not yet supported !"
-        else
-          @entry_point_path = File.join project.project_plugin_path(name), 'lib', "#{name.underscore}.rb"
-          logger.debug "Plugin '#{name}' is provided locally: '#{entry_point_path}'"
-          plugin_root_path = File.dirname(entry_point_path)
-          begin
-            $LOAD_PATH << plugin_root_path
-            securely_require entry_point_path unless plugin_definition[:plugin_module].nil?
-          rescue LoadError => e
-            logger.warn "As plugin '#{name}' code is invalid, removing '#{plugin_root_path}' from LOAD_PATH"
-            $LOAD_PATH.delete plugin_root_path
-          end
-
+        @entry_point_path = File.join plugin_path, 'lib', "#{name.underscore}.rb"
+        logger.debug "Plugin '#{name}' entry point: '#{entry_point_path}'"
+        plugin_root_path = File.dirname(entry_point_path)
+        begin
+          $LOAD_PATH << plugin_root_path
+          securely_require entry_point_path unless plugin_definition[:plugin_module].nil?
+        rescue LoadError => e
+          @entry_point_path = nil
+          logger.warn "As plugin '#{name}' code is invalid, removing '#{plugin_root_path}' from LOAD_PATH"
+          $LOAD_PATH.delete plugin_root_path
         end
       end
 

data/lib/power_stencil/plugins/templates.rb

@@ -3,15 +3,15 @@ module PowerStencil
 
     module Templates
 
-      def register_plugin_templates
+      def register_plugin_templates_templates
         return unless capabilities[:templates]
         logger.info "Loading '#{self.name}' plugin templates..."
         plugin_definition[:templates].each do |templates_path|
-          plugin_templates_path = File.join self.path, templates_path
+          plugin_templates_path = File.join self.plugin_path, templates_path
           Dir.entries(plugin_templates_path).reject { |e| %w(. ..).include? e }.each do |entry|
             template_path = File.join(plugin_templates_path, entry)
             if Dir.exist? template_path
-              project.register_template_path_for_type entry.to_sym, template_path
+              project.register_template_template_path_for_type entry.to_sym, template_path
             end
           end
         end

data/lib/power_stencil/project/base.rb

@@ -5,6 +5,7 @@ require 'power_stencil/project/versioning'
 require 'power_stencil/project/info'
 require 'power_stencil/project/templates'
 require 'power_stencil/project/plugins'
+require 'power_stencil/project/git'
 
 require 'power_stencil/engine/project_engine'
 require 'power_stencil/engine/entity_engine'
@@ -30,40 +31,54 @@ module PowerStencil
       include PowerStencil::Project::Templates
       include PowerStencil::Project::Plugins
       include PowerStencil::Project::Info
+      include PowerStencil::Project::Git
       extend PowerStencil::Project::Create
 
       attr_reader :engine, :entity_engine
 
+      def name
+        File.dirname project_config_root
+      end
+
       def initialize(search_from_path: Dir.pwd)
         initialize_paths search_from_path
         load_project_specific_config
         check_project_version
         bootstrap_plugins
         build_engines
-        register_system_templates
-        register_project_templates
+        register_system_templates_templates
+        register_plugins_templates_templates
+        register_project_templates_templates
+        setup_git_tracking
       end
 
       private
 
-      def register_project_templates
-        dir = project_templates_path
+      def register_plugins_templates_templates
+        plugins.each do |_, plugin|
+          plugin.register_plugin_templates_templates
+        end
+      end
+
+
+      def register_project_templates_templates
+        dir = project_templates_templates_path
         if Dir.exist? dir and File.readable? dir
           logger.info 'Registering project specific templates.'
           Dir.entries(dir).each do |potential_entity_type|
             next if potential_entity_type.match /^\./
             template_dir = File.join(dir, potential_entity_type)
             next unless File.directory? template_dir
-            register_template_path_for_type potential_entity_type.to_sym, template_dir
+            register_template_template_path_for_type potential_entity_type.to_sym, template_dir
           end
         end
       end
 
-      def register_system_templates
+      def register_system_templates_templates
         logger.debug 'Registering system templates'
         %i(plugin_definition simple_exec).each do |template_name|
-          template_path = template_path template_name
-          register_template_path_for_type template_name, template_path
+          template_path = system_template_template_path template_name
+          register_template_template_path_for_type template_name, template_path
         end
       end
 
@@ -76,4 +91,4 @@ module PowerStencil
     end
 
   end
-end
+end

data/lib/power_stencil/project/config.rb

@@ -21,8 +21,9 @@ module PowerStencil
       end
 
 
-      def add_plugin_config(plugin_name)
-        yaml_file = plugin_config_specific_file plugin_name
+      def add_plugin_config(plugin)
+        plugin_name = plugin.name
+        yaml_file = plugin.plugin_config_specific_file
         priority = if priority.nil?
                      PLUGIN_CONFIG_PRIORITY_MIN
                    else

data/lib/power_stencil/project/create.rb

@@ -5,6 +5,8 @@ module PowerStencil
 
     module Create
 
+      INITIAL_REPOSITORY_COMMIT_MESSAGE = 'Initial commit for project "%s".'
+
       include Climatic::Proxy
 
       def create_project_tree(path, config_directory_name = PowerStencil.config[:default_config_directory_name])
@@ -14,14 +16,33 @@ module PowerStencil
           raise PowerStencil::Error, "The directory '#{path}' already contains a PowerStencil project !" unless config[:force]
         end
         logger.info "Creating project in '#{path}'..."
-        render_project_template_in(path)
+        render_project_template_in path
+        initialize_git_repository path
       end
 
       private
 
+      def initialize_git_repository(repo_path)
+        if config[:'no-git']
+          puts_and_logs 'Do not initialize project git repository as per config request.', logs_as: :debug
+          return
+        end
+        if Dir.exists? File.join(repo_path, '.git')
+          puts_and_logs 'Git repository already exists. Skipping.', logs_as: :debug, check_verbose: false
+          return
+        end
+        puts_and_logs 'Initializing git repository...', logs_as: :debug
+        git = ::Git.init repo_path
+        logger.debug 'Adding all files.'
+        git.add repo_path
+        logger.debug 'Committing initial status'
+        commit_msg = INITIAL_REPOSITORY_COMMIT_MESSAGE % [File.basename(repo_path)]
+        git.commit_all commit_msg
+      end
+
       def render_project_template_in(new_project_config_path)
         engine = PowerStencil::Engine::InitEngine.new
-        engine.render_source PowerStencil::Project::Paths.project_system_template_path, new_project_config_path
+        engine.render_source PowerStencil::Project::Paths.project_system_template_template_path, new_project_config_path
       end
 
     end

data/lib/power_stencil/project/git.rb

@@ -0,0 +1,75 @@
+module PowerStencil
+  module Project
+
+    module Git
+
+      include Climatic::Utils::Input
+
+      def track_action_with_git(action_message,
+                                user_validation_required: false,
+                                validation_message: 'Commit changes ?',
+                                show_files_to_commit: false,
+                                &block)
+        return yield if git.nil?
+
+        status_before_action = git.status
+        yield
+        status_after_action = git.status
+
+        files_introduced_by_action = status_after_action.untracked.reject { |f| status_before_action.untracked.keys.include? f}
+        files_deleted_by_action = status_after_action.deleted.reject { |f| status_before_action.deleted.keys.include? f}
+        files_modified_by_action = status_after_action.changed.reject { |f| status_before_action.changed.keys.include? f}
+        files_to_commit = [files_introduced_by_action, files_deleted_by_action, files_modified_by_action].map(&:keys).flatten.sort.uniq
+
+        if files_to_commit.empty?
+          puts_and_logs 'Nothing to commit.'
+          return
+        end
+
+        if show_files_to_commit
+          header = 'Following file'
+          header << 's' if files_to_commit.count > 1
+          header << ' will be committed:'
+          puts header
+          puts files_to_commit.map { |filename| " - '#{filename}'" }
+        end
+
+        if user_validation_required
+          unless get_user_confirmation(default_choice: 'Yes', prompt: validation_message)
+            puts_and_logs 'Commit cancelled by user.', check_verbose: false
+            return
+          end
+        end
+
+        files_to_commit.each { |filename| git.add filename }
+
+        # Verify files to be committed really are
+        files_really_to_be_committed = git.diff.stats[:files].keys.select { |filename| files_to_commit.include? filename }
+        return if files_really_to_be_committed.empty?
+        files_really_to_be_committed.each { |filename| logger.info "File '#{filename}' will be committed" }
+
+        git.commit action_message
+        puts_and_logs 'All changes introduced have been committed.'
+      end
+
+      private
+
+      attr_reader :git
+
+      def setup_git_tracking
+        @git = nil
+        if config[:'no-git']
+          logger.debug "Won't track any changes with git as per config request!"
+          return
+        end
+        @git = ::Git.open(self.project_root, :log => PowerStencil.logger)
+        logger.debug 'Following project changes with git'
+      rescue => e
+        logger.debug PowerStencil::Error.report_error(e)
+        logger.warn 'This project is not managed by git'
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/project/info.rb

@@ -60,7 +60,20 @@ module PowerStencil
             .sort{ |a,b| a.first <=> b.first }
             .each do |type, klass|
           msg = "Type '#{type}' --> #{klass}"
-          msg << " (template-template path: '#{entity_type_templates[type]}')" unless entity_type_templates[type].nil?
+
+          source_provider = klass.entity_type_source_provider
+          source_provider_display = if source_provider == PowerStencil
+                                      "'#{source_provider.name}'"
+                                    elsif source_provider == self
+                                      "project '#{source_provider.name}'"
+                                    elsif source_provider.is_a? PowerStencil::Plugins::Base
+                                      "plugin '#{source_provider.name}'"
+                                    else
+                                      raise PowerStencil::Error, "Unidentified source provider for #{klass} !"
+                                    end
+
+          msg << " (provided by #{source_provider_display})"
+          msg << " template-template path: '#{entity_type_templates_templates[type]}'" unless entity_type_templates_templates[type].nil?
           report << msg
         end
         report

data/lib/power_stencil/project/paths.rb

@@ -7,12 +7,12 @@ module PowerStencil
 
       attr_reader :project_config_root, :started_from
 
-      def self.system_templates_path
+      def self.system_templates_templates_path
         File.expand_path File.join('..', '..', '..', '..', 'etc', 'templates'), __FILE__
       end
 
-      def self.project_system_template_path
-        File.join system_templates_path, 'project'
+      def self.project_system_template_template_path
+        File.join system_templates_templates_path, 'project'
       end
 
       def build_run_path(seed)
@@ -31,44 +31,40 @@ module PowerStencil
         File.join project_root, PowerStencil.config[:project_build_root_directory_name]
       end
 
-      def template_path(entity_type)
-        File.join PowerStencil::Project::Paths.system_templates_path, entity_type.to_s
+      def system_template_template_path(entity_type)
+        File.join PowerStencil::Project::Paths.system_templates_templates_path, entity_type.to_s
       end
 
-      def project_plugins_path
+      def project_local_plugins_path
         File.join project_config_root, PowerStencil.config[:project_plugins_directory_name]
       end
 
-      def project_templates_path
-        File.join project_config_root, PowerStencil.config[:project_templates_directory_name]
-      end
-
-      def project_entity_definitions_path
-        File.join project_config_root, PowerStencil.config[:project_entity_definitions_directory_name]
+      def project_local_plugin_path(plugin_name)
+        File.join project_local_plugins_path, plugin_name
       end
 
-      def project_plugin_path(plugin_name)
-        File.join project_plugins_path, plugin_name
-      end
-
-      def plugin_capabilities_definition_file(plugin_name)
-        File.join project_plugin_path(plugin_name), 'etc', 'plugin_capabilities.yaml'
+      def project_templates_templates_path
+        File.join project_config_root, PowerStencil.config[:project_templates_directory_name]
       end
 
-      def plugin_commands_line_definition_file(plugin_name)
-        File.join project_plugin_path(plugin_name), 'etc', 'command_line.yaml'
+      def entities_template_path
+        File.join project_root, PowerStencil.config[:versioned_entities_templates_directory_name]
       end
 
-      def plugin_config_specific_file(plugin_name)
-        File.join project_plugin_path(plugin_name), 'etc', 'plugin_config.yaml'
+      def user_entities_template_path
+        File.join project_root, PowerStencil.config[:unversioned_user_entities_templates_directory_name]
       end
 
-      def plugin_processors_dir(plugin_name)
-        File.join project_plugin_path(plugin_name), 'lib', plugin_name, 'processors'
+      def entity_template_path(entity)
+        if entity.is_versioned_entity?
+          File.join entities_template_path, entity.type.to_s, entity.name
+        else
+          File.join user_entities_template_path, entity.type.to_s, entity.name
+        end
       end
 
-      def plugin_entities_definitions_dir(plugin_name)
-        File.join project_plugin_path(plugin_name), 'etc',  plugin_name, 'entities_definitions'
+      def project_entity_definitions_path
+        File.join project_config_root, PowerStencil.config[:project_entity_definitions_directory_name]
       end
 
       def project_entity_path(entity)

data/lib/power_stencil/project/plugins.rb

@@ -7,11 +7,11 @@ module PowerStencil
         @plugins ||= {}
       end
 
-      def create_plugin_tree(plugin_name, new_plugin_path, overwrite_files: false)
+      def create_new_local_plugin_tree(plugin_name, new_plugin_path, overwrite_files: false)
         raise PowerStencil::Error, "Plugin '#{plugin_name}' already exists !" if plugins.keys.include? plugin_name
         raise PowerStencil::Error, "Invalid plugin name '#{plugin_name}'" if (plugin_name.underscore =~ /^[_[:lower:]][_[:alnum:]]*$/).nil?
         entity_engine.dsl = PowerStencil::Dsl::PluginGeneration
-        entity_engine.render_source entity_type_templates[:plugin_definition],
+        entity_engine.render_source entity_type_templates_templates[:plugin_definition],
                                     new_plugin_path,
                                     overwrite_files: overwrite_files,
                                     main_entry_point: plugin_name
@@ -21,6 +21,7 @@ module PowerStencil
       private
 
       def bootstrap_plugins
+        @plugins = {}
         initialize_gem_plugins
         initialize_local_plugins
         command_line_manager.definition_hash_to_commands
@@ -31,45 +32,39 @@ module PowerStencil
         end
       end
 
-
       def initialize_gem_plugins
-        # PowerStencil::logger.warn 'Gem plugins not yet supported ! Skipping...'
         if config[:project_plugins].empty?
-          PowerStencil.logger.info "No gem plugin found in '#{project_plugins_path}'"
+          PowerStencil.logger.info 'No gem plugin found in project'
           return
         end
         config[:project_plugins].each do |plugin_definition|
-          plugin_name, plugin_requirements = case plugin_definition
-                                             when String
-                                               [plugin_definition, '']
-                                             when Hash
-                                               [plugin_definition.keys.first, plugin_definition.values.first]
-                                             end
-          unless PowerStencil::Plugins::Base.gem_locally_installed? plugin_name, plugin_requirements
-            PowerStencil::Plugins::Base.install_gem plugin_name, plugin_requirements
-          end
+
+          (gem_name, gem_req) = PowerStencil::Plugins::Base.plugin_definition_to_name_and_req plugin_definition
+          raise PowerStencil::Error, "Plugin '#{gem_name}' already exists !" unless plugins[gem_name].nil?
+
+          plugins[gem_name] = PowerStencil::Plugins::Base.new(gem_name, self, type: :gem, gem_req: gem_req)
         end
       end
 
       def initialize_local_plugins
-        unless File.directory? project_plugins_path
-          PowerStencil.logger.info "No local plugin found in '#{project_plugins_path}'"
+        unless File.directory? project_local_plugins_path
+          PowerStencil.logger.info "No local plugin found in '#{project_local_plugins_path}'"
           return
         end
 
-        candidates = Dir.entries(project_plugins_path)
-                         .select { |e| File.directory? File.join(project_plugins_path, e) }
-                         .reject { |d| %w(. ..).include? d }
-        @plugins = {}
-        candidates.each do |candidate|
+        Dir.entries(project_local_plugins_path)
+            .select { |e| File.directory? File.join(project_local_plugins_path, e) }
+            .reject { |d| %w(. ..).include? d }
+            .each do |candidate|
           begin
             raise PowerStencil::Error, "Plugin '#{candidate}' already exists !" unless plugins[candidate].nil?
             plugins[candidate] = PowerStencil::Plugins::Base.new(candidate, self)
           rescue PowerStencil::Error => pse
-            PowerStencil.logger.debug pse.message
-            PowerStencil.logger.error "Discarding invalid plugin '#{candidate}'."
+            logger.puts_and_logs pse.message, logs_as: :error
+            logger.puts_and_logs "Discarding invalid plugin '#{candidate}'.", logs_as: :error
           end
         end
+
       end
 
     end