aws-must 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8326b8dfa72e7fea5dc9d0b4f20d7f02e2071f50
-  data.tar.gz: 7c2ea2b9ad369395c758e60e1bd655e4c32225be
+  metadata.gz: b5cbfe13a7f701b92bdb2bb092716c9ad6a58403
+  data.tar.gz: ce6ebf729e31b5d0a66294ced5060365fda6ebab
 SHA512:
-  metadata.gz: 231f3f0d6c8ae16b2cbe73bdbc5a84004c167c2a622c2a69c65338502fc16311545108994c7bb69b8a78fc82c1b1eea538ed73ea56b2872f7b10fa68a1ffe22a
-  data.tar.gz: 5990bcc8e7bcd562356d4c99edce55530458086066cad26900c7e41c0c280cc17058c7ae72b19c89119aeae5e66df667dc6e4bf792ffd971b752d05191b94e9b
+  metadata.gz: 1d62abc49a43f6347439054009544963440daf46159f37b1a8413a9b91de1271909b291dd4599f7d5f811a39cb6de24ac45794fbc2b142cdc306ef8b265687eb
+  data.tar.gz: 5952680e1bd12a74c3f6e427351cb0f5c0ec8a61c9b329e44b7f5f8899fd5f6fbae9d65476074ddb002b116f8c26f165fd521ea85cd1f49088d211339eeb2756

data/README.md

@@ -1,4 +1,4 @@
-# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.6$
+# aws-must - Minimum Viable Solution to Manage CloudFormation Templates - $Release:0.0.7$
 
 `aws-must` is a tool, which allows separating infrastructure
 configuration and Amazon related syntax in CloudFormation JSON
@@ -78,7 +78,6 @@ Add following lines to `Gemfile`
     source 'https://rubygems.org'
 	gem 'aws-must'
 
-
 and run
 
 	bundle install
@@ -99,11 +98,18 @@ template `./mustache/root.mustache` issue the command
 
 	aws-must.rb gen yaml_file
 
-To extract documentation between **++start++** and
-**++close++** -tags starting with template
-`./mustache/root.mustache`, issue the command
+To extract documentation from template `./mustache/root.mustache`,
+issue the command
 
 	aws-must.rb doc 
+	
+
+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
+
+	aws-must.rb help doc 
 
 To dump YAML `yaml_file` in JSON format
 

data/bin/aws-must.rb

@@ -8,8 +8,17 @@ class App < Thor
 
   include Utils::MyLogger     # mix logger
   PROGNAME = "main"           # logger progname
+
+  # default values
+
   DEAFAULT_TEMPLATE="root"    # name of template in :template_path -directory
 
+  # DEFAUL_FOLD_ON="<!--*SED-MAGIC* <div class=window> -->"     # default output for +++fold-on+++ tag
+  # DEFAUL_FOLD_OFF="<!--*SED-MAGIC* </div>  -->"               # default output for +++fold-off+++ tag
+
+  # default output for +++fold-on+++ tag
+  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
 
   # ------------------------------------------------------------------
 
@@ -26,12 +35,42 @@ class App < Thor
   :default => "mustache", 
   :desc => "Directory holding mustache templates"
 
+  option :fold_on, :aliases => "-n", :type => :string, 
+  :default => DEFAUL_FOLD_ON, 
+  :desc => "Output for +++fold-on+++ tag"
+
+  option :fold_off, :aliases => "-f", :type => :string, 
+  :default => DEFAUL_FOLD_OFF, 
+  :desc => "Output for +++fold-off+++ tag"
+
   long_desc <<-LONGDESC
 
-  Extract documation from <template_name> in ':template_path' -direcotory.
+  Extract documation from <template_name> in ':template_path' -directory.
 
   <template_name> defaults to '#{DEAFAULT_TEMPLATE}'
 
