power_stencil 0.4.22 → 0.5.0

data/etc/meta_templates/plugin_seed/lib/{entity}/dsl/{entity}_dsl.rb.erb

@@ -0,0 +1,9 @@
+module <%= plugin_module_name %>
+  module Dsl
+
+    module <%= plugin_module_name %>Dsl
+
+    end
+
+  end
+end

data/etc/meta_templates/plugin_seed/lib/{entity}/entity_definitions/{entity}_entity.rb.erb

@@ -5,6 +5,8 @@ module <%= plugin_module_name %>
 
       entity_type :<%= plugin_name %>_entity
 
+      buildable_by :<%= plugin_name %>
+
     end
 
   end

data/etc/meta_templates/plugin_seed/lib/{entity}/{entity}_processor.rb.erb

@@ -8,7 +8,10 @@ module <%= plugin_module_name %>
 
 
     def execute
-      puts '<%= main_entry_point.upcase %> PLUGIN WAZ HERE'
+      hello_message = '<%= main_entry_point.upcase %> PLUGIN WAZ HERE !!'
+      # You have full access to the configuration and command line options within the plugin !
+      hello_message = 'HI, ' + hello_message if config[:hello]
+      puts hello_message
     end
 
 

data/etc/templates/plugin_definition/.travis.yml

@@ -4,4 +4,4 @@ language: ruby
 cache: bundler
 rvm:
   - 2.3.1
-before_install: gem install bundler -v 2.0.2
+before_install: gem install bundler -v 2.0.1

data/etc/templates/plugin_definition/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at lbnetid+gh@gmail.com. All
+reported by contacting the project team at lbnetid+rb@gmail.com. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

data/etc/templates/plugin_definition/etc/command_line.yaml

@@ -9,4 +9,4 @@
     :options:
       hello:
         :type: bool
-        :summary: Just a hello flag.
+        :summary: Just a useless hello flag.

data/etc/templates/plugin_definition/etc/plugin_capabilities.yaml

@@ -0,0 +1,33 @@
+---
+# This file defines the capabilities exposed by the plugin. This file is mandatory
+# for a plugin to be considered as valid.
+
+# Define the main module of the plugin. In this module you can define the build method
+# if the plugin exposes a build (actually a post build hook occurring after the files
+# are "detemplatized")
+:plugin_module: <%= plugin_module_name %>
+
+# In the processors defined in the hereunder hash you map a subcommand with the processor 
+# that will handle it. A plugin can define as many subcommands as needed, or none...
+# Hash keys should match sub-commands declared in the `command_line.yaml` file and processor 
+# classes should expose an `execute` method.
+:processors:
+  <%= plugin_name %>: <%= plugin_module_name %>::Processor
+
+# This is the name of the method called after the files are detemplatized. This method has
+# to be a module method in the `plugin_module` module.
+:build: post_build_hook
+
+# If a dsl module is declared it will be injected in the DSL available in the shell or templates
+:dsl: null
+
+# These are the files (array) defining entity types. These files should not be already 
+# required by the plugin as they will be required by the framework when needed.
+:entity_definitions:
+  - <%= plugin_name %>/entity_definitions/<%= plugin_name %>_entity
+
+# A list of root directories where you can find templates in directories named from the
+# entity types they are attached to. 
+:templates:
+  - etc/templates
+

data/etc/templates/plugin_definition/etc/plugin_config.yaml

@@ -25,4 +25,4 @@
 #  :customizations:
 #    :my_custom_entity:
 #      :shape: circle
-#      :fillcolor: red
+#      :fillcolor: red

data/etc/templates/plugin_definition/etc/templates/{entity}_entity/.copy_ignore

@@ -0,0 +1,2 @@
+.subst_ignore
+.copy_ignore

data/etc/templates/plugin_definition/etc/templates/{entity}_entity/.subst_ignore

@@ -0,0 +1 @@
+**

data/etc/templates/plugin_definition/etc/templates/{entity}_entity/message.txt

