power_stencil 0.6.3 → 0.7.0

data/doc/templates.md

@@ -27,7 +27,7 @@ The default templating engine being [ERB], your templates should be written usin
 
 Templates are always associated to some [buildable entities][buildable].
 
-When a [buildable entity][buildable] has some templates associated, they will be located in a directory `<entity_type>/<entity_name>/`. For some entity types, when you will create a new entity of this type, some default templates will be created in that directory (this is the case of the `simple_exec` entity type as you will see in the next paragraph). This is what is called `templates-templates`.
+When a [buildable entity][buildable] has some templates associated, they will be initially generated in a directory `templates/<entity_type>/<entity_name>/` (unless they are [unversioned]). For some entity types, when you will create a new entity of this type, some default templates will be created in that directory (this is the case of the `simple_exec` entity type as you will see in the next paragraph) from some kind of "_meta-templates_". This is what is called `templates-templates` in `PowerStencil`.
 
 In this document, you will learn how to create your own templates, as well as your own templates-templates.
 
@@ -37,20 +37,21 @@ In the basic entity types, the only one providing default templates is the `simp
 
 ```shell
 $ power_stencil create simple_exec/demo_templates 
-Created 'simple_exec/demo_templates'
+Creating 'simple_exec/demo_templates'...
+Generated templates in '/tmp/tst3/templates/simple_exec/demo_templates'.
 
 $ power_stencil check simple_exec/demo_templates 
 RAW ENTITIES
  'simple_exec/demo_templates':
   - Storage path   : '/tmp/tst3/.ps_project/entities/simple_exec/demo_templates.yaml'
   - Provided by    : 'PowerStencil core'
-  - Templates path : '/tmp/tst3/simple_exec/demo_templates'
+  - Templates path : '/tmp/tst3/templates/simple_exec/demo_templates'
   - Status         : Valid 
   - Buildable      : true
 ```
 As you can see the output of `power_stencil check` shows more information than entities we created so far. First we see that this entity is `buildable`, and we'll detail that in the [builds] document, but for the moment what we will focus on the `Templates path` information.
 
-And it's true if we have a look in the `simple_exec/demo_templates/` directory from the root of the project, a file appeared there:
+And it's true if we have a look in the `templates/simple_exec/demo_templates/` directory from the root of the project, a file appeared there:
 
 ```shell
 $ ls -l simple_exec/demo_templates
@@ -79,14 +80,14 @@ End of process 15572
 
 What can we see there ? 
 
-The first line is the most interesting one for us. It says "De-templating ... into ...", and it's true that a brand new directory named `build` appeared at the root of the project. Again we won't focus too much on the name of the sub-directory as we will see that in the [builds], but if we have a look in the generated directory we see the same content as what we had in `simple_exec/demo_templates`... 
+The first line is the most interesting one for us. It says "De-templating ... into ...", and it's true that a brand new directory named `build` appeared at the root of the project. Again we won't focus too much on the name of the sub-directory as we will see that in the [builds], but if we have a look in the generated directory we see the same content as what we had in `templates/simple_exec/demo_templates`... 
 And by the way the generated script seems to have been run, as we can see in the output.
 
 :warning: If bash is not installed on your system, the output will obviously be different as `PowerStencil` won't be able to run the script, yet all the files should have been generated correctly.
 
-Ok is it possible, that everything inside `simple_exec/demo_templates` is actually considered as templates ? **The answer is yes !!**
+Ok is it possible, that everything inside `templates/simple_exec/demo_templates` is actually considered as templates ? **The answer is yes !!**
 
