power_stencil 0.3.1

data/etc/base_commands_definition.yml

@@ -0,0 +1,259 @@
+:options:
+  verbose:
+    :type: bool
+    :summary: Displays extra runtime information.
+    :global: true
+    :short_aliases:
+      - v
+  help:
+    :type: bool
+    :summary: Displays this help.
+    :global: true
+    :short_aliases:
+      - h
+  version:
+    :type: bool
+    :summary: Displays program version.
+    :short_aliases:
+      - V
+    :long_aliases:
+      - program-version
+  simulate:
+    :type: bool
+    :global: true
+    :summary: Will not perform actual actions
+  debug:
+    :type: bool
+    :summary: Debug mode
+    :global: true
+  debug-on-stderr:
+    :type: bool
+    :global: true
+    :summary: Sends debugging to SDTERR
+    :long_aliases:
+      - debug-on-err
+    :dependencies:
+      - debug
+    :incompatibilities:
+      - log-file
+  log-level:
+    :global: true
+    :dependencies:
+      - debug
+    :type: integer
+    :summary: Defines the level of logging (0 to 5)
+  log-file:
+    :global: true
+    :dependencies:
+      - debug
+    :incompatibilities:
+      - debug-on-stderr
+    :type: string
+    :summary: Specifies a file to log into
+  truncate-log-file:
+    :global: true
+    :dependencies:
+      - log-file
+    :type: bool
+    :summary: Truncates the log file (appends by default)
+  project-path:
+    :global: true
+    :type: string
+    :summary: Specifies a startup path to use instead of '.'
+  auto:
+    :global: true
+    :type: bool
+    :summary: Bypasses command-line confirmations to the user
+
+:banner: |
+  This is power_stencil. A powerful templating engine.
+
+:subcommands:
+  init:
+    :banner: |
+      Initializes a PowerStencil repository.
+
+      Usage:
+        init [project_path] [options]
+
+      Default is initializing the PowerStencil repository in current directory. If
+      specified, will initialize a repository in project_path (global option
+      project_path can be used too).
+    :options:
+      force:
+        :type: bool
+        :summary: Forces creation in an already existing directory.
+        :short_aliases:
+          - f
+  info:
+    :banner: |
+      Generic information about the repository.
+
+      Usage:
+        info [options]
+
+      Displays information about the repository.
+  new-plugin:
+    :banner: |
+      Generates the skeleton for a plugin.
+
+      Usage:
+        new-plugin [options]
+
+      Generates a fully working although useless plugin skeleton.
+  get:
+    :banner: |
+      Query entities from repository.
+
+      Usage:
+
+        get [entity_type[/ ]entity_name] [options]
+
+      Retrieves entities from the repostory. You can have multiple
+      criteria passed on the command line. either of the form
+      "type/name" or two consecutive parameters "type name". If in
+      "regexp" mode then each criterion is considered as a regular
+      expression (be careful, not a file pattern alike)
+    :options:
+      regexp: &REGEXPOPT
+        :type: bool
+        :summary: Parameters are considered as regular expressions.
+        :short_aliases:
+          - r
+        :long_aliases:
+          - regular-expression
+      names-only:
+        :type: bool
+        :summary: Only returns the name of the entities found.
+      compiled: &COMPILEDOPT
+        :type: bool
+        :summary: Entities as used by susbstitution engine.
+      scenario: &SCENARIOOPT
+        :type: string
+        :summary: Applies overrides defined for this scenario.
+        :dependencies:
+          - compiled
+      raw:
+        :type: bool
+        :summary: Displays entities as they are stored
+      graph:
+        :type: bool
+        :summary: Displays the query result as a graph.
+        :short_aliases:
+          - g
+  shell:
+    :banner: |
+      Opens a shell to interact with entities.
+
+      Usage:
+        shell [options]
+
+      Opens a Ruby "pry" shell with all entities loaded. You can modify
+      create, delete any entity from there.
+    :options:
+      compiled:
+        <<: *COMPILEDOPT
+      scenario:
+        <<: *SCENARIOOPT
+  check:
+    :banner: |
+      Check repository entities consistency.
+
+      Usage:
+
+        check [entity_type[[/ ]entity_name]] [options]
+
+      Check entities consistency. By default will check all entities.
+    :options:
+      regexp:
+        <<: *REGEXPOPT
+  create:
+    :banner: |
+      Creates entities in the repository.
+
+      Usage:
+
+        create entity_type[/ ]entity_name [options]
+
+      Creates repository entities. Both type and name have to be provided
+    :options:
+      property:
+        :type: array
+        :summary: Specifiies a first-level property for the entity
+        :short_aliases:
+          - p
+      edit:
+        :type: bool
+        :summary: Edits the newly created entity.
+        :short_aliases:
+          - e
+        :long_aliases:
+          - edit-after-create
+      editor:
+        :type: string
+        :summary: Specifies an editor to use.
+        :dependencies:
+          - edit
+      user:
+        :type: bool
+        :summary: Stores the entities as local user entities, ie non-versioned
+        :long_aliases:
+          - user-storage
+          - non-versioned
+        :short_aliases:
+          - u
+  edit:
+    :banner: |
+      Edit entities from repository.
+
+      Usage:
+
+        edit [object_type[[/ ]object_name]] [options]
+
+      Edits repository entities. Parameters are used the same way as in 'get'.
+    :options:
+      regexp: *REGEXPOPT
+      editor:
+        :type: string
+        :summary: Specifies an editor to use.
+        :short_aliases:
+          - e
+  delete:
+    :banner: |
+      Delete entities from repository.
+
+      Usage:
+
+        delete [object_type[[/ ]object_name]] [options]
+
+      Deletes repository entities. Parameters are used the same way as in 'get'.
+    :options:
+      regexp: *REGEXPOPT
+      delete-files:
+        :type: bool
+        :summary: Will also remove files related to the entity.
+  build:
+    :banner: |
+      Builds entities.
+
+      Usage:
+
+        build [entity_type[[/ ]entity_name]]+ [options]
+
+      Builds repository entities. Parameters are used the same way as in 'get'.
+    :options:
+      regexp: *REGEXPOPT
+      supported-builds:
+        :type: bool
+        :summary: Displays the list of supported builds
+        :short_aliases:
+          - s
+        :long_aliases:
+          - list
+      fail-on-error:
+        :type: bool
+        :summary: Fails at the first failure
+      parallelized:
+        :type: bool
+        :summary: Parallelizes builds if possible
+