+
+  Documentation is extracted from lines surrounded by #{AwsMust::Docu::DEFAULT_OPEN_TAG} and #{AwsMust::Docu::DEFAULT_CLOSE_TAG} tags,
+  or by  #{AwsMust::Docu::DEFAULT_FOLD_ON_TAG} and  #{AwsMust::Docu::DEFAULT_FOLD_OFF_TAG} tags. 
+
+  Following rules apply:
+
+  - #{AwsMust::Docu::DEFAULT_OPEN_TAG},  #{AwsMust::Docu::DEFAULT_CLOSE_TAG} -tags: nothing is outputted for these lines
+
+  - #{AwsMust::Docu::DEFAULT_FOLD_ON_TAG} -tag: output text for --fold_on option (defaults '#{DEFAUL_FOLD_ON}')
+
+  - #{AwsMust::Docu::DEFAULT_FOLD_OFF_TAG} -tag: output text for --fold_off option (defaults '#{DEFAUL_FOLD_OFF}')
+
+
+  Defult fold_on and fold_off parameters implement CCS-toggle when using following css-code
+
+          /* CSS-support fold-on/fold-off toggle */\n
+          div.fold { width: 90%; padding: .42rem; border-radius: 5px;  margin: 1rem; }\n
+          div.fold div { height: 0px; margin: .2rem; overflow: hidden; }\n
+          div.toggle ~ div { height: 0px; margin: .2rem; overflow: hidden; }\n
+          input.toggle:checked ~ div { height: auto;color: white; background: #c6a24b;font-family: monospace;white-space: pre; }\n
+
+
 LONGDESC
 
   def doc( template_name=DEAFAULT_TEMPLATE )
@@ -52,7 +91,8 @@ LONGDESC
   'with_adjust' (yes/no)
 
   By default 'adjusts' data, i.e. adds property "_comma" with the
-  value "," to each sub document expect the last one in an array.
+  value "," to each sub document, expect the last sub-document is
+  adjusted with empty string "".
 
   The "_comma" -property helps in generating valid json arrays in
   mustache templates. For example, YAML construct

data/demo/1/root.mustache

@@ -8,6 +8,8 @@ only region `eu-central-1`. No ssh connection allowed by default.
 
 +++close+++
 }}
+
+
 {
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Description" : "A simple Amazon EC2 instance. Initial copy",
@@ -21,3 +23,4 @@ only region `eu-central-1`. No ssh connection allowed by default.
     }
   }
 }
+

data/demo/2/resources.mustache

@@ -2,7 +2,7 @@
 
     resources.mustache - fixed resources
 
-++start++
++++start+++
 
 ## <a id="resources.mustache"></a>resources.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -11,11 +11,12 @@ Create an EC2 with following fixed parameters
 * `ImageId` : "ami-00dae61d",
 * `InstanceType` : "t2.micro"
 
-++close++
++++close+++
 
 
 }}
 
+{{! +++fold-on+++ }}
 
     "MyEC2Instance" : {
       "Type" : "AWS::EC2::Instance",
@@ -23,4 +24,7 @@ Create an EC2 with following fixed parameters
         "ImageId" : "ami-00dae61d",
         "InstanceType" : "t2.micro"
       }
-    }
+    }
+
+
+{{! +++fold-off+++ }}

data/demo/2/root.mustache

@@ -5,7 +5,7 @@
 STYLE section
 ==================================================================
 
-++start++
++++start+++
 <style>
 h1 {
     color:blue; 
@@ -18,23 +18,41 @@ h2 {
 body {
     background-color: #b0c4de;
 } 
+/* Support fold-on/fold-off toggle */
+div.fold { 
+    width: 90%; padding: .42rem; border-radius: 5px;  margin: 1rem; 
+
+}
+div.fold div { 
+       height: 0px; margin: .2rem; overflow: hidden; 
+}
+div.toggle ~ div { height: 0px; margin: .2rem; overflow: hidden; }
+input.toggle:checked ~ div { 
+     height: auto;      
+     color: white; 
+     background: #c6a24b;
+     font-family: monospace;
+     white-space: pre; 
+}
 </style>
-++close++
++++close+++
 }}
 
 {{!
-++start++
++++start+++
 
 # <a id="top">aws-must demo 2 template</a>
 
 Create an EC2 with following fixed parnameters `ImageId`
 ("ami-00dae61d") and `InstanceType` ("t2.micro")
 
-> resources
 
-++close++
++++close+++
 }}
 
+
+{{! +++fold-on+++ }}
+
 {
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Description" : "{{description}}",
@@ -42,3 +60,21 @@ Create an EC2 with following fixed parnameters `ImageId`
     {{> resources }}
   }
 }
+
+{{! +++fold-off+++ }}
+
+{{! 
+
+==================================================================
+INCLUDED templates
+==================================================================
+
++++start+++
+
+> resources
+
++++close+++
+
+}}
+
+

data/demo/3/resource.mustache

@@ -2,7 +2,7 @@
 
     resource.mustache
 
