power_stencil 0.4.12 → 0.4.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f0cd3595adda0996cd964ee0a4a8f7c07ebb27e
-  data.tar.gz: 0b60844a7c8bcae8b410a0a0db76137f80cc04c5
+  metadata.gz: 090721c55ffc99653d0be5a9b923c45c175cd538
+  data.tar.gz: 80ba7636a39ceed4f6403cef1170206ca33ee8d4
 SHA512:
-  metadata.gz: 8de37294748189b813890f137b72bd0f42eb179038ec790a12a4df0c4005c0f498e3fd7b62f40f8bc96a2845a78a0dcf4175d38d1b41f4aa77531dfc3fa92ce2
-  data.tar.gz: a76e25e2d10d5c314a1da7fd3918a9da1bdb9fda88a886c2074736c2d69a30a4f1b534826441e966040ae744f0f3b797a3c32d00edcc8b357ce58cde625111d5
+  metadata.gz: 601aa0ba6a72326dc3dab22ecc0304ac26c33046dd0f208c1bd2e045d0767c4624a69027389dc76b2dc154f38eb55750e7229fffcbaee853aa891b77368d2e08
+  data.tar.gz: 87f465b799e7802715383c226e8acd57c4eb0cc50ff336b7666eb22802b876662554b43d0e482a2f0fc84b15f4323e047484dc19543413dd47463024c2bb99d8

data/README.md

@@ -75,10 +75,12 @@ Then you can install the `PowerStencil` gem by issuing the usual:
 
     $ gem install power_stencil
 
-If you want to create graphviz graphs, you probably may want to install it for your system. If you are using an _apt-based_ system like Ubuntu or Debian it may probably be as simple as:
+If you want to create [Graphviz] graphs, you probably may want to install it for your system. If you are using an _apt-based_ system like Ubuntu or Debian it may probably be as simple as:
 
     $ sudo apt install graphviz
 
+If you use Windows, install [Graphviz] using the stable version for Windows and add the `bin` directory to the `%PATH%`.
+
 # Usage
 
 ## Help
@@ -246,4 +248,5 @@ Everyone interacting in the PowerStencil project’s codebases, issue trackers,
 [Haml]: http://haml.info/ "The templating engine for XML-like documents"
 [Ruby]: https://www.ruby-lang.org "The powerful Ruby language"
 [Rails]: https://rubyonrails.org/ "The Ruby on Rails framework"
-[PowerStencil site]: https://powerstencil.brizone.org "Official PowerStencil website"
+[PowerStencil site]: https://powerstencil.brizone.org "Official PowerStencil website"
+[Graphviz]: https://www.graphviz.org/ "Graph Visualization Software"

data/doc/builds.md

