aws-must 0.0.7 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5cbfe13a7f701b92bdb2bb092716c9ad6a58403
-  data.tar.gz: ce6ebf729e31b5d0a66294ced5060365fda6ebab
+  metadata.gz: 2c24b20220f2f8c9469ed37c1521f47945b33abf
+  data.tar.gz: 555fea1c14b4f38f29db7d46b7f6346ee61006f1
 SHA512:
-  metadata.gz: 1d62abc49a43f6347439054009544963440daf46159f37b1a8413a9b91de1271909b291dd4599f7d5f811a39cb6de24ac45794fbc2b142cdc306ef8b265687eb
-  data.tar.gz: 5952680e1bd12a74c3f6e427351cb0f5c0ec8a61c9b329e44b7f5f8899fd5f6fbae9d65476074ddb002b116f8c26f165fd521ea85cd1f49088d211339eeb2756
+  metadata.gz: 15bf6f675da9078c230ade99c7e5975aedf8912948c8b22335fa14b58b68353172475457dd8a91f65960198534e3628d9c468e5f64634a7935bc32325425ed3a
+  data.tar.gz: 755034b30c68c6f4245cddfd1b8eb89fb203d747ce671037d5daa78ea8591544f2d96a7fcf94b4d691216281aea2df78bc5ef1e40dc0d5a978a0024f90dd670b

data/README.md

@@ -1,4 +1,4 @@
-# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.7$
+# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.10$
 
 `aws-must` is a tool, which allows separating infrastructure
 configuration and Amazon related syntax in CloudFormation JSON
@@ -98,16 +98,38 @@ template `./mustache/root.mustache` issue the command
 
 	aws-must.rb gen yaml_file
 
