sparkle_formation 3.0.26 → 3.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33f948df7a83782e8ab90fd9900cae9e88e5e4bb
-  data.tar.gz: 9329bf4f33788f8ad4589828f1a38ace0c3c0af7
+SHA256:
+  metadata.gz: 19b9bff2dd1817a3ea403221d40cdcd9b6f8b8f999670f3a1baa37a36cd0ab9c
+  data.tar.gz: 5c0627a7fcc3cb91c68a7576276d8c6431632111cd1b7a0a4135fe68fea1d346
 SHA512:
-  metadata.gz: 63f3a963ac6233c943c897df5e9d462933384060e42e6beb00a6502186a3f35f6e97659a66b757e60d48a3b44322bc31f8bd2bb5a5dd5a37262db3fbcc2f55c8
-  data.tar.gz: 35ede30d5db9519d4d8c41db21119d4d9de5328ce525f41d086f583a6212b7a2a3a5102feb9579a537c1a1f56f5a4128f04dbbcf29f7808a1d172c559aa60ac6
+  metadata.gz: 382e8fbc12ed460abedd332e734902dff596a2a86b52606a4950c6c7bd64cf8ea591ad3e4a6baa23c12ef65171f62cdafa6d89901710bc04ad7fd6181dd57421
+  data.tar.gz: 3cac5a75ec2fe95ad0a67284a0db2bc7cd1b7679a0a117ce6c10f6c41998ed4e247883bfc441519501f6be71b4810e4022c488c229d1ed85d840cf21f81bc235

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# v3.0.28
+* Fix sub! when no hash is provided (#236)
+* Only run template extraction when required
+* Use explicit type checks when searching for nested stacks
+* Fix output bubbling to use proper nil checking
+
 # v3.0.26
 * Allow Fn::Sub helper to accept no arguments
 * Fix Ruby 2.4 deprecation warnings

data/lib/sparkle_formation/composition.rb

@@ -24,10 +24,10 @@ class SparkleFormation
     # @option args [Array<Component>] :components seed components for composition
     # @option args [Array<Override>] :overrides seed overrides for composition
     # @return [self]
-    def initialize(origin, args={})
-      unless(origin.is_a?(SparkleFormation))
+    def initialize(origin, args = {})
+      unless origin.is_a?(SparkleFormation)
         raise TypeError.new 'Composition requires `SparkleFormation` instance as origin. ' \
-          "Received origin type `#{origin.class}`."
+                            "Received origin type `#{origin.class}`."
       end
       @origin = origin
       @components_list = []
@@ -62,11 +62,11 @@ class SparkleFormation
     # @param item [Component, Override]
     # @param location [Symbol] :prepend or :append (defaults to :append)
     # @return [self]
-    def add_component(item, location=:append)
-      unless(item.is_a?(Component) || item.is_a?(Override))
+    def add_component(item, location = :append)
+      unless item.is_a?(Component) || item.is_a?(Override)
         raise TypeError.new("Expecting `Component` or `Override` but received `#{item.class}`")
       end
-      if(item.respond_to?(:key) && component_keys.include?(item.key))
+      if item.respond_to?(:key) && component_keys.include?(item.key)
         # do nothing
       else
         case location
@@ -76,7 +76,7 @@ class SparkleFormation
           components_list.unshift(item)
         else
           raise ArgumentError.new 'Unknown addition location provided. Valid: `:append, :prepend`. ' \
-            "Received: `#{location.inspect}`"
+                                  "Received: `#{location.inspect}`"
         end
       end
       self
@@ -87,8 +87,8 @@ class SparkleFormation
     # @param item [Override]
     # @param location [Symbol] :prepend or :append (defaults to :append)
     # @return [self]
-    def add_override(item, location=:append)
-      unless(item.is_a?(Override))
+    def add_override(item, location = :append)
+      unless item.is_a?(Override)
         raise TypeError.new("Expecting `Override` but received `#{item.class}`")
       end
       case location
@@ -98,7 +98,7 @@ class SparkleFormation
         overrides_list.unshift(item)
       else
         raise ArgumentError.new 'Unknown addition location provided. Valid: ' \
-          "`:append, :prepend`. Received: `#{location.inspect}`"
+                                "`:append, :prepend`. Received: `#{location.inspect}`"
       end
       self
     end
@@ -109,7 +109,7 @@ class SparkleFormation
     # @param location [Symbol] :prepend or :append (defaults to :append)
     # @yield component block (optional)
     # @return [self]
-    def new_component(key, location=:append, &block)
+    def new_component(key, location = :append, &block)
       comp = Component.new(origin, key, block)
       add_component(comp, location)
       self
@@ -121,8 +121,8 @@ class SparkleFormation
     # @param location [Symbol] :prepend or :append (defaults to :append)
     # @yield override block
     # @return [self]
-    def new_override(args={}, location=:append, &block)
-      if(args.is_a?(Symbol))
+    def new_override(args = {}, location = :append, &block)
+      if args.is_a?(Symbol)
         location = args
         args = {}
       end
@@ -137,7 +137,7 @@ class SparkleFormation
     # @yieldparam [Component, Override]
     # @return [self]
     def each
-      if(block_given?)
+      if block_given?
         composite.each do |item|
           yield item
         end
@@ -162,14 +162,14 @@ class SparkleFormation
     # @return [Array]
     def seed_value(items, type)
       type = [type].flatten.compact
-      if(items)
+      if items
         items.each do |item|
           valid_item = type.any? do |klass|
             item.is_a?(klass)
           end
-          unless(valid_item)
+          unless valid_item
             raise TypeError.new "Invalid type encountered within collection `#{item.class}`. " \
-              "Expected `#{type.map(&:to_s).join('`, `')}`."
+                                "Expected `#{type.map(&:to_s).join('`, `')}`."
           end
         end
         items.dup

data/lib/sparkle_formation/error.rb

@@ -16,7 +16,7 @@ class SparkleFormation
       attr_reader :name
 
       def initialize(*args)
-        opts = args.detect{|o| o.is_a?(Hash)}
+        opts = args.detect { |o| o.is_a?(Hash) }
         args.delete(opts) if opts
         super(args)
         @name = opts[:name] if opts
@@ -24,7 +24,7 @@ class SparkleFormation
 
       # @return [String] customized message including name
       def to_s
-        if(name)
+        if name
           "Failed to locate item named: `#{name}`"
         else
           'Failed to locate item'
@@ -39,12 +39,9 @@ class SparkleFormation
 
       # Template internals
       class Resource < NotFound; end
-
     end
 
     # Deprecation error
     class Deprecated < Error; end
-
   end
-
 end

data/lib/sparkle_formation/function_struct.rb

@@ -16,12 +16,12 @@ class SparkleFormation
     # @param f_name [String] name of function
     # @param args [Array<Object>] argument list
     # @return [self]
-    def initialize(f_name=nil, *args)
+    def initialize(f_name = nil, *args)
       super()
       @_fn_name = f_name.to_s
       @_fn_args = args
       @_fn_args.map! do |l_arg|
-        if(l_arg.is_a?(_klass))
+        if l_arg.is_a?(_klass)
           l_arg = l_arg._root
           l_arg._parent(self)
         end
@@ -33,13 +33,13 @@ class SparkleFormation
     def _clone(*_)
       new_inst = _klass_new(_fn_name, *_fn_args)
       new_inst._data.replace(__hashish[
-        @table.map{ |_key, _value|
-          if(_key.is_a?(::AttributeStruct))
+        @table.map { |_key, _value|
+          if _key.is_a?(::AttributeStruct)
             _key = _key._clone
           else
             _key = _do_dup(_key)
           end
-          if(_value.is_a?(::AttributeStruct))
+          if _value.is_a?(::AttributeStruct)
             _value = _value._clone
           else
             _value = _do_dup(_value)
@@ -57,7 +57,7 @@ class SparkleFormation
 
     # @return [TrueClass, FalseClass]
     def eql?(_other)
-      if(_other.respond_to?(:_dump) && _other.respond_to?(:_parent))
+      if _other.respond_to?(:_dump) && _other.respond_to?(:_parent)
         ::MultiJson.dump(_dump).hash ==
           ::MultiJson.dump(_other._dump).hash &&
           _parent == _other._parent
@@ -88,7 +88,7 @@ class SparkleFormation
     # @param args [Object<Array>] argument list
     # @return [Object]
     def method_missing(name, *args)
-      if(args.empty?)
+      if args.empty?
         super
       else
         @table['_function_'] = _klass_new(name, *args)
@@ -100,7 +100,7 @@ class SparkleFormation
     # @param val [Integer, String]
     # @return [FunctionStruct]
     def [](val)
-      if(val.is_a?(::String) && __single_quote_strings)
+      if val.is_a?(::String) && __single_quote_strings
         _set("['#{val}']")
       else
         _set("[#{val.inspect}]")
@@ -111,39 +111,39 @@ class SparkleFormation
     #
     # @return [String]
     def _dump
-      unless(@table.empty?)
+      unless @table.empty?
         key, value = @table.first
         suffix = _eval_join(
           *[
-            key == '_function_' ? nil : key,
-            !value.nil? ? value._dump : nil
-          ].compact
+          key == '_function_' ? nil : key,
+          !value.nil? ? value._dump : nil,
+        ].compact
         )
       end
-      if(_fn_name)
+      if _fn_name
         args = _fn_args.map do |arg|
-          if(arg.respond_to?(:_dump))
+          if arg.respond_to?(:_dump)
             arg._dump
-          elsif(arg.is_a?(::Symbol))
+          elsif arg.is_a?(::Symbol)
             quote = __single_quote_strings ? "'" : '"'
             "#{quote}#{::Bogo::Utility.camel(arg.to_s, false)}#{quote}"
-          elsif(arg.is_a?(::String) && __single_quote_strings)
+          elsif arg.is_a?(::String) && __single_quote_strings
             "'#{arg}'"
           else
             arg.inspect
           end
         end.join(', ')
-        unless(_fn_name.to_s.empty?)
+        unless _fn_name.to_s.empty?
           function_name = args.empty? ? "#{_fn_name}#{__empty_argument_list}" : "#{_fn_name}(#{args})"
         end
         internal = _eval_join(
           *[
-            function_name,
-            suffix
-          ].compact
+          function_name,
+          suffix,
+        ].compact
         )
-        if(root? || (!__single_anchor? && function_name))
-          if(!root? && __quote_nested_funcs?)
+        if root? || (!__single_anchor? && function_name)
+          if !root? && __quote_nested_funcs?
             quote = __single_quote_strings ? "'" : '"'
           end
           "#{quote}#{__anchor_start}#{internal}#{__anchor_stop}#{quote}"
@@ -154,6 +154,7 @@ class SparkleFormation
         suffix
       end
     end
+
     alias_method :_sparkle_dump, :_dump
 
     # Join arguments into a string for remote evaluation
@@ -162,9 +163,9 @@ class SparkleFormation
     # @return [String]
     def _eval_join(*args)
       args = args.compact
-      args.delete_if(&:empty?)
+      args.delete_if &:empty?
       args.slice(1, args.size).to_a.inject(args.first) do |memo, item|
-        if(item.start_with?('['))
+        if item.start_with?('[')
           memo += item
         else
           memo += ".#{item}"
@@ -215,7 +216,6 @@ class SparkleFormation
     def __single_quote_strings
       true
     end
-
   end
 
   # Function struct specialized for Azure variables to check nested
@@ -236,14 +236,14 @@ class SparkleFormation
     # the function if found.
     def _dump
       # Remap nested function keys if possible
-      if(_fn_context && _fn_context.root!.data![_fn_name] && _fn_context.root!.data![_fn_name].data![_fn_args.first])
+      if _fn_context && _fn_context.root!.data![_fn_name] && _fn_context.root!.data![_fn_name].data![_fn_args.first]
         __valid_keys = _fn_context.root!.data![_fn_name].data![_fn_args.first].keys!
         __current_key = @table.keys.first
         __match_key = __current_key.to_s.downcase.gsub('_', '')
         __key_remap = __valid_keys.detect do |__nested_key|
           __nested_key.to_s.downcase.gsub('_', '') == __match_key
         end
-        if(__key_remap)
+        if __key_remap
           @table[__key_remap] = @table.delete(@table.keys.first)
         end
       end
@@ -283,7 +283,6 @@ class SparkleFormation
     def _klass
       ::SparkleFormation::JinjaExpressionStruct
     end
-
   end
 
   # FunctionStruct for jinja statements
@@ -313,7 +312,6 @@ class SparkleFormation
     def _klass
       ::SparkleFormation::JinjaStatementStruct
     end
-
   end
 
   # FunctionStruct for customized google functions
@@ -343,7 +341,6 @@ class SparkleFormation
     def _klass
       ::SparkleFormation::GoogleStruct
     end
-
   end
 
   # FunctionStruct for customized terraform functions
@@ -382,6 +379,5 @@ class SparkleFormation
     def _klass
       ::SparkleFormation::TerraformStruct
     end
-
   end
 end

data/lib/sparkle_formation/provider/aws.rb

@@ -17,13 +17,13 @@ class SparkleFormation
         statements = []
         compile.resources.keys!.each do |r_name|
           r_object = compile.resources[r_name]
-          if(r_object['Policy'])
+          if r_object['Policy']
             r_object['Policy'].keys!.each do |effect|
               statements.push(
                 'Effect' => effect.to_s.capitalize,
-                'Action' => [r_object['Policy'][effect]].flatten.compact.map{|i| "Update:#{i}"},
+                'Action' => [r_object['Policy'][effect]].flatten.compact.map { |i| "Update:#{i}" },
                 'Resource' => "LogicalResourceId/#{r_name}",
-                'Principal' => '*'
+                'Principal' => '*',
               )
             end
             r_object.delete!('Policy')
@@ -33,7 +33,7 @@ class SparkleFormation
           'Effect' => 'Allow',
           'Action' => 'Update:*',
           'Resource' => '*',
-          'Principal' => '*'
+          'Principal' => '*',
         )
         Smash.new('Statement' => statements)
       end
@@ -51,15 +51,15 @@ class SparkleFormation
       def apply_deep_nesting(*args, &block)
         outputs = collect_outputs
         nested_stacks(:with_resource).each do |stack, resource|
-          unless(stack.nested_stacks.empty?)
+          unless stack.nested_stacks.empty?
             stack.apply_deep_nesting(*args)
           end
-          unless(stack.root?)
+          unless stack.root?
             stack.compile.parameters.keys!.each do |parameter_name|
               next if stack.compile.parameters.set!(parameter_name).stack_unique == true
-              if(!stack.parent.compile.parameters.data![parameter_name].nil?)
+              if !stack.parent.compile.parameters.data![parameter_name].nil?
                 resource.properties.parameters.set!(parameter_name, resource.ref!(parameter_name))
-              elsif(output_name = output_matched?(parameter_name, outputs.keys))
+              elsif output_name = output_matched?(parameter_name, outputs.keys)
                 next if outputs[output_name] == stack
                 stack_output = stack.make_output_available(output_name, outputs)
                 resource.properties.parameters.set!(parameter_name, stack_output)
@@ -67,7 +67,7 @@ class SparkleFormation
             end
           end
         end
-        if(block_given?)
+        if block_given?
           extract_templates(&block)
         end
         compile
@@ -88,18 +88,20 @@ class SparkleFormation
         nested_stacks(:with_resource, :with_name).each do |_stack, stack_resource, stack_name|
           remap_nested_parameters(compile, parameters, stack_name, stack_resource, output_map)
         end
-        extract_templates(&block)
+        if block_given?
+          extract_templates(&block)
+        end
         compile.parameters parameters
-        if(args.include?(:bubble_outputs))
+        if args.include?(:bubble_outputs)
           outputs_hash = Hash[
-            output_map do |name, value|
+            output_map.map do |name, value|
               [name, {'Value' => {'Fn::GetAtt' => value}}]
             end
           ]
-          if(compile.outputs)
+          unless compile.outputs.nil?
             compile._merge(compile._klass_new(outputs_hash))
           else
-            compile.outputs output_hash
+            compile.outputs outputs_hash
           end
         end
         compile
@@ -122,26 +124,26 @@ class SparkleFormation
             )
           )
         end
-        if(bubble_path.empty?)
-          if(drip_path.size == 1)
+        if bubble_path.empty?
+          if drip_path.size == 1
             parent = drip_path.first.parent
-            if(parent && parent.compile.parameters.data![output_name])
+            if parent && parent.compile.parameters.data![output_name]
               return compile.ref!(output_name)
             end
           end
           raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. " <<
-            'This may be due to a circular dependency! ' <<
-            "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
-            "Requester Path: #{root_path.map(&:name).join(' > ')})"
+                                    'This may be due to a circular dependency! ' <<
+                                    "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
+                                    "Requester Path: #{root_path.map(&:name).join(' > ')})"
         end
         result = compile.attr!(bubble_path.first.name, "Outputs.#{output_name}")
-        if(drip_path.size > 1)
+        if drip_path.size > 1
           parent = drip_path.first.parent
           drip_path.unshift(parent) if parent
           drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
             next unless ref_sparkle
             base_sparkle.compile.resources[ref_sparkle.name].properties.parameters.set!(output_name, result)
-            ref_sparkle.compile.parameters.set!(output_name){ type 'String' } # TODO: <<<<------ type check and prop
+            ref_sparkle.compile.parameters.set!(output_name) { type 'String' } # TODO: <<<<------ type check and prop
             result = compile.ref!(output_name)
           end
         end
@@ -164,26 +166,26 @@ class SparkleFormation
       #   be added to container stack and it will not use outputs
       def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
         stack_parameters = stack_resource.properties.stack.compile.parameters
-        unless(stack_parameters.nil?)
+        unless stack_parameters.nil?
           stack_parameters._dump.each do |pname, pval|
-            if(pval['StackUnique'])
+            if pval['StackUnique']
               check_name = [stack_name, pname].join
             else
               check_name = pname
             end
-            if(parameters.keys.include?(check_name))
-              if(list_type?(parameters[check_name]['Type']))
+            if parameters.keys.include?(check_name)
+              if list_type?(parameters[check_name]['Type'])
                 new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
               else
                 new_val = {'Ref' => check_name}
               end
               template.resources.set!(stack_name).properties.parameters.set!(pname, new_val)
-            elsif(output_map[check_name])
+            elsif output_map[check_name]
               template.resources.set!(stack_name).properties.parameters.set!(
-                pname, 'Fn::GetAtt' => output_map[check_name]
+                pname, 'Fn::GetAtt' => output_map[check_name],
               )
             else
-              if(list_type?(pval['Type']))
+              if list_type?(pval['Type'])
                 new_val = {'Fn::Join' => [',', {'Ref' => check_name}]}
               else
                 new_val = {'Ref' => check_name}
@@ -193,7 +195,7 @@ class SparkleFormation
             end
           end
         end
-        unless(stack_resource.properties.stack.compile.outputs.nil?)
+        unless stack_resource.properties.stack.compile.outputs.nil?
           stack_resource.properties.stack.compile.outputs.keys!.each do |oname|
             output_map[oname] = [stack_name, "Outputs.#{oname}"]
           end
@@ -208,7 +210,6 @@ class SparkleFormation
       def list_type?(type)
         type == 'CommaDelimitedList' || type.start_with?('List<')
       end
-
     end
   end
 end

data/lib/sparkle_formation/provider/azure.rb

@@ -41,15 +41,15 @@ class SparkleFormation
       def apply_deep_nesting(*args, &block)
         outputs = collect_outputs
         nested_stacks(:with_resource).each do |stack, resource|
-          unless(stack.nested_stacks.empty?)
+          unless stack.nested_stacks.empty?
             stack.apply_deep_nesting(*args)
           end
-          unless(stack.root?)
+          unless stack.root?
             stack.compile.parameters.keys!.each do |parameter_name|
               next if stack.compile.parameters.set!(parameter_name).stack_unique == true
-              if(!stack.parent.compile.parameters.data![parameter_name].nil?)
+              if !stack.parent.compile.parameters.data![parameter_name].nil?
                 resource.properties.parameters.set!(parameter_name, resource.ref!(parameter_name))
-              elsif(output_name = output_matched?(parameter_name, outputs.keys))
+              elsif output_name = output_matched?(parameter_name, outputs.keys)
                 next if outputs[output_name] == stack
                 stack_output = stack.make_output_available(output_name, outputs)
                 resource.properties.parameters.set!(parameter_name, stack_output)
@@ -57,7 +57,7 @@ class SparkleFormation
             end
           end
         end
-        if(block_given?)
+        if block_given?
           extract_templates(&block)
         end
         compile
@@ -79,7 +79,7 @@ class SparkleFormation
           remap_nested_parameters(compile, parameters, stack_name, stack_resource, output_map)
         end
         extract_templates(&block)
-        if(args.include?(:bubble_outputs))
+        if args.include?(:bubble_outputs)
           output_map.each do |o_name, o_val|
             compile.outputs._set(o_name).value compile._stack_output(*o_val)
           end
@@ -104,20 +104,20 @@ class SparkleFormation
             )
           )
         end
-        if(bubble_path.empty?)
-          if(drip_path.size == 1)
+        if bubble_path.empty?
+          if drip_path.size == 1
             parent = drip_path.first.parent
-            if(parent && !parent.compile.parameters._set(output_name).nil?)
+            if parent && !parent.compile.parameters._set(output_name).nil?
               return compile.parameter!(output_name)
             end
           end
           raise ArgumentError.new "Failed to detect available bubbling path for output `#{output_name}`. " <<
-            'This may be due to a circular dependency! ' <<
-            "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
-            "Requester Path: #{root_path.map(&:name).join(' > ')})"
+                                    'This may be due to a circular dependency! ' <<
+                                    "(Output Path: #{outputs[output_name].root_path.map(&:name).join(' > ')} " <<
+                                    "Requester Path: #{root_path.map(&:name).join(' > ')})"
         end
         result = compile._stack_output(bubble_path.first.name, output_name)
-        if(drip_path.size > 1)
+        if drip_path.size > 1
           parent = drip_path.first.parent
           drip_path.unshift(parent) if parent
           drip_path.each_slice(2) do |base_sparkle, ref_sparkle|
@@ -147,19 +147,19 @@ class SparkleFormation
       def remap_nested_parameters(template, parameters, stack_name, stack_resource, output_map)
         nested_template = stack_resource.properties.stack.compile
         stack_parameters = nested_template.parameters
-        unless(stack_parameters.nil?)
+        unless stack_parameters.nil?
           stack_parameters._keys.each do |pname|
             pval = stack_parameters[pname]
-            unless(pval.stack_unique.nil?)
+            unless pval.stack_unique.nil?
               check_name = [stack_name, pname].join
             else
               check_name = pname
             end
-            if(!parameters._set(check_name).nil?)
+            if !parameters._set(check_name).nil?
               template.resources._set(stack_name).properties.parameters._set(pname).value(
                 template._parameter(check_name)
               )
-            elsif(output_map[check_name])
+            elsif output_map[check_name]
               template.resources._set(stack_name).properties.parameters._set(pname).value(
                 template._stack_output(*output_map[check_name])
               )
@@ -171,14 +171,13 @@ class SparkleFormation
             end
           end
         end
-        unless(nested_template.outputs.nil?)
+        unless nested_template.outputs.nil?
           nested_template.outputs.keys!.each do |oname|
             output_map[oname] = [stack_name, oname]
           end
         end
         true
       end
-
     end
   end
 end