@@ -244,6 +244,8 @@ PowerStencil::SystemEntityDefinitions::ProcessDescriptor:
 ```
 It creates a `process_descriptor` entity (which is referenced from the `simple_exec` entity as the `post_process` field). So you can edit this process descriptor and define there whatever executable you want to be called.
 
+:information_source: If you are using Windows you may want to rename `main.sh` to `main.bat` and edit the `process_descriptor/simple_exec_example.process` to change the process to `main.bat`. 
+
 This should already cover 95% of everything needed.
 
 If you want to do something more custom after the build process completed, this is where you will have to do a [plugin][plugins].

data/doc/entities.md

@@ -984,4 +984,4 @@ Now you know an entity type is just a regular Ruby class. As such you could add
 [Ruby On Rails]: https://rubyonrails.org/ "One of the best Web framework"
 [universe_compiler]: https://gitlab.com/tools4devops/universe_compiler "The underlying engine to manage entities and compilation !"
 [`universe_compiler` advanced relations documentation]: https://gitlab.com/tools4devops/universe_compiler#advanced-relations "Advanced relational features"
-[Graphviz]: (https://www.graphviz.org/) "Graph Visualization Software"
+[Graphviz]: https://www.graphviz.org/ "Graph Visualization Software"

data/doc/faq.md

@@ -65,7 +65,9 @@ So the two main remaining contenders are JSON and YAML. Although there is no rea
 
 As such, even if I never tested, I would expect it to probably work out of the box on MacOS, BSD or other Unices supporting Ruby 2.2+.
 
-Regarding Windows, I stopped using spywareOS years ago so I can't really tell you. Last time I tried using Ruby on Windows (maybe 10 years ago), I did face a lot of dependency issues. Maybe things are better now, but I have no idea. As far as I understood you can now have an Ubuntu running on top of Windows 10 as a kind of blessed VM. I would probably more go this way...
+~~Regarding Windows, I stopped using spywareOS years ago so I can't really tell you. Last time I tried using Ruby on Windows (maybe 10 years ago), I did face a lot of dependency issues. Maybe things are better now, but I have no idea. As far as I understood you can now have an Ubuntu running on top of Windows 10 as a kind of blessed VM. I would probably more go this way...~~
+
+I had the opportunity to have access to a Windows VM and tested `PowerStencil`. I had to fix a couple of issues related to the way Windows manages concurrent access to files (:rofl:) , but **since version `0.4.14`, `PowerStencil` should now fully work under Windows**, including generating files using GraphViz if it is installed and correctly set in the `%PATH%`. I used the standard Ruby for Windows with no hack.
 
 
 # What is the status of `PowerStencil` ?

data/etc/base_commands_definition.yml

@@ -268,4 +268,17 @@
       parallelized:
         :type: bool
         :summary: Parallelizes builds if possible
-
+      tag-build:
+        :type: string
+        :summary: Tags the build with a specific name
+        :long_aliases:
+          - tag
+        :short_aliases:
+          - t
+      target-path:
+        :type: string
+        :summary: Build into specified directory
+        :long_aliases:
+          - path
+        :short_aliases:
+          - p

data/etc/power_stencil.yaml

@@ -33,6 +33,10 @@
 :project_plugins_directory_name: plugins
 # Root directory where builds are generated
 :project_build_root_directory_name: build
+# Last build link name
+:project_build_last_stable_path: last_build
+# Previous build link name
+:project_build_previous_stable_path: previous_build
 
 
 # DSL CUSTOMIZATIONS
@@ -71,6 +75,8 @@
 
 # Files matching particular patterns can be changed on the fly
 :file_renaming_patterns:
+  # Specific .gitignore file for Windows
+  ^(.+)\.zzzgitignore\.erb$: '\1.gitignore'
   # Erb files
   ^(.+)\.erb$: '\1'
 

data/etc/templates/project/.ps_project/plugins/README.md

@@ -0,0 +1,12 @@
+PowerStencil plugins
+====================
+
+
+In this directory, you can define project specific local plugins.
+You should create them using the `PowerStencil` command-line.
+
+    $ power_stencil new-plugin myplugin 
+
+__It is strongly advised to keep this directory under source control__
+
+This should be the PowerStencil default behaviour. 

data/etc/templates/project/.ps_project/templates-templates/README.md

@@ -1,12 +1,10 @@
-PowerStencil project templates
-==============================
+PowerStencil project templates templates
+========================================
 
 
-In this directory, you can define project specific templates for entities
-defined locally in this project. 
+In this directory, you can define project specific templates for entity types defined locally in this project. 
 
-Templates can be a whole tree structure in a directory named from the entity
-type of entities you defined in `entity_definitions` folder that are `buildable`.
+Templates can be a whole tree structure in a directory named from the entity type of entities you defined in `entity_definitions` folder that are `buildable`.
 
 __It is strongly advised to keep this directory under source control__
 

data/etc/templates/simple_exec/main.sh

@@ -2,3 +2,6 @@
 # Generated on the <%= Time.now %>
 
 echo "Nothing to do... Easy task..."
+
+# Return 0 if the build succeeds
+exit 0

data/lib/power_stencil.rb

@@ -7,6 +7,7 @@ $DO_NOT_AUTOSTART_CLIMATIC=true
 require 'climatic'
 
 require 'power_stencil/error'
+require 'power_stencil/utils/os'
 require 'power_stencil/utils/semantic_version'
 require 'power_stencil/utils/file_helper'
 require 'power_stencil/utils/directory_processor'

data/lib/power_stencil/command_processors/build.rb

@@ -25,6 +25,11 @@ module PowerStencil
           raise PowerStencil::Error, 'Please specify something to build'
         end
 
+        if config[:'build-tag']
+          raise PowerStencil::Error, "Invalid tag name '#{config[:'build-tag']}'" if config[:'build-tag'].include? '/'
+          raise PowerStencil::Error, "Cannot tag a build under Windows" if PowerStencil::Utils::Os.windows?
+        end
+
         targets = targets_from_criteria analyse_extra_params, project.engine.root_universe
         raise PowerStencil::Error, 'No valid entity specified' if targets.empty?
         project.engine.build targets, fail_on_error: config[:'fail-on-error'], parallelized: config[:parallelized]

data/lib/power_stencil/engine/build_handling.rb

@@ -26,7 +26,16 @@ module PowerStencil
               entity_build_report << msg
               raise PowerStencil::Error, msg
             end
-            build_entity_target_path = File.join build_target_path, entity_to_build.as_path.tr('/', '_')
+            build_entity_target_path = if config[:'target-path']
+                                         specified_target_path = File.expand_path config[:'target-path']
+                                         if File.exists? specified_target_path
+                                           raise PowerStencil::Error, "Specified target path '#{specified_target_path}' already exists ! Aborting..."
+                                         end
+                                         specified_target_path
+                                       else
+                                         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'
@@ -46,10 +55,51 @@ module PowerStencil
 
       private
 
+      def manage_build_links(last_build_path)
+        if PowerStencil::Utils::Os.windows?
+          logger.info 'Cannot create link to last build folder under Windows !'
+          return
+        end
+        last_build_link_path = project.last_build_stable_link_path
+        previous_build_link_path = project.previous_build_stable_link_path
+        current_last_build_link_target_path = (File.symlink? last_build_link_path) ? File.readlink(last_build_link_path) : nil
+
+        safely_remove_link previous_build_link_path
+        unless current_last_build_link_target_path.nil?
+          File.symlink current_last_build_link_target_path, previous_build_link_path unless File.exists? previous_build_link_path
+        end
+
+        safely_remove_link last_build_link_path
+        File.symlink last_build_path, last_build_link_path unless File.exists? last_build_link_path
+
+        if config[:'tag-build']
+          build_tag_path = File.join project.build_root_path, config[:'tag-build']
+          safely_remove_link build_tag_path
+          File.symlink last_build_path, build_tag_path unless File.exists? build_tag_path
+        end
+      end
+
+
+      def safely_remove_link(link)
+        if File.exists? link
+          if File.symlink? link
+            File.unlink link
+          else
+            logger.warn "Warning '#{link}' is not a symlink !!"
+            return false
+          end
+        else
+          logger.debug "No file/link to delete ('#{link}')"
+        end
+        true
+      end
+
+
       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
         if target_plugin_name.empty?
           post_build_hook entity_to_build, target_path
@@ -67,7 +117,11 @@ module PowerStencil
           script_to_execute = File.expand_path File.join(files_path, entity_to_build.post_process.process)
           exec_options = {message: "Running '#{script_to_execute}'"}
           exec_options[:show_output] = true if config[:verbose]
-          safely_exec_command script_to_execute, exec_options
+          process_report = safely_exec_command "'#{script_to_execute}'", exec_options
+          unless process_report.exit_status.exitstatus == 0
+            raise PowerStencil::Error, "Process `#{process_report.command}` failed and returned exit code '#{process_report.exit_status.exitstatus}'"
+          end
+          process_report
         end
       end
 