@@ -0,0 +1,7 @@
+
+This message has been generated on the <%= erb_insert 'Time.now' %>
+This is an example of what you can do, and how much PowerStencil is customizable ! Check the plugin generated code and
+taylor it to your needs...
+
+This text is the result of a full build process of the entity '<%= erb_insert 'build_target.as_path' %>' by the plugin '<%= erb_insert 'build_target.buildable_by' %>'.
+

data/etc/templates/plugin_definition/lib/{entity}.rb.erb

@@ -1,34 +1,19 @@
 require '<%= plugin_name %>/version'
 require '<%= plugin_name %>/plugin_helper'
 require '<%= plugin_name %>/<%= plugin_name %>_processor'
+require '<%= plugin_name %>/dsl/<%= plugin_name %>_dsl'
 
 module <%= plugin_module_name %>
 
-  extend PowerStencil::Utils::SecureRequire
-  extend <%= plugin_module_name %>::PluginHelper
-
-  REQUIRED_PLUGINS = []
-
-  def self.setup_processors
-    clm = PowerStencil.command_line_manager
-    clm.register_processor clm.command_by_alias('<%= main_entry_point %>'), <%= plugin_module_name %>::Processor.new
-  end
-
-  def self.setup_entity_definitions
-    PowerStencil.logger.info 'Setting up <%= main_entry_point %> plugin entities'
-    securely_require '<%= plugin_name %>/entity_definitions/<%= plugin_name %>_entity', fail_on_error: true
-  end
-
-  def self.setup_plugin_templates
-    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
-        PowerStencil.project.register_template_path_for_type entry.to_sym, template_path
-      end
+  def self.post_build_hook(built_entity, generated_files_path)
+    # This is an example of what you could do after files are generated, ie pretty much anything...
+    case built_entity.type
+    when :<%= plugin_name %>_entity
+      generated_file = File.join generated_files_path, 'message.txt'
+      puts File.readlines(generated_file)
+    else
+      raise PowerStencil::Error, 'Plugin <%= plugin_name %> doesnt know how handle the build of a <%= plugin_name %>_entity entity type !'
     end
   end
 
 end
-
-# All plugins have to be in the PowerStencil::Plugin namespace !
-PowerStencil::Plugin::<%= plugin_module_name %> = <%= plugin_module_name %>

data/etc/templates/plugin_definition/lib/{entity}/dsl/{entity}_dsl.rb.erb

@@ -0,0 +1,9 @@
+module <%= plugin_module_name %>
+  module Dsl
+
+    module <%= plugin_module_name %>Dsl
+
+    end
+
+  end
+end

data/etc/templates/plugin_definition/lib/{entity}/entity_definitions/{entity}_entity.rb.erb

@@ -5,6 +5,8 @@ module <%= plugin_module_name %>
 
       entity_type :<%= plugin_name %>_entity
 
+      buildable_by :<%= plugin_name %>
+
     end
 
   end

data/etc/templates/plugin_definition/lib/{entity}/{entity}_processor.rb.erb

@@ -8,7 +8,10 @@ module <%= plugin_module_name %>
 
 
     def execute
-      puts '<%= main_entry_point.upcase %> PLUGIN WAZ HERE'
+      hello_message = '<%= main_entry_point.upcase %> PLUGIN WAZ HERE !!'
+      # You have full access to the configuration and command line options within the plugin !
+      hello_message = 'HI, ' + hello_message if config[:hello]
+      puts hello_message
     end
 
 

data/lib/power_stencil/command_processors/info.rb

@@ -20,9 +20,6 @@ module PowerStencil
           puts '-' * 80
           puts ' Plugins:'
           project.plugins.each do |plugin_name, plugin|
-            if plugin.has_dependencies?
-              puts " --> Plugin '#{plugin_name}' depends on plugin#{plugin.declared_dependencies.size > 1 ? 's' : ''}: '#{plugin.declared_dependencies.join ', '}'"
-            end
             puts " --> Plugin '#{plugin_name}' has following capabilities:"
             puts(project.plugin_report(plugin_name, plugin).map { |p| '   - %s' % [p] })
           end

