power_stencil 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7a7ba04e35989e29c761da1e15018121ada88a4
-  data.tar.gz: be2c3cfe6550a722e126d0587a5aa76273573edb
+  metadata.gz: f8ef665f1ce87e962192d7725c2dbd851759bc00
+  data.tar.gz: 65d6b440a419dddc9a3f0c46c2b7c80db9d78d90
 SHA512:
-  metadata.gz: 1f29b2f27112124935ec5b9c63222206d9ec34570154c05d02d38ad2954a74a12590ba3ab017f978ef1f9f5d71fb56d4dc75e5b2e3f48ab6d95418935d770bee
-  data.tar.gz: bad80333308df6484785785077046e16161188297a15eb95302024e48c882e1ceca0d3ac48c45b19c616f0b61973aab6795d99549ae9dc781eb7bd1614e0acfe
+  metadata.gz: 8e39368e94c8710dba97db574916017d9a30ce45468d5674787daef4f2ad915af8dba03235d60988a2f887a96020f151dabccd160b32baef0d4421a576339284
+  data.tar.gz: 7a7ba9f93020d3d92954ef997d46d5724ff11e79deec6270e1a283009faf00df56762435532aa8762dbad93ea062af4931b21fb76941fa04ec59cc0b141de69d

data/etc/meta_templates/plugin_seed/README.md

