power_stencil 0.8.11 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df94a3acebefba79cac4230615727310af33352c
-  data.tar.gz: d9c23c0e8b153af072e533d6e170b412e9bcccdd
+  metadata.gz: 7dc79ec2bfd2b5329682f131365f15c693374d8d
+  data.tar.gz: 76f1e96f4d147cf6f1cd02895943033e8d1d3686
 SHA512:
-  metadata.gz: ef6af6b335756c7120575eba283887e704371a90032ae24c60f12915ddf43cebdb2205eb58c445b36a374d6255c114150bb816576ef3ded5304ef4227198e43c
-  data.tar.gz: 60b5625ba00c9fa20176f584d32b8c405b9dbf41a93b29d1d24b4bf453cd75d133c74b41e3620d1fef80beb6a44009ba8755c3a2dbdcd1834167b3dc42538131
+  metadata.gz: e672747d710d0b5a350a1870d651594ddc5eb5e4f8d3a0eead55a121a4f7d0ba4380a32f272bd5315bf2c8751452cc554e8fc63c1d58d5f27078ab57587ddea0
+  data.tar.gz: 8780ba7d6d7dd186f4de790e37154c46eee6ed3f085639420a22e771c44d91e8586aeb175993577c5e76bb87aaae367a6439130107462e6f7a513ad0682efaf6

data/etc/meta_templates/plugin_seed/README.md