data/lib/power_stencil/dsl/plugin_generation.rb

@@ -11,6 +11,15 @@ module PowerStencil
         plugin_name.camelize
       end
 
+      def erb_code(ruby_code_str, skip_line = true)
+        end_char = skip_line ? '-' : ''
+        '%s %s %s%s' % ['<%', ruby_code_str, end_char, '%>']
+      end
+
+      def erb_insert(ruby_code_str)
+        '%s %s %s' % ['<%=', ruby_code_str, '%>']
+      end
+
     end
 
   end

data/lib/power_stencil/engine/build_handling.rb

@@ -36,8 +36,8 @@ module PowerStencil
                                          File.join build_target_path, entity_to_build.as_path.tr('/', '_')
                                        end
 
-            puts_and_logs "De-templating files for '#{entity_to_build.as_path}' into '#{build_entity_target_path}'"
             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}' !"
@@ -96,21 +96,26 @@ module PowerStencil
 
 
       def build_entity(entity_to_build, target_path)
-        logger.info "Building #{entity_to_build.as_path} in '#{target_path}'"
-        render_source entity_to_build.templates_path, target_path, main_entry_point: entity_to_build.as_path
-        logger.info "Detemplatized filed generated in '#{target_path}'"
-        manage_build_links target_path
-        target_plugin_name =  entity_to_build.buildable_by
+        target_plugin_name =  entity_to_build.buildable_by.to_s
+        default_build entity_to_build, target_path
+
         if target_plugin_name.empty?
           post_build_hook entity_to_build, target_path
         else
           target_plugin = project.plugins[target_plugin_name]
           raise PowerStencil::Error, "Could not find plugin '#{target_plugin_name}' !" if target_plugin.nil?
           raise PowerStencil::Error, "Plugin '#{target_plugin_name}' has no build capability !" unless target_plugin.capabilities[:build]
-          target_plugin.plugin_module.send PowerStencil::Plugins::Require::POST_BUILD_HOOK, entity_to_build, target_path
+          target_plugin.post_build_hook entity_to_build, target_path
         end
       end
 
+      def default_build(entity_to_build, target_path)
+        logger.info "Building #{entity_to_build.as_path} in '#{target_path}'"
+        render_source entity_to_build.templates_path, target_path, main_entry_point: entity_to_build.as_path
+        logger.info "Detemplatized filed generated in '#{target_path}'"
+        manage_build_links target_path
+      end
+
       def post_build_hook(entity_to_build, files_path)
         case entity_to_build.type
         when :simple_exec

data/lib/power_stencil/engine/project_engine.rb

@@ -17,6 +17,7 @@ module PowerStencil
         @project = project
         load_system_entities_definition
         load_plugins_entities_definition
+        load_plugins_dsl_definition
         load_project_entities_definition
         load_entities
       end
@@ -32,15 +33,6 @@ module PowerStencil
         end
       end
 
-      def load_plugins_entities_definition
-        project.plugins.each do |plugin_name, plugin|
-          if plugin.capabilities[:entity_definitions]
-            logger.info "Loading entity definitions for plugin '#{plugin_name}'."
-            plugin.plugin_module.send PowerStencil::Plugins::Require::SETUP_ENTITY_DEFINITIONS_CALLBACK
-          end
-        end
-      end
-
       def load_entities
         root_universe.clear
         load_system_entities
@@ -50,6 +42,18 @@ module PowerStencil
 
       private
 
+      def load_plugins_entities_definition
+        project.plugins.each do |_, plugin|
+          plugin.require_plugin_entity_definitions if plugin.capabilities[:entity_definitions]
+        end
+      end
+
+      def load_plugins_dsl_definition
+        project.plugins.each do |_, plugin|
+          plugin.require_plugin_dsl if plugin.capabilities[:dsl]
+        end
+      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|

data/lib/power_stencil/plugins/base.rb

@@ -1,10 +1,13 @@
-require 'power_stencil/plugins/dependencies'
+require 'power_stencil/plugins/type'
 require 'power_stencil/plugins/config'
 require 'power_stencil/plugins/command_line'
