lono 4.0.2 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9b91cb687fe123c8805a6d17b6ac8e9fa4d7c127bdbf1ec0269c4b59e602853
-  data.tar.gz: ebb6686fce572346f786a3c1c25aeaa6973ecfd07394678743293c0ddb86b2b1
+  metadata.gz: 8ba5e18a4dfb8c1e380410585608cb85e2c99337337b99c4c65f507641286017
+  data.tar.gz: c98670aa02f8cae8b814cb10b0db1f4c250c82d5a4938d214e27694fba8efca6
 SHA512:
-  metadata.gz: 38c0b1c0c9e64e2e64ef1d0410507f7cb1ed6ac3a4bb53ca2a55366291032a887788cfe41eb4f629752e5aecb14b8b952d35ed45920ce371446cfd251ae53f2a
-  data.tar.gz: bad9f02a40e9d06712aacdd6173811f7b97d1c9e96a385f7cc85c823e235264bcacc30413997889619dc76465b2a389dd343edade4a844ef4ad15b032c2dccfa
+  metadata.gz: c03529f77875e6b7959c50cd7b8d5980829dbd4d9dbdab08972ca68b90a51d28f86184612853bf63c96fb2f30bf3e4723d526b7d0a81c8ca65c5901425ab80f2
+  data.tar.gz: 3b0e254cea2dce5f9f2b10157afb4262fadec5a6695ed66fc50127bed025cfc7d615c2879fdf3801edc8c63d7f6fb3f2ba79cff50cd571b96bb752587f62df23

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [4.0.3]
+- update cli docs
+- make `--name` option for lono import optional
+- simplified template_params helper return structure
+
 ## [4.0.2]
 - update cli docs
 

data/lib/lono/cli.rb

@@ -9,13 +9,14 @@ module Lono
 
     desc "import SOURCE", "Imports CloudFormation template and lono-fies it."
     long_desc Help.text(:import)
-    option :name, required: true, default: nil, desc: "final name of downloaded template without extension"
+    option :name, default: nil, desc: "final name of downloaded template without extension"
+    option :casing, default: "dasherize", desc: "camelcase or dasherize the template name"
     option :summary, default: true, type: :boolean, desc: "provide template summary after import"
     def import(source)
       Importer.new(source, options).run
     end
 
-    desc "generate", "Generate both CloudFormation templates and parameters files"
+    desc "generate", "Generate both CloudFormation templates and parameters files."
     long_desc Help.text(:generate)
     option :clean, type: :boolean, default: true, desc: "remove all output files before generating"
     option :quiet, type: :boolean, desc: "silence the output"
@@ -26,7 +27,7 @@ module Lono
       Param::Generator.generate_all(options)
     end
 
-    desc "user_data NAME", "Generates user_data script for debugging"
+    desc "user_data NAME", "Generates user_data script for debugging."
     long_desc Help.text(:user_data)
     option :clean, type: :boolean, default: true, desc: "remove all output/user_data files before generating"
     def user_data(name)
@@ -34,13 +35,13 @@ module Lono
       UserData.new(options.merge(name: name)).generate
     end
 
-    desc "summary STACK", "Prints summary of CloudFormation template"
+    desc "summary STACK", "Prints summary of CloudFormation template."
     long_desc Help.text("summary")
     def summary(name)
       Lono::Inspector::Summary.new(name, options).run
     end
 
-    desc "xgraph STACK", "Graphs dependencies tree of CloudFormation template resources"
+    desc "xgraph STACK", "Graphs dependencies tree of CloudFormation template resources."
     long_desc Help.text("xgraph")
     option :display, type: :string, desc: "graph or text", default: "graph"
     option :noop, type: :boolean, desc: "noop mode"
@@ -48,18 +49,18 @@ module Lono
       Lono::Inspector::Graph.new(name, options).run
     end
 
-    desc "clean", "Clean up generated files in `output` folder."
+    desc "clean", "Removes `output` folder."
     def clean
       Clean.new(options).run
     end
 
