humidifier 1.8.0 → 1.9.1.1

data/lib/humidifier/aws_adapters/base.rb

@@ -31,7 +31,8 @@ module Humidifier
       # Upload a CFN stack to S3 so that it can be referenced via template_url
       def upload(payload)
         Humidifier.config.ensure_upload_configured!(payload)
-        upload_object(payload, "#{Humidifier.config.s3_prefix}#{payload.identifier}.json")
+        filename = "#{Humidifier.config.s3_prefix}#{payload.identifier}.json"
+        upload_object(payload, filename)
       end
 
       # Validate a template in CFN
@@ -48,7 +49,8 @@ module Humidifier
       private
 
       def client
-        @client ||= base_module::CloudFormation::Client.new(region: AwsShim::REGION)
+        @client ||=
+          base_module::CloudFormation::Client.new(region: AwsShim::REGION)
       end
 
       def try_valid

data/lib/humidifier/aws_adapters/noop.rb

@@ -2,7 +2,8 @@ module Humidifier
   module AwsAdapters
     # An adapter used when neither SDK is loaded
     class Noop
-      # Capture all STACK_METHODS method calls and warn that they will not be run
+      # Capture all STACK_METHODS method calls and warn that they will not be
+      # run
       def method_missing(method, *)
         if AwsShim::STACK_METHODS.include?(method)
           puts "WARNING: Cannot run #{method} because aws-sdk not loaded."

data/lib/humidifier/aws_adapters/sdkv1.rb

@@ -23,12 +23,20 @@ module Humidifier
         AWS
       end
 
+      def failure_event_filtered?(event)
+        !event.resource_status.include?('FAILED') ||
+          !event.key?(:resource_status_reason)
+      end
+
       def handle_failure(payload)
         reasons = []
-        client.describe_stack_events(stack_name: payload.identifier).stack_events.each do |event|
-          next unless event.resource_status.include?('FAILED') && event.key?(:resource_status_reason)
+        response = client.describe_stack_events(stack_name: payload.identifier)
+
+        response.stack_events.each do |event|
+          next if failure_event_filtered?(event)
           reasons.unshift(event.resource_status_reason)
         end
+
         raise "#{payload.name} stack failed:\n#{reasons.join("\n")}"
       end
 
@@ -37,7 +45,8 @@ module Humidifier
 
         aws_stack = nil
         Sleeper.new(payload.max_wait) do
-          aws_stack = client.describe_stacks(stack_name: payload.identifier).stacks.first
+          response = client.describe_stacks(stack_name: payload.identifier)
+          aws_stack = response.stacks.first
           !aws_stack.stack_status.end_with?('IN_PROGRESS')
         end
 
@@ -48,11 +57,14 @@ module Humidifier
       def upload_object(payload, key)
         base_module.config(region: AwsShim::REGION)
         @s3 ||= base_module::S3.new
-        @s3.buckets[Humidifier.config.s3_bucket].objects.create(key, payload.template_body).url_for(:read)
+
+        objects = @s3.buckets[Humidifier.config.s3_bucket].objects
+        objects.create(key, payload.template_body).url_for(:read)
       end
 
       def unsupported(method)
-        puts "WARNING: Cannot #{method} because that functionality is not supported in V1 of aws-sdk."
+        puts "WARNING: Cannot #{method} because that functionality is not " \
+             'supported in V1 of aws-sdk.'
         false
       end
     end

data/lib/humidifier/aws_adapters/sdkv2.rb

@@ -2,9 +2,13 @@ module Humidifier
   module AwsAdapters
     # The adapter for v2 of aws-sdk
     class SDKV2 < Base
+      # Format of the timestamp used in changeset naming
+      TIME_FORMAT = '%Y-%m-%d-%H-%M-%S'.freeze
+
       # Create a change set in CFN
       def create_change_set(payload)
-        payload.merge(change_set_name: "changeset-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}")
+        change_set_name = "changeset-#{Time.now.strftime(TIME_FORMAT)}"
+        payload.merge(change_set_name: change_set_name)
         try_valid { client.create_change_set(payload.create_change_set_params) }
       end
 
@@ -27,8 +31,9 @@ module Humidifier
       def perform_and_wait(method, payload)
         method = exists?(payload) ? :update : :create if method == :deploy
         response = public_send(method, payload)
+        signal = :"stack_#{method}_complete"
 
-        client.wait_until(:"stack_#{method}_complete", stack_name: payload.identifier) do |waiter|
+        client.wait_until(signal, stack_name: payload.identifier) do |waiter|
           waiter.max_attempts = payload.max_wait / 5
           waiter.delay = 5
         end
@@ -39,8 +44,15 @@ module Humidifier
       def upload_object(payload, key)
         base_module.config.update(region: AwsShim::REGION)
         @s3_client ||= base_module::S3::Client.new
-        @s3_client.put_object(body: payload.template_body, bucket: Humidifier.config.s3_bucket, key: key)
-        base_module::S3::Object.new(Humidifier.config.s3_bucket, key).presigned_url(:get)
+
+        @s3_client.put_object(
+          body: payload.template_body,
+          bucket: Humidifier.config.s3_bucket,
+          key: key
+        )
+
+        object = base_module::S3::Object.new(Humidifier.config.s3_bucket, key)
+        object.presigned_url(:get)
       end
     end
   end

data/lib/humidifier/aws_shim.rb

@@ -17,13 +17,13 @@ module Humidifier
       create_change_set deploy_change_set
     ].freeze
 
-    attr_accessor :shim
+    attr_reader :shim
 
     # Either set the SDK based on the configured option or guess the SDK
     # version by attempting to require both aws-sdk-v1 and aws-sdk, then setting
     # the shim based on what successfully loaded
     def initialize
-      self.shim =
+      @shim =
         if Humidifier.config.sdk_version_1?
           AwsAdapters::SDKV1.new
         elsif Humidifier.config.sdk_version_2?

data/lib/humidifier/condition.rb

@@ -1,10 +1,10 @@
 module Humidifier
   # Represents a CFN stack condition
   class Condition
-    attr_accessor :opts
+    attr_reader :opts
 
     def initialize(opts)
-      self.opts = opts
+      @opts = opts
     end
 
     # CFN stack syntax

data/lib/humidifier/configuration.rb

@@ -4,9 +4,10 @@ module Humidifier
     # The message that gets displayed when the stack body is too large to use
     # the template_body option
     UPLOAD_MESSAGE = <<-MSG.freeze
-The %<identifier>s stack's body is too large to be use the template_body option, and therefore must use the
-template_url option instead. You can configure Humidifier to do this automatically by setting up the s3 config
-on the top-level Humidifier object like so:
+The %<identifier>s stack's body is too large to be use the template_body option,
+and therefore must use the template_url option instead. You can configure
+Humidifier to do this automatically by setting up the s3 config on the top-level
+Humidifier object like so:
 
     Humidifier.configure do |config|
       config.s3_bucket = 'my.s3.bucket'
@@ -24,7 +25,8 @@ MSG
 
     # raise an error unless the s3_bucket field is set
     def ensure_upload_configured!(payload)
-      raise UPLOAD_MESSAGE.gsub('%<identifier>s', payload.identifier) if s3_bucket.nil?
+      return if s3_bucket
+      raise UPLOAD_MESSAGE.gsub('%<identifier>s', payload.identifier)
     end
 
     # true if the sdk_version option is set to 1 or '1'

data/lib/humidifier/fn.rb

@@ -2,20 +2,22 @@ module Humidifier
   # Builds CFN function calls
   class Fn
     # The list of all internal functions provided by AWS from
-    # http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
+    # http://docs.aws.amazon.com
+    #   /AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html
     FUNCTIONS = Utils.underscored(%w[And Base64 Equals FindInMap GetAtt GetAZs
                                      If ImportValue Join Not Or Select Sub])
 
-    attr_accessor :name, :value
+    attr_reader :name, :value
 
     def initialize(name, value)
-      self.name = "Fn::#{name}"
-      self.value = value
+      @name = "Fn::#{name}"
+      @value = value
     end
 
     # CFN stack syntax
     def to_cf
