cloudformation-ruby-dsl 0.5.3 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: da465e2c61c5e0ed8e43f200ecc5bcada19c4d15
-  data.tar.gz: 944159f87d612d6c5cc9ec1273c7f0d359c72e81
+  metadata.gz: 3c4ac135faa6e385379b3156225d4408853fe025
+  data.tar.gz: 683175d8ba2a0933803e4cdfdb07eaed10a00a2c
 SHA512:
-  metadata.gz: 2b3e19f1204f0f1fb87aee2322f2aeaed7b516aaefd453857af5b8b832678e8ca919459f788e143909476ad763ac376093ca69757829b3286217384dfeffe082
-  data.tar.gz: bdcfbe758e2538f545888597e893b79116e99d2b26d3b5953d200df4ca450b360684d403e5d04520ec2c3597948372e28027b79e10758ee3c8f6430ffb21e324
+  metadata.gz: 8d25c190a403f173dd70def2b7b59bad1682e969cf3ccf6b786e2901a6a33f20c15ca59ce00520bf51e13acabd383ddcb65c57d7ee78efc974064ab071ccf808
+  data.tar.gz: 034d390533c3197d2f2fbffeeed5b4ccb352a6c40475d389cacb997b9a255e3f4111f7e39caa2f05906566499ee54629e497ac3b7525db7255e51cc537b716f9

data/README.md

@@ -20,6 +20,14 @@ Run `gem install cloudformation-ruby-dsl` to install system-wide.
 
 To use in a specific project, add `gem 'cloudformation-ruby-dsl'` to your Gemfile, and then run `bundle`.
 
+## Releasing
+
+See [Releasing](docs/Releasing.md).
+
+## Contributing
+
+See [Contributing](docs/Contributing.md).
+
 ## Usage
 
 To convert existing JSON templates to use the DSL, run
@@ -42,7 +50,7 @@ Below are the various functions currently available in the DSL. See [the example
 Add the named object to the appropriate collection.
 - `parameter(name, options)` (may be marked :Immutable, which will raise error on a later change)
 - `mapping(name, options)`
-- `condition(name, options)`
+- `condition(name, conditions)`
 - `resource(name, options)`
 - `output(name, options)`
 
@@ -57,6 +65,14 @@ Invoke an intrinsic CloudFormation function.
 - `select(index, list)`
 - `ref(name)`
 
+Intrinsic conditionals are also supported, with some syntactic sugar.
+- `fn_not(condition)`
+- `fn_or(*condition_list)`
+- `fn_and(*condition_list)`
+- `fn_if(condition, value_if_true, value_if_false)`
+- `equal(lhsOperand, rhsOperand)`
+- `not_equal(lhsOperand, rhsOperand)`
+
 Reference a CloudFormation pseudo parameter.
 - `aws_account_id()`
 - `aws_notification_arns()`
@@ -76,4 +92,4 @@ Additional capabilities for file inclusion, etc.
 
 ### Default Region
 
-The tool defaults to region 'us-east-1'. To change this set either 'EC2_REGION' or 'AWS_DEFAULT_REGION' environment variables.
+The tool defaults to region `us-east-1`. To change this set either `EC2_REGION` or `AWS_DEFAULT_REGION` in your environment.

data/docs/Contributing.md

@@ -0,0 +1,21 @@
+# Contributing
+
+Thanks for your interest in contributing! Here are some things you should know.
+
+## Getting started
+
+To get started:
+
+- fork this project on github
+- create a new branch named after the change you want to make; i.e., `git checkout -b mynewfeature`
+- make your changes and commit them
+- send a pull request to this project from your fork/branch
+
+Once you've sent your pull request, one of the project collaborators will review it and provide feedback. Please accept this commentary as constructive! It is intended as such.
+
+## git
+
+We're opinionated about git. Don't be surprised if we ask you to update your pull request to meet the following standards.
+
+- rebase+squash your branch into a single commit. For clean git history, we'd prefer we merged in just 1 commit that contains the entire set of changes.
+- don't write commit messages longer than 50 characters. See [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) for some examples of how to achieve this, and why.

data/docs/Releasing.md

@@ -0,0 +1,20 @@
+# Releasing
+
+## Performing releases
+
+0. Merge the desired commits to master. But merge them cleanly! See: [merging](#merging)
+1. Edit and commit the version file in `lib/cloudformation-ruby-dsl/version.rb`. Bump the version based on the [version specification](#versioning-specification)
+2. `git push` to origin/master
+3. `rake release`
+
+## Versioning specification
+
+For this project, we will follow the methodology proposed by http://semver.org/spec/v2.0.0.html.
+
+1. Major versions break existing interfaces.
+2. Minor versions are additive only.
+3. Patch versions are for backward-compatible bug fixes.
+
+## Merging
+
+When you use the shiny green "Merge" button on a pull request, github creates a separate commit for the merge (because of the use of the `--no-ff` option). This is noisy and makes git history confusing. Instead of using the green merge button, merge the branch into master using [git-land](https://github.com/bazaarvoice/git-land#git-land) (or manually follow the steps described in the project).

data/examples/cloudformation-ruby-script.rb

@@ -172,7 +172,8 @@ template do
   }
 
   resource 'InstanceProfile', :Type => 'AWS::IAM::InstanceProfile', :Properties => {
-      :Path => '/',
+      # use cfn intrinsic conditional to choose the 2nd value because the expression evaluates to false
+      :Path => fn_if(equals(3, 0), '/unselected/', '/'),
       :Roles => [ ref('InstanceRole') ],
   }
 
@@ -189,6 +190,9 @@ template do
       :Path => '/',
   }
 
+  # add conditions that can be used elsewhere in the template
+  condition 'myCondition', fn_and(equals("one", "two"), not_equals("three", "four"))
+
   output 'EmailSNSTopicARN',
           :Value => ref('EmailSNSTopic'),
           :Description => 'ARN of SNS Topic used to send emails on events.'

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

@@ -391,6 +391,30 @@ end
 # Variant of join that matches the native CFN syntax.
 def join_list(delim, list) { :'Fn::Join' => [ delim, list ] } end
 
+def equal(one, two) { :'Fn::Equals' => [one, two] } end
+
+def fn_not(condition) { :'Fn::Not' => [condition] } end
+
+def fn_or(*condition_list)
+  case condition_list.length
+    when 0..1 then raise "fn_or needs at least 2 items."
+    when 2..10 then  { :'Fn::Or' => condition_list }
+    else raise "fn_or needs a list of 2-10 items that evaluate to true/false."
+  end
+end
+
+def fn_and(*condition_list)
+  case condition_list.length
+    when 0..1 then raise "fn_and needs at least 2 items."
+    when 2..10 then  { :'Fn::And' => condition_list }
+    else raise "fn_and needs a list of 2-10 items that evaluate to true/false."
+  end
+end
+
+def fn_if(cond, if_true, if_false) { :'Fn::If' => [cond, if_true, if_false] } end
+
+def not_equal(one, two) fn_not(equal(one,two)) end
+
 def select(index, list) { :'Fn::Select' => [ index, list ] } end
 
 def ref(name) { :Ref => name } end

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

@@ -15,7 +15,7 @@
 module Cfn
   module Ruby
     module Dsl
-      VERSION = "0.5.3"
+      VERSION = "0.5.4"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudformation-ruby-dsl
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
 platform: ruby
 authors:
 - Shawn Smith
@@ -15,62 +15,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: detabulator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Ruby DSL library that provides a wrapper around the cfn-cmd.
@@ -88,13 +88,15 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/cfntemplate-to-ruby
 - cloudformation-ruby-dsl.gemspec
+- docs/Contributing.md
+- docs/Releasing.md
 - examples/cloudformation-ruby-script.rb
 - examples/maps/map.json
 - examples/maps/map.rb
@@ -181,17 +183,17 @@ require_paths:
 - bin
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Ruby DSL library that provides a wrapper around the cfn-cmd.  Written by