@@ -16,6 +16,9 @@ See [official website][PowerStencil site].
 - [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 dependencies](#plugin-dependencies)
+    - [Standard gems dependencies](#standard-gems-dependencies)
+    - [Dependency to other plugins](#dependency-to-other-plugins)
 - [Plugin capabilities](#plugin-capabilities)
     - [Config](#config)
     - [Subcommands and options](#subcommands-and-options)
@@ -66,9 +69,22 @@ 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
+# Goal of this plugin
 
-# Plugin capabilities
+# Plugin dependencies
+
+## Standard gems dependencies
+
+Standard dependencies are declared normally in the _gemspec file_. They are automatically installed when installing the plugin with `power_stencil plugin --install`.
+
+## Dependency to other plugins
+
+For development purpose, dependency to other plugins are declared in the _gemspec file_ as _development dependency_. 
+
+But within a project, dependencies have to be added to the `:project_plugins` array in the project configuration file (`.ps_project/versioned-config.yaml`).
+
+
+# Plugin capabilities
 
 This plugin provides the following features:
 
@@ -78,13 +94,12 @@ This plugin provides the following features:
 
 ## Post-build actions
 
-## DSL in templates and in `power_stencil shell`
+## 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.

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

@@ -0,0 +1,50 @@
+module PowerStencilTests
+
+  module Project
+
+    TEMP_DIR_PREFIX = 'PS_TESTS_'
+
+    module ClassMethods
+
+
+      def temporary_project(project_name, with_git_support: false, scope: :all)
+        self.instance_eval do
+          puts scope
+          around(scope) do |execution|
+            Dir.mktmpdir(TEMP_DIR_PREFIX) do |tests_root_dir|
+              tmp_project_path = File.join tests_root_dir, project_name
+              create_project_including_this_plugin tmp_project_path, with_git_support: with_git_support
+              execution.run
+              @tmp_project_path = nil
+            end
+          end
+        end
+      end
+
+      def plugin_path
+        File.expand_path File.join('..', '..'), __FILE__
+      end
+
+    end
+
+    attr_reader :tmp_project_path
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def create_project_including_this_plugin(project_path, with_git_support: false)
+      cmd = "power_stencil init --project-path '#{project_path}'"
+      cmd << ' --no-git' unless with_git_support
+      `#{cmd}`
+      project_plugin_path = File.join project_path, '.ps_project', 'plugins'
+      `ln -s '#{self.class.plugin_path}' '#{project_plugin_path}'`
+      @tmp_project_path = project_path
+    end
+
+    def temporary_project_cmd(params)
+      "power_stencil #{params} --project-path '#{tmp_project_path}'"
+    end
+
+  end
+end

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

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

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

@@ -1,10 +1,30 @@
 RSpec.describe <%= plugin_module_name %> do
+
+  include PowerStencilTests::Project
+  temporary_project 'test_project', scope: :all
+
+  let(:plugin_list) { 'plugin --list' }
+  let(:test_entity) { '<%= plugin_name %>_entity/test_<%= plugin_name %>' }
+  let(:create_<%= plugin_name %>) { "create #{test_entity}" }
+  let(:get_<%= plugin_name %>) { "get #{test_entity}" }
+
   it 'has a version number' do
     expect(<%= plugin_module_name %>::VERSION).not_to be nil
   end
 
-  it 'does something useful' do
+  it 'should add a "<%= plugin_name %>" sub-command' do
+    expect(`#{temporary_project_cmd plugin_list}`).to match '- <%= plugin_name %>'
+  end
+
+  it 'should be possible to create a "<%= plugin_name %>_entity"' do
+    `#{temporary_project_cmd create_<%= plugin_name %>}`
+    expect($?.success?).to be_truthy
+    expect(`#{temporary_project_cmd get_<%= plugin_name %>}`).not_to be_empty
+  end
+
+  it 'should do something useful' do
     pending 'Tests implementation'
     RSpec.fail
   end
+
 end

data/etc/templates/plugin_definition/README.md

@@ -16,6 +16,9 @@ See [official website][PowerStencil site].
 - [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 dependencies](#plugin-dependencies)
+    - [Standard gems dependencies](#standard-gems-dependencies)
+    - [Dependency to other plugins](#dependency-to-other-plugins)
 - [Plugin capabilities](#plugin-capabilities)
     - [Config](#config)
     - [Subcommands and options](#subcommands-and-options)
@@ -66,9 +69,22 @@ 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
+# Goal of this plugin
 
-# Plugin capabilities
+# Plugin dependencies
+
+## Standard gems dependencies
+
+Standard dependencies are declared normally in the _gemspec file_. They are automatically installed when installing the plugin with `power_stencil plugin --install`.
+
+## Dependency to other plugins
+
+For development purpose, dependency to other plugins are declared in the _gemspec file_ as _development dependency_. 
+
+But within a project, dependencies have to be added to the `:project_plugins` array in the project configuration file (`.ps_project/versioned-config.yaml`).
+
+
+# Plugin capabilities
 
 This plugin provides the following features:
 
@@ -78,13 +94,12 @@ This plugin provides the following features:
 
 ## Post-build actions
 
-## DSL in templates and in `power_stencil shell`
+## 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.

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

@@ -0,0 +1,50 @@
+module PowerStencilTests
+
+  module Project
+
+    TEMP_DIR_PREFIX = 'PS_TESTS_'
+
+    module ClassMethods
+
+
+      def temporary_project(project_name, with_git_support: false, scope: :all)
+        self.instance_eval do
+          puts scope
+          around(scope) do |execution|
+            Dir.mktmpdir(TEMP_DIR_PREFIX) do |tests_root_dir|
+              tmp_project_path = File.join tests_root_dir, project_name
+              create_project_including_this_plugin tmp_project_path, with_git_support: with_git_support
+              execution.run
+              @tmp_project_path = nil
+            end
+          end
+        end
+      end
+
+      def plugin_path
+        File.expand_path File.join('..', '..'), __FILE__
+      end
+
+    end
+
+    attr_reader :tmp_project_path
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def create_project_including_this_plugin(project_path, with_git_support: false)
+      cmd = "power_stencil init --project-path '#{project_path}'"
+      cmd << ' --no-git' unless with_git_support
+      `#{cmd}`
+      project_plugin_path = File.join project_path, '.ps_project', 'plugins'
+      `ln -s '#{self.class.plugin_path}' '#{project_plugin_path}'`
+      @tmp_project_path = project_path
+    end
+
+    def temporary_project_cmd(params)
+      "power_stencil #{params} --project-path '#{tmp_project_path}'"
+    end
+
+  end
+end

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

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

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

@@ -1,10 +1,30 @@
 RSpec.describe <%= plugin_module_name %> do
+
+  include PowerStencilTests::Project
+  temporary_project 'test_project', scope: :all
+
+  let(:plugin_list) { 'plugin --list' }
+  let(:test_entity) { '<%= plugin_name %>_entity/test_<%= plugin_name %>' }
+  let(:create_<%= plugin_name %>) { "create #{test_entity}" }
+  let(:get_<%= plugin_name %>) { "get #{test_entity}" }
+
   it 'has a version number' do
     expect(<%= plugin_module_name %>::VERSION).not_to be nil
   end
 
-  it 'does something useful' do
+  it 'should add a "<%= plugin_name %>" sub-command' do
+    expect(`#{temporary_project_cmd plugin_list}`).to match '- <%= plugin_name %>'
+  end
+
+  it 'should be possible to create a "<%= plugin_name %>_entity"' do
+    `#{temporary_project_cmd create_<%= plugin_name %>}`
+    expect($?.success?).to be_truthy
+    expect(`#{temporary_project_cmd get_<%= plugin_name %>}`).not_to be_empty
+  end
+
+  it 'should do something useful' do
     pending 'Tests implementation'
     RSpec.fail
   end
+
 end

data/lib/power_stencil/command_processors/create.rb

@@ -41,8 +41,8 @@ module PowerStencil
             end
             puts_and_logs "Generated templates in '#{new_entity.templates_path}'.", check_verbose: false if new_entity.buildable?
           rescue => e
-            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)
+            raise PowerStencil::Error, "Failed to create '#{search_criterion.as_path}' with message '#{e.message}'."
           end
         end
       end

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.9.0'.freeze
+  VERSION = '0.9.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Laurent Briais
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-10 00:00:00.000000000 Z
+date: 2019-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -183,6 +183,7 @@ 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/project_helper.rb
 - etc/meta_templates/plugin_seed/spec/spec_helper.rb
 - etc/meta_templates/plugin_seed/spec/{entity}_spec.rb
 - etc/power_stencil.yaml
@@ -210,6 +211,7 @@ files:
 - etc/templates/plugin_definition/lib/{entity}/version.rb.erb
 - etc/templates/plugin_definition/lib/{entity}/{entity}_processor.rb.erb
 - etc/templates/plugin_definition/psplugin_{entity}.gemspec
+- etc/templates/plugin_definition/spec/project_helper.rb
 - etc/templates/plugin_definition/spec/spec_helper.rb
 - etc/templates/plugin_definition/spec/{entity}_spec.rb
 - etc/templates/project/.copy_ignore
@@ -321,7 +323,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.9.0 !\nFrom the command
+post_install_message: "\nThank you for installing PowerStencil 0.9.1 !\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