-      { name => value }
+      cf_value = value.respond_to?(:cf) ? value.to_cf : value
+      { name => cf_value }
     end
 
     class << self

data/lib/humidifier/loader.rb

@@ -10,8 +10,10 @@ module Humidifier
   # Reads the specs/CloudFormationResourceSpecification.json file and load each
   # resource as a class
   class Loader
+    filename = 'CloudFormationResourceSpecification.json'
+
     # The path to the specification file
-    SPECPATH = File.expand_path(File.join('..', '..', '..', 'CloudFormationResourceSpecification.json'), __FILE__)
+    SPECPATH = File.expand_path(File.join('..', '..', '..', filename), __FILE__)
 
     # Handles searching the PropertyTypes specifications for a specific
     # resource type
@@ -25,7 +27,8 @@ module Humidifier
       # find the substructures necessary for the given resource key
       def search(key)
         results = structs.keys.grep(/#{key}/)
-        Hash[results.map { |result| result.gsub("#{key}.", '') }.zip(structs.values_at(*results))].merge(global)
+        shortened_names = results.map { |result| result.gsub("#{key}.", '') }
+        shortened_names.zip(structs.values_at(*results)).to_h.merge(global)
       end
 
       private
@@ -37,8 +40,8 @@ module Humidifier
 
     # loop through the specs and register each class
     def load
-      parsed   = JSON.parse(File.read(SPECPATH))
-      structs  = StructureContainer.new(parsed['PropertyTypes'])
+      parsed = JSON.parse(File.read(SPECPATH))
+      structs = StructureContainer.new(parsed['PropertyTypes'])
 
       parsed['ResourceTypes'].each do |key, spec|
         match = key.match(/\AAWS::(\w+)::(\w+)\z/)
@@ -68,7 +71,10 @@ module Humidifier
       aws_name = "AWS::#{group}::#{resource}"
       resource_class = build_class(aws_name, spec, substructs)
 
-      Humidifier.const_set(group, Module.new) unless Humidifier.const_defined?(group)
+      unless Humidifier.const_defined?(group)
+        Humidifier.const_set(group, Module.new)
+      end
+
       Humidifier.const_get(group).const_set(resource, resource_class)
       Humidifier.registry[aws_name] = resource_class
     end

data/lib/humidifier/mapping.rb

@@ -1,10 +1,10 @@
 module Humidifier
   # Represents a CFN stack mapping
   class Mapping
-    attr_accessor :opts
+    attr_reader :opts
 
     def initialize(opts = {})
-      self.opts = opts
+      @opts = opts
     end
 
     # CFN stack syntax

data/lib/humidifier/parameter.rb

@@ -2,14 +2,19 @@ module Humidifier
   # Represents a CFN stack parameter
   class Parameter
     # The allowed properties of all stack parameters
-    PROPERTIES = Utils.underscored(%w[AllowedPattern AllowedValues ConstraintDescription Default Description
-                                      MaxLength MaxValue MinLength MinValue NoEcho])
+    PROPERTIES =
+      Utils.underscored(%w[AllowedPattern AllowedValues ConstraintDescription
+                           Default Description MaxLength MaxValue MinLength
+                           MinValue NoEcho])
 
-    attr_accessor :type, *PROPERTIES.values
+    attr_reader :type, *PROPERTIES.values
 
     def initialize(opts = {})
-      PROPERTIES.each_value { |prop| send(:"#{prop}=", opts[prop]) }
-      self.type = opts.fetch(:type, 'String')
+      PROPERTIES.each_value do |property|
+        instance_variable_set(:"@#{property}", opts[property])
+      end
+
+      @type = opts.fetch(:type, 'String')
     end
 
     # CFN stack syntax

data/lib/humidifier/props/base.rb

@@ -2,7 +2,8 @@ module Humidifier
   module Props
     # Superclass for all CFN properties
     class Base
-      # The list of classes that are valid beyond the normal values for each prop
+      # The list of classes that are valid beyond the normal values for each
+      # prop
       WHITELIST = [Fn, Ref].freeze
 
       attr_reader :key, :name, :spec, :substructs
@@ -29,7 +30,8 @@ module Humidifier
         [key, Serializer.dump(value)]
       end
 
-      # the type of update that occurs when this property is updated on its associated resource
+      # the type of update that occurs when this property is updated on its
+      # associated resource
       def update_type
         spec['UpdateType']
       end

data/lib/humidifier/props/boolean_prop.rb

@@ -14,7 +14,8 @@ module Humidifier
 
       # true if it is a boolean
       def valid?(value)
-        whitelisted_value?(value) || value.is_a?(TrueClass) || value.is_a?(FalseClass)
+        return true if whitelisted_value?(value)
+        value.is_a?(TrueClass) || value.is_a?(FalseClass)
       end
     end
   end

data/lib/humidifier/props/list_prop.rb

@@ -11,12 +11,21 @@ module Humidifier
 
       # CFN stack syntax
       def to_cf(list)
-        [key, list.map { |value| subprop.to_cf(value).last }]
+        cf_value =
+          if list.respond_to?(:to_cf)
+            list.to_cf
+          else
+            list.map { |value| subprop.to_cf(value).last }
+          end
+
+        [key, cf_value]
       end
 
-      # Valid if the value is whitelisted or every value in the list is valid on the subprop
+      # Valid if the value is whitelisted or every value in the list is valid
+      # on the subprop
       def valid?(list)
-        whitelisted_value?(list) || (list.is_a?(Enumerable) && list.all? { |value| subprop.valid?(value) })
+        return true if whitelisted_value?(list)
+        list.is_a?(Enumerable) && list.all? { |value| subprop.valid?(value) }
       end
 
       private

data/lib/humidifier/props/map_prop.rb

@@ -6,18 +6,29 @@ module Humidifier
 
       # converts the value through mapping using the subprop unless it is valid
       def convert(map)
-        valid?(map) ? map : map.map { |key, value| [key, subprop.convert(value)] }.to_h
+        return map if valid?(map)
+        map.map { |key, value| [key, subprop.convert(value)] }.to_h
       end
 
       # CFN stack syntax
       def to_cf(map)
-        [key, map.map { |subkey, subvalue| [subkey, subprop.to_cf(subvalue).last] }.to_h]
+        cf_value =
+          if map.respond_to?(:to_cf)
+            map.to_cf
+          else
+            map.each_with_object({}) do |(subkey, subvalue), serialized|
+              serialized[subkey] = subprop.to_cf(subvalue).last
+            end
+          end
+
+        [key, cf_value]
       end
 
       # Valid if the value is whitelisted or every value in the map is valid on
       # the subprop
       def valid?(map)
-        whitelisted_value?(map) || (map.is_a?(Hash) && map.values.all? { |value| subprop.valid?(value) })
+        return true if whitelisted_value?(map)
+        map.is_a?(Hash) && map.values.all? { |value| subprop.valid?(value) }
       end
 
       private

data/lib/humidifier/props/structure_prop.rb

@@ -18,27 +18,50 @@ module Humidifier
 
       # CFN stack syntax
       def to_cf(struct)
-        [key, struct.map { |subkey, subvalue| subprops[subkey.to_s].to_cf(subvalue) }.to_h]
+        cf_value =
+          if struct.respond_to?(:to_cf)
+            struct.to_cf
+          else
+            struct.map do |subkey, subvalue|
+              subprops[subkey.to_s].to_cf(subvalue)
+            end.to_h
+          end
+
+        [key, cf_value]
       end
 
-      # true if the value is whitelisted or Hash and all keys are valid for their corresponding props
+      # true if the value is whitelisted or Hash and all keys are valid for
+      # their corresponding props
       def valid?(struct)
-        whitelisted_value?(struct) || (struct.is_a?(Hash) && valid_struct?(struct))
+        return true if whitelisted_value?(struct)
+        struct.is_a?(Hash) && valid_struct?(struct)
       end
 
       private
 
       def after_initialize(substructs)
-        type = spec['ItemType'] || spec['Type']
-        @subprops =
-          substructs.fetch(type, {}).fetch('Properties', {}).map do |key, config|
-            subprop = config['ItemType'] == type ? self : Props.from(key, config, substructs)
-            [Utils.underscore(key), subprop]
-          end.to_h
+        @subprops = subprops_from(substructs, spec['ItemType'] || spec['Type'])
+      end
+
+      def subprops_from(substructs, type)
+        subprop_names = substructs.fetch(type, {}).fetch('Properties', {})
+
+        subprop_names.each_with_object({}) do |(key, config), subprops|
+          subprop =
+            if config['ItemType'] == type
+              self
+            else
+              Props.from(key, config, substructs)
+            end
+
+          subprops[Utils.underscore(key)] = subprop
+        end
       end
 
       def valid_struct?(struct)
-        struct.all? { |key, value| subprops.key?(key.to_s) && subprops[key.to_s].valid?(value) }
+        struct.all? do |key, value|
+          subprops.key?(key.to_s) && subprops[key.to_s].valid?(value)
+        end
       end
     end
   end

data/lib/humidifier/props.rb

@@ -12,7 +12,8 @@ module Humidifier
       end
 
       # builds a prop that is not a List or Map type
-      # PrimitiveType is one of Boolean, Double, Integer, Json, String, or Timestamp
+      # PrimitiveType is one of Boolean, Double, Integer, Json, String, or
+      # Timestamp
       def singular_from(key, spec, substructs)
         primitive = spec['PrimitiveItemType'] || spec['PrimitiveType']
 

data/lib/humidifier/ref.rb

@@ -1,10 +1,10 @@
 module Humidifier
   # Builds CFN references
   class Ref
-    attr_accessor :reference
+    attr_reader :reference
 
     def initialize(reference)
-      self.reference = reference
+      @reference = reference
     end
 
     # Builds CFN syntax

data/lib/humidifier/resource.rb

@@ -3,7 +3,8 @@ module Humidifier
   class Resource
     # Attributes that are available to every stack
     COMMON_ATTRIBUTES =
-      Utils.underscored(%w[Condition CreationPolicy DeletionPolicy DependsOn Metadata UpdatePolicy])
+      Utils.underscored(%w[Condition CreationPolicy DeletionPolicy DependsOn
+                           Metadata UpdatePolicy])
 
     attr_accessor :properties, *COMMON_ATTRIBUTES.values
 
@@ -13,7 +14,8 @@ module Humidifier
     end
 
     # Patches method_missing to include property accessors
-    # After the first method call, builds the accessor methods to get a speed boost
+    # After the first method call, builds the accessor methods to get a speed
+    # boost
     def method_missing(name, *args)
       if !valid_accessor?(name)
         super
@@ -33,19 +35,31 @@ module Humidifier
 
     # CFN stack syntax
     def to_cf
-      props_cf = properties.map { |key, value| self.class.props[key].to_cf(value) }.to_h
-      { 'Type' => self.class.aws_name, 'Properties' => props_cf }.merge(common_attributes)
+      props_cf =
+        properties.map do |key, value|
+          self.class.props[key].to_cf(value)
+        end
+
+      common_attributes.merge!(
+        'Type' => self.class.aws_name,
+        'Properties' => props_cf.to_h
+      )
     end
 
     # Update a set of properties defined by the given properties hash
     def update(properties, raw = false)
-      properties.each { |property, value| update_property(property, value, raw) }
+      properties.each do |property, value|
+        update_property(property, value, raw)
+      end
     end
 
     # Update the attributes of the resource defined by COMMON_ATTRIBUTES
     def update_attributes(attributes)
       attributes.each do |attribute, value|
-        raise ArgumentError, "Invalid attribute: #{attribute}" unless COMMON_ATTRIBUTES.value?(attribute)
+        unless COMMON_ATTRIBUTES.value?(attribute)
+          raise ArgumentError, "Invalid attribute: #{attribute}"
+        end
+
         public_send(:"#{attribute}=", value)
       end
     end
@@ -96,18 +110,23 @@ module Humidifier
 
     def validate_property(property, raw)
       property = Utils.underscore(property) if raw
+
       unless self.class.prop?(property)
-        raise ArgumentError, "Attempting to set invalid property for #{self.class.name}: #{property}"
+        raise ArgumentError, 'Attempting to set invalid property for ' \
+                             "#{self.class.name}: #{property}"
       end
+
       property
     end
 
     def validate_value(property, value, raw)
       prop = self.class.props[property]
       value = prop.convert(value) if raw
+
       unless prop.valid?(value)
         raise ArgumentError, "Invalid value for #{property}: #{value.inspect}"
       end
+
       value
     end
   end

data/lib/humidifier/sdk_payload.rb

@@ -1,35 +1,38 @@
 module Humidifier
   # The payload sent to the shim methods, representing the stack and the options
   class SdkPayload
-    # The maximum size a template body can be before it has to be put somewhere and referenced through a URL
+    # The maximum size a template body can be before it has to be put somewhere
+    # and referenced through a URL
     MAX_TEMPLATE_BODY_SIZE = 51_200
 
     # The maximum size a template body can be inside of an S3 bucket
     MAX_TEMPLATE_URL_SIZE = 460_800
 
-    # The maximum amount of time that Humidifier should wait for a stack to complete a CRUD operation
+    # The maximum amount of time that Humidifier should wait for a stack to
+    # complete a CRUD operation
     MAX_WAIT = 600
 
     # Thrown when a template is too large to use the template_url option
     class TemplateTooLargeError < StandardError
       def initialize(bytesize)
-        message = <<-MSG
-Cannot use a template > #{MAX_TEMPLATE_URL_SIZE} bytes (currently #{bytesize} bytes), consider using nested stacks
-(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-stack.html)
-MSG
+        message =
+          "Cannot use a template > #{MAX_TEMPLATE_URL_SIZE} bytes " \
+          "(currently #{bytesize} bytes), consider using nested stacks " \
+          '(http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide' \
+          '/aws-properties-stack.html)'
         super(message)
       end
     end
 
-    attr_accessor :stack, :options, :max_wait
+    attr_reader :stack, :options, :max_wait
 
     extend Forwardable
     def_delegators :stack, :id=, :identifier, :name
 
     def initialize(stack, options)
-      self.stack    = stack
-      self.options  = options
-      self.max_wait = options.delete(:max_wait) || MAX_WAIT
+      @stack = stack
+      @options = options
+      @max_wait = options.delete(:max_wait) || MAX_WAIT
     end
 
     # True if the stack and options are the same as the other (used for testing)
@@ -39,7 +42,7 @@ MSG
 
     # Merge in options
     def merge(new_options)
-      self.options = new_options.merge(options)
+      @options = new_options.merge(options)
     end
 
     # The body of the template
@@ -78,17 +81,19 @@ MSG
 
     private
 
-    def template_param
-      @template_param ||= begin
-        bytesize = template_body.bytesize
-        raise TemplateTooLargeError, bytesize if bytesize > MAX_TEMPLATE_URL_SIZE
+    def bytesize
+      template_body.bytesize.tap do |size|
+        raise TemplateTooLargeError, size if size > MAX_TEMPLATE_URL_SIZE
+      end
+    end
 
+    def template_param
+      @template_param ||=
         if bytesize > MAX_TEMPLATE_BODY_SIZE
           { template_url: AwsShim.upload(self) }
         else
           { template_body: template_body }
         end
-      end
     end
   end
 end

data/lib/humidifier/sleeper.rb

@@ -1,11 +1,11 @@
 module Humidifier
   # Manages waiting for stack events for v1 of the SDK
   class Sleeper
-    attr_accessor :attempts
+    attr_reader :attempts
 
     # Store attempts and wait for the block to return true
     def initialize(attempts, &block)
-      self.attempts = attempts
+      @attempts = attempts
       hibernate_until(&block)
     end
 
@@ -15,7 +15,7 @@ module Humidifier
       raise 'Waited too long, giving up' if attempts.zero?
       return if yield
 
-      self.attempts -= 1
+      @attempts -= 1
       sleep 1
       hibernate_until(&block)
     end