power_stencil 0.9.7 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ab7d833b0c353a7f1a1d1cd240bd89b7e1d6920
-  data.tar.gz: 61a22b0e88f7fe4072f241619174a231407e52e5
+SHA256:
+  metadata.gz: fc4f20ce02555b3700fc39255dea0343e85964afebe0b3658be510294252b5f3
+  data.tar.gz: 18cbb67c91884f9d18ed2570c763e6f883ce1553fa7cd5ae02af2955288b471f
 SHA512:
-  metadata.gz: 5754fd517225f6b0f17100e9129a7eb55b1be226cffeec5f69b4f16fbc26755d7911137d7cfef9d7a408d12cd0aceff13bcda261e707a622574b853e41f8c8a8
-  data.tar.gz: 26ffefc937dd522b7c8834f31d4d2a06fc3800e6576a4f5512878396956ddf49f25723bad7ea24ab0458b75493554ec1a711a4e58bc9ba2dc9d394d3c3a647ee
+  metadata.gz: de64a256d395c0dc7501da6e62b469d78b5f96e798c32b2801ddefce232df93745874c4d6614af46d4727150a0ffaab589c94a7ff033ae1f215ff745d770771e
+  data.tar.gz: 073ef7a1c0043972b3d1ca9358926bac0ee871e1a42147e709989d138860d9207fa9a2f09603f4aca295fb0c77ce32a5b0dca8ec698769af861f11ed27bb3311

data/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: "ruby:2.3"
+image: "ruby:3.1"
 
 before_script:
   - gem install bundler --no-document

data/README.md

@@ -72,14 +72,14 @@ So `PowerStencil` is definitely not a templating engine, it is actually much mor
 
 # Installation
 
-You need a working install of the [Ruby] language (>= 2.3).
+You need a working install of the [Ruby] language (>= 2.3). You should have `bundler` installed (`gem install bundler`). This is not added as an automatic dependency as updating `bundler` may not be what you want. Yet any working install of Ruby should consider having `bundler` installed.
+
+:hand: It is **strongly** advised to have `git` installed on your system, as `PowerStencil` is integrated with `git` to provide a better user experience.
 
 Then you can install the `PowerStencil` gem by issuing the usual:
 
     $ gem install power_stencil
 
-:hand: It is **strongly** advised to have `git` installed on your system, as `PowerStencil` is integrated with `git` to provide a better user experience.
-
 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
@@ -205,7 +205,7 @@ It provides a very useful auto-completion for sub-commands, options as well as o
 
 * Project independent completion is generated in `~/.zsh/completion/_power_stencil`, whereas completion related to new commands or options, coming from plugins used in a project, is generated (and versioned) within the project itself, in `.ps_project/.zsh_project_completion`.
 
-* Meaning that if you want to benefit from the "_full_" completion from within a project you may have to re-run `power_stencil add --zsh-completion` from within any project where you use extra plugins, in order to generate that `.ps_project/.zsh_project_completion` file. If you don't, it is not a big deal, but then you will only have access to the "_generic_" completion, ie completion not taking in account any of the extra commands or options you are using in this project brought by plugins you may use...
+* Meaning that if you want to benefit from the "_full_" completion from within a project (ie including extra command line options brought by the project itself), you may have to re-run `power_stencil add --zsh-completion` from within any project where you use extra plugins, in order to (re)generate the `.ps_project/.zsh_project_completion` file. If you don't, it is not a big deal, but then you will only have access to the "_generic_" completion, ie completion not taking in account any of the extra commands or options you are using in this project brought by plugins you may use...
 
 ### Entities
 

data/doc/plugins.md