-To extract documentation from template `./mustache/root.mustache`,
+The path of Mustache templates can be changed using `-t` option, or by
+giving the name of a gem with a `-g` option. For example, to use the
+latest version of
+[aws-must-templates](https://github.com/jarjuk/aws-must-templates),
+use the command
+
+	aws-must.rb gen yaml_file -g aws-must-templates
+
+The version constraint for the gem can be specified followed by a
+comma -character. For example, to use version specification `~>0.0.1`,
 issue the command
 
+	aws-must.rb gen yaml_file -g 'aws-must-templates,~>0.0.1'
+
+To extract documentation for the templates
+
 	aws-must.rb doc 
-	
+
+The documentation command supports the same `-t` and `-g` options, as
+the `gen` -command.
 
 Documentation is extracted from lines surrounded by **+++start+++**
 and **+++close+++** tags, or by **+++fold-on+++** and
-**+++fold-off+++** tags. To see more information on how documentation
-is generated, issue the the command
+**+++fold-off+++** tags. Examples documents for
+[demo:html-7](https://rawgit.com/jarjuk/aws-must/master/generated-docs/7.html),
+[demo:html-6](https://rawgit.com/jarjuk/aws-must/master/generated-docs/6.html),
+[demo:html-5](https://rawgit.com/jarjuk/aws-must/master/generated-docs/5.html),
+[demo:html-4](https://rawgit.com/jarjuk/aws-must/master/generated-docs/4.html),
+and
+[demo:html-3](https://rawgit.com/jarjuk/aws-must/master/generated-docs/3.html).
+To see more information on how documentation is generated, issue the
+the command
 
 	aws-must.rb help doc 
 
@@ -242,6 +264,6 @@ See [RELEASES](RELEASES.md)
 MIT
 
 
-	 
+
 
 

data/bin/aws-must.rb

@@ -20,20 +20,53 @@ class App < Thor
   DEFAUL_FOLD_ON="<div class='fold'>Check to show template: <input type='checkbox' class='toggle'/><div>"
   DEFAUL_FOLD_OFF="</div></div>"                # default output for +++fold-off+++ tag
 
+  # ------------------------------------------------------------------
+  # make two thor tasks share options?
+  # http://stackoverflow.com/questions/14346285/how-to-make-two-thor-tasks-share-options
+
+  class << self
+    def add_shared_option(name, options = {})
+      @shared_options = {} if @shared_options.nil?
+      @shared_options[name] =  options
+    end
+
+    def shared_options(*option_names)
+      option_names.each do |option_name|
+        opt =  @shared_options[option_name]
+        raise "Tried to access shared option '#{option_name}' but it was not previously defined" if opt.nil?
+        option option_name, opt
+      end
+    end
+  end
+
+  def initialize(*args)
+    super
+    @logger = getLogger( PROGNAME, options )
+  end
+
   # ------------------------------------------------------------------
 
   class_option :log, :aliases => "-l", :type =>:string, :default => nil, 
   :enum => [ "DEBUG", "INFO", "WARN", "ERROR" ],
   :desc => "Set debug level "
 
+
+  # ------------------------------------------------------------------
+  add_shared_option :template_gem, :aliases => "-g", :type => :string,
+  :desc => "Mustache template Gem name (optionally with version constraint e.g. 'aws-must-templates,~>0.0.1')"
+
+  add_shared_option :template_path, :aliases => "-t", :type =>
+  :string, :default => "mustache", 
+  :desc => "Directory holding mustache templates"
+
+
   # ------------------------------------------------------------------
   # action 'doc'
 
   desc "doc", "Extract template documentation"
 
-  option :template_path, :aliases => "-t", :type => :string, 
-  :default => "mustache", 
-  :desc => "Directory holding mustache templates"
+  shared_options :template_path
+  shared_options :template_gem
 
   option :fold_on, :aliases => "-n", :type => :string, 
   :default => DEFAUL_FOLD_ON, 
@@ -75,7 +108,12 @@ LONGDESC
 
   def doc( template_name=DEAFAULT_TEMPLATE )
 
-    app = ::AwsMust::AwsMust.new( options )
+    @logger.info( "#{__FILE__}.#{__method__} starting" )
+
+    
+    my_options = option_adjust_common( options )
+
+    app = ::AwsMust::AwsMust.new( my_options )
     app.doc( template_name )
 
   end
@@ -135,14 +173,13 @@ LONGDESC
 
   desc "gen <yaml_file> [<template_name>]", "Generate CloudFormation JSON template"
 
-  option :template_path, :aliases => "-t", :type => :string, 
-  :default => "mustache", 
-  :desc => "Directory holding mustache templates"
+  shared_options :template_path
+  shared_options :template_gem
 
   long_desc <<-LONGDESC
 
   Generate Amazon CloudFormation JSON file for <yaml_file> using
-  <template_name> in ':template_path' -direcotory.
+  <template_name> in ':template_path' -directory.
 
   <template_name> defaults to '#{DEAFAULT_TEMPLATE}'
 
@@ -151,11 +188,60 @@ LONGDESC
 
   def gen( yaml_file, template_name=DEAFAULT_TEMPLATE )
 
-    app = ::AwsMust::AwsMust.new( options )
-    app.generate( template_name, yaml_file, options )
+    my_options = option_adjust_common( options )
+
+    app = ::AwsMust::AwsMust.new( my_options )
+    app.generate( template_name, yaml_file, my_options )
 
   end
 
+  # ------------------------------------------------------------------
+  # common routines
+  no_commands do
+
+    def option_adjust_common( options ) 
+
+      raise "No optios give" unless options
+      ret = options
+      ret = option_template_gem_to_template_path( options )  if options[:template_gem]
+      
+      return ret
+    end
+
+
+    def option_template_gem_to_template_path( options ) 
+
+      # The version requirements are optional.
+      # You can also specify multiple version requirements, just append more at the end
+      gem_spec = options[:template_gem].split(',')
+      gem_name, *gem_ver_reqs = gem_spec[0], gem_spec[1]
+      gdep = Gem::Dependency.new(gem_name, *gem_ver_reqs)
+      # find latest that satisifies
+      found_gspec = gdep.matching_specs.sort_by(&:version).last
+      # instead of using Gem::Dependency, you can also do:
+      # Gem::Specification.find_all_by_name(gem_name, *gem_ver_reqs)
+
+      if found_gspec
+        # unfreeze options
+        @logger.debug( "#{__FILE__}.#{__method__}, Requirement '#{gdep}' already satisfied by #{found_gspec.name}-#{found_gspec.version}" )
+        @logger.debug( "#{__FILE__}.#{__method__}, old-options=#{options}" )
+        options = options.dup
+        options[:template_path] = "#{found_gspec.gem_dir}/mustache"
+        @logger.debug( "#{__FILE__}.#{__method__}, new-options=#{options}" )
+      else
+        #puts "Requirement '#{gdep}' not satisfied; installing..."
+        # ver_args = gdep.requirements_list.map{|s| ['-v', s] }.flatten
+        # # multi-arg is safer, to avoid injection attacks
+        # system('gem', 'install', gem_name, *ver_args)
+        raise "Could not find gem '#{gdep}' - try 'gem install #{gdep}'"
+      end
+      
+      return options
+
+    end
+    
+  end # no commands
+
 end
 
 App.start

data/demo/0/root.mustache

@@ -1,3 +1,8 @@
+{{!
++++start+++
+Demo 0
++++close+++
+}}
 {
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Description" : "A simple Amazon EC2 instance. Initial copy",

data/demo/2.old/root.mustache

@@ -1,6 +1,7 @@
 {{!
 
-++start++
++++start+++
+
 
 <style>
 h1 {
@@ -66,7 +67,7 @@ each template, it
 * **Description**: `description`
 
 
-++close++
++++close+++
 
 }}
 

data/demo/5/root.mustache

@@ -176,7 +176,6 @@ INCLUDED templates
 > resources
 > resource
 > resourceInstance
-> resourceSecurityGroup
 > output
 
 +++close+++

data/lib/tasks/demo.rake

@@ -19,7 +19,7 @@ namespace "demo" do |ns|
 
   all_regions= ["ap-northeast-1", "ap-southeast-1", "ap-southeast-2", "cn-north-1", "eu-central-1", "eu-west-1", "sa-east-1", "us-east-1", "us-gov-west-1", "us-west-1", "us-west-2"] 
 
-  [ 
+  demos =   [ 
 
    { :id => "1", :desc=>"Initial copy", :region=>['eu-central-1'], :ssh => false },
    { :id => "2", :desc=>"Added 'description' property, Use resources.mustache -partial", :region=>['eu-central-1'], :ssh => false    },
@@ -29,8 +29,9 @@ namespace "demo" do |ns|
    { :id => "6", :desc=>"Create security group, and EC2 instances", :region=>all_regions, :ssh => true  },
    { :id => "7", :desc=>"Add support for installing Chef", :region=>all_regions, :ssh => true  },
 
+  ]
 
-  ].each do  |c|
+  demos.each do  |c|
 
     desc "Output CF template using configs in '#{demo_dir}/#{c[:id]}' to demonstrate '#{c[:desc]}'"
     task "template-#{c[:id]}" do
@@ -60,12 +61,22 @@ namespace "demo" do |ns|
       sh "aws cloudformation create-stack --stack-name #{stack}  --template-body \"$(#{cmd} gen -t #{demo_dir}/#{c[:id]} #{demo_dir}/#{c[:id]}/conf.yaml)\""
     end
 
-    desc "Open html documentation in 'browser' (default 'firefox')"
+    desc "Output html documentation for demo case #{c[:id]} to STDOUT"
+    task "doc-#{c[:id]}"  do |t,args|
+      # sh "#{cmd} doc -t #{demo_dir}/#{c[:id]} | markdown"
+      sh html_doc_to_stdout( cmd, demo_dir, c )
+    end
+
+
+    desc "Open html documentation for demo case #{c[:id]} in 'browser' (default 'firefox')"
     task "html-#{c[:id]}", :browser  do |t,args|
 
       args.with_defaults( browser: "firefox" )
 
-      sh "#{cmd} doc -t #{demo_dir}/#{c[:id]} | markdown | #{args.browser} \"data:text/html;base64,$(base64 -w 0 <&0)\""
+      # sh "#{cmd} doc -t #{demo_dir}/#{c[:id]} | markdown | #{args.browser} \"data:text/html;base64,$(base64 -w 0 <&0)\""
+      sh "#{html_doc_to_stdout( cmd, demo_dir, c )}  | #{args.browser} \"data:text/html;base64,$(base64 -w 0 <&0)\""
+
+
     end
 
 
@@ -99,6 +110,14 @@ namespace "demo" do |ns|
       }
 
     end
+    
+    # ------------------------------------------------------------------
+    # common methods
+
+    # sh-commnand pipelito to create mardown documentation for demo case c[:id]
+    def html_doc_to_stdout( cmd, demo_dir, c ) 
+      return "#{cmd} doc -t #{demo_dir}/#{c[:id]} | markdown"
+    end
 
 
   end

data/mustache/root.mustache

@@ -0,0 +1,18 @@
+{{! This is default template root.mustache 
+
++++start+++
+
+Text between start/close tags is outputted verbatim to standard output.
+
++++close+++
+
+}}
+
+{{! +++fold-on+++ }}
+
+Text between fold-on/fold-off tags is surrounded by string set by
+options 'fold_on' and 'fold_off'.
+
+Create your own template in file `mustache/root.mustache`
+
+{{! +++fold-off+++ }}

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: aws-must
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.10
 platform: ruby
 authors:
 - jarjuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-10 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.18.1
 description: |
   aws-must is a tool, which allows separating infrastructure
   configuration and Amazon related syntax using YAML and Mustache templates
@@ -91,6 +105,7 @@ files:
 - lib/tasks/demo.rake
 - lib/utils/hasher.rb
 - lib/utils/logger.rb
+- mustache/root.mustache
 homepage: 
 licenses:
 - MIT
@@ -101,9 +116,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="