lono-params 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a5318c7d431c212dc1deb77a918fc3d3dcce2a5
-  data.tar.gz: 3bcb90dcdd5a5cce47000e9ab38544cee6876f4c
+  metadata.gz: 79469aa41beee128511ce61e2a880608b6bbfcba
+  data.tar.gz: 55ea002171278b9da58f5486b511361f345e5ef0
 SHA512:
-  metadata.gz: 307ac647c0ca743c1caed7c8c2d6d9b5dd934722e33b4cb1afb381e3938aaf39981f8f358dc7a51df31189615b90323ea141fce0d6794055d37d86ad231c6ad0
-  data.tar.gz: ef16cc69a1064537ff9ee2c9cc5356d821e8c2eae5b4af92fc8279da7d1b349ed4b806d09f6d7b5456668a8f4430c7ebf1f6679b00aa054ebfd704eb5383ee7e
+  metadata.gz: b993abd2ac3196ef75c4b9eb8df48191d456a58acc23604492dfffda439057a1c1fc798ef0376fdb12573ca5466912da64507171030964f3e3ca42324d5eb804
+  data.tar.gz: 97e53b3377f59aa3c754ede75d8d579778a037b73711c7a6016c26c87132cd599ff29c01a2783cadd1c9f9ea0ad63ac88efee58b61574f5efe106cdba1c7603a

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+
+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.
+
+## [0.0.4] Implement use_previous_value
+
+- Implement use_previous_value: will create a hash with UsePreviousValue key.
+- Allow trailing comment on the same line.
+
+## [0.0.1] Initial Release
+
+- Initial release.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lono-params (0.0.1)
+    lono-params (0.0.4)
       colorize
       hashie
       plissken

data/README.md

@@ -1,6 +1,30 @@
 # LonoParams
 
-Tool to generate a CloudFormation params json formatted file
+Tool to generate a CloudFormation params json formatted file from a simplier env like file.
+
+Given:
+
+```
+Param1=1
+Param2=1
+```
+
+This is produced:
+
+```json
+[
+  {
+    "ParameterKey": "Param1",
+    "ParameterValue": "1",
+    "UsePreviousValue": true
+  },
+  {
+    "ParameterKey": "Param2",
+    "ParameterValue": "1",
+    "UsePreviousValue": true
+  }
+]
+```
 
 ## Installation
 
@@ -21,10 +45,12 @@ Or install it yourself as:
 Create a directory under your project folder called `params`.  Then given, a file with params in a simple list format:
 
 ```
-$ cat params/my-stack.txt 
+$ cat params/my-stack.txt
+# comments are fine
 Param1=1
-Param2=1
-$ 
+Param2=2 # comments can go after the line too
+Param2=use_previous_value # treated specially
+$
 ```
 
 Generate the CloudFormation json file that can be used with the `aws cloudformation create-stack` command.
@@ -32,7 +58,7 @@ Generate the CloudFormation json file that can be used with the `aws cloudformat
 ```
 $ lono-params generate my-stack
 Params file generated for my-stack at ./params/my-stack.json
-$ 
+$
 ```
 
 This is what the `output/params/my-stack.json` file looks like:
@@ -41,12 +67,14 @@ This is what the `output/params/my-stack.json` file looks like:
 [
   {
     "ParameterKey": "Param1",
-    "ParameterValue": "1",
-    "UsePreviousValue": true
+    "ParameterValue": "1"
+  },
+  {
+    "ParameterKey": "Param2",
+    "ParameterValue": "2"
   },
   {
     "ParameterKey": "Param2",
-    "ParameterValue": "1",
     "UsePreviousValue": true
   }
 ]
@@ -55,43 +83,9 @@ This is what the `output/params/my-stack.json` file looks like:
 
 ## More Help
 
-
-<pre>
+```
 $ bin/lono-params help