data/etc/meta_templates/plugin_seed/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/meta_templates/plugin_seed/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/meta_templates/plugin_seed/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/meta_templates/plugin_seed/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/meta_templates/plugin_seed/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/meta_templates/plugin_seed/lib/{entity}/version.rb.erb

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

data/etc/meta_templates/plugin_seed/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/meta_templates/plugin_seed/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/power_stencil.yaml

@@ -0,0 +1,92 @@
+---
+# This file defines `power_stencil` executable defaults.
+# It can be overridden via various mechanisms (mainly coming from
+# the `climatic` gem), so system-wide config file, user config file,
+# executable config file, project config file or for some of the
+# properties directly from command line.
+
+
+# PROJECT PATHS
+
+# Default Power Stencil project configuration directory
+:default_config_directory_name: .ps_project
+# Ignore files for files/directory to completely skip in the process
+:ignore_filename_for_files_to_skip: .copy_ignore
+# Ignore files for files/directory to simply copy and apply no substitution
+:ignore_filename_for_files_to_copy: .subst_ignore
+# Ignore files for files/directory to simply copy and apply no renaming (see
+# below :file_renaming_patterns: for more info)
+:ignore_filename_for_files_to_rename: .rename_ignore
+# Versioned project config file name.
+:versioned_project_config_file_name: versioned-config.yaml
+# Non versioned user's personal project config file name.
+:unversioned_user_project_config_file_name: personal-config.yaml
+# Entity definitions specific to the project
+:project_entity_definitions_directory_name: entity_definitions
+# Templates specific to the project
+:project_templates_directory_name: templates-templates
+# Directory name where entities are stored
+:project_entities_directory_name: entities
+# Directory name where user (unversioned) entities are stored
+:user_entities_directory_name: user_entities
+# Directory name where repository plugins are stored
+:project_plugins_directory_name: plugins
+# Root directory where builds are generated
+:project_build_root_directory_name: build
+
+
+# DSL CUSTOMIZATIONS
+
+# Customizations for the shell. Basically defining various behaviors
+# of Pry which is the underlying REPL.
+:shell_dsl:
+  :prompt_level_1: 'PowerStencil DSL> '
+  :prompt_level_2: 'PowerStencil DSL --> '
+  :session_greetings: |
+    -------------------------------------------------------------------------------
+     Welcome to the PowerStencil shell session
+     In this shell you have access to anything the templating engine has access to.
+     You can view, edit, save entities.
+
+     - Retrieve and manipulate entities using the `entities` hash.
+     - Persist your changes using the `save` method on each entity.
+     - Create new project or user entities using `new_<type>` and `user_new_<type>`
+       methods (see `available_entity_types` for a list of possible types).
+     - And of course, it is a fully fledged Ruby Pry REPL, so you can do anything
+       you want...
+
+     Type `exit` to end your session.
+    -------------------------------------------------------------------------------
+
+
+
+# TEMPLATING ENGINE
+
+# Map to define which kind of template engine for which type of file. Be careful if you
+# overlap two definitions. Warning, it is ruby Regex not shell pattern !
+:templating_engines_map:
+  # Currently all files are rendered using ERB engine
+  :erb: '.*'
+
+# Files matching particular patterns can be changed on the fly
+:file_renaming_patterns:
+  # Erb files
+  ^(.+)\.erb$: '\1'
+
+
+# PLUGINS
+
+# Define the property to avoid a nil. It represents the plugins that are provided
+# as real Ruby gems. Local plugins defined in the `:project_plugins_directory_name:`
+# are automatically discovered and loaded.
+:project_plugins: []
+
+
+
+# MISC
+
+# Default log level (warn)
+:log-level: 2
+# Maximum number of retries when editing a file
+:max_file_edit_retry_times: 3
+