-Let prove it and replace the content of `simple_exec/demo_templates/main.sh` by the following:
+Let prove it and replace the content of `templates/simple_exec/demo_templates/main.sh` by the following:
 
 ```shell
 #!/usr/bin/env bash
@@ -123,7 +124,7 @@ echo "It was done in the scope of 'demo_templates' (which is of the type 'simple
 
 The content has been "de-templated"... :+1: sooo cool !
 
-:information_source: Here the template directory of the `simple_exec/demo_templates` was containing only on file (the bash script), but **any file in any sub-directory of that directory would have been considered as a template** (yet there are some mechanism to control and limit which files have to be processed, like for example imagine there would be images, or zip files, probably you don't want them to be processed. All of this will be covered in the [builds] document).
+:information_source: Here the template directory of the `simple_exec/demo_templates` entity was containing only on file (the bash script), but **any file in any sub-directory of that directory would have been considered as a template** (yet there are some mechanism to control and limit which files have to be processed, like for example imagine there would be images, or zip files, probably you don't want them to be processed. All of this will be covered in the [builds] document).
 
 # What can I do within templates ?
 
@@ -176,7 +177,7 @@ This should be self explanatory, there is another part that could be displayed i
 
 # Where do I create templates ?
 
-**When an entity is [buildable] you can find its templates in the `<entity_type>/<entity_name>` from the root of the project.** 
+**When an entity is [buildable] you can find its templates in the `templates/<entity_type>/<entity_name>` from the root of the project.** 
 
 But by default, that directory is not created, and if no templates is created at this place for a [buildable] entity, the build will fail saying it didn't find any template...
 
@@ -189,7 +190,7 @@ $ power_stencil info
     .
     .
     .
- - Type 'simple_exec' --> PowerStencil::SystemEntityDefinitions::SimpleExec (template-template path: '/opt/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/power_stencil-0.2.18/etc/templates/simple_exec')
+ - Type 'simple_exec' --> PowerStencil::SystemEntityDefinitions::SimpleExec (provided by 'PowerStencil core') template-template path: '/opt/rbenv/versions/2.3.1/lib/ruby/gems/2.3.0/gems/power_stencil-0.6.3/etc/templates/simple_exec'
 ```
 
 `simple_exec` is an entity type coming with `PowerStencil`, and you can see that it takes its _template-template_ from within the `PowerStencil` gem itself !
@@ -200,7 +201,7 @@ To summarize about templates and _templates-templates_:
 
 ![entity-creation-flow]
 
-:information_source: There is actually a third place where you could find entity types and _templates-templates_, this is within [plugins], but we will cover that in the [plugins] part...
+:information_source: As you can see, there is actually a third place where you could find entity types and _templates-templates_, this is within [plugins], but we will cover that in the [plugins] part...
 
 # Creating templates-templates of your own
 
@@ -231,20 +232,21 @@ Let's now create an entity of this type:
 
 ```shell
 $ power_stencil create custom_buildable_entity/test1
-Created 'custom_buildable_entity/test1'
+Creating 'custom_buildable_entity/test1'...
+Generated templates in '/tmp/tst3/templates/custom_buildable_entity/test1'.
 
-$ ll custom_buildable_entity/test1 
+$ ll templates/custom_buildable_entity/test1 
 total 12
 drwxrwxr-x 2 laurent laurent 4096 août  26 13:40 ./
 drwxrwxr-x 3 laurent laurent 4096 août  26 13:40 ../
 -rw-rw-r-- 1 laurent laurent   26 août  26 13:40 a_useless_text_file.txt
 ```
-Everything, seems ok. The entity `custom_buildable_entity/test1` has been created and there is now a new folder at the root of the project named `custom_buildable_entity/test1` and which content is a text file named `a_useless_text_file.txt`... So far so good.
+Everything, seems ok. The entity `custom_buildable_entity/test1` has been created and there is now a new folder named `templates/custom_buildable_entity/test1` and which content is a text file named `a_useless_text_file.txt`... So far so good.
 
 And what is the content of this file ?
 
 ```shell
-$ cat custom_buildable_entity/test1/a_useless_text_file.txt
+$ cat templates/custom_buildable_entity/test1/a_useless_text_file.txt
 This text has been generated on the 2019-08-26 13:50:35 +0200
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit,
@@ -309,15 +311,16 @@ Et voilà, let's verify:
 
 ```shell
 $ power_stencil create custom_buildable_entity/test2
-Created 'custom_buildable_entity/test2'
+Creating 'custom_buildable_entity/test2'...
+Generated templates in '/tmp/tst3/templates/custom_buildable_entity/test2'.
 
