stack_master 2.17.1 → 2.19.0

data/lib/stack_master/sparkle_formation/template_file.rb

@@ -49,17 +49,17 @@ module StackMaster
       def _joined_file(file_name, vars = {})
         join!(Template.render('joined_file', file_name, vars))
       end
-      alias_method :joined_file!, :_joined_file
+      alias joined_file! _joined_file
     end
 
     module UserDataFile
       def _user_data_file(file_name, vars = {})
         base64!(join!(Template.render('user_data', file_name, vars)))
       end
-      alias_method :user_data_file!, :_user_data_file
+      alias user_data_file! _user_data_file
     end
   end
 end
 
-SparkleFormation::SparkleAttribute::Aws.send(:include, StackMaster::SparkleFormation::UserDataFile)
-SparkleFormation::SparkleAttribute::Aws.send(:include, StackMaster::SparkleFormation::JoinedFile)
+SparkleFormation::SparkleAttribute::Aws.include StackMaster::SparkleFormation::UserDataFile
+SparkleFormation::SparkleAttribute::Aws.include StackMaster::SparkleFormation::JoinedFile

data/lib/stack_master/sso_group_id_finder.rb

@@ -19,9 +19,9 @@ module StackMaster
             alternate_identifier: {
               unique_attribute: {
                 attribute_path: 'displayName',
-                attribute_value: match[:group_name],
-              },
-            },
+                attribute_value: match[:group_name]
+              }
+            }
           }
         )
         return response.group_id

data/lib/stack_master/stack.rb

@@ -20,9 +20,8 @@ module StackMaster
       TemplateUtils
         .template_hash(template)
         .fetch('Parameters', {})
-        .inject({}) do |result, (parameter_name, description)|
+        .each_with_object({}) do |(parameter_name, description), result|
           result[parameter_name] = description['Default']&.to_s
-          result
         end
     end
 
@@ -35,19 +34,22 @@ module StackMaster
       cf_stack = cf.describe_stacks({ stack_name: stack_name }).stacks.first
       return unless cf_stack
 
-      parameters = cf_stack.parameters.inject({}) do |params_hash, param_struct|
+      parameters = cf_stack.parameters.each_with_object({}) do |param_struct, params_hash|
         params_hash[param_struct.parameter_key] = param_struct.parameter_value
-        params_hash
       end
       template_body ||= cf.get_template({ stack_name: stack_name, template_stage: 'Original' }).template_body
       template_format = TemplateUtils.identify_template_format(template_body)
       stack_policy_body ||= cf.get_stack_policy({ stack_name: stack_name }).stack_policy_body
       outputs = cf_stack.outputs
+      tags = cf_stack.tags&.each_with_object({}) do |tag_struct, tags_hash|
+        tags_hash[tag_struct.key] = tag_struct.value
+      end || {}
 
       new(region: region,
           stack_name: stack_name,
           stack_id: cf_stack.stack_id,
           parameters: parameters,
+          tags: tags,
           template_body: template_body,
           template_format: template_format,
           outputs: outputs,

data/lib/stack_master/stack_definition.rb

@@ -35,7 +35,7 @@ module StackMaster
       @compiler = nil
       super
       @additional_parameter_lookup_dirs ||= []
-      @base_dir ||= ""
+      @base_dir ||= ''
       @template_dir ||= File.join(@base_dir, 'templates')
       @parameters_dir ||= File.join(@base_dir, 'parameters')
       @allowed_accounts = Array(@allowed_accounts)
@@ -44,7 +44,7 @@ module StackMaster
     end
 
     def ==(other)
-      self.class === other &&
+      other.is_a?(self.class) &&
         @region == other.region &&
         @stack_name == other.stack_name &&
         @template == other.template &&
@@ -74,13 +74,12 @@ module StackMaster
     end
 
     def s3_files
-      files.inject({}) do |hash, file|
+      files.each_with_object({}) do |file, hash|
         path = File.join(files_dir, file)
         hash[file] = {
           path: path,
           body: File.read(path)
         }
-        hash
       end
     end
 

data/lib/stack_master/stack_differ.rb

@@ -1,5 +1,5 @@
-require "diffy"
-require "hashdiff"
+require 'diffy'
+require 'hashdiff'
 
 module StackMaster
   class StackDiffer
@@ -34,7 +34,7 @@ module StackMaster
       params = @proposed_stack.parameters_with_defaults
       if @current_stack
         noecho_keys.each do |key|
-          params[key] = "****"
+          params[key] = '****'
         end
       end
       YAML.dump(sort_params(params))
@@ -61,20 +61,43 @@ module StackMaster
                                after: proposed_parameters)
     end
 