@@ -0,0 +1,118 @@
+<% gem_name = "psplugin_#{ plugin_name}" -%>
+<%= plugin_title_name %>
+<%= '=' * plugin_title_name.size %>
+
+[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
+
+[PowerStencil] is the Swiss-army knife templating workflow for developers and ops.
+
+`<%= plugin_title_name %>` is a [PowerStencil] plugin.
+
+See [official website][PowerStencil site].
+
+
+<!-- TOC -->
+
+- [What is a PowerStencil plugin ?](#what-is-a-powerstencil-plugin-)
+- [Using this plugin in your `PowerStencil` projects](#using-this-plugin-in-your-powerstencil-projects)
+- [Goal of this plugin](#goal-of-this-plugin)
+- [Plugin capabilities](#plugin-capabilities)
+    - [Config](#config)
+    - [Subcommands and options](#subcommands-and-options)
+    - [Post-build actions](#post-build-actions)
+    - [DSL in templates and in `power_stencil shell`](#dsl-in-templates-and-in-power_stencil-shell)
+    - [Entity types](#entity-types)
+    - [Templates-templates](#templates-templates)
+- [Contributing](#contributing)
+    - [License](#license)
+    - [Code of Conduct](#code-of-conduct)
+
+<!-- /TOC -->
+
+# What is a PowerStencil plugin ?
+
+A `PowerStencil` plugin can be used in the context of a `PowerStencil` project and bring extra features to a standard project.
+
+If you don't know what `PowerStencil` is made for, you may read [the documentation][PowerStencil] first.
+
+Features provided by a plugin can be:
+
+* Extra config.
+* Extra subcommands or options added to the `power_stencil` command-line.
+* Extra post-build actions.
+* Extra DSL methods available in templates and in `power_stencil shell`.
+* Extra entity types.
+* Extra templates-templates.
+
+# Using this plugin in your `PowerStencil` projects
+
+To use this plugin within your `PowerStencil` project, you need to:
+
+* be within a `PowerStencil` project :wink:.
+* declare this plugin in the project configuration (from the root of your project in the `.ps_project/versioned-config.yaml` file).
+
+In this yaml configuration file, you just have to add a new entry in the `:project_plugins` array or simply create it if it is not yet existing:
+
+```yaml
+:project_plugins:
+  - <%= gem_name %>
+```
+If this plugin is not already present on your machine, you may have to download it:
+
+    $ power_stencil plugin --install
+
+And then you may see information about the plugin by running:
+
+* `power_stencil info` in the plugins section.
+* `power_stencil plugin --list -v`
+
+# Goal of this plugin
+
+# Plugin capabilities
+
+This plugin provides the following features:
+
+## Config
+
+## Subcommands and options
+
+## Post-build actions
+
+## DSL in templates and in `power_stencil shell`
+
+## Entity types
+
+## Templates-templates
+
+
+# Contributing
+
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License].
+
+## Code of Conduct
+
+Everyone interacting in the PowerStencil project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct].
+
+<!-- End of Document -->
+
+<!-- Pages -->
+[code of conduct]: CODE_OF_CONDUCT.md
+
+<!-- Code links -->
+
+<!-- Illustrations -->
+[simple-flow-image]: doc/images/power-stencil-simple-flow.svg
+
+<!-- External links -->
+[MIT License]: http://opensource.org/licenses/MIT "The MIT license"
+[ERB]: https://ruby-doc.org/stdlib-2.6.3/libdoc/erb/rdoc/ERB.html "Quick ERB description"
+[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]: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md "PowerStencil documentation"
+[PowerStencil plugins]: https://gitlab.com/tools4devops/power_stencil/blob/master/doc/plugins.md "PowerStencil plugins documentation"

data/etc/meta_templates/plugin_seed/psplugin_{entity}.gemspec

@@ -12,13 +12,27 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{<%= plugin_name %> is a plugin for the PowerStencil framework.}
   spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # Change this and following metadata if you don't want your plugin to be an "official" PowerStencil plugin.
+  # ie deployed to https://gitlab.com/tools4devops/psplugins
+  source_code_uri = 'https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>'
+
+  # Gem metadata
   if spec.respond_to?(:metadata)
+    # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+    # to allow pushing to a single host or delete this line to allow pushing to any host.
     spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-    # This metadata is mandatory for PowerStencil !!
+
+    # Nice link to your home page on rubygems.org
+    spec.metadata['homepage_uri'] = spec.homepage
+
+    # You have to probably change this if you don't deploy to gitlab
+    spec.metadata['bug_tracker_uri'] = "#{source_code_uri}/issues"
+    spec.metadata['documentation_uri'] = "#{source_code_uri}/blob/master/README.md"
+    spec.metadata['source_code_uri'] = source_code_uri
+
+    # This metadata is mandatory for a PowerStencil plugin !!
     spec.metadata['plugin_name'] = '<%= plugin_name %>'
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes and PowerStencil plugin mechanism !'
@@ -31,8 +45,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'power_stencil', "~> <%= PowerStencil::VERSION %>"
+
 end

data/etc/meta_templates/plugin_seed/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require 'power_stencil'
+require "<%= plugin_name %>"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/etc/meta_templates/plugin_seed/spec/{entity}_spec.rb

@@ -0,0 +1,10 @@
+RSpec.describe <%= plugin_module_name %> do
+  it 'has a version number' do
+    expect(<%= plugin_module_name %>::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    pending 'Tests implementation'
+    RSpec.fail
+  end
+end

data/etc/templates/plugin_definition/README.md

@@ -1,43 +1,118 @@
-# <%= plugin_module_name %>
+<% gem_name = "psplugin_#{ plugin_name}" -%>
+<%= plugin_title_name %>
+<%= '=' * plugin_title_name.size %>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/<%= plugin_module_name %>`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/<%= gem_name %>.svg)](https://rubygems.org/gems/<%= gem_name %>) [![Pipeline status](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/badges/master/pipeline.svg)](https://gitlab.com/tools4devops/psplugins/<%= gem_name %>/commits/master)
 
-TODO: Delete this and the text above, and describe your gem
+[PowerStencil] is the Swiss-army knife templating workflow for developers and ops.
 
-## Installation
+`<%= plugin_title_name %>` is a [PowerStencil] plugin.
 
-Add this line to your application's Gemfile:
+See [official website][PowerStencil site].
 
-```ruby
-gem '<%= plugin_module_name %>'
+
+<!-- TOC -->
+
+- [What is a PowerStencil plugin ?](#what-is-a-powerstencil-plugin-)
+- [Using this plugin in your `PowerStencil` projects](#using-this-plugin-in-your-powerstencil-projects)
+- [Goal of this plugin](#goal-of-this-plugin)
+- [Plugin capabilities](#plugin-capabilities)
+    - [Config](#config)
+    - [Subcommands and options](#subcommands-and-options)
+    - [Post-build actions](#post-build-actions)
+    - [DSL in templates and in `power_stencil shell`](#dsl-in-templates-and-in-power_stencil-shell)
+    - [Entity types](#entity-types)
+    - [Templates-templates](#templates-templates)
+- [Contributing](#contributing)
+    - [License](#license)
+    - [Code of Conduct](#code-of-conduct)
+
+<!-- /TOC -->
+
+# What is a PowerStencil plugin ?
+
+A `PowerStencil` plugin can be used in the context of a `PowerStencil` project and bring extra features to a standard project.
+
+If you don't know what `PowerStencil` is made for, you may read [the documentation][PowerStencil] first.
+
+Features provided by a plugin can be:
+
+* Extra config.
+* Extra subcommands or options added to the `power_stencil` command-line.
+* Extra post-build actions.
+* Extra DSL methods available in templates and in `power_stencil shell`.
+* Extra entity types.
+* Extra templates-templates.
+
+# Using this plugin in your `PowerStencil` projects
+
+To use this plugin within your `PowerStencil` project, you need to:
+
+* be within a `PowerStencil` project :wink:.
+* declare this plugin in the project configuration (from the root of your project in the `.ps_project/versioned-config.yaml` file).
+
+In this yaml configuration file, you just have to add a new entry in the `:project_plugins` array or simply create it if it is not yet existing:
+
+```yaml
+:project_plugins:
+  - <%= gem_name %>
 ```
+If this plugin is not already present on your machine, you may have to download it:
+
+    $ power_stencil plugin --install
+
+And then you may see information about the plugin by running:
+
+* `power_stencil info` in the plugins section.
+* `power_stencil plugin --list -v`
+
+# Goal of this plugin
 
-And then execute:
+# Plugin capabilities
 
-    $ bundle
+This plugin provides the following features:
 
-Or install it yourself as:
+## Config
 
-    $ gem install <%= plugin_module_name %>
+## Subcommands and options
 
-## Usage
+## Post-build actions
 
-TODO: Write usage instructions here
+## DSL in templates and in `power_stencil shell`
 
-## Development
+## Entity types
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Templates-templates
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Contributing
+# Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/<%= plugin_module_name %>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License].
 
 ## Code of Conduct
 
-Everyone interacting in the <%= plugin_module_name %> project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/<%= plugin_module_name %>/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the PowerStencil project’s codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct].
+
+<!-- End of Document -->
+
+<!-- Pages -->
+[code of conduct]: CODE_OF_CONDUCT.md
+
+<!-- Code links -->
+
+<!-- Illustrations -->
+[simple-flow-image]: doc/images/power-stencil-simple-flow.svg
+
+<!-- External links -->
+[MIT License]: http://opensource.org/licenses/MIT "The MIT license"
+[ERB]: https://ruby-doc.org/stdlib-2.6.3/libdoc/erb/rdoc/ERB.html "Quick ERB description"
+[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]: https://gitlab.com/tools4devops/power_stencil/blob/master/README.md "PowerStencil documentation"
+[PowerStencil plugins]: https://gitlab.com/tools4devops/power_stencil/blob/master/doc/plugins.md "PowerStencil plugins documentation"

data/etc/templates/plugin_definition/psplugin_{entity}.gemspec

@@ -12,13 +12,27 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{<%= plugin_name %> is a plugin for the PowerStencil framework.}
   spec.description   = %q{TODO: Write a longer description or delete this line.}
   spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # Change this and following metadata if you don't want your plugin to be an "official" PowerStencil plugin.
+  # ie deployed to https://gitlab.com/tools4devops/psplugins
+  source_code_uri = 'https://gitlab.com/tools4devops/psplugins/<%= plugin_name %>'
+
+  # Gem metadata
   if spec.respond_to?(:metadata)
+    # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+    # to allow pushing to a single host or delete this line to allow pushing to any host.
     spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-    # This metadata is mandatory for PowerStencil !!
+
+    # Nice link to your home page on rubygems.org
+    spec.metadata['homepage_uri'] = spec.homepage
+
+    # You have to probably change this if you don't deploy to gitlab
+    spec.metadata['bug_tracker_uri'] = "#{source_code_uri}/issues"
+    spec.metadata['documentation_uri'] = "#{source_code_uri}/blob/master/README.md"
+    spec.metadata['source_code_uri'] = source_code_uri
+
+    # This metadata is mandatory for a PowerStencil plugin !!
     spec.metadata['plugin_name'] = '<%= plugin_name %>'
   else
     raise 'RubyGems 2.0 or newer is required to protect against public gem pushes and PowerStencil plugin mechanism !'
@@ -31,8 +45,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0.2'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'power_stencil', "~> <%= PowerStencil::VERSION %>"
+
 end

data/etc/templates/plugin_definition/spec/spec_helper.rb

@@ -1,5 +1,6 @@
 require "bundler/setup"
-require "<%= plugin_module_name %>"
+require 'power_stencil'
+require "<%= plugin_name %>"
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure

data/etc/templates/plugin_definition/spec/{entity}_spec.rb

@@ -1,9 +1,10 @@
 RSpec.describe <%= plugin_module_name %> do
-  it "has a version number" do
+  it 'has a version number' do
     expect(<%= plugin_module_name %>::VERSION).not_to be nil
   end
 
-  it "does something useful" do
-    expect(false).to eq(true)
+  it 'does something useful' do
+    pending 'Tests implementation'
+    RSpec.fail
   end
 end

data/lib/power_stencil/dsl/plugin_generation.rb

@@ -7,6 +7,10 @@ module PowerStencil
          main_entry_point.underscore
       end
 
+      def plugin_title_name
+        plugin_name.tr('_', ' ').split.map(&:capitalize).join(' ')
+      end
+
       def plugin_module_name
         plugin_name.camelize
       end

data/lib/power_stencil/engine/entities_handling.rb

@@ -34,11 +34,11 @@ module PowerStencil
         @available_entities_hash.keys
       end
 
-      def entity(type, name, universe)
+      def entity(type, name, universe = self.root_universe)
         universe.get_entity type, name
       end
 
-      def entities(universe, criterion: nil, value: nil, &filter_block)
+      def entities(universe = self.root_universe, criterion: nil, value: nil, &filter_block)
         universe.get_entities criterion: criterion, value: value, &filter_block
       end
 

data/lib/power_stencil/project/completion.rb

@@ -6,17 +6,15 @@ module PowerStencil
       def query_for_completion(query_type)
         case query_type
         when :entities
-          engine.entities(engine.root_universe).map(&:as_path).sort
+          engine.entities.map(&:as_path).sort
         when :'entity-types'
           engine.available_entity_types.sort
         when :scenario
-          engine.entities(engine.root_universe, criterion: :by_type, value: :entity_override) do |entity|
+          engine.entities(criterion: :by_type, value: :entity_override) do |entity|
             !entity.scenario.nil? and !entity.scenario.empty?
           end.map(&:scenario).sort.uniq
         when :buildable
-          engine.entities(engine.root_universe) do |entity|
-            entity.buildable?
-          end.map(&:as_path).sort
+          engine.entities(&:buildable?).map(&:as_path).sort
         else
           raise PowerStencil::Error, "'#{query_type}' is not a valid query type for completion !"
         end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.8.11'.freeze
+  VERSION = '0.8.12'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.8.12
 platform: ruby
 authors:
 - Laurent Briais
@@ -154,6 +154,7 @@ files:
 - doc/plugins.md
 - doc/templates.md
 - etc/base_commands_definition.yml
+- etc/meta_templates/plugin_seed/README.md
 - etc/meta_templates/plugin_seed/etc/command_line.yaml
 - etc/meta_templates/plugin_seed/etc/plugin_capabilities.yaml
 - etc/meta_templates/plugin_seed/etc/plugin_config.yaml
@@ -168,6 +169,8 @@ files:
 - etc/meta_templates/plugin_seed/lib/{entity}/version.rb.erb
 - etc/meta_templates/plugin_seed/lib/{entity}/{entity}_processor.rb.erb
 - etc/meta_templates/plugin_seed/psplugin_{entity}.gemspec
+- etc/meta_templates/plugin_seed/spec/spec_helper.rb
+- etc/meta_templates/plugin_seed/spec/{entity}_spec.rb
 - etc/power_stencil.yaml
 - etc/templates/plugin_definition/.gitignore
 - etc/templates/plugin_definition/.rspec
@@ -299,7 +302,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.8.11 !\nFrom the
+post_install_message: "\nThank you for installing PowerStencil 0.8.12 !\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   :