-++start++
++++start+++
 
 ## <a id="resource.mustache"></a>resource.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -13,15 +13,14 @@ Dispatches resource sub-type templates based resource Type propertys
 * `Instance`: sub-document defining an EC instance
 
 
-**Actions**:
++++close+++
 
-* include <a href="#resourceInstance.mustache">resourceInstance.mustache</a> if `Instance` 
 
-> resourceInstance
-
-++close++
+}}
 
 
-}}
+{{! +++fold-on+++ }}
 
 {{# Instance }}{{> resourceInstance}}{{/ Instance }}
+
+{{! +++fold-off+++ }}

data/demo/3/resourceInstance.mustache

@@ -1,7 +1,7 @@
 {{!
 
 
-++start++
++++start+++
 
 ## <a id="resourceInstance.mustache"></a>resourceInstance.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -12,16 +12,13 @@ Create an EC2 instance
 * `Name`: name of the EC2 instance to create
 * `ImageId`: AIM id to create
 
-**Actions**:
 
-* **Name**:  `Name`
-* **Type**: 'AWS::EC2::Instance'
-* **ImageId**: `ImageId`
-
-++close++
++++close+++
 
 }}
 
+{{! +++fold-on+++ }}
+
 
     "{{Name}}" : {
       "Type" : "AWS::EC2::Instance",
@@ -30,3 +27,5 @@ Create an EC2 instance
         "InstanceType" : "{{InstanceType}}"
       }
     }{{_comma}}
+
+{{! +++fold-off+++ }}

data/demo/3/resources.mustache

@@ -1,12 +1,12 @@
 {{! 
 
-++start++
++++start+++
 
 ## resources.mustache
 
 Nothing created here
 
-++close++
++++close+++
 
 
 }}
@@ -24,4 +24,9 @@ Nothing created here
     }
 
 }}