-$ ls -la custom_buildable_entity/test2 
+$ ls -la templates/custom_buildable_entity/test2 
 total 12
 drwxrwxr-x 2 laurent laurent 4096 août  26 18:37 .
 drwxrwxr-x 4 laurent laurent 4096 août  26 18:37 ..
 -rw-rw-r-- 1 laurent laurent  148 août  26 18:37 a_useless_text_file.txt
 
-$ cat custom_buildable_entity/test2/a_useless_text_file.txt 
+$ cat templates/custom_buildable_entity/test2/a_useless_text_file.txt 
 This text has been generated on the <%= Time.now %>
 
 Lorem ipsum dolor sit amet, consectetur adipiscing elit,
@@ -352,6 +355,7 @@ Flawless victory !!
 [buildable]: entities.md#buildable-and-buildable_by "How to make an entity buildable ?"
 [entity field]: entities.md#field "How to access basic entity data"
 [reverse methods]: entities.md#has_one "Check reverse methods"
+[unversioned]: entities.md#local-unversioned-entities "Unversioned/developer entities"
 <!-- Code links -->
 
 

data/etc/base_commands_definition.yml

@@ -85,6 +85,12 @@
         :summary: Forces creation in an already existing directory.
         :short_aliases:
           - f
+      no-git:
+        :type: bool
+        :summary: Do not initiate a git repo when creating a new project.
+        :long_aliases:
+          - ng
+          - nogit
   info:
     :banner: |
       Generic information about the repository.
@@ -123,6 +129,14 @@
         :incompatibilities:
           - create
           - list
+      no-git:
+        :type: bool
+        :summary: Do not include the newly created plugin into the repository.
+        :long_aliases:
+          - ng
+          - nogit
+        :dependencies:
+          - create
 
   get:
     :banner: |

data/etc/power_stencil.yaml

@@ -23,7 +23,7 @@
 :unversioned_user_project_config_file_name: personal-config.yaml
 # Entity definitions specific to the project
 :project_entity_definitions_directory_name: entity_definitions
-# Templates specific to the project
+# Templates templates specific to the project
 :project_templates_directory_name: templates-templates
 # Directory name where entities are stored
 :project_entities_directory_name: entities
@@ -33,6 +33,10 @@
 :project_plugins_directory_name: plugins
 # Root directory where builds are generated
 :project_build_root_directory_name: build
+# Versioned entities templates directory
+:versioned_entities_templates_directory_name: templates
+# Unversioned entities templates directory
+:unversioned_user_entities_templates_directory_name: unversioned-templates
 # Last build link name
 :project_build_last_stable_path: last_build
 # Previous build link name
@@ -108,4 +112,6 @@
 :log-level: 2
 # Maximum number of retries when editing a file
 :max_file_edit_retry_times: 3
+# Integration with git
+:no-git: false
 

data/etc/templates/project/.zzzgitignore.erb

@@ -1,6 +1,11 @@
 # Ignore power stencil generated files
-<%= File.join '', project_config[:project_build_root_directory_name]  %>
+<%= File.join '', project_config[:project_build_root_directory_name] %>
+
 # Ignore power stencil local entities created by developer
-<%= File.join '', project_config[:default_config_directory_name], project_config[:user_entities_directory_name]  %>
+<%= File.join '', project_config[:default_config_directory_name], project_config[:user_entities_directory_name] %>
+
+# Ignore power stencil local entities templates created by developer
+<%= File.join '', project_config[:unversioned_user_entities_templates_directory_name] %>
+
 # Ignore power stencil local developer's config
-<%= File.join '', project_config[:default_config_directory_name], project_config[:unversioned_user_project_config_file_name]  %>
+<%= File.join '', project_config[:default_config_directory_name], project_config[:unversioned_user_project_config_file_name] %>

data/lib/power_stencil.rb

@@ -1,6 +1,7 @@
 require 'power_stencil/version'
 
 require 'universe_compiler'
+require 'git'
 require 'dir_glob_ignore'
 
 $DO_NOT_AUTOSTART_CLIMATIC=true

data/lib/power_stencil/command_processors/create.rb

@@ -12,7 +12,7 @@ module PowerStencil
       def execute
         analyse_extra_params.each do |search_criterion|
           begin
