cfndsl 1.2.0 → 1.3.3

data/lib/cfndsl/globals.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'version'
+require 'fileutils'
 
 # Global variables to adjust CfnDsl behavior
 module CfnDsl

data/lib/cfndsl/jsonable.rb

@@ -136,12 +136,13 @@ module CfnDsl
       check_names
       hash = {}
       instance_variables.each do |var|
-        name = var[1..-1]
+        name = var[1..]
 
-        if name =~ /^__/
+        case name
+        when /^__/
           # if a variable starts with double underscore, strip one off
-          name = name[1..-1]
-        elsif name =~ /^_/
+          name = name[1..]
+        when /^_/
           # Hide variables that start with single underscore
           name = nil
         end

data/lib/cfndsl/orchestration_template.rb

@@ -72,18 +72,24 @@ module CfnDsl
         resource_name = name.gsub(/::/, '_')
         type_module.const_set(resource_name, resource)
         info['Properties'].each_pair do |pname, ptype|
+          # handle bogus List defined as Type
+          unless ptype.is_a?(Array)
+            pclass = type_module.const_get ptype
+            if pclass.is_a?(Array)
+              ptype = pclass
+            else
+              create_property_def(resource, pname, pclass)
+            end
+          end
+
           if ptype.is_a? Array
             pclass = type_module.const_get ptype.first
             create_array_property_def(resource, pname, pclass, info)
-          else
-            pclass = type_module.const_get ptype
-            create_property_def(resource, pname, pclass)
           end
         end
         resource_name
       end
 
-      # rubocop:disable Metrics/PerceivedComplexity
       def create_array_property_def(resource, pname, pclass, info)
         singular_name = CfnDsl::Plurals.singularize pname
         plural_name = singular_name == pname ? CfnDsl::Plurals.pluralize(pname) : pname
@@ -111,7 +117,6 @@ module CfnDsl
         # Singular form understands concatenation and Fn::If property
         create_singular_property_def(resource, pname, pclass, singular_name) if singular_name
       end
-      # rubocop:enable Metrics/PerceivedComplexity
 
       def create_resource_accessor(accessor, resource, type)
         class_eval do
@@ -245,7 +250,7 @@ module CfnDsl
       end
     end
 
-    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
     def _check_refs(container_name, method, source_containers)
       container = instance_variable_get("@#{container_name}s")
       return [] unless container
@@ -279,7 +284,7 @@ module CfnDsl
 
       invalids
     end
-    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/CyclomaticComplexity
 
     def validate
       errors = check_refs || []

data/lib/cfndsl/plurals.rb

@@ -20,7 +20,7 @@ module CfnDsl
     @singles = @plurals.invert
 
     def pluralize(name)
-      @plurals.fetch(name.to_s) { |key| key + 's' }
+      @plurals.fetch(name.to_s) { |key| "#{key}s" }
     end
 
     def singularize(name)
@@ -29,7 +29,7 @@ module CfnDsl
         when /List$/
           key[0..-5]
         when /ies$/
-          key[0..-4] + 'y'
+          "#{key[0..-4]}y"
         when /s$/
           key[0..-2]
         else

data/lib/cfndsl/rake_task.rb

@@ -79,7 +79,7 @@ module CfnDsl
     #    then any existing file is considered sufficient, and 'latest' is the version used for downloading
     #
     # @todo Add capability to provide a user spec/patches dir
-    def specification(name: nil, file:, version: nil)
+    def specification(file:, name: nil, version: nil)
       if name
         desc 'Update Resource Specification' unless ::Rake.application.last_description
         task name, [:cfn_spec_version] => file
@@ -218,7 +218,7 @@ module CfnDsl
     end
 
     def verbose
-      (Rake.verbose? || cfndsl_opts&.fetch(:verbose, false)) && STDERR
+      (Rake.verbose? || cfndsl_opts&.fetch(:verbose, false)) && $stderr
     end
 
     def generate(opts)
@@ -238,8 +238,8 @@ module CfnDsl
       verbose&.puts("Writing to #{type}")
     end
 
-    def outputter(opts)
-      opts[:output].nil? ? yield(STDOUT) : file_output(opts[:output]) { |f| yield f }
+    def outputter(opts, &block)
+      opts[:output].nil? ? yield($stdout) : file_output(opts[:output], &block)
     end
 
     def model(filename)
@@ -253,8 +253,8 @@ module CfnDsl
       cfndsl_opts.fetch(:extras, [])
     end
 
-    def file_output(path)
-      File.open(File.expand_path(path), 'w') { |f| yield f }
+    def file_output(path, &block)
+      File.open(File.expand_path(path), 'w', &block)
     end
   end
   # rubocop:enable Metrics/ClassLength

data/lib/cfndsl/ref_check.rb