+    def tags_different?
+      tags_diff.different?
+    end
+
+    def tags_diff
+      @tags_diff ||= Diff.new(name: 'Tags',
+                              before: current_tags,
+                              after: proposed_tags)
+    end
+
+    def current_tags
+      tags_hash = @current_stack&.tags
+      return '' if tags_hash.nil? || tags_hash.empty?
+
+      YAML.dump(sort_params(tags_hash))
+    end
+
+    def proposed_tags
+      tags_hash = @proposed_stack.tags
+      return '' if tags_hash.nil? || tags_hash.empty?
+
+      YAML.dump(sort_params(tags_hash))
+    end
+
     def output_diff
       body_diff.display
       parameters_diff.display
+      tags_diff.display
 
-      unless noecho_keys.empty?
-        StackMaster.stdout.puts " * can not tell if NoEcho parameters are different."
-      end
-      StackMaster.stdout.puts "No stack found" if @current_stack.nil?
+      StackMaster.stdout.puts ' * can not tell if NoEcho parameters are different.' unless noecho_keys.empty?
+      StackMaster.stdout.puts 'No stack found' if @current_stack.nil?
     end
 
     def noecho_keys
       if @current_stack
-        @current_stack.parameters_with_defaults.select do |key, value|
-          value == "****"
+        @current_stack.parameters_with_defaults.select do |_key, value|
+          value == '****'
         end.keys
       else
         []
@@ -88,7 +111,7 @@ module StackMaster
       return false if differences.count != 1
 
       diff = differences[0]
-      diff[0] == "~" && diff[1] == param_name
+      diff[0] == '~' && diff[1] == param_name
     end
 
     private

data/lib/stack_master/template_compiler.rb

@@ -10,7 +10,7 @@ module StackMaster
                  end
       compiler.require_dependencies
       compiler.compile(template_dir, template, compile_time_parameters, compiler_options)
-    rescue StandardError => e
+    rescue StandardError
       raise TemplateCompilationFailed, "Failed to compile #{template}"
     end
 

data/lib/stack_master/template_compilers/json.rb

@@ -1,6 +1,6 @@
 module StackMaster::TemplateCompilers
   class Json
-    MAX_TEMPLATE_SIZE = 51200
+    MAX_TEMPLATE_SIZE = 51_200
     private_constant :MAX_TEMPLATE_SIZE
 
     def self.require_dependencies

data/lib/stack_master/template_compilers/sparkle_formation.rb

@@ -3,80 +3,82 @@ require 'stack_master/sparkle_formation/compile_time/definitions_validator'
 require 'stack_master/sparkle_formation/compile_time/state_builder'
 
 module StackMaster::TemplateCompilers
-  class SparkleFormation
+  module SparkleFormation
     CompileTime = StackMaster::SparkleFormation::CompileTime
 
-    def self.require_dependencies
-      require 'sparkle_formation'
-      require 'stack_master/sparkle_formation/template_file'
-    end
+    class << self
+      def require_dependencies
+        require 'sparkle_formation'
+        require 'stack_master/sparkle_formation/template_file'
+      end
 
-    def self.compile(template_dir, template, compile_time_parameters, compiler_options = {})
-      sparkle_template = compile_sparkle_template(template_dir, template, compiler_options)
-      definitions = sparkle_template.parameters
-      validate_definitions(definitions)
-      validate_parameters(definitions, compile_time_parameters)
+      def compile(template_dir, template, compile_time_parameters, compiler_options = {})
+        sparkle_template = compile_sparkle_template(template_dir, template, compiler_options)
+        definitions = sparkle_template.parameters
+        validate_definitions(definitions)
+        validate_parameters(definitions, compile_time_parameters)
 
-      sparkle_template.compile_time_parameter_setter do
-        sparkle_template.compile_state = create_state(definitions, compile_time_parameters)
+        sparkle_template.compile_time_parameter_setter do
+          sparkle_template.compile_state = create_state(definitions, compile_time_parameters)
+        end
+
+        JSON.pretty_generate(sparkle_template.dump)
       end
 