data/lib/power_stencil/engine/directory_processor.rb

@@ -59,7 +59,7 @@ module PowerStencil
         unless files_not_to_rename.ignore_file? src_file
           config[:file_renaming_patterns].each do |regexp_str, replacement|
             regexp = Regexp.new regexp_str
-            next if (dest_file =~ regexp).nil?
+            next if (src_file =~ regexp).nil?
             dest_file = dest_file.gsub regexp, replacement
             break
           end

data/lib/power_stencil/project/paths.rb

@@ -19,6 +19,14 @@ module PowerStencil
         File.join build_root_path, timestamped_uniq_dir(seed, Time.now)
       end
 
+      def last_build_stable_link_path
+        File.join build_root_path, PowerStencil.config[:project_build_last_stable_path]
+      end
+
+      def previous_build_stable_link_path
+        File.join build_root_path, PowerStencil.config[:project_build_previous_stable_path]
+      end
+
       def build_root_path
         File.join project_root, PowerStencil.config[:project_build_root_directory_name]
       end

data/lib/power_stencil/utils/directory_processor.rb

@@ -12,7 +12,7 @@ module PowerStencil
         # 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|
+        Dir.glob_with_ignore_file(ignore_files_pattern, source, file_pattern, File::FNM_DOTMATCH).sort.each do |original_file|
           logger.debug "Processing '#{original_file}'"
           res[original_file] = destination_file(original_file, source, destination)
           if block_given?