+
+{{! +++fold-on+++ }}
+
     {{# resources }}{{> resource }}{{/ resources }}
+
+{{! +++fold-off+++ }}

data/demo/3/root.mustache

@@ -6,7 +6,7 @@
 STYLE section
 ==================================================================
 
-++start++
++++start+++
 
 <style>
 h1 {
@@ -24,16 +24,32 @@ h3 {
 body {
     background-color: #b0c4de;
 } 
+/* Support fold-on/fold-off toggle */
+div.fold { 
+    width: 90%; padding: .42rem; border-radius: 5px;  margin: 1rem; 
+
+}
+div.fold div { 
+       height: 0px; margin: .2rem; overflow: hidden; 
+}
+div.toggle ~ div { height: 0px; margin: .2rem; overflow: hidden; }
+input.toggle:checked ~ div { 
+     height: auto;      
+     color: white; 
+     background: #c6a24b;
+     font-family: monospace;
+     white-space: pre; 
+}
 </style>
 
-++close++
++++close+++
 
 
 ==================================================================
 CONTENT section
 ==================================================================
 
-++start++
++++start+++
 
 # <a id="top">aws-must demo 3 template</a>
 
@@ -65,33 +81,23 @@ each template, it
 * documents the attribute context e.g. `.` or `./resources/Instance`,
   and attributes references of the template
 
-* lists template actions, i.e.  output from template, or template
-  inclusion
+* checkbox to show template implementation
 
 ## <a id="root.mustache"></a>root.mustache <a class='navigator' href='#top'">[top]</a>
 
 
 Root template 
 
-
 **Attributes**: context= `.`
 
 * `description`: description for the CF template
 
-
-**Actions**:
-
-* **Description**: `description`
-* **include** <a href="#resources.mustache">resources.mustache</a>
-* **for** `resource` **in** `resource` **include** <a href="#resource.mustache">resource.mustache</a>
-
-> resources
-> resource
-
-++close++
++++close+++
 
 }}
 
+{{! +++fold-on+++ }}
+
 {
   "AWSTemplateFormatVersion" : "2010-09-09",
   "Description" : "{{description}}",
@@ -99,3 +105,22 @@ Root template
     {{> resources }}
   }
 }
+
+{{! +++fold-off+++ }}
+
+
+{{! 
+
+==================================================================
+INCLUDED templates
+==================================================================
+
++++start+++
+
+> resources
+> resource
+> resourceInstance
+
++++close+++
+
+}}

data/demo/4/output.mustache

@@ -1,7 +1,7 @@
 {{!
 
 
-++start++
++++start+++
 
 ## <a id="output.mustache"></a>output.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -18,18 +18,12 @@ Create one output entry to CloudFormation JSON output section
   * `Name`: name of the attribute
 
 
-
-**Actions**:
-
-* **Name**: `Name`
-* **Description**: `Description`
-* **Value**: **Ref** if `Ref`
-* **Value**: `Attr.Ref`, `Attr.Name` if `Attr`
-
-++close++
++++close+++
 
 }}
 
+{{! +++fold-on+++ }}
+
 
     "{{Name}}": {
       "Description" : "{{Description}}"
@@ -37,3 +31,5 @@ Create one output entry to CloudFormation JSON output section
       {{#Attr}}, "Value" : { "Fn::GetAtt" : [ "{{Ref}}", "{{Name}}" ] }{{/Attr}}
     }{{_comma}}
 
+
+{{! +++fold-off+++ }}

data/demo/4/resource.mustache

@@ -2,7 +2,7 @@
 
     resource.mustache
 
-++start++
++++start+++
 
 ## <a id="resource.mustache"></a>resource.mustache <a class='navigator' href='#top'">[top]</a>
 
@@ -12,16 +12,14 @@ Dispatches resource sub-type templates based resource Type propertys
 
 * `Instance`: sub-document defining an EC instance
 
-**Actions**:
-
-* include <a href="#resourceInstance.mustache">resourceInstance.mustache</a> if `Instance` 
-
-> resourceInstance
-
-++close++
++++close+++
 
 
 }}
 
+{{! +++fold-on+++ }}
+
 {{# Instance }}{{> resourceInstance}}{{/ Instance }}
 {{# InstanceSecurityGroup }}{{> resourceSecurityGroup}}{{/ InstanceSecurityGroup }}
+
+{{! +++fold-off+++ }}

data/demo/4/resourceInstance.mustache

@@ -1,7 +1,7 @@
 {{!
 
 
-++start++
++++start+++
 
 
 
@@ -14,18 +14,11 @@ Create an EC2 instance
 * `Name`: name of the EC2 instance to create
 * `InstanceType` : The instance type, such as t2.micro. 
 
-**Actions**:
-
-
-* **Name**:  `Name`
-* **Type**: 'AWS::EC2::Instance'
-* **ImageId**: `ImageId`
-* **SecurityGroups.Ref**: `SecurityGroup` if `SecurityGroup`
-
-++close++
++++close+++
 
 }}
 
+{{! +++fold-on+++ }}
 
     "{{Name}}" : {
       "Type" : "AWS::EC2::Instance",
@@ -34,4 +27,6 @@ Create an EC2 instance
         , "InstanceType" : "{{InstanceType}}"
         {{#SecurityGroup}}, "SecurityGroups" : [ { "Ref" : "{{SecurityGroup}}" } ]{{/SecurityGroup}}
       }
-    }{{_comma}}
+    }{{_comma}}
+
+{{! +++fold-off+++ }}

data/demo/4/resourceSecurityGroup.mustache

@@ -1,7 +1,7 @@
 {{!
 
 
-++start++
++++start+++
 
 
 ## <a id="resourceSecurityGroup.mustache"></a>resourceSecurityGroup.mustache <a class='navigator' href='#top'">[top]</a>
@@ -13,16 +13,12 @@ Create an EC2 Security Group
 * `Name` : of the security group
 * `IngressCidrIp`: CIDR for to inbound traffic (ingress)
 
-**Actions**:
-
-* **Name**:  `Name`
-* **Type**: "AWS::EC2::SecurityGroup"
-* **Properties.SecurityGroupIngress[0].CidrIp**: `IngressCidrIp`
-
-++close++
++++close+++
 
 }}
 
+{{! +++fold-on+++ }}
+
     "{{Name}}" : {
       "Type" : "AWS::EC2::SecurityGroup",
       "Properties" : {
@@ -35,3 +31,5 @@ Create an EC2 Security Group
         } ]
       }
     }{{_comma}}
+
+{{! +++fold-off+++ }}

data/demo/4/resources.mustache

@@ -1,15 +1,17 @@
 {{! 
 
-++start++
++++start+++
 
 ## resources.mustache
 
 Nothing created here
 
-++close++
-
++++close+++
 
 }}
+
+{{! +++fold-on+++ }}
+
 {{! 
 
     Moved to YAML
@@ -22,4 +24,6 @@ Nothing created here
       }
     }
 
-}}
+}}
+
+{{! +++fold-off+++ }}