-      JSON.pretty_generate(sparkle_template.dump)
-    end
+      private
+
+      def compile_sparkle_template(template_dir, template, compiler_options)
+        sparkle_path =
+          if compiler_options['sparkle_path']
+            File.expand_path(compiler_options['sparkle_path'])
+          else
+            template_dir
+          end
+
+        collection = ::SparkleFormation::SparkleCollection.new
+        root_pack = ::SparkleFormation::Sparkle.new(
+          root: sparkle_path
+        )
+        collection.set_root(root_pack)
+        if compiler_options['sparkle_packs']
+          compiler_options['sparkle_packs'].each do |pack_name|
+            require pack_name
+            pack = ::SparkleFormation::SparklePack.new(name: pack_name)
+            collection.add_sparkle(pack)
+          end
+        end
 
-    private
+        if compiler_options['sparkle_pack_template']
+          unless collection.templates['aws'].include? template
+            raise ArgumentError.new("Template #{template.inspect} not found in any sparkle pack")
+          end
 
-    def self.compile_sparkle_template(template_dir, template, compiler_options)
-      sparkle_path =
-        if compiler_options['sparkle_path']
-          File.expand_path(compiler_options['sparkle_path'])
+          template_file_path = collection.templates['aws'][template].top['path']
         else
-          template_dir
+          template_file_path = File.join(template_dir, template)
         end
 
-      collection = ::SparkleFormation::SparkleCollection.new
-      root_pack = ::SparkleFormation::Sparkle.new(
-        :root => sparkle_path,
-      )
-      collection.set_root(root_pack)
-      if compiler_options['sparkle_packs']
-        compiler_options['sparkle_packs'].each do |pack_name|
-          require pack_name
-          pack = ::SparkleFormation::SparklePack.new(:name => pack_name)
-          collection.add_sparkle(pack)
-        end
+        sparkle_template = compile_template_with_sparkle_path(template_file_path, sparkle_path)
+        sparkle_template.sparkle.apply(collection)
+        sparkle_template
       end
 
-      if compiler_options['sparkle_pack_template']
-        unless collection.templates['aws'].include? template
-          raise ArgumentError.new("Template #{template.inspect} not found in any sparkle pack")
-        end
-
-        template_file_path = collection.templates['aws'][template].top['path']
-      else
-        template_file_path = File.join(template_dir, template)
+      def compile_template_with_sparkle_path(template_path, sparkle_path)
+        ::SparkleFormation.sparkle_path = sparkle_path
+        ::SparkleFormation.compile(template_path, :sparkle)
       end
 
-      sparkle_template = compile_template_with_sparkle_path(template_file_path, sparkle_path)
-      sparkle_template.sparkle.apply(collection)
-      sparkle_template
-    end
-
-    def self.compile_template_with_sparkle_path(template_path, sparkle_path)
-      ::SparkleFormation.sparkle_path = sparkle_path
-      ::SparkleFormation.compile(template_path, :sparkle)
-    end
-
-    def self.validate_definitions(definitions)
-      CompileTime::DefinitionsValidator.new(definitions).validate
-    end
+      def validate_definitions(definitions)
+        CompileTime::DefinitionsValidator.new(definitions).validate
+      end
 
-    def self.validate_parameters(definitions, compile_time_parameters)
-      CompileTime::ParametersValidator.new(definitions, compile_time_parameters).validate
-    end
+      def validate_parameters(definitions, compile_time_parameters)
+        CompileTime::ParametersValidator.new(definitions, compile_time_parameters).validate
+      end
 
-    def self.create_state(definitions, compile_time_parameters)
-      CompileTime::StateBuilder.new(definitions, compile_time_parameters).build
+      def create_state(definitions, compile_time_parameters)
+        CompileTime::StateBuilder.new(definitions, compile_time_parameters).build
+      end
     end
 
     StackMaster::TemplateCompiler.register(:sparkle_formation, self)

data/lib/stack_master/template_utils.rb

@@ -1,7 +1,7 @@
 module StackMaster
   module TemplateUtils
-    MAX_TEMPLATE_SIZE = 51200
-    MAX_S3_TEMPLATE_SIZE = 460800
+    MAX_TEMPLATE_SIZE = 51_200
+    MAX_S3_TEMPLATE_SIZE = 460_800
     # Matches if the first non-whitespace character is a '{', handling cases
     # with leading whitespace and extra (whitespace-only) lines.
     JSON_IDENTIFICATION_PATTERN = Regexp.new('\A\s*{', Regexp::MULTILINE)

data/lib/stack_master/test_driver/cloud_formation.rb

@@ -28,6 +28,14 @@ module StackMaster
                          parameter_value: hash[:parameter_value])
         end
       end
