cloudformation-ruby-dsl 0.4.5 → 0.4.6

data/README.md

@@ -1,18 +1,18 @@
 # cloudformation-ruby-dsl
 
-A Ruby DSL and helper utilities for building Cloudformation templates dynamically.
+A Ruby DSL and helper utilities for building CloudFormation templates dynamically.
 
 Written by [Bazaarvoice](http://www.bazaarvoice.com): see [the contributors page](https://github.com/bazaarvoice/cloudformation-ruby-dsl/graphs/contributors) and [the initial contributions](https://github.com/bazaarvoice/cloudformation-ruby-dsl/blob/master/initial_contributions.md) for more details.
 
 ## Motivation
 
-Cloudformation templates often contain repeated stanzas, information which must be loaded from external sources, and other functionality that would be easier handled as code, instead of configuration. 
+CloudFormation templates often contain repeated stanzas, information which must be loaded from external sources, and other functionality that would be easier handled as code, instead of configuration.
 
-Consider when a userdata script needs to be added to a Cloudformation template. Traditionally, you would re-write the script by hand in a valid JSON format. Using the DSL, you can specify the file containing the script and generate the correct information at runtime.
+Consider when a userdata script needs to be added to a CloudFormation template. Traditionally, you would re-write the script by hand in a valid JSON format. Using the DSL, you can specify the file containing the script and generate the correct information at runtime.
 
     :UserData => base64(interpolate(file('userdata.sh')))
 
-Additionally, Cloudformation templates are just massive JSON documents, making general readability and reusability an issue. The DSL allows not only a cleaner format (and comments!), but will also allow the same DSL template to be reused as needed.
+Additionally, CloudFormation templates are just massive JSON documents, making general readability and reusability an issue. The DSL allows not only a cleaner format (and comments!), but will also allow the same DSL template to be reused as needed.
 
 ## Installation
 
@@ -46,9 +46,9 @@ Add the named object to the appropriate collection.
 - `resource(name, options)`
 - `output(name, options)`
 
-### Cloudformation Function Calls
+### CloudFormation Function Calls
 
-Invoke a native Cloudformation function.
+Invoke an intrinsic CloudFormation function.
 - `base64(value)`
 - `find_in_map(map, key, name)`
 - `get_att(resource, attribute)`
@@ -56,7 +56,14 @@ Invoke a native Cloudformation function.
 - `join(delim, *list)`
 - `select(index, list)`
 - `ref(name)`
-- `no_value()`
+
+Reference a CloudFormation pseudo parameter.
+- `aws_account_id()`
+- `aws_notification_arns()`
+- `aws_no_value()`
+- `aws_region()`
+- `aws_stack_id()`
+- `aws_stack_name()`
 
 ### Utility Functions
 

data/bin/cfntemplate-to-ruby

@@ -286,6 +286,14 @@ def fmt_string(s)
   end
 end
 
+def many(val)
+  if val.is_a?(Array)
+    val
+  else
+    [ val ]
+  end
+end
+
 def simplify(val)
   if val.is_a?(Hash)
     val = Hash[val.map { |k,v| [k, simplify(v)] }]
@@ -304,11 +312,19 @@ def simplify(val)
         when k == 'Fn::GetAZs'
           FnCall.new 'get_azs', v != '' ? [v] : []
         when k == 'Fn::Join'
-          FnCall.new 'join', [v[0]] + v[1], true
+          FnCall.new 'join', [v[0]] + many(v[1]), true
         when k == 'Fn::Select'
           FnCall.new 'select', v
+        when k == 'Ref' && v == 'AWS::AccountId'
+          FnCall.new 'aws_account_id', []
+        when k == 'Ref' && v == 'AWS::NotificationARNs'
+          FnCall.new 'aws_notification_arns', []
+        when k == 'Ref' && v == 'AWS::NoValue'
+          FnCall.new 'aws_no_value', []
         when k == 'Ref' && v == 'AWS::Region'
           FnCall.new 'aws_region', []
+        when k == 'Ref' && v == 'AWS::StackId'
+          FnCall.new 'aws_stack_id', []
         when k == 'Ref' && v == 'AWS::StackName'
           FnCall.new 'aws_stack_name', []
         when k == 'Ref'

data/examples/cloudformation-ruby-script.rb

@@ -19,7 +19,7 @@ require 'cloudformation-ruby-dsl/cfntemplate'
 require 'cloudformation-ruby-dsl/table'
 
 # Note: this is only intended to demonstrate the cloudformation-ruby-dsl. It compiles
-#   and validates correctly, but won't produce a viable Cloudformation stack.
+#   and validates correctly, but won't produce a viable CloudFormation stack.
 
 template do
 
@@ -95,7 +95,7 @@ template do
           vpc.get_multimap({ :visibility => 'private', :zone => ['a', 'c'] }, :env, :region, :subnet)
 
   # The tag type is a Ruby CFN extension. These tags are excised from the template and used to generate a series of --tag arguments
-  #   which are passed to cfn-cmd. They do not ultimately appear in the expanded Cloudformation template. The diff subcommand will
+  #   which are passed to cfn-cmd. They do not ultimately appear in the expanded CloudFormation template. The diff subcommand will
   #   compare tags with the running stack and identify any changes, but cfn-update-stack will do the diff and throw an error on any
   #   changes. The tags are propagated to all resources created by the stack, including the stack itself.
   #

data/lib/cloudformation-ruby-dsl/cfntemplate.rb

@@ -376,7 +376,21 @@ def select(index, list) { :'Fn::Select' => [ index, list ] } end
 
 def ref(name) { :Ref => name } end
 
-def no_value() ref("AWS::NoValue") end
+def aws_account_id() ref("AWS::AccountId") end
+
+def aws_notification_arns() ref("AWS::NotificationARNs") end
+
+def aws_no_value() ref("AWS::NoValue") end
+
+def aws_stack_id() ref("AWS::StackId") end
+
+def aws_stack_name() ref("AWS::StackName") end
+
+# deprecated, for backward compatibility
+def no_value()
+    warn_deprecated('no_value()', 'aws_no_value()')
+    aws_no_value()
+end
 
 # Read the specified file and return its value as a string literal
 def file(filename) File.read(File.absolute_path(filename, File.dirname($PROGRAM_NAME))) end
@@ -417,3 +431,7 @@ end
 def erb_template(filename, params = {})
   ERB.new(file(filename), nil, '-').result(Namespace.new(params).get_binding)
 end
+
+def warn_deprecated(old, new)
+    $stderr.puts "Warning: '#{old}' has been deprecated.  Please update your template to use '#{new}' instead."
+end

data/lib/cloudformation-ruby-dsl/spotprice.rb

@@ -37,7 +37,7 @@ SPOT_PRICES_BY_INSTANCE_TYPE = {
 
 def spot_price(spot_price_string, instance_type)
   case spot_price_string
-    when 'false', '' then no_value()
+    when 'false', '' then aws_no_value()
     when 'true' then spot_price_for_instance_type(instance_type)
     else spot_price_string
   end

data/lib/cloudformation-ruby-dsl/version.rb

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "0.4.5"
+      VERSION = "0.4.6"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6
   prerelease: 
 platform: ruby
 authors:
@@ -16,7 +16,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-17 00:00:00.000000000 Z
+date: 2014-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator