power_stencil 0.3.0

data/etc/templates/plugin_definition/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/etc/templates/plugin_definition/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/etc/templates/plugin_definition/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.1

data/etc/templates/plugin_definition/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lbnetid+gh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/etc/templates/plugin_definition/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in <%= plugin_module_name %>.gemspec
+gemspec

data/etc/templates/plugin_definition/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Laurent B.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/etc/templates/plugin_definition/README.md

@@ -0,0 +1,43 @@
+# <%= plugin_module_name %>
+
+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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '<%= plugin_module_name %>'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install <%= plugin_module_name %>
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+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.
+
+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
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## 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).

data/etc/templates/plugin_definition/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/etc/templates/plugin_definition/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "<%= plugin_module_name %>"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/etc/templates/plugin_definition/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/etc/templates/plugin_definition/etc/command_line.yaml

@@ -0,0 +1,12 @@
+# This is an example
+# With this file, you can contribute to the power_stencil
+# command-line global semantic
+:subcommands:
+  <%= main_entry_point %>:
+    :banner: |
+      Does nothing useful
+      Added by plugin <%= plugin_name %>
+    :options:
+      hello:
+        :type: bool
+        :summary: Just a hello flag.

data/etc/templates/plugin_definition/etc/plugin_config.yaml

@@ -0,0 +1,4 @@
+# This config file provided by the plugin '<%= main_entry_point %>' will be
+# automatically merged into the global project config
+
+# :<%= plugin_name %>.property1: value 1

data/etc/templates/plugin_definition/etc/templates/.git_keep

@@ -0,0 +1 @@
+

data/etc/templates/plugin_definition/lib/{entity}.rb.erb

@@ -0,0 +1,34 @@
+require '<%= plugin_name %>/version'
+require '<%= plugin_name %>/plugin_helper'
+require '<%= plugin_name %>/<%= plugin_name %>_processor'
+
+module <%= plugin_module_name %>
+
+  extend PowerStencil::Utils::SecureRequire
+  extend <%= plugin_module_name %>::PluginHelper
+
+  REQUIRED_PLUGINS = []
+
+  def self.setup_processors
+    clm = PowerStencil.command_line_manager
+    clm.register_processor clm.command_by_alias('<%= main_entry_point %>'), <%= plugin_module_name %>::Processor.new
+  end
+
+  def self.setup_entity_definitions
+    PowerStencil.logger.info 'Setting up <%= main_entry_point %> plugin entities'
+    securely_require '<%= plugin_name %>/entity_definitions/<%= plugin_name %>_entity', fail_on_error: true
+  end
+
+  def self.setup_plugin_templates
+    Dir.entries(plugin_templates_path).reject { |e| %w(. ..).include? e }.each do |entry|
+      template_path = File.join(plugin_templates_path, entry)
+      if Dir.exist? template_path
+        PowerStencil.project.register_template_path_for_type entry.to_sym, template_path
+      end
+    end
+  end
+
+end
+
+# All plugins have to be in the PowerStencil::Plugin namespace !
+PowerStencil::Plugin::<%= plugin_module_name %> = <%= plugin_module_name %>

data/etc/templates/plugin_definition/lib/{entity}/entity_definitions/{entity}_entity.rb.erb

@@ -0,0 +1,11 @@
+module <%= plugin_module_name %>
+  module EntityDefinitions
+
+    class <%= plugin_module_name %>Entity < PowerStencil::SystemEntityDefinitions::ProjectEntity
+
+      entity_type :<%= plugin_name %>_entity
+
+    end
+
+  end
+end

data/etc/templates/plugin_definition/lib/{entity}/plugin_helper.rb.erb

@@ -0,0 +1,17 @@
+module <%= plugin_module_name %>
+  module PluginHelper
+
+    def plugin_templates_path
+      File.join plugin_root_path, 'etc', 'templates'
+    end
+
+    def command_line_definition_file_path
+      File.join plugin_root_path, 'etc', 'command_line.yaml'
+    end
+
+    def plugin_root_path
+      File.expand_path File.join('..', '..', '..'), __FILE__
+    end
+
+  end
+end

data/etc/templates/plugin_definition/lib/{entity}/version.rb.erb

@@ -0,0 +1,3 @@
+module <%= plugin_module_name %>
+  VERSION = '0.1.0'.freeze
+end

data/etc/templates/plugin_definition/lib/{entity}/{entity}_processor.rb.erb

@@ -0,0 +1,19 @@
+module <%= plugin_module_name %>
+
+  class Processor
+
+    include Climatic::Script::UnimplementedProcessor
+    include Climatic::Proxy
+    include PowerStencil::Project::Proxy
+
+
+    def execute
+      puts '<%= main_entry_point.upcase %> PLUGIN WAZ HERE'
+      puts_and_logs config[].to_yaml
+    end
+
+
+  end
+
+
+end

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

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '<%= plugin_name %>/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'psplugin_<%= plugin_name %>'
+  spec.version       = <%= plugin_module_name %>::VERSION
+  spec.authors       = ['Your name']
+  spec.email         = ['you@somewhere']
+
+  spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  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"
+
+  # 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.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'power_stencil', "~> #{<%= plugin_module_name %>::VERSION}"
+end

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

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "<%= plugin_module_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/templates/plugin_definition/spec/{entity}_spec.rb

@@ -0,0 +1,9 @@
+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
+    expect(false).to eq(true)
+  end
+end

data/etc/templates/project/.copy_ignore

@@ -0,0 +1,2 @@
+.copy_ignore
+**/.gitkeep

data/etc/templates/project/.gitignore.erb

@@ -0,0 +1,6 @@
+# Ignore power stencil generated files
+<%= File.join '', project_config[:project_build_root_directory_name]  %>
+# Ignore power stencil local entities created by developer
+<%= File.join '', project_config[:default_config_directory_name], project_config[:user_entities_directory_name]  %>
+# Ignore power stencil local developer's config
+<%= File.join '', project_config[:default_config_directory_name], project_config[:unversioned_user_project_config_file_name]  %>

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

@@ -0,0 +1,11 @@
+PowerStencil entities
+=====================
+
+
+In this directory, you will find all project entities.
+
+They are organized as `<entity_type>/<entity_name>.yaml`
+
+__It is strongly advised to keep this directory under source control__
+
+This should be the default PowerStencil behaviour. 

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

@@ -0,0 +1,15 @@
+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`
+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. 

data/etc/templates/project/.ps_project/personal-config.yaml

@@ -0,0 +1,8 @@
+# This file has been generated on the <%= Time.now %> by the power stencil framework (v: <%= PowerStencil::VERSION %>)
+# THIS FILE *IS NOT* MEANT TO BE VERSIONED (and is not by default)
+# You can use it for any configuration you want to keep local
+
+# debug
+:debug: false
+# :log-level: 2
+# :debug-on-stderr: true