+
+      def tags
+        return [] if @tags.nil?
+
+        @tags.map do |hash|
+          OpenStruct.new(key: hash[:key], value: hash[:value])
+        end
+      end
     end
 
     class StackEvent
@@ -139,11 +147,11 @@ module StackMaster
         stack_name = options[:stack_name]
         stacks =
           if stack_name
-            if @stacks[stack_name]
-              [@stacks[stack_name]]
-            else
+            unless @stacks[stack_name]
               raise Aws::CloudFormation::Errors::ValidationError.new('', 'Stack does not exist')
             end
+
+            [@stacks[stack_name]]
           else
             @stacks.values
           end
@@ -184,7 +192,7 @@ module StackMaster
         @stacks.delete(stack_name)
       end
 
-      def validate_template(options)
+      def validate_template(_options)
         true
       end
 

data/lib/stack_master/test_driver/s3.rb

@@ -5,11 +5,10 @@ module StackMaster
         reset
       end
 
-      def set_region(_)
-      end
+      def set_region(_); end
 
       def reset
-        @files = Hash.new { |hash, key| hash[key] = Hash.new }
+        @files = Hash.new { |hash, key| hash[key] = {} }
       end
 
       def upload_files(bucket: nil, prefix: nil, region: nil, files: {})

data/lib/stack_master/utils.rb

@@ -22,18 +22,16 @@ module StackMaster
     end
 
     def hash_to_aws_parameters(params)
-      params.inject([]) do |params, (key, value)|
+      params.each_with_object([]) do |(key, value), params|
         params << { parameter_key: key, parameter_value: value }
-        params
       end
     end
 
     def hash_to_aws_tags(tags)
       return [] if tags.nil?
 
-      tags.inject([]) do |aws_tags, (key, value)|
+      tags.each_with_object([]) do |(key, value), aws_tags|
         aws_tags << { key: key, value: value }
-        aws_tags
       end
     end
 
@@ -42,9 +40,8 @@ module StackMaster
     end
 
     def underscore_keys_to_hyphen(hash)
-      hash.inject({}) do |hash, (key, value)|
+      hash.each_with_object({}) do |(key, value), hash|
         hash[underscore_to_hyphen(key)] = value
-        hash
       end
     end
   end

data/lib/stack_master/validator.rb

@@ -17,7 +17,7 @@ module StackMaster
         return false
       end
       cf.validate_template(template_body: TemplateUtils.maybe_compressed_template_body(stack.template_body))
-      StackMaster.stdout.puts "valid"
+      StackMaster.stdout.puts 'valid'
       true
     rescue Aws::CloudFormation::Errors::ValidationError => e
       StackMaster.stdout.puts "invalid. #{e.message}"

data/lib/stack_master/version.rb

@@ -1,3 +1,3 @@
 module StackMaster
-  VERSION = "2.17.1"
+  VERSION = '2.19.0'
 end

data/lib/stack_master.rb

@@ -172,7 +172,7 @@ module StackMaster
   @non_interactive_answer = 'y'
 
   def base_dir
-    File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    File.expand_path(File.join(File.dirname(__FILE__), '..'))
   end
 
   def cloud_formation_driver

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stack_master
 version: !ruby/object:Gem::Version
-  version: 2.17.1
+  version: 2.19.0
 platform: ruby
 authors:
 - Steve Hodgkiss
@@ -173,7 +173,7 @@ dependencies:
         version: 4.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -183,7 +183,7 @@ dependencies:
         version: 4.6.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-acm
   requirement: !ruby/object:Gem::Requirement
@@ -616,14 +616,15 @@ files:
 - stacktemplates/parameter_stack_name.yml
 - stacktemplates/stack.json.erb
 - stacktemplates/stack_master.yml.erb
-homepage: https://opensource.envato.com/projects/stack_master.html
+homepage: https://github.com/envato/stack_master
 licenses:
 - MIT
 metadata:
+  allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/envato/stack_master/issues
   changelog_uri: https://github.com/envato/stack_master/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.17.1
-  source_code_uri: https://github.com/envato/stack_master/tree/v2.17.1
+  documentation_uri: https://www.rubydoc.info/gems/stack_master/2.19.0
+  source_code_uri: https://github.com/envato/stack_master/tree/v2.19.0
 rdoc_options: []
 require_paths:
 - lib
@@ -638,7 +639,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.2
+rubygems_version: 4.0.16
 specification_version: 4
 summary: StackMaster is a sure-footed way of creating, updating and keeping track
   of Amazon (AWS) CloudFormation stacks.