-Commands:
-  lono-params generate NAME   # generate parameter json file for NAME
-  lono-params help [COMMAND]  # Describe available commands or one specific command
-
-Options:
-  [--verbose], [--no-verbose]    
-  [--noop], [--no-noop]          
-  [--project-root=PROJECT_ROOT]  # project root to use
-                                 # Default: .
-
-$ lono-params help generate
-/Users/tung/src/gitresolve/infra/lono/vendor/gems/lono-params/bin
-Usage:
-  lono-params generate NAME
-
-Options:
-  [--use-previous-value], [--no-use-previous-value]  
-                                                     # Default: true
-  [--verbose], [--no-verbose]                        
-  [--noop], [--no-noop]                              
-  [--project-root=PROJECT_ROOT]                      # project root to use
-                                                     # Default: .
-
-Description:
-  Example:
-
-  To generate a CloudFormation json file from params/my-stack.txt
-
-  $ lono-params generate my-stack
-
-  This will output a CloudFormation json file in output/params/my-stack.json
-$ 
-</pre>
-
+```
 ## Contributing
 
 1. Fork it

data/lib/lono_params/cli.rb

@@ -11,7 +11,6 @@ module LonoParams
     desc "generate NAME", "generate parameter json file for NAME"
     long_desc Help.generate
     option :path, desc: "Path of the source params txt file.  Use this to override the params/NAME.txt convention"
-    option :use_previous_value, type: :boolean, default: true
     def generate(name)
       Generator.new(name, options).generate
     end

data/lib/lono_params/generator.rb

@@ -13,7 +13,7 @@ module LonoParams
 
     def generate
       # useful option for lono-cfn
-      return if @options[:allow_blank] && !File.exist?(@source_path)
+      return if @options[:allow_no_file] && !File.exist?(@source_path)
 
       if File.exist?(@source_path)
         contents = IO.read(@source_path)
@@ -30,7 +30,7 @@ module LonoParams
     # useful for when calling CloudFormation via the aws-sdk gem
     def params
       # useful option for lono-cfn
-      return {} if @options[:allow_blank] && !File.exist?(@source_path)
+      return {} if @options[:allow_no_file] && !File.exist?(@source_path)
 
       contents = IO.read(@source_path)
       convert_to_cfn_format(contents, :underscore)
@@ -38,14 +38,12 @@ module LonoParams
 
     def parse_contents(contents)
       lines = contents.split("\n")
+      # remove comment at the end of the line
+      lines.map! { |l| l.sub(/#.*/,'').strip }
       # filter out commented lines
       lines = lines.reject { |l| l =~ /(^|\s)#/i }
       # filter out empty lines
       lines = lines.reject { |l| l.strip.empty? }
-
-      # looked into trying to remove the commnet at the end of the line but it looks like the reliably way to do that by breaking the line into a syntax tree?
-      # http://stackoverflow.com/questions/5865371/ruby-regex-for-finding-comments
-      # http://stackoverflow.com/questions/7330171/how-to-match-code-comment-with-regex-in-ruby
       lines
     end
 
@@ -54,11 +52,17 @@ module LonoParams
       params = []
       lines.each do |line|
         key,value = line.strip.split("=").map {|x| x.strip}
-        param = {
-          "ParameterKey": key,
-          "ParameterValue": value,
-          "UsePreviousValue": @options[:use_previous_value]
-        }
+        param = if value == "use_previous_value"
+                  {
+                    ParameterKey: key,
+                    UsePreviousValue: true
+                  }
+                else
+                  {
+                    ParameterKey: key,
+                    ParameterValue: value
+                  }
+                end
         param = param.to_snake_keys if casing == :underscore
         params << param
       end

data/lib/lono_params/version.rb

@@ -1,3 +1,3 @@
 module LonoParams
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/fixtures/my_project/params/my-stack.txt

@@ -1,2 +1,4 @@
+# comments are fine
 Param1=1
-Param2=1
+Param2=2 # comments can go after the line too
+Param2=use_previous_value # treated specially

data/spec/lib/cli_spec.rb

@@ -2,18 +2,38 @@ require 'spec_helper'
 
 # to run specs with what's remembered from vcr
 #   $ rake
-# 
+#
 # to run specs with new fresh data from aws api calls
 #   $ rake clean:vcr ; time rake
 describe LonoParams::CLI do
   before(:all) do
-    @args = "--project-root spec/fixtures/my_project"
+    @project_root = "spec/fixtures/my_project"
+    @args = "--project-root #{@project_root}"
   end
 
   describe "lono-params" do
-    it "should generate params" do
-      out = execute("bin/lono-params generate my-stack #{@args}")
-      expect(out).to include("Params file generated for my-stack")
+    context "generate" do
+      let(:output) { execute("bin/lono-params generate my-stack #{@args}") }
+      it "should generate output/params/my-stack.json params file" do
+        expect(output).to include("Params file generated for my-stack")
+        data = JSON.load(IO.read("#{@project_root}/output/params/my-stack.json"))
+        expect(data).to be_a(Array)
+      end
+
+      it "should treat use_previous_value as a special value" do
+        out = execute("bin/lono-params generate my-stack #{@args}")
+        expect(output).to include("Params file generated for my-stack")
+        data = JSON.load(IO.read("#{@project_root}/output/params/my-stack.json"))
+        param3 = data.last
+        expect(param3["UsePreviousValue"]).to be true
+      end
+
+      it "should remove comments" do
+        out = execute("bin/lono-params generate my-stack #{@args}")
+        expect(output).to include("Params file generated for my-stack")
+        data = JSON.load(IO.read("#{@project_root}/output/params/my-stack.json"))
+        expect(data.size).to eq 3
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lono-params
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tung Nguyen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-29 00:00:00.000000000 Z
+date: 2016-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -146,6 +146,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile
@@ -190,4 +191,3 @@ test_files:
 - spec/fixtures/my_project/params/my-stack.txt
 - spec/lib/cli_spec.rb
 - spec/spec_helper.rb
-has_rdoc: