cfndsl 0.11.4 → 0.11.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    N2UzMWFmNmYxM2E2MTQ4M2U1NmM2MDk3NGFkNzUwMzI5ZjJmZmI4ZQ==
+    ODkxMWE3OWJjMmM4NjNhYzYxMzE3MmYyMTU3ZDQ4NDMwY2YzNTE1Yg==
   data.tar.gz: !binary |-
-    YmYyNzZlM2RkNzRmNzE2YmYwOGI2OWVlMTM4MGZhYzE2Yjk4ODFlYw==
+    OGVlYzBmODllYzZjYjZlYzFiZGNmYjZhYzI3Mzk5Y2E3OGVhMDdjZQ==
 SHA512:
   metadata.gz: !binary |-
-    MzY3ZjVjZDU4NGQ3ZTNlMTdmNmM1N2RkYmMzZjIwZmYxZGRkZjM3NTIwNGEx
-    OGFkMTJmZTViZWQ5MTEzNGU3MjAxYzQyYjNmZDVlN2JkNmVhMGM2YTBjOTEy
-    MTI0M2U1MDRhZDVjMjc3ZDVkN2FmMGFmZTA1ZjhiMWJjNGNkMDE=
+    Mjc4MjJlZjBmZDk4NjliODdhMDcyYTAxM2NmNjRhMjU5NjNhZmZlNTczM2Q0
+    MDlhZDY5NDdhZjVkNGQzMTdlNWRjZmI2NDM5NmYzMjY5N2IzNmJjMWMzZjlm
+    NzQ5YzgyYTU1YzkwM2M2YWNiNGNmMzc4NTM1NmMwN2ExNjcyYjE=
   data.tar.gz: !binary |-
-    YTVhZTA1NTIxODg2ZmM5NjJlNzZhZWViNTg2NjAwZWJmMDFlNzlhOTYzMzM1
-    NGU0NzdlNDBlMDMwZDllODRmMDlmOTZiZTU0MmZiZTdkZjhkY2ZkMjk0MjFm
-    ZjBhNzFjY2RjYTQwN2FmOTYyNmU0ZDFjMmUxMThhMzFjZjdlOWU=
+    OTc3MDY5ZTBkMWJjYmUzZjA3M2MzMzEzNzkyYzMxMmQ1ZWE2MWZlNmI0M2Zk
+    NzQ5YTE2NGI5N2I4NWIzMjc1MGVlOGE3MmY1MzJhY2JjNDNhMjUyMWJhMzZh
+    ZTIwMWE0MzE4M2FmMGNhZmNmZDdmZTE2ZmRhZDc3OThjYzA1ZTA=

data/lib/cfndsl/jsonable.rb

@@ -76,11 +76,23 @@ module CfnDsl
       Fn.new('Select', [index, array])
     end
 
+    # Equivalent to the CloudFormation template built in function Fn::Sub
+    def FnSub(string, substitutions = nil)
+      raise ArgumentError, 'The first argument passed to Fn::Sub must be a string' unless string.is_a? String
+      if substitutions
+        raise ArgumentError, 'The second argument passed to Fn::Sub must be a Hash' unless substitutions.is_a? Hash
+        Fn.new('Sub', [string, substitutions])
+      else
+        Fn.new('Sub', string)
+      end
+    end
+
     # Equivalent to the CloudFormation template built in function Fn::ImportValue
     def FnImportValue(value)
       Fn.new('ImportValue', value)
     end
 
+    # DEPRECATED
     # Usage
     #  FnFormat('This is a %0. It is 100%% %1', 'test', 'effective')
     # or
@@ -103,9 +115,9 @@ module CfnDsl
     # variable name does not exist in the hash, it is used as a Ref
     # to an existing resource or parameter.
     #
-    # TODO Can we simplyfy this somehow?
     # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def FnFormat(string, *arguments)
+      warn '`FnFormat` is deprecated and will be removed a future release. Use `FnSub` instead'
       array = []
 
       if arguments.empty? || (arguments.length == 1 && arguments[0].instance_of?(Hash))

data/lib/cfndsl/version.rb

@@ -1,3 +1,3 @@
 module CfnDsl
-  VERSION = '0.11.4'.freeze
+  VERSION = '0.11.5'.freeze
 end

data/sample/autoscale.rb

@@ -201,9 +201,7 @@ a stack from this template.
                }
              ])
     Property('HealthCheck',
-             # FnFormat replaces %0, %1, etc with passed in parameters
-             # Note that it renders to a call to Fn::Join in the json.
-             'Target' => FnFormat('HTTP:%0/', Ref('WebServerPort')),
+             'Target' => FnSub('HTTP:${WebServerPort}/'),
              'HealthyThreshold' => '3',
              'UnhealthyThreshold' => '5',
              'Interval' => '30',

data/sample/autoscale2.rb

@@ -189,9 +189,7 @@ a stack from this template.
                }
              ])
     Property('HealthCheck',
-             # FnFormat replaces %0, %1, etc with passed in parameters
-             # Note that it renders to a call to Fn::Join in the json.
-             'Target' => FnFormat('HTTP:%0/', Ref('WebServerPort')),
+             'Target' => FnSub('HTTP:${WebServerPort}/'),
              'HealthyThreshold' => '3',
              'UnhealthyThreshold' => '5',
              'Interval' => '30',

data/spec/cfndsl_spec.rb

@@ -175,6 +175,28 @@ describe CfnDsl::CloudFormationTemplate do
       end
     end
 
+    context 'FnSub', 'String' do
+      it 'formats correctly' do
+        func = subject.FnSub('http://aws.${AWS::Region}.com')
+        expect(func.to_json).to eq('{"Fn::Sub":"http://aws.${AWS::Region}.com"}')
+      end
+
+      it 'raises an error if not given a string' do
+        expect { subject.FnSub(1234) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'FnSub', 'Hash' do
+      it 'formats correctly' do
+        func = subject.FnSub('http://aws.${domain}.com', domain: 'foo')
+        expect(func.to_json).to eq('{"Fn::Sub":["http://aws.${domain}.com",{"domain":"foo"}]}')
+      end
+
+      it 'raises an error if not given a second argument that is not a Hash' do
+        expect { subject.FnSub('abc', 123) }.to raise_error(ArgumentError)
+      end
+    end
+
     context 'FnFormat', 'String' do
       it 'formats correctly' do
         func = subject.FnFormat('abc%0def%1ghi%%x', 'A', 'B')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cfndsl
 version: !ruby/object:Gem::Version
-  version: 0.11.4
+  version: 0.11.5
 platform: ruby
 authors:
 - Steven Jack