data/lib/power_stencil/utils/file_edit.rb

@@ -25,14 +25,21 @@ module PowerStencil
       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}", '.yaml']) do |tmpfile|
+        tmpfile = Tempfile.create(["#{entity.type.to_s}_#{entity.name.to_s}", '.yaml'])
+        tmpfile_path = tmpfile.path
+        begin
           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
+        ensure
+          tmpfile.close
         end
+        securely_edit_file(tmpfile_path, &modifications_validation_block)
+        modified_entity = UniverseCompiler::Entity::Persistence.load tmpfile_path
+        modified_entity.source_uri = initial_uri
         return modified_entity
+      ensure
+        tmpfile.close
+        File.unlink tmpfile
       end
 
       def securely_edit_file(file, &modifications_validation_block)
@@ -41,7 +48,9 @@ module PowerStencil
         end
         ext = File.extname file
         base = File.basename file, ext
-        tmp_file_path = Tempfile.new([base, ext]).path
+        tmp_file = Tempfile.create([base, ext])
+        tmp_file_path = tmp_file.path
+        tmp_file.close
         retry_count = 1
         begin
           FileUtils.copy file, tmp_file_path if retry_count == 1

data/lib/power_stencil/utils/os.rb

@@ -0,0 +1,15 @@
+module PowerStencil
+  module Utils
+
+    module Os
+
+      WINDOWS_RUBY_FLAVOURS = %w(mswin32 cygwin mingw bccwin)
+
+      def self.windows?
+        WINDOWS_RUBY_FLAVOURS.include? RbConfig::CONFIG['host_os']
+      end
+
+    end
+
+  end
+end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.4.12'.freeze
+  VERSION = '0.4.17'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.4.17
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2019-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,18 +171,19 @@ files:
 - etc/templates/plugin_definition/spec/spec_helper.rb
 - etc/templates/plugin_definition/spec/{entity}_spec.rb
 - etc/templates/project/.copy_ignore
-- etc/templates/project/.gitignore.erb
 - etc/templates/project/.ps_project/entities/.gitkeep
 - etc/templates/project/.ps_project/entities/README.md
 - etc/templates/project/.ps_project/entity_definitions/.gitkeep
 - etc/templates/project/.ps_project/entity_definitions/README.md
 - etc/templates/project/.ps_project/personal-config.yaml
 - etc/templates/project/.ps_project/plugins/.gitkeep
+- etc/templates/project/.ps_project/plugins/README.md
 - etc/templates/project/.ps_project/templates-templates/.gitkeep
 - etc/templates/project/.ps_project/templates-templates/README.md
 - etc/templates/project/.ps_project/user_entities/.gitkeep
 - etc/templates/project/.ps_project/user_entities/README.md
 - etc/templates/project/.ps_project/versioned-config.yaml
+- etc/templates/project/.zzzgitignore.erb
 - etc/templates/simple_exec/main.sh
 - exe/power_stencil
 - lib/power_stencil.rb
@@ -246,6 +247,7 @@ files:
 - lib/power_stencil/utils/file_helper.rb
 - lib/power_stencil/utils/gem_utils.rb
 - lib/power_stencil/utils/graphviz.rb
+- lib/power_stencil/utils/os.rb
 - lib/power_stencil/utils/secure_require.rb
 - lib/power_stencil/utils/semantic_version.rb
 - lib/power_stencil/version.rb
@@ -258,7 +260,7 @@ metadata:
   documentation_uri: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md
   source_code_uri: https://gitlab.com/tools4devops/power_stencil
   homepage_uri: https://powerstencil.brizone.org/
-post_install_message: "\nThank you for installing PowerStencil 0.4.12 !\nFrom the
+post_install_message: "\nThank you for installing PowerStencil 0.4.17 !\nFrom the
   command line you can run `power_stencil --help`\nIf your shell is not completing
   the command:\n  If you use rbenv: `rbenv rehash`\n  If you use zsh  : `rehash`\n\nOfficial
   Website          : https://powerstencil.brizone.org/\nFull documentation here   :