+require 'power_stencil/plugins/entity_definitions'
 require 'power_stencil/plugins/templates'
 require 'power_stencil/plugins/require'
 require 'power_stencil/plugins/capabilities'
 require 'power_stencil/plugins/gem'
+require 'power_stencil/plugins/build'
+require 'power_stencil/plugins/dsl'
 
 module PowerStencil
 
@@ -15,19 +18,23 @@ module PowerStencil
       extend PowerStencil::Plugins::Gem
 
       include Climatic::Proxy
-      include PowerStencil::Plugins::Dependencies
+      include PowerStencil::Plugins::Type
       include PowerStencil::Plugins::Config
       include PowerStencil::Plugins::CommandLine
       include PowerStencil::Plugins::Require
       include PowerStencil::Plugins::Capabilities
+      include PowerStencil::Plugins::EntityDefinitions
       include PowerStencil::Plugins::Templates
+      include PowerStencil::Plugins::Build
 
       attr_reader :name, :version, :entry_point_path
 
-      def initialize(name, project)
+      def initialize(name, project, type = :local)
         @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
         logger.debug "Loading plugin '#{name}'..."
         setup_plugin
         logger.info "Plugin '#{name}' successfully available"
@@ -35,7 +42,14 @@ module PowerStencil
       end
 
       def path
-        project.project_plugin_path(name)
+        case type
+        when :local
+          project.project_plugin_path(name)
+        end
+      end
+
+      def plugin_module
+        Object.const_get plugin_definition[:plugin_module]
       end
 
       private
@@ -43,9 +57,10 @@ module PowerStencil
       attr_reader :project
 
       def setup_plugin
-        require_entry_point
+        load_capabilities
         load_plugin_specific_config
         load_yaml_command_definition
+        require_entry_point
       end
 
     end

data/lib/power_stencil/plugins/build.rb

@@ -0,0 +1,17 @@
+module PowerStencil
+  module Plugins
+
+    module Build
+
+      def post_build_hook(*args)
+        build_method_name = plugin_definition[:build]
+        msg = "Plugin '#{self.name}' doesn't contain the '#{build_method_name}' method in the '#{plugin_definition[:plugin_module]}' module. Cannot build !"
+        raise PowerStencil::Error, msg unless plugin_module.respond_to? build_method_name
+        plugin_module.send build_method_name, *args
+      end
+
+    end
+
+  end
+end
+

data/lib/power_stencil/plugins/capabilities.rb

@@ -3,25 +3,34 @@ module PowerStencil
 
     module Capabilities
 
-      DEFAULT_CAPABILITIES = {
-          command_line: false,
-          local_config: false,
-          processors: false,
-          build: false,
-          dsl: false,
-          entity_definitions: false,
-          code: false,
-          version: false,
-          templates: false
-      }.freeze
+      include PowerStencil::Utils::FileHelper
+
+      CAPABILITIES = %i(config command_line processors build dsl entity_definitions templates).freeze
+
+      attr_reader :plugin_definition
+
+      def plugin_capabilities_definition_file
+        project.plugin_capabilities_definition_file self.name
+      end
 
       def capabilities
-        @capabilities ||= DEFAULT_CAPABILITIES.dup
+        @capabilities ||= CAPABILITIES.dup.zip([false] * CAPABILITIES.size).to_h
       end
 
-      def valid?
-        capabilities.keys.each {|cap_name| return true if capabilities[cap_name]}
-        false
+      private
+
+      def load_capabilities
+        yaml_file = plugin_capabilities_definition_file
+        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
+          end
+        end
+
       end
 
     end

data/lib/power_stencil/plugins/command_line.rb

@@ -5,10 +5,22 @@ 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|
+          clm = PowerStencil.command_line_manager
+          processor_class = Object.const_get processor
+          clm.register_processor clm.command_by_alias(processors_name), processor_class.new
+        end
+      end
+
       private
 
       def load_yaml_command_definition
-        yaml_file = project.plugin_commands_line_definition_file name
+        yaml_file = plugin_commands_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