-    desc "completion *PARAMS", "prints words for auto-completion"
+    desc "completion *PARAMS", "Prints words for auto-completion."
     long_desc Help.text("completion")
     def completion(*params)
       Completer.new(CLI, *params).run
     end
 
-    desc "completion_script", "generates script that can be eval to setup auto-completion"
+    desc "completion_script", "Generates a script that can be eval to setup auto-completion."
     long_desc Help.text("completion_script")
     def completion_script
       Completer::Script.generate

data/lib/lono/help/cfn/preview.md

@@ -20,7 +20,7 @@ The preview includes colors:
 
 <img src="/img/reference/lono-cfn-preview.png" alt="Stack Update" class="doc-photo">
 
-Notice that before the update gets performed lono provides a preview of the changes that are about to take place. There are two types of "diffs" in the preview.
+There are two types of "diffs" in the preview.
 
 1. Source code diff of the templates. This is generated by downloading the current CloudFormation template and comparing it with the locally generated one using `colordiff`.
 2. CloudFormation Change Set list of changes. This is generated using [AWS CloudFormation Change Set](https://medium.com/boltops/a-simple-introduction-to-cloudformation-part-4-change-sets-dry-run-mode-c14e41dfeab7) feature.

data/lib/lono/help/cfn/update.md

@@ -1,5 +1,32 @@
 ## Examples
 
+Let's say we make a simple change to a template, like changing the default InstanceType from `t2.small` to `t2.micro`.  Here's what happens when you run `lono cfn update`
+
+```sh
+lono cfn update ec2
+```
+
+The output should look similiar to this:
+
+<img src="/img/tutorials/ec2/cfn-update-instance-type.png" alt="Stack Update" class="doc-photo">
+
+Notice that before the update gets performed lono provides a preview of the changes that are about to take place. There are two types of "diffs" in the preview.
+
+1. Source code diff of the templates. This is generated by downloading the current CloudFormation template and comparing it with the locally generated one using `colordiff`.
+2. CloudFormation Change Set list of changes. This is generated using [AWS CloudFormation Change Set](https://medium.com/boltops/a-simple-introduction-to-cloudformation-part-4-change-sets-dry-run-mode-c14e41dfeab7) feature.
+
+You are prompted with an "Are you sure?" confirmation before lono continues.
+
+By default, the update command will display a preview of the stack changes before applying the update and prompt to check if you are sure.  If you want to bypass the are you sure prompt, use the `--sure` option.
+
+```
+lono cfn update ec2 --sure
+```
+
+## Conventions: template and param
+
+Lono follows some [coventions](http://lono.cloud/docs/conventions/) that helps keep the commands short.  We'll go through an example to explain:
+
 Provided that you are in a lono project and have a `my-stack` lono template definition.  To update a stack you can simply run:
 
   lono cfn update my-stack

data/lib/lono/help/completion.md

@@ -12,7 +12,7 @@ Prints words for TAB auto-completion.
 
 To enable, TAB auto-completion add the following to your profile:
 
-  eval $(lono completion script)
+  eval $(lono completion_script)
 
 Auto-completion example usage:
 

data/lib/lono/help/completion_script.md

@@ -1,3 +1,3 @@
 To use, add the following to your `~/.bashrc` or `~/.profile`:
 
-    eval $(lono completion script)
+    eval $(lono completion_script)

data/lib/lono/help/import.md

@@ -1,8 +1,8 @@
 ## Examples
 
-    lono import /path/to/file
-    lono import http://url.com/path/to/template.json
-    lono import http://url.com/path/to/template.yml
+    lono import /path/to/file --name my-stack
+    lono import http://url.com/path/to/template.json --name my-stack
+    lono import http://url.com/path/to/template.yml --name my-stack
 
 ## Example Output
 
@@ -25,3 +25,30 @@
     Here are contents of the params config/params/base/ec2.txt file:
     KeyName=
     #InstanceType=        # optional
+
+### Template name: CamelCase or dasherize
+
+If you do not specify the `--name` option, `lono import` sets a name based on the filename of the imported file.  It converts the name to a dasherize version of the filename by default.
+
+You can specify whether or not to CamelCase or dasherize the name of the final template file with the `--casing` option.  Examples:
+
+Dasherize:
+
+```sh
+lono import https://s3.amazonaws.com/cloudformation-templates-us-east-1/EC2InstanceWithSecurityGroupSample.template --casing dasherize
+```
+
+CamelCase:
+
+```sh
+lono import https://s3.amazonaws.com/cloudformation-templates-us-east-1/EC2InstanceWithSecurityGroupSample.template --casing camelcase
+```
+
+The default is dasherize.
+
+Question: You might be wondering, why does lono import has dasherize vs underscore?
+
+Answer: I prefer filenames to be underscore. However, CloudFormation stack names do not allow underscores in their naming, so it is encourage to either dasherize or camelize your template names so the stack name and the template name can be the same.
+
+This blog post [Introducing the lono import Command](https://blog.boltops.com/2017/09/15/introducing-the-lono-import-command) also covers `lono import`.
+

data/lib/lono/help/summary.md

@@ -1,4 +1,4 @@
-Lono inspect is provides commands to help you quickly understand a CloudFormation template.
+The `lono summary` command helps you quickly understand a CloudFormation template.
 
 ## Examples
 
@@ -16,4 +16,4 @@ Lono inspect is provides commands to help you quickly understand a CloudFormatio
       2 Total
     $
 
-Blog Post also covers this: [lono inspect summary Tutorial Introduction](https://blog.boltops.com/2017/09/18/lono-inspect-summary-tutorial-introduction)
+Blog Post also covers this: [lono summary Tutorial Introduction](https://blog.boltops.com/2017/09/18/lono-inspect-summary-tutorial-introduction)

data/lib/lono/help/user_data.md

@@ -13,7 +13,7 @@ Script:
     SCRIPTS=/opt/scripts
     $SCRIPTS/install_stuff.sh
 
-Running `ono user_data bootstrap` produces:
+Running `lono user_data bootstrap` produces:
 
     $ lono user_data bootstrap
     Detected app/scripts

data/lib/lono/help/xgraph.md

@@ -1,9 +1,9 @@
 ## Example
 
-With more complex CloudFormation templates, the dependency get more difficult to follow.  Visualizing the dependencies is helpful.
+With more complex CloudFormation templates, the dependency can get difficult to follow.  Visualizing the dependencies is helpful.
 
     lono import https://s3.amazonaws.com/solutions-reference/aws-waf-security-automations/latest/aws-waf-security-automations.template --name waf
-    lono inspect depends waf
+    lono xgraph waf
 
 This above command generates a dependency chart.  The command uses the DependsOn attribute specified in each resource to figure this out.  It does not show implied dependencies that CloudFormaton automatically computes for us.  The chart looks like this:
 

data/lib/lono/importer.rb

@@ -104,8 +104,6 @@ class Lono::Importer
   def template_name
     return @options[:name] if @options[:name]
     # Else infer name from the original source.
-    # Not really being used since --name is now required but leaving in place
-    # in case we decide to make --name optional again
     name = File.basename(@source, ".*")
     @options[:casing] == "camelcase" ? name.camelize : name.underscore.dasherize
   end

data/lib/lono/template/helper.rb

@@ -69,7 +69,11 @@ BASH_CODE
     }.merge(@options)
     generator = Lono::Param::Generator.new(param_name, generator_options)
     # do not generate because lono cfn calling logic already generated it we only need the values
-    generator.params    # Returns Array in underscore keys format
+    params = generator.params    # Returns Array in underscore keys format
+    # convert Array to simplified hash structure
+    params.inject({}) do |h, param|
+      h.merge(param[:parameter_key] => param[:parameter_value])
+    end
   end
 
   # Adjust the partial path so that it will use app/user_data

data/lib/lono/version.rb

@@ -1,3 +1,3 @@
 module Lono
-  VERSION = "4.0.2"
+  VERSION = "4.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.0.3
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-24 00:00:00.000000000 Z
+date: 2018-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport