mantra 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4c83562bb8a27496087aa37e7585c7b8732a2a4
-  data.tar.gz: 359689e95b93eddb73263abd1d9d95839a3353c3
+  metadata.gz: 4bde299aead3e479dcc120a2cac913f12db69610
+  data.tar.gz: 22b16fe9b31eb8254f5403c15d461b55a2ad38dc
 SHA512:
-  metadata.gz: aefe2b31df347529fbb9fcc28e53f8046f87587aea529f5b4fb9d790e22f52cadd33c185ba319eb1bb7404de0f14d6a89ec3c6e9c7bb9453979ab13f84750330
-  data.tar.gz: 34ed3e362bb454af43997aec1e06fd5de3b226687cc90d1187adde4a6e10326ba01cb03e63474ebbb9d7310fedea0e82d859e6dc9f779975eb9661a3d4a57834
+  metadata.gz: 3ca75ec86cd4208543bddc0e135dd59f6fb280cdb02341fd2ea17b81a8b1dda76f3b6b67af7d83c2a55a7872d9c66042acb585313fcfa655004394d0e83bf8f2
+  data.tar.gz: d6dd4ec38e35a77849248c1edf9e7711ee9ffb089172edaa11b90026a752f34ca2bf9c18a7412c716ba4c8e18aa9efa3f4ea3a6481bbe980e904c99bec7d7f50

data/README.md

@@ -24,12 +24,25 @@ Mantra tends to be an easily extendable tool, so you can add new commands and tr
 
 While some actions performed on manifest can be automated, anther require special configuration and extra knowledges about source manifes. Here is a small glossery that I use:
 
-`Transformation Manifest` - config file that describes how your manifest should be udpated
+`Transformation Manifest` - config file that describes how your manifest should be udpated.
+
 `Source Manifest` - your source BOSH manifest, if you run templatizers on source manifest they can change it.
+
 `Target Manifest` - manifest that will contain extracted template properties, to restore source manifest you'll need to run merge tool with resulting source manifest.
+
 `Transform` - a ruby class that declares how specific transformation should be done.
 
-One more concept: no nokogiri and native dependencies.
+One more concept: **no nokogiri and native dependencies**.
+
+### Dependencies
+
+Ruby.
+
+### How to install
+
+```
+gem install mantra
+```
 
 ### Examples
 

data/bin/mantra

@@ -2,16 +2,24 @@
 
 $LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
 require "mantra"
+include Mantra::Helpers
 
-if ARGV.empty?
+if ARGV.empty? || ARGV.first == "-h" || ARGV.first == "--help"
   puts Mantra::Command.usage
   exit 0
 end
 
-command_type = ARGV.shift
-options = {type: command_type.to_sym, args: ARGV}
+command_name = ARGV.shift
+options = {type: command_name.to_sym, args: ARGV}
+
+begin
+  command = Mantra::Command.create(options)
+  command.run
+rescue ObjectWithType::UnknownType, ObjectWithType::UnspecifiedType
+  puts "Error: Unknown command '#{command_name}', see command usage\n\n"
+  puts Mantra::Command.usage
+  exit 1
+end
 
-command = Mantra::Command.create(options)
 
-command.run
 

data/lib/mantra/command.rb

@@ -9,8 +9,22 @@ module Mantra
     end
 
     def self.usage
-      "\n\tUsage:  \tmantra <action> [options]\n" +
-      "\tactions:\t#{self.subclasses.map { |s| s.type }.join(", ")}\n\n"
+      "Mantra is Manifest Transformation tool to ease work with BOSH manifest.\n" +
+      "\nUsage:\tmantra <command> [options]" +
+      "\n\nCommands:\n" + 
+      self.subclasses.map { |s| "#{" "*6}#{s.type}#{" "*20}\t#{s.description}" }.join("\n") +
+      "\n\n" +
+      "For help on any command run:\n" +
+      ["mantra <command> -h", "mantra <command> help", "mantra <command> --help"].map { |s| " " * 6 + s }.join("\n") +
+      "\n\n"
+    end
+
+    def self.description(description=nil)
+      description.nil? ? full_description : (@description = description)
+    end
+
+    def self.full_description
+      [@description, aliases.empty? ? nil : "(aliases: #{aliases.join(", ")})"].compact.join(" ")
     end
 
     def self.option(name, long_option, short_option, description)
@@ -33,7 +47,7 @@ module Mantra
     def parse_options
       @options = {}
       OptionParser.new do |options_parser|
-        options_parser.banner = "Usage: mantra #{} [options]"
+        options_parser.banner = "Usage: mantra [options]"
         self.class.option_descriptors.each do |option|
           option_name = option.shift.to_s
           options_parser.on(*option) do |value|
@@ -50,3 +64,7 @@ end
 require "mantra/commands/find"
 require "mantra/commands/merge"
 require "mantra/commands/transform"
+require "mantra/commands/highlight"
+require "mantra/commands/render_release_template"
+require "mantra/commands/detect_certificates"
+require "mantra/commands/help"

data/lib/mantra/commands/detect_certificates.rb

@@ -0,0 +1,17 @@
+module Mantra
+  class Commands
+    class DetectCertificates < Command
+      type :"detect-certificates"
+      aliases "certs", "dc"
+      description "Find and group certificates in manifest"
+
+      option :manifest,    "--manifest manifest-file", "-m manifest-file", "manifest file"
+
+      def perform
+        m = Manifest.new(manifest)
+        raise "Not implemented yet"
+      end
+
+    end
+  end
+end

data/lib/mantra/commands/find.rb

@@ -5,7 +5,9 @@ module Mantra
   class Commands
     class Find < Command
       type :find