@@ -10,7 +10,7 @@ module RefCheck
   end
 
   # Build up a set of references.
-  # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+  # rubocop:disable Metrics/CyclomaticComplexity
   def build_references(refs = [], origin = nil, method = :all_refs)
     if respond_to?(method)
       send(method).each do |ref|
@@ -30,7 +30,7 @@ module RefCheck
 
     refs
   end
-  # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
+  # rubocop:enable Metrics/CyclomaticComplexity
 
   def ref_children
     []

data/lib/cfndsl/runner.rb

@@ -117,14 +117,14 @@ module CfnDsl
       end
 
       filename = File.expand_path(ARGV[0])
-      verbose = options[:verbose] && STDERR
+      verbose = options[:verbose] && $stderr
 
       verbose.puts "Using specification file #{CfnDsl.specification_file}" if verbose
 
       require_relative 'cloudformation'
       model = CfnDsl.eval_file_with_extras(filename, options[:extras], verbose)
 
-      output = STDOUT
+      output = $stdout
       if options[:output] != '-'
         verbose.puts("Writing to #{options[:output]}") if verbose
         output = File.open(File.expand_path(options[:output]), 'w')

data/lib/cfndsl/specification.rb

@@ -70,20 +70,18 @@ module CfnDsl
         next unless %w[ResourceTypes PropertyTypes].include?(top_level_type)
 
         patches.each_pair do |property_type_name, patch_details|
-          begin
-            applies_to = spec[top_level_type]
-            unless property_type_name == 'patch'
-              # Patch applies within a specific property type
-              applies_to = applies_to[property_type_name]
-              patch_details = patch_details['patch']
-            end
-
-            Hana::Patch.new(patch_details['operations']).apply(applies_to) if patch_required?(patch_details)
-          rescue Hana::Patch::MissingTargetException => e
-            raise "Failed specification patch #{top_level_type} #{property_type_name} from #{from_file}" if fail_patches
-
-            warn "Ignoring failed specification patch #{top_level_type} #{property_type_name} from #{from_file} - #{e.class.name}:#{e.message}"
+          applies_to = spec[top_level_type]
+          unless property_type_name == 'patch'
+            # Patch applies within a specific property type
+            applies_to = applies_to[property_type_name]
+            patch_details = patch_details['patch']
           end
+
+          Hana::Patch.new(patch_details['operations']).apply(applies_to) if patch_required?(patch_details)
+        rescue Hana::Patch::MissingTargetException => e
+          raise "Failed specification patch #{top_level_type} #{property_type_name} from #{from_file}" if fail_patches
+
+          warn "Ignoring failed specification patch #{top_level_type} #{property_type_name} from #{from_file} - #{e.class.name}:#{e.message}"
         end
       end
     end

data/lib/cfndsl/types.rb

@@ -9,6 +9,18 @@ module CfnDsl
   # Types helper
   # rubocop:disable Metrics/ModuleLength
   module Types
+    def self.extract_list_type(root_name, property_info)
+      # Tag is a reused type, but not quite primitive
+      # and not all resources use the general form
+      if property_info['ItemType'] == 'Tag'
+        ['Tag']
+      elsif (property_info['ItemType'] == 'Json') && (property_info['Type'] == 'List')
+        ['Json']
+      else
+        Array(root_name + property_info['ItemType'])
+      end
+    end
+
     def self.extract_from_resource_spec(fail_patches: false)
       spec = Specification.load_file(fail_patches: fail_patches)
       resources = extract_resources spec.resources
@@ -16,35 +28,31 @@ module CfnDsl
       { 'Resources' => resources, 'Types' => types, 'Version' => spec.version, 'File' => spec.file }
     end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/CyclomaticComplexity
     def self.extract_resources(spec)
       spec.each_with_object({}) do |(resource_name, resource_info), resources|
         properties = resource_info['Properties'].each_with_object({}) do |(property_name, property_info), extracted|
           # some json incorrectly labelled as Type -> Json instead of PrimitiveType
           # also, AWS now has the concept of Map which cfndsl had never defined
-          if property_info['Type'] == 'Map' || property_info['Type'] == 'Json'
-            property_type = 'Json'
-          elsif property_info['PrimitiveType']
-            property_type = property_info['PrimitiveType']
-          elsif property_info['PrimitiveItemType']
-            property_type = Array(property_info['PrimitiveItemType'])
-          elsif property_info['PrimitiveTypes']
-            property_type = property_info['PrimitiveTypes'][0]
-          elsif property_info['ItemType']
-            # Tag is a reused type, but not quite primitive
-            # and not all resources use the general form
-            property_type = if property_info['ItemType'] == 'Tag'
-                              ['Tag']
-                            else
-                              Array(resource_name.split('::').join + property_info['ItemType'])
-                            end
-          elsif property_info['Type']
-            # Special types (defined below) are joined with their parent
-            # resource name for uniqueness and connection
-            property_type = resource_name.split('::').join + property_info['Type']
-          else
-            warn "could not extract resource type from #{resource_name}"
-          end
+          property_type =
+            if property_info['Type'] == 'Map' || property_info['Type'] == 'Json'
+              'Json'
+            elsif property_info['PrimitiveType']
+              property_info['PrimitiveType']
+            elsif property_info['PrimitiveItemType']
+              Array(property_info['PrimitiveItemType'])
+            elsif property_info['PrimitiveTypes']
+              property_info['PrimitiveTypes'][0]
+            elsif property_info['ItemType']
+              extract_list_type(resource_name.split('::').join, property_info)
+            elsif property_info['Type']
+              # Special types (defined below) are joined with their parent
+              # resource name for uniqueness and connection
+              resource_name.split('::').join + property_info['Type']
+            else
+              warn "could not extract resource type for property #{property_name} from #{resource_name}, assuming Json"
+              'Json'
+            end
           extracted[property_name] = property_type
           extracted
         end
@@ -52,7 +60,6 @@ module CfnDsl
         resources
       end
     end
-    # rubocop:enable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
 
     # rubocop:disable Metrics/AbcSize, Metrics/PerceivedComplexity, Metrics/MethodLength
     def self.extract_types(spec)
@@ -76,43 +83,43 @@ module CfnDsl
         root_resource_name = root_resource ? root_resource[1].gsub(/::/, '') : property_name
         property_name = property_name.gsub(/::|\./, '')
 
-        if property_info.key?('PrimitiveType')
-          properties = property_info['PrimitiveType']
-        elsif property_info.key?('Type')
-          properties = property_info['Type']
-        elsif property_info.key?('Properties')
-          properties = property_info['Properties'].each_with_object({}) do |(nested_prop_name, nested_prop_info), extracted|
-            if nested_prop_info['Type'] == 'Map' || nested_prop_info['Type'] == 'Json'
-              # The Map type and the incorrectly labelled Json type
-              nested_prop_type = 'Json'
-            elsif nested_prop_info['PrimitiveType']
-              nested_prop_type = nested_prop_info['PrimitiveType']
-            elsif nested_prop_info['PrimitiveItemType']
-              nested_prop_type = Array(nested_prop_info['PrimitiveItemType'])
-            elsif nested_prop_info['PrimitiveItemTypes']
-              nested_prop_type = Array(nested_prop_info['PrimitiveItemTypes'])
-            elsif nested_prop_info['Types']
-              nested_prop_type = Array(nested_prop_info['Types'])
-            elsif nested_prop_info['ItemType']
-              # Tag is a reused type, but not quite primitive
-              # and not all resources use the general form
+        properties =
+          if property_info.key?('PrimitiveType')
+            property_info['PrimitiveType']
+          elsif property_info.key?('ItemType')
+            extract_list_type(root_resource_name, property_info)
+          elsif property_info.key?('Type')
+            property_info['Type']
+          elsif property_info.key?('Properties')
+            property_info['Properties'].each_with_object({}) do |(nested_prop_name, nested_prop_info), extracted|
               nested_prop_type =
-                if nested_prop_info['ItemType'] == 'Tag'
-                  ['Tag']
+                if nested_prop_info['Type'] == 'Map' || nested_prop_info['Type'] == 'Json'
+                  # The Map type and the incorrectly labelled Json type
+                  'Json'
+                elsif nested_prop_info['PrimitiveType']
+                  nested_prop_info['PrimitiveType']
+                elsif nested_prop_info['PrimitiveItemType']
+                  Array(nested_prop_info['PrimitiveItemType'])
+                elsif nested_prop_info['PrimitiveItemTypes']
+                  Array(nested_prop_info['PrimitiveItemTypes'])
+                elsif nested_prop_info['Types']
+                  Array(nested_prop_info['Types'])
+                elsif nested_prop_info['ItemType']
+                  extract_list_type(root_resource_name, nested_prop_info)
+                elsif nested_prop_info['Type']
+                  root_resource_name + nested_prop_info['Type']
                 else
-                  Array(root_resource_name + nested_prop_info['ItemType'])
+                  warn "could not extract property type for #{nested_prop_name} from #{property_name}, assuming Json"
+                  p nested_prop_info
+                  'Json'
                 end
-
-            elsif nested_prop_info['Type']
-              nested_prop_type = root_resource_name + nested_prop_info['Type']
-            else
-              warn "could not extract property type from #{property_name}"
-              p nested_prop_info
+              extracted[nested_prop_name] = nested_prop_type
+              extracted
             end
-            extracted[nested_prop_name] = nested_prop_type
-            extracted
+          else
+            # No Type information typically just a plain JSON object
+            'Json'
           end
-        end
         types[property_name] = properties
         types
       end
@@ -152,27 +159,33 @@ module CfnDsl
       classes = {}
 
       # Go through and declare all of the types first
-      types_list['Types'].each_key do |typename|
-        if !type_def.const_defined?(typename)
-          klass = type_def.const_set(typename, Class.new(type_def::Type))
-          classes[typename] = klass
-        else
-          classes[typename] = type_def.const_get(typename)
+      types_list['Types'].each_pair do |typename, type_val|
+        unless type_def.const_defined?(typename)
+          if type_val.is_a?(Array)
+            type_def.const_set(typename, type_val)
+          else
+            classes[typename] = type_def.const_set(typename, Class.new(type_def::Type))
+          end
         end
       end
 
       # Now go through them again and define attribute setter methods
-      classes.each_pair do |typename, type|
+      classes.each_pair do |typename, klass|
         typeval = types_list['Types'][typename]
         next unless typeval.respond_to?(:each_pair)
 
         typeval.each_pair do |attr_name, attr_type|
           attr_method = attr_name
           variable = "@#{attr_name}".to_sym
-          klass = nil
+
+          # handle bogus List defined as Type
+          unless attr_type.is_a?(Array)
+            attr_class = type_def.const_get(attr_type)
+            attr_type = attr_class if attr_class.is_a?(Array)
+          end
 
           if attr_type.is_a?(Array)
-            klass = type_def.const_get(attr_type[0])
+            attr_class = type_def.const_get(attr_type[0])
             singular_method = CfnDsl::Plurals.singularize(attr_name)
 
             if singular_method == attr_name
@@ -180,16 +193,14 @@ module CfnDsl
               attr_method = CfnDsl::Plurals.pluralize(attr_name)
             end
 
-            define_array_method(klass, singular_method, type, variable) if singular_method != attr_method
-
-          else
-            klass = type_def.const_get(attr_type)
+            define_array_method(attr_class, singular_method, klass, variable) if singular_method != attr_method
           end
 
-          type.class_eval do
+          klass.class_eval do
             CfnDsl.method_names(attr_method) do |inner_method|
               define_method(inner_method) do |value = nil, *_rest, &block|
-                value ||= klass.new
+                # noinspection RubyScope
+                value ||= attr_class.new
                 instance_variable_set(variable, value)
                 value.instance_eval(&block) if block
                 value

data/lib/cfndsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CfnDsl
-  VERSION = '1.2.0'
+  VERSION = '1.3.3'
 end

data/lib/deep_merge/core.rb

@@ -120,16 +120,16 @@ module DeepMerge
           puts "#{di} looping: #{src_key.inspect} => #{src_value.inspect} :: #{dest.inspect}" if merge_debug
           if dest[src_key]
             puts "#{di} ==>merging: #{src_key.inspect} => #{src_value.inspect} :: #{dest[src_key].inspect}" if merge_debug
-            dest[src_key] = deep_merge!(src_value, dest[src_key], options.merge(debug_indent: di + '  '))
+            dest[src_key] = deep_merge!(src_value, dest[src_key], options.merge(debug_indent: "#{di}  "))
           else # dest[src_key] doesn't exist so we want to create and overwrite it (but we do this via deep_merge!)
             puts "#{di} ==>merging over: #{src_key.inspect} => #{src_value.inspect}" if merge_debug
-            # note: we rescue here b/c some classes respond to "dup" but don't implement it (Numeric, TrueClass, FalseClass, NilClass among maybe others)
+            # NOTE: we rescue here b/c some classes respond to "dup" but don't implement it (Numeric, TrueClass, FalseClass, NilClass among maybe others)
             begin
               src_dup = src_value.dup # we dup src_value if possible because we're going to merge into it (since dest is empty)
             rescue TypeError
               src_dup = src_value
             end
-            dest[src_key] = deep_merge!(src_value, src_dup, options.merge(debug_indent: di + '  '))
+            dest[src_key] = deep_merge!(src_value, src_dup, options.merge(debug_indent: "#{di}  "))
           end
         elsif dest.is_a?(Array) && extend_existing_arrays
           dest.push(source)
@@ -181,12 +181,12 @@ module DeepMerge
             list = []
             dest.each_index do |i|
               list[i] = deep_merge!(source[i] || {}, dest[i],
-                                    options.merge(debug_indent: di + '  '))
+                                    options.merge(debug_indent: "#{di}  "))
             end
-            list += source[dest.count..-1] if source.count > dest.count
+            list += source[dest.count..] if source.count > dest.count
             dest = list
           elsif keep_array_duplicates
-            dest = dest.concat(source)
+            dest.concat(source)
           else
             dest |= source
           end