power_stencil 0.4.10 → 0.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc9c6f2ea647c097f3a6e9c84546369d8de9419e
-  data.tar.gz: ffae8695d6cf182ea47bb990904838e2aaeb44ef
+  metadata.gz: 39ef892e57acf1b138606b8ce494324a76759eac
+  data.tar.gz: 811c9bbb835afa1f137c76d74a5261a01486fd6e
 SHA512:
-  metadata.gz: c8f1c410c06d4be6b1e05bb4c2ac1c523bda13542108e5778db6778bec6a0d6defd5c6dccc31edfa212fb65fb7546607c0d316c9b4df668ec3f381e3e713ae58
-  data.tar.gz: aa1e9c615cedefd8cebefdae156d3594c9e1e008de87a1a1ab864780182dd9851d81f527dc3a0b70855659e1afa75c1cbd2fed9b0f86a6e1441d08f0e373fc74
+  metadata.gz: 8d7d187f50b36b965576bc4dd538bacd401a8b62df1968c9f7cbc13ccfc3e6027c842dcc6e82be8753cd62e093c7d1c28d4e0f87c8247324cfa99d0e45a3aa70
+  data.tar.gz: 091f7d4bf28c89f292e33a78a1176b72678c8464c1dc0e517b6be47b42908fefd9a4fdabeec3af905871acecb72172b8a0a6395d67973ea3588c426c57acab42

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/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/power_stencil.yaml

@@ -71,6 +71,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/engine/build_handling.rb

@@ -67,7 +67,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/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/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.4.10'.freeze
+  VERSION = '0.4.15'.freeze
 end

data/power_stencil.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{PowerStencil is the Swiss-army knife templating workflow for developers and ops.}
   spec.description   = %q{PowerStencil is the Swiss-army knife templating workflow for developers and ops.}
-  spec.homepage      = 'https://gitlab.com/tools4devops/power_stencil'
+  spec.homepage      = 'https://powerstencil.brizone.org/'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -30,10 +30,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'universe_compiler', '~> 0.4.3'
   spec.add_dependency 'pry'
 
+  source_code_uri = 'https://gitlab.com/tools4devops/power_stencil'
+
   spec.metadata = {
-      "bug_tracker_uri"       => "#{spec.homepage}/issues",
-      "documentation_uri"     => "#{spec.homepage}/blob/master/README.md",
-      "official_website_uri"  => "https://powerstencil.brizone.org"
+      'bug_tracker_uri'       => "#{source_code_uri}/issues",
+      'documentation_uri'     => "#{source_code_uri}/blob/master/README.md",
+      'source_code_uri'       => source_code_uri,
+      'homepage_uri'          => spec.homepage
   }
 
   spec.post_install_message = %Q{
@@ -43,7 +46,8 @@ If your shell is not completing the command:
   If you use rbenv: `rbenv rehash`
   If you use zsh  : `rehash`
 
-Full documentation here   : #{spec.homepage}/blob/master/README.md
-Feel free to report issues: #{spec.homepage}/issues
+Official Website          : #{spec.homepage}
+Full documentation here   : #{spec.metadata['source_code_uri']}/blob/master/README.md
+Feel free to report issues: #{spec.metadata['source_code_uri']}/issues
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.4.15
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-28 00:00:00.000000000 Z
+date: 2019-10-03 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
@@ -250,18 +251,20 @@ files:
 - lib/power_stencil/utils/semantic_version.rb
 - lib/power_stencil/version.rb
 - power_stencil.gemspec
-homepage: https://gitlab.com/tools4devops/power_stencil
+homepage: https://powerstencil.brizone.org/
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://gitlab.com/tools4devops/power_stencil/issues
   documentation_uri: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md
-  official_website_uri: https://powerstencil.brizone.org
-post_install_message: "\nThank you for installing PowerStencil 0.4.10 !\nFrom the
+  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.15 !\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\nFull
-  documentation here   : https://gitlab.com/tools4devops/power_stencil/blob/master/README.md\nFeel
-  free to report issues: https://gitlab.com/tools4devops/power_stencil/issues\n  "
+  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   :
+  https://gitlab.com/tools4devops/power_stencil/blob/master/README.md\nFeel free to
+  report issues: https://gitlab.com/tools4devops/power_stencil/issues\n  "
 rdoc_options: []
 require_paths:
 - lib