-      alias_type :f
+      aliases :f
+      description "Transform manifest using transform config"
+
       option :scope,       "--scope scope-path",       "-s scope",         "path scope you want to find"
       option :manifest,    "--manifest manifest-file", "-m manifest-file", "manifest"
       option :format,      "--format format",          "-f format",        "format (yaml or json)"

data/lib/mantra/commands/help.rb

@@ -0,0 +1,17 @@
+require "yaml"
+require "json"
+
+module Mantra
+  class Commands
+    class Help < Command
+      type :help
+      description "Print help message"
+
+      def perform
+        puts Mantra::Command.usage
+        exit 0        
+      end
+
+    end
+  end
+end

data/lib/mantra/commands/highlight.rb

@@ -0,0 +1,23 @@
+require "yaml"
+require "json"
+
+module Mantra
+  class Commands
+    class Highlight < Command
+      type :highlight
+      aliases :h
+      description "Highlight manifest path or values"
+
+      option :scope,       "--scope scope-path",       "-s scope",         "path scope you want to highlight"
+      option :value,       "--value value",            "-v value",         "value to highlight"
+      option :regex,       "--regex value",            "-r regex",         "regex of value to highlight"
+      option :manifest,    "--manifest manifest-file", "-m manifest-file", "manifest file"
+
+      def perform
+        m = Manifest.new(manifest)
+        raise "Not implemented yet"
+      end
+
+    end
+  end
+end

data/lib/mantra/commands/merge.rb

@@ -5,14 +5,17 @@ module Mantra
   class Commands
     class Merge < Command
       type :merge
-      alias_type :m
-      attr_accessor :manifest
-
-      option :json,          "--json JSON_STRING",  "-j", "json in text format"
-      option :file,          "--file JSON_FILE",    "-f", "File that should be merged to the manifest (not implemented)"
+      aliases :m
+      description "Merge object to manifest to specified path"
+      
+      option :json,          "--json JSON_STRING",  "-j", "String with JSON object that should be merged to the manifest"
+      option :file,          "--file JSON_FILE",    "-f", "JSON file that should be merged to the manifest"
+      option :yaml_file,     "--yaml YAML_FILE",    "-y", "File that should be merged to the manifest (not implemented)"
       option :path,          "--scope PATH",        "-s", "Scope (or path) in Manifest where to merge this value"
       option :manifest_path, "--manifest MANIFEST", "-m", "Manifest path"
 
+      attr_accessor :manifest
+      
       def perform
         if json.nil? && file.nil?
           raise "json of file should be specified"

data/lib/mantra/commands/render_release_template.rb

@@ -0,0 +1,23 @@
+require "yaml"
+require "json"
+
+module Mantra
+  class Commands
+    class RenderReleaseTemplate < Command
+      type :"render-release-template"
+      aliases "render-template", "rt", "rrt"
+      description "Transform manifest using transform config"
+
+      option :release_folder, "--release-folder release-folder", "-r scope",         "path scope you want to find"
+      option :template_name,  "--template template-path",        "-m manifest-file", "manifest"
+      option :context,        "--context format",                 "-f format",        "format (yaml or json)"
+      option :context_file,   "--context-file",                   "-p",               "format (yaml or json)"
+
+      def perform
+      	# see this gist: https://gist.github.com/allomov/c2e7780384674fa85486cc3c3f6bf54f
+        raise "Not implemented yet"
+      end
+
+    end
+  end
+end

data/lib/mantra/commands/transform.rb

@@ -4,12 +4,14 @@ module Mantra
   class Commands
     class Transform < Command
       type :transform
-      alias_type :t
-      attr_accessor :manifest
+      aliases :t
+      description "Transform manifest using transform config"
 
       option :transform_config_path, "--config CONFIG",     "-t", "Transformation config path"
       option :manifest_path,         "--manifest MANIFEST", "-m", "Manifest path"
 
+      attr_accessor :manifest
+
       def transform_config
         @transform_config ||= YAML.load_file(transform_config_path)
       end

data/lib/mantra/helpers/object_with_type.rb

@@ -15,8 +15,13 @@ module Mantra
           type.nil? ? @type : (@type = type.to_sym)
         end
 
-        def alias_type(alias_type=nil)
-          alias_type.nil? ? @alias_type : (@alias_type = alias_type.to_sym)
+        def alias_type(alias_type)
+          aliases(alias_type)
+        end
+
+        def aliases(*args)
+          @aliases = [] if @aliases.nil?
+          args.empty? ? @aliases : (@aliases.concat(args.map {|a| a.to_sym }))
         end
 
         def create(options)
@@ -31,7 +36,7 @@ module Mantra
         end
 
         def find_by_type(type)
-          self.subclasses.find { |s| s.type == type || s.alias_type == type }
+          self.subclasses.find { |s| s.type == type || s.aliases.include?(type) }
         end
 
         def inherited(subclass)

data/lib/mantra/version.rb

@@ -1,3 +1,3 @@
 module Mantra
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mantra
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Alexander Lomov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-12 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -120,8 +120,12 @@ files:
 - lib/mantra/certificates/cortege.rb
 - lib/mantra/certificates/group.rb
 - lib/mantra/command.rb
+- lib/mantra/commands/detect_certificates.rb
 - lib/mantra/commands/find.rb
+- lib/mantra/commands/help.rb
+- lib/mantra/commands/highlight.rb
 - lib/mantra/commands/merge.rb
+- lib/mantra/commands/render_release_template.rb
 - lib/mantra/commands/transform.rb
 - lib/mantra/helpers/object_with_type.rb
 - lib/mantra/helpers/regexp_helper.rb