power_stencil 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7736f19eb314bb8a662792b159f223d4375a88c6
-  data.tar.gz: ceed2b532f89506d4c1a4c94fcf7eb11b05c1c56
+  metadata.gz: dcd80aee0e9932a4fe819203fff8699c949eaa24
+  data.tar.gz: 7495afdc4abbf4c5c09a728b352ba8868d9851c0
 SHA512:
-  metadata.gz: 74e89da925a8e158de5d3efa4d8ac57d869ad8f4a03ca86dab7d41b109abe70f6daaef21a399ab194ff2a2a53a9e55b6fbbbed5ab3dc2849cd46949500531f2f
-  data.tar.gz: 96814a5d1ef98ca8a6e78e047c194c9f8e7ad45612d24db35eeb4f4e35dbcc98e901024bdeee55511b48df57933c8739ba8e2cbe76263b18d0e86929017201cb
+  metadata.gz: b22d036ea9744681e4c838133790e91fc08e14ebfc09cc1980549516ec83dcd47469b800ce9c3d599055b0dbebe1caeeecf59190563b5ca3c39626c1928cad6b
+  data.tar.gz: e0825248d461ca674ed3c4714b6d33a890d1b0110aa4dc1ea0f948da99c0b80a481c880b79381057bdb0b19959567294abe1e4ac9b0df141c6b099d94064a672

data/README.md

@@ -116,6 +116,12 @@ The `--project-path` option can be applied to any sub-command, but à-la-git, on
 
 :information_source: The rest of this documentation will assume you are at the root of this created project.
 
+:information_source: Of course, once you created a new project you should version it with Git:
+
+    $ git init
+    $ git commit -a -m 'Initial commit'
+
+
 ## `PowerStencil` project structure
 
 The structure of a brand new `PowerStencil` project is the following:

data/doc/entities.md

@@ -191,7 +191,7 @@ RAW ENTITIES
 
 The goal of this command is normally to check the validity of entities, but it brings as well extra information like if the entity is _buildable_ or even where it is stored in the repository.
 
-:information_source: You can notice that the `project_config` entity has no storage path, the reason being [it is not persisted](#default-entity-types).
+:information_source: You can notice that the `project_config` entity has no storage path, the reason being [it is not persisted](#default-entity-types) in the entities repository (its content actually comes from config files outside of the repository).
 
 This command may show some extra information, for more complex entities. We will see that later on.
 
@@ -209,7 +209,7 @@ RAW ENTITIES
   - Status      : Valid 
   - Buildable   : false
 ```
-Another possibility is to check a list of objects using a regular expression by using the `--regexp` option:
+Another possibility is to check a list of objects using a regular expression (applied to the ID of an entity, ie `<entity_type</<entity_name>`) by using the `--regexp` option:
 
 ```shell
 $ power_stencil check base_ --regexp
@@ -555,7 +555,7 @@ class MyCustomEntity < PowerStencil::SystemEntityDefinitions::ProjectEntity
     field :my_custom_field
 end
 ```
-Then it means I can access the `my_custom_field` property in two different ways:
+Then it means I can access the `my_custom_field` property in three different ways:
 
 ```ruby
 PowerStencil DSL> e = new_custom_entity name: :test_entity
@@ -568,8 +568,10 @@ PowerStencil DSL> e.my_custom_field
 => "foo"
 PowerStencil DSL> e.fields[:my_custom_field]
 => "foo"
+PowerStencil DSL> e[:my_custom_field]
+=> "foo"
 ```
-:information_source: You can notice the `new_<entity_type>` DSL method which is a shortcut to create entities.
+:information_source: You can notice the `new_<entity_type>` DSL method which is a shortcut to create entities (actually you have to use this DSL method and not create entities using its `<classname>.new`, because this DSL method on top of creating the entity, setup everything for persistence as well...).
 
 So you can see the field directive will actually create accessor methods for first level properties in the `#fields` Hash.
 

data/doc/example_use_cases.md

@@ -14,7 +14,7 @@ Example use cases
 
 # Overview
 
-Considering the genericity of the `PowerStencil`, it is a bit difficult to a scope for its usage. It's a bit like saying what you could do with a programming language.
+Considering the genericity of the `PowerStencil` framework, it is a bit difficult to define a strict scope for its usage. It's a bit like wondering what you could do with a programming language.
 
 Neverthless, I will give two short ideas that should open you mind to things you could do with it.
 

data/lib/power_stencil/version.rb

@@ -1,3 +1,3 @@
 module PowerStencil
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.3.3'.freeze
 end

data/power_stencil.gemspec

@@ -29,4 +29,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dir_glob_ignore', '~> 0.3'
   spec.add_dependency 'universe_compiler', '~> 0.2', '>= 0.2.11'
   spec.add_dependency 'pry'
+
+  spec.post_install_message = %Q{
+Thank you for installing PowerStencil #{PowerStencil::VERSION} !
+From the command line you can run `power_stencil --help`
+If your shell is not completing the command:
+  If you use rbenv: `rbenv rehash`
+  If you use zsh  : `rehash`
+
+Feel free to report issues: https://gitlab.com/tools4devops/power_stencil/issues
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: power_stencil
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Laurent B.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-28 00:00:00.000000000 Z
+date: 2019-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -263,7 +263,10 @@ homepage: https://gitlab.com/tools4devops/power_stencil
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\nThank you for installing PowerStencil 0.3.3 !\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\nFeel free to
+  report issues: https://gitlab.com/tools4devops/power_stencil/issues\n  "
 rdoc_options: []
 require_paths:
 - lib