@@ -12,6 +12,7 @@ Plugins
 - [Creating plugin local to the project](#creating-plugin-local-to-the-project)
     - [Plugin creation](#plugin-creation)
     - [Adding new subcommands to `PowerStencil`](#adding-new-subcommands-to-powerstencil)
+    - [Updating zsh auto-completion](#updating-zsh-auto-completion)
     - [Providing entity types and templates](#providing-entity-types-and-templates)
     - [Providing custom build process](#providing-custom-build-process)
 - [Plugin capabilities and structure](#plugin-capabilities-and-structure)
@@ -183,6 +184,15 @@ MYPLUGIN PLUGIN WAZ HERE !!
 
 Wow it worked ! Useless, but worked ! But it's a good demo on how to create your own subcommands in `PowerStencil`.
 
+## Updating zsh auto-completion
+
+When you add a plugin to a project, be it local or from a separated gem, you may want to update the command-line auto-completion for that project as new plugins may add extra command-line options and sub-commands.
+
+You do that as you probably already [dit it initially][completion].
+
+    $ power_stencil adm --zsh-completion
+
+
 ## Providing entity types and templates
 
 Of course you can provide new entity types and templates templates within plugin. The plugin created contains a demo entity type which brings its own template template (and even a custom build, but we will see that in next paragraph).
@@ -507,6 +517,7 @@ The documentation for plugins is not fully complete, so you are encouraged to re
 [builds]: builds.md "Builds in PowerStencil"
 [templates]: templates.md "Templates in PowerStencil"
 [post-process]: builds.md#post-process-actions "post-process actions in builds"
+[completion]: ../README.md#command-line-auto-completion "how to setup zsh command-line auto-completion"
 
 <!-- Code links -->
 

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

@@ -5,11 +5,22 @@ PowerStencil entity definitions
 In this directory, you can define project specific entity definitions
  which basically are plain ruby files processed in alphabetical order.
  
-You can create classes that are inheriting from `PowerStencil::SystemEntityDefinition::Base`
+You can create classes that are inheriting from `PowerStencil::SystemEntityDefinitions::ProjectEntity`
 To express relations between entities you should use the ActiveRecord-like
 syntax provided by the `universe_compiler` gem. 
 
 
 __It is strongly advised to keep this directory under source control__
 
-This should be the PowerStencil default behaviour. 
+This should be the PowerStencil default behaviour.
+
+example class:
+
+```ruby
+class ExampleEntity < PowerStencil::SystemEntityDefinitions::ProjectEntity
+    entity_type :example
+
+    [...]
+
+end
+```

data/lib/power_stencil/command_processors/build.rb

@@ -46,13 +46,18 @@ module PowerStencil
         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]
+        build_ok = true
         project.engine.last_build_report.each do |entity_full_name, entity_report|
           if entity_report == ['Ok']
             puts " - '#{entity_full_name}' has been correctly built"
           else
+            build_ok = false
             puts_and_logs " - Failed to build '#{entity_full_name}' because #{entity_report.join}", logs_as: :error, check_verbose: false
           end
         end
+        unless build_ok
+          raise PowerStencil::Error, 'Could not complete build !'
+        end
 
       end
 

data/lib/power_stencil/command_processors/init.rb

@@ -14,7 +14,7 @@ module PowerStencil
 
       def execute
         setup_project_path
-        # log_startup_context
+        # log_startup_context
         puts_and_logs "Creating new project structure in '#{config[:'project-path']}'", check_verbose: false
         PowerStencil::Project::Base.create_project_tree config[:'project-path']
         puts_and_logs 'Done.', check_verbose: false
@@ -44,4 +44,4 @@ module PowerStencil
     end
 
   end
-end
+end

data/lib/power_stencil/engine/build_handling.rb

@@ -55,10 +55,15 @@ module PowerStencil
       def generate_build_files(entity_to_build, target_path)
         logger.info "Rendering '#{entity_to_build.as_path}' templates in '#{target_path}'"
         render_source entity_to_build.templates_path, target_path, main_entry_point: entity_to_build.as_path
+        render_entity entity_to_build, target_path if entity_to_build.class.provides_own_build?
         logger.info "Detemplatized files generated in '#{target_path}'"
         manage_build_links target_path
       end
 
+      def render_entity(entity_to_build, target_path)
+        entity_to_build.class.entity_build entity_to_build, target_path
+      end
+
       def post_build_hook(entity_to_build, files_path)
         case entity_to_build.type
         when :simple_exec
@@ -127,7 +132,7 @@ module PowerStencil
           target_plugin = project.plugins[target_plugin_name]
           raise PowerStencil::Error, "Could not find plugin '#{target_plugin_name}' !" if target_plugin.nil?
           if target_plugin.capabilities[:generate_build_files]
-            target_plugin.generate_build_files entity_to_build, target_path
+            target_plugin.generate_build_files entity_to_build, target_path, &:generate_build_files
           else
             logger.info 'Falling back to PowerStencil core build files generation process...'
             generate_build_files entity_to_build, target_path

data/lib/power_stencil/engine/renderers/erb.rb

@@ -8,7 +8,7 @@ module PowerStencil
 
         def render_erb_template(source, context)
           logger.debug "Using ERB to render file '#{source}'"
-          ERB.new(File.read(source), nil, '-').result(context)
+          ERB.new(File.read(source), trim_mode: '-').result(context)
         rescue => e
           logger.debug PowerStencil::Error.report_error(e)
           raise PowerStencil::Error, "Error rendering '#{source}': '#{e.message}'"

data/lib/power_stencil/initializer.rb

@@ -15,7 +15,7 @@ module PowerStencil
     def bootstrap(cmd_line_args = ARGV.dup)
       setup_climatic cmd_line_args
       logger.debug 'Starting PowerStencil initialization...'
-      setup_system_processors
+      register_system_processors
       setup_universe_compiler_logger
       project fail_on_error: false
       logger.debug 'PowerStencil initialization complete'
@@ -38,7 +38,7 @@ module PowerStencil
 
     end
 
-    def setup_system_processors
+    def register_system_processors
       logger.debug 'Registering system processors'
       {
           '' => PowerStencil::CommandProcessors::Root,
@@ -63,6 +63,7 @@ module PowerStencil
     end
 
     def setup_climatic(cmd_line_args)
+      ::UltraCommandLine.permissive_mode = true
       mngr = Climatic::ConfigLayers::CommandLineLayer.build_command_line_manager base_commands_definition_file
       Climatic.bootstrap cmd_line_args: cmd_line_args, command_manager: mngr
       mngr.commands.each do |command|

data/lib/power_stencil/project/plugins.rb

@@ -44,6 +44,8 @@ module PowerStencil
         initialize_gem_plugins
         initialize_local_plugins
         require_plugins_entry_points
+        # Here all the command line options are known. We can turn the slop "permissive mode" back to default
+        ::UltraCommandLine.permissive_mode = false
         command_line_manager.definition_hash_to_commands
         register_plugins_processors
       end

data/lib/power_stencil/system_entity_definitions/buildable.rb

@@ -17,6 +17,10 @@ module PowerStencil
         not @build_plugin_name.nil?
       end
 
+      def provides_own_build?
+        respond_to? :entity_build
+      end
+
     end
 
   end

data/lib/power_stencil/ultra_command_line/command_line_manager.rb

@@ -24,7 +24,6 @@ class UltraCommandLine::Manager::Base
       end
     end
 
- #   private
 
     def internal_provider_mapping
       @internal_provider_mapping ||= {}
@@ -32,4 +31,22 @@ class UltraCommandLine::Manager::Base
 
   end
 
+  # def contribute_to_definition(hash, layer_name: :unknown_layer)
+  #   super
+  # end
+
+
+
+  def processor
+    processor_candidates = processors_hash.fetch(command(cmd_line_args).name, []) .select do |processor|
+      processor.check_params command.cmd_line_args
+    end
+    raise UltraCommandLine::Error, 'No processor found for this command line' if processor_candidates.empty?
+    return processor_candidates.first if processor_candidates.size == 1
+
+
+    raise UltraCommandLine::Error, 'Too many possible processors' unless processor_candidates.size == 1
+    processor_candidates.first
+  end
+
 end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.9.7'.freeze
+  VERSION = '0.10.0'.freeze
 end

data/power_stencil.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_dependency 'climatic', '~> 0.2.35'
+  spec.add_dependency 'climatic', '~> 0.2.40'
   spec.add_dependency 'dir_glob_ignore', '~> 0.3'
   spec.add_dependency 'universe_compiler', '~> 0.5.6'
   spec.add_dependency 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.9.7
+  version: 0.10.0
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-20 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.35
+        version: 0.2.40
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.35
+        version: 0.2.40
 - !ruby/object:Gem::Dependency
   name: dir_glob_ignore
   requirement: !ruby/object:Gem::Requirement
@@ -329,12 +329,13 @@ 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.9.7 !\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   : https://gitlab.com/tools4devops/power_stencil/blob/master/README.md\nFeel
-  free to report issues: https://gitlab.com/tools4devops/power_stencil/issues\n\nType
-  'power_stencil adm --zsh-completion' to install auto-completion for zsh.\n\n  "
+post_install_message: "\nThank you for installing PowerStencil 0.10.0 !\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   :
+  https://gitlab.com/tools4devops/power_stencil/blob/master/README.md\nFeel free to
+  report issues: https://gitlab.com/tools4devops/power_stencil/issues\n\nType 'power_stencil
+  adm --zsh-completion' to install auto-completion for zsh.\n\n  "
 rdoc_options: []
 require_paths:
 - lib
@@ -349,8 +350,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: PowerStencil is the Swiss-army knife templating workflow for developers and