-            puts_and_logs "Creating new entity '#{search_criterion.as_path}'", check_verbose: false
+            puts_and_logs "Creating new entity '#{search_criterion.as_path}'...", check_verbose: false
             entity_as_hash = {name: search_criterion.name}
             unless config[:property].nil?
               config[:property].each do |property_def|
@@ -36,11 +36,12 @@ module PowerStencil
             end
 
             new_entity.valid? raise_error: true
-            new_entity.save
-
-            puts "Created '#{new_entity.as_path}'"
+            project.track_action_with_git("Created '#{new_entity.as_path}' (and potential dependencies).") do
+              new_entity.save
+            end
+            puts_and_logs "Generated templates in '#{new_entity.templates_path}'.", check_verbose: false if new_entity.buildable?
           rescue => e
-            puts "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'."
+            puts_and_logs "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'.", logs_as: :error, check_verbose: false
             logger.debug PowerStencil::Error.report_error(e)
           end
         end

data/lib/power_stencil/command_processors/delete.rb

@@ -9,24 +9,32 @@ module PowerStencil
       include PowerStencil::CommandProcessors::EntityHelper
 
       def execute
-        analyse_extra_params.each do |search_criterion|
+        targets = targets_from_criteria analyse_extra_params, project.engine.root_universe
+        targets.each do |target|
           begin
-            unless project.engine.entity *search_criterion.to_a, project.engine.root_universe
-              puts_and_logs "Skipping '#{search_criterion.as_path}'. Entity not found.", check_verbose: false
-              next
-            end
-            puts_and_logs "Deleting entity '#{search_criterion.as_path}'", check_verbose: false
-            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_and_logs msg, check_verbose: false
-            else
-              puts_and_logs 'Cancelled by user input.', check_verbose: false
+            # unless project.engine.entity *target.to_a, project.engine.root_universe
+            #   puts_and_logs "Skipping '#{target.as_path}'. Entity not found.", check_verbose: false
+            #   next
+            # end
+            puts_and_logs "Deleting entity '#{target.as_path}'", check_verbose: false
+
+            msg = "Deleted entity '#{target.as_path}' (and potential dependencies)"
+            msg << ' including templates.' if config[:'delete-files']
+            msg << '.'
+            project.track_action_with_git(msg) do
+              if project.engine.delete_entity project.engine.root_universe,
+                                              target.type,
+                                              target.name,
+                                              delete_files: config[:'delete-files']
+                msg = "Deleted '#{target.as_path}'"
+                msg << ' and template files.' if config[:'delete-files']
+                puts_and_logs msg, check_verbose: false
+              else
+                puts_and_logs 'Cancelled by user input.', check_verbose: false
+              end
             end
           rescue => e
-            puts_and_logs "Failed to delete '#{search_criterion.as_path}' with message '#{e.message}'.", logs_as: :error, check_verbose: false
+            puts_and_logs "Failed to delete '#{target.as_path}' with message '#{e.message}'.", logs_as: :error, check_verbose: false
             logger.debug PowerStencil::Error.report_error(e)
           end
         end

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/plugin.rb

@@ -44,8 +44,12 @@ module PowerStencil
           config.command_line_layer.extra_parameters.each do |plugin_name|
             begin
               target_path = File.join project.project_local_plugin_path(plugin_name)
-              project.create_new_local_plugin_tree plugin_name, target_path
-              puts "Generated new plugin '#{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/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/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

@@ -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/plugins/templates.rb

@@ -3,7 +3,7 @@ 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|
@@ -11,7 +11,7 @@ module PowerStencil
           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,6 +31,7 @@ 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
@@ -44,38 +46,39 @@ module PowerStencil
         check_project_version
         bootstrap_plugins
         build_engines
-        register_system_templates
-        register_plugins_templates
-        register_project_templates
+        register_system_templates_templates
+        register_plugins_templates_templates
+        register_project_templates_templates
+        setup_git_tracking
       end
 
       private
 
-      def register_plugins_templates
+      def register_plugins_templates_templates
         plugins.each do |_, plugin|
-          plugin.register_plugin_templates
+          plugin.register_plugin_templates_templates
         end
       end
 
 
-      def register_project_templates
-        dir = project_templates_path
+      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
 
@@ -88,4 +91,4 @@ module PowerStencil
     end
 
   end
-end
+end