pdk 2.7.1 → 3.0.0

data/lib/pdk/validate/internal_ruby_validator.rb

@@ -38,6 +38,7 @@ module PDK
       # @see PDK::Validate::Validator.prepare_invoke!
       def prepare_invoke!
         return if @prepared
+
         super
 
         # Parse the targets
@@ -65,11 +66,11 @@ module PDK
           validation_result = validate_target(report, target)
           if validation_result.nil?
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message:  "Validation did not return an exit code for #{target}",
+              message: "Validation did not return an exit code for #{target}"
             )
             validation_result = 1
           end

data/lib/pdk/validate/invokable_validator.rb

@@ -38,6 +38,7 @@ module PDK
       # @see PDK::Validate::Validator.prepare_invoke!
       def prepare_invoke!
         return if @prepared
+
         super
 
         # Register the spinner
@@ -63,6 +64,7 @@ module PDK
         # targets. For example, using rubocop with no targets, will allow rubocop to determine the
         # target list using it's .rubocop.yml file
         return [[], [], []] if requested_targets.empty? && allow_empty_targets?
+
         # If no targets are specified, then we will run validations from the base context directory.
         targets = requested_targets.empty? ? [context.root_path] : requested_targets
         targets.map! { |r| r.gsub(File::ALT_SEPARATOR, File::SEPARATOR) } if File::ALT_SEPARATOR
@@ -72,7 +74,7 @@ module PDK
 
         skipped = []
         invalid = []
-        matched = targets.map { |target|
+        matched = targets.filter_map do |target|
           if pattern.nil?
             target
           else
@@ -87,16 +89,14 @@ module PDK
               target_list = target_list.reject { |file| ignore_list.match(file) }
 
               if target_list.flatten.empty?
-                PDK.logger.info('Validator \'%{validator}\' skipped for \'%{target}\'. No files matching \'%{pattern}\' found to validate.' % { validator: name, target: target, pattern: pattern })
+                PDK.logger.info(format('Validator \'%{validator}\' skipped for \'%{target}\'. No files matching \'%{pattern}\' found to validate.', validator: name, target: target, pattern: pattern))
 
                 skipped << target
               end
 
               target_list
             elsif PDK::Util::Filesystem.file?(target)
-              if Array(pattern).include? target
-                target
-              elsif Array(pattern).any? { |p| PDK::Util::Filesystem.fnmatch(PDK::Util::Filesystem.expand_path(p), PDK::Util::Filesystem.expand_path(target), File::FNM_DOTMATCH) }
+              if (Array(pattern).include? target) || fnmatch?(pattern, target)
                 target
               else
                 skipped << target
@@ -107,10 +107,17 @@ module PDK
               next
             end
           end
-        }.compact.flatten.uniq
+        end.flatten.uniq
         [matched, skipped, invalid]
       end
 
+      # Matches a target against a pattern
+      # @param pattern [String, Array[String]] The pattern to match against
+      # @return [Boolean]
+      def fnmatch?(pattern, target)
+        Array(pattern).any? { |p| PDK::Util::Filesystem.fnmatch(PDK::Util::Filesystem.expand_path(p), PDK::Util::Filesystem.expand_path(target), File::FNM_DOTMATCH) }
+      end
+
       # Whether the target parsing ignores "dotfiles" (e.g. .gitignore or .pdkignore) which are considered hidden files in POSIX
       # @return [Boolean]
       # @abstract
@@ -121,13 +128,14 @@ module PDK
       # @see PDK::Validate::Validator.spinner_text
       # @abstract
       def spinner_text
-        'Running %{name} validator ...' % { name: name }
+        format('Running %{name} validator ...', name: name)
       end
 
       # @see PDK::Validate::Validator.spinner
       def spinner
         return nil unless spinners_enabled?
         return @spinner unless @spinner.nil?
+
         require 'pdk/cli/util/spinner'
 
         @spinner = TTY::Spinner.new("[:spinner] #{spinner_text}", PDK::CLI::Util.spinner_opts_for_platform)
@@ -138,13 +146,13 @@ module PDK
       # @param skipped [Array[String]] The list of skipped targets
       def process_skipped(report, skipped = [])
         skipped.each do |skipped_target|
-          PDK.logger.debug('%{validator}: Skipped \'%{target}\'. Target does not contain any files to validate (%{pattern}).' % { validator: name, target: skipped_target, pattern: pattern })
+          PDK.logger.debug(format('%{validator}: Skipped \'%{target}\'. Target does not contain any files to validate (%{pattern}).', validator: name, target: skipped_target, pattern: pattern))
           report.add_event(
-            file:     skipped_target,
-            source:   name,
-            message:  'Target does not contain any files to validate (%{pattern}).' % { pattern: pattern },
+            file: skipped_target,
+            source: name,
+            message: format('Target does not contain any files to validate (%{pattern}).', pattern: pattern),
             severity: :info,
-            state:    :skipped,
+            state: :skipped
           )
         end
       end
@@ -154,13 +162,13 @@ module PDK
       # @param invalid [Array[String]] The list of invalid targets
       def process_invalid(report, invalid = [])
         invalid.each do |invalid_target|
-          PDK.logger.debug('%{validator}: Skipped \'%{target}\'. Target file not found.' % { validator: name, target: invalid_target })
+          PDK.logger.debug(format('%{validator}: Skipped \'%{target}\'. Target file not found.', validator: name, target: invalid_target))
           report.add_event(
-            file:     invalid_target,
-            source:   name,
-            message:  'File does not exist.',
+            file: invalid_target,
+            source: name,
+            message: 'File does not exist.',
             severity: :error,
-            state:    :error,
+            state: :error
           )
         end
       end
@@ -187,7 +195,8 @@ module PDK
       def contextual_pattern(module_pattern)
         module_pattern = [module_pattern] unless module_pattern.is_a?(Array)
         return module_pattern unless context.is_a?(PDK::Context::ControlRepo)
-        context.actualized_module_paths.map { |mod_path| module_pattern.map { |pat_path| mod_path + '/*/' + pat_path } }.flatten
+
+        context.actualized_module_paths.map { |mod_path| module_pattern.map { |pat_path| "#{mod_path}/*/#{pat_path}" } }.flatten
       end
 
       private
@@ -195,10 +204,11 @@ module PDK
       # Helper method to collate the default ignored paths
       # @return [PathSpec] Paths to ignore
       def ignore_pathspec
-        ignore_pathspec = if context.is_a?(PDK::Context::Module)
+        ignore_pathspec = case context
+                          when PDK::Context::Module
                             require 'pdk/module'
                             PDK::Module.default_ignored_pathspec(ignore_dotfiles?)
-                          elsif context.is_a?(PDK::Context::ControlRepo)
+                          when PDK::Context::ControlRepo
                             require 'pdk/control_repo'
                             PDK::ControlRepo.default_ignored_pathspec(ignore_dotfiles?)
                           else

data/lib/pdk/validate/metadata/metadata_json_lint_validator.rb

@@ -19,9 +19,7 @@ module PDK
         end
 
         def spinner_text_for_targets(targets)
-          'Checking module metadata style (%{targets}).' % {
-            targets: PDK::Util.targets_relative_to_pwd(targets.flatten).join(' '),
-          }
+          format('Checking module metadata style (%{targets}).', targets: PDK::Util.targets_relative_to_pwd(targets.flatten).join(' '))
         end
 
         def pattern
@@ -54,27 +52,27 @@ module PDK
 
           if json_data.empty?
             report.add_event(
-              file:     targets.first,
-              source:   name,
-              state:    :passed,
-              severity: :ok,
+              file: targets.first,
+              source: name,
+              state: :passed,
+              severity: :ok
             )
           else
             json_data.delete('result')
-            json_data.keys.each do |type|
+            json_data.each_key do |type|
               json_data[type].each do |offense|
                 # metadata-json-lint groups the offenses by type, so the type ends
                 # up being `warnings` or `errors`. We want to convert that to the
                 # singular noun for the event.
-                event_type = type[%r{\A(.+?)s?\Z}, 1]
+                event_type = type[/\A(.+?)s?\Z/, 1]
 
                 report.add_event(
-                  file:     targets.first,
-                  source:   name,
-                  message:  offense['msg'],
-                  test:     offense['check'],
+                  file: targets.first,
+                  source: name,
+                  message: offense['msg'],
+                  test: offense['check'],
                   severity: event_type,
-                  state:    :failure,
+                  state: :failure
                 )
               end
             end

data/lib/pdk/validate/metadata/metadata_syntax_validator.rb

@@ -13,9 +13,7 @@ module PDK
         end
 
         def spinner_text
-          'Checking metadata syntax (%{patterns}).' % {
-            patterns: pattern.join(' '),
-          }
+          format('Checking metadata syntax (%{patterns}).', patterns: pattern.join(' '))
         end
 
         def invoke(report)
@@ -40,7 +38,7 @@ module PDK
               source: name,
               state: :failure,
               severity: 'error',
-              message: 'Could not be read.',
+              message: 'Could not be read.'
             )
             return 1
           end
@@ -49,27 +47,27 @@ module PDK
             JSON.parse(PDK::Util::Filesystem.read_file(target))
 
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :passed,
-              severity: 'ok',
+              file: target,
+              source: name,
+              state: :passed,
+              severity: 'ok'
             )
-            return 0
+            0
           rescue JSON::ParserError => e
             # Because the message contains a raw segment of the file, we use
             # String#dump here to unescape any escape characters like newlines.
             # We then strip out the surrounding quotes and the exclaimation
             # point that json_pure likes to put in exception messages.
-            sane_message = e.message.dump[%r{\A"(.+?)!?"\Z}, 1]
+            sane_message = e.message.dump[/\A"(.+?)!?"\Z/, 1]
 
             report.add_event(
-              file:     target,
-              source:   name,
-              state:    :failure,
+              file: target,
+              source: name,
+              state: :failure,
               severity: 'error',
-              message:  sane_message,
+              message: sane_message
             )
-            return 1
+            1
           end
         end
       end

data/lib/pdk/validate/metadata/metadata_validator_group.rb

@@ -11,7 +11,7 @@ module PDK
         def validators
           [
             MetadataSyntaxValidator,
-            MetadataJSONLintValidator,
+            MetadataJSONLintValidator
           ].freeze
         end
       end

data/lib/pdk/validate/puppet/puppet_epp_validator.rb

@@ -5,16 +5,16 @@ module PDK
     module Puppet
       class PuppetEPPValidator < ExternalCommandValidator
         # In Puppet >= 5.3.4, the error context formatting was changed to facilitate localization
-        ERROR_CONTEXT = %r{(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))}
+        ERROR_CONTEXT = /(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))/.freeze
         # In Puppet < 5.3.3, the error context was formatted in these variations:
         #   - "at file_path:line_num:col_num"
         #   - "at file_path:line_num"
         #   - "at line line_num"
         #   - "in file_path"
-        ERROR_CONTEXT_LEGACY = %r{(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))}
+        ERROR_CONTEXT_LEGACY = /(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))/.freeze
 
-        PUPPET_LOGGER_PREFIX = %r{^(debug|info|notice|warning|error|alert|critical):\s.+?$}i
-        PUPPET_SYNTAX_PATTERN = %r{^
+        PUPPET_LOGGER_PREFIX = /^(debug|info|notice|warning|error|alert|critical):\s.+?$/i.freeze
+        PUPPET_SYNTAX_PATTERN = /^
           (?<severity>.+?):\s
           (?<message>.+?)
           (?:
@@ -22,7 +22,7 @@ module PDK
             \s#{ERROR_CONTEXT_LEGACY}| # attempt to match the old " at file:line:column" location
             $                                               # handle cases where the output has no location
           )
-        $}x
+        $/x.freeze
 
         def name
           'puppet-epp'
@@ -37,7 +37,7 @@ module PDK
         end
 
         def spinner_text_for_targets(_targets)
-          'Checking Puppet EPP syntax (%{pattern}).' % { pattern: pattern.join(' ') }
+          format('Checking Puppet EPP syntax (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def parse_options(targets)
@@ -76,7 +76,7 @@ module PDK
         def parse_output(report, result, targets)
           # Due to PUP-7504, we will have to programmatically construct the json
           # object from the text output for now.
-          output = result[:stderr].split(%r{\r?\n}).reject { |entry| entry.empty? }
+          output = result[:stderr].split(/\r?\n/).reject(&:empty?)
 
           results_data = []
           output.each do |offense|
@@ -87,12 +87,12 @@ module PDK
           # puppet parser validate does not include files without problems in its
           # output, so we need to go through the list of targets and add passing
           # events to the report for any target not listed in the output.
-          targets.reject { |target| results_data.any? { |j| j[:file] =~ %r{#{target}} } }.each do |target|
+          targets.reject { |target| results_data.any? { |j| j[:file] =~ /#{target}/ } }.each do |target|
             report.add_event(
-              file:     target,
-              source:   name,
+              file: target,
+              source: name,
               severity: :ok,
-              state:    :passed,
+              state: :passed
             )
           end
 
@@ -105,17 +105,15 @@ module PDK
           sanitize_console_output(offense)
 
           offense_data = {
-            source:  name,
-            state:  :failure,
+            source: name,
+            state: :failure
           }
 
           if offense.match(PUPPET_LOGGER_PREFIX)
             attributes = offense.match(PUPPET_SYNTAX_PATTERN)
 
-            unless attributes.nil?
-              attributes.names.each do |name|
-                offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
-              end
+            attributes&.names&.each do |name|
+              offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
             end
           else
             offense_data[:message] = offense
@@ -125,7 +123,7 @@ module PDK
         end
 
         def sanitize_console_output(line)
-          line.gsub!(%r{\e\[([;\d]+)?m}, '')
+          line.gsub!(/\e\[([;\d]+)?m/, '')
         end
       end
     end

data/lib/pdk/validate/puppet/puppet_lint_validator.rb

@@ -17,7 +17,7 @@ module PDK
         end
 
         def spinner_text_for_targets(_targets)
-          'Checking Puppet manifest style (%{pattern}).' % { pattern: pattern.join(' ') }
+          format('Checking Puppet manifest style (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def parse_options(targets)
@@ -40,24 +40,24 @@ module PDK
           # events to the report for any target not listed in the JSON output.
           targets.reject { |target| json_data.any? { |j| j['path'] == target } }.each do |target|
             report.add_event(
-              file:     target,
-              source:   name,
+              file: target,
+              source: name,
               severity: 'ok',
-              state:    :passed,
+              state: :passed
             )
           end
 
           json_data.each do |offense|
-            report.add_event(
-              file:     offense['path'],
-              source:   name,
-              line:     offense['line'],
-              column:   offense['column'],
-              message:  offense['message'],
-              test:     offense['check'],
-              severity: (offense['kind'] == 'fixed') ? 'corrected' : offense['kind'],
-              state:    :failure,
-            )
+            report.add_event({
+                               file: offense['path'],
+                               source: name,
+                               line: offense['line'],
+                               column: offense['column'],
+                               message: offense['message'],
+                               test: offense['check'],
+                               severity: offense['kind'] == 'fixed' ? 'corrected' : offense['kind'],
+                               state: :failure
+                             })
           end
         end
       end

data/lib/pdk/validate/puppet/puppet_plan_syntax_validator.rb

@@ -15,7 +15,7 @@ module PDK
         def pattern_ignore; end
 
         def spinner_text_for_targets(_targets)
-          'Checking Puppet plan syntax (%{pattern}).' % { pattern: pattern.join(' ') }
+          format('Checking Puppet plan syntax (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def parse_options(targets)

data/lib/pdk/validate/puppet/puppet_syntax_validator.rb

@@ -5,16 +5,16 @@ module PDK
     module Puppet
       class PuppetSyntaxValidator < ExternalCommandValidator
         # In Puppet >= 5.3.4, the error context formatting was changed to facilitate localization
-        ERROR_CONTEXT = %r{(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))}
+        ERROR_CONTEXT = /(?:file:\s(?<file>.+?)|line:\s(?<line>.+?)|column:\s(?<column>.+?))/.freeze
         # In Puppet < 5.3.3, the error context was formatted in these variations:
         #   - "at file_path:line_num:col_num"
         #   - "at file_path:line_num"
         #   - "at line line_num"
         #   - "in file_path"
-        ERROR_CONTEXT_LEGACY = %r{(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))}
+        ERROR_CONTEXT_LEGACY = /(?:at\sline\s(?<line>\d+)|at\s(?<file>.+?):(?<line>\d+):(?<column>\d+)|at\s(?<file>.+?):(?<line>\d+)|in\s(?<file>.+?))/.freeze
 
-        PUPPET_LOGGER_PREFIX = %r{^(debug|info|notice|warning|error|alert|critical):\s.+?$}i
-        PUPPET_SYNTAX_PATTERN = %r{^
+        PUPPET_LOGGER_PREFIX = /^(debug|info|notice|warning|error|alert|critical):\s.+?$/i.freeze
+        PUPPET_SYNTAX_PATTERN = /^
           (?<severity>.+?):\s
           (?<message>.+?)
           (?:
@@ -22,7 +22,7 @@ module PDK
             \s#{ERROR_CONTEXT_LEGACY}| # attempt to match the old " at file:line:column" location
             $                                               # handle cases where the output has no location
           )
-        $}x
+        $/x.freeze
 
         def name
           'puppet-syntax'
@@ -41,7 +41,7 @@ module PDK
         end
 
         def spinner_text_for_targets(_targets)
-          'Checking Puppet manifest syntax (%{pattern}).' % { pattern: pattern.join(' ') }
+          format('Checking Puppet manifest syntax (%{pattern}).', pattern: pattern.join(' '))
         end
 
         def parse_options(targets)
@@ -80,7 +80,7 @@ module PDK
         def parse_output(report, result, targets)
           # Due to PUP-7504, we will have to programmatically construct the json
           # object from the text output for now.
-          output = result[:stderr].split(%r{\r?\n}).reject { |entry| entry.empty? }
+          output = result[:stderr].split(/\r?\n/).reject(&:empty?)
 
           results_data = []
           output.each do |offense|
@@ -91,12 +91,12 @@ module PDK
           # puppet parser validate does not include files without problems in its
           # output, so we need to go through the list of targets and add passing
           # events to the report for any target not listed in the output.
-          targets.reject { |target| results_data.any? { |j| j[:file] =~ %r{#{target}} } }.each do |target|
+          targets.reject { |target| results_data.any? { |j| j[:file] =~ /#{target}/ } }.each do |target|
             report.add_event(
-              file:     target,
-              source:   name,
+              file: target,
+              source: name,
               severity: :ok,
-              state:    :passed,
+              state: :passed
             )
           end
 
@@ -109,17 +109,15 @@ module PDK
           sanitize_console_output(offense)
 
           offense_data = {
-            source:  name,
-            state:  :failure,
+            source: name,
+            state: :failure
           }
 
           if offense.match(PUPPET_LOGGER_PREFIX)
             attributes = offense.match(PUPPET_SYNTAX_PATTERN)
 
-            unless attributes.nil?
-              attributes.names.each do |name|
-                offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
-              end
+            attributes&.names&.each do |name|
+              offense_data[name.to_sym] = attributes[name] unless attributes[name].nil?
             end
           else
             offense_data[:message] = offense
@@ -129,7 +127,7 @@ module PDK
         end
 
         def sanitize_console_output(line)
-          line.gsub!(%r{\e\[([;\d]+)?m}, '')
+          line.gsub!(/\e\[([;\d]+)?m/, '')
         end
       end
     end

data/lib/pdk/validate/puppet/puppet_validator_group.rb

@@ -13,7 +13,7 @@ module PDK
             PuppetSyntaxValidator,
             PuppetPlanSyntaxValidator,
             PuppetLintValidator,
-            PuppetEPPValidator,
+            PuppetEPPValidator
           ].freeze
         end
       end

data/lib/pdk/validate/ruby/ruby_rubocop_validator.rb

@@ -25,15 +25,13 @@ module PDK
         end
 
         def spinner_text_for_targets(_targets)
-          'Checking Ruby code style (%{pattern}).' % { pattern: pattern }
+          format('Checking Ruby code style (%{pattern}).', pattern: pattern)
         end
 
         def parse_options(targets)
           cmd_options = ['--format', 'json']
 
-          if options[:auto_correct]
-            cmd_options << '--auto-correct'
-          end
+          cmd_options << '--auto-correct' if options[:auto_correct]
 
           cmd_options.concat(targets)
         end
@@ -51,9 +49,10 @@ module PDK
 
           json_data['files'].each do |file_info|
             next unless file_info.key?('offenses')
+
             result = {
               file: file_info['path'],
-              source: 'rubocop',
+              source: 'rubocop'
             }
 
             if file_info['offenses'].empty?
@@ -62,13 +61,13 @@ module PDK
               file_info['offenses'].each do |offense|
                 report.add_event(
                   result.merge(
-                    line:     offense['location']['line'],
-                    column:   offense['location']['column'],
-                    message:  offense['message'],
+                    line: offense['location']['line'],
+                    column: offense['location']['column'],
+                    message: offense['message'],
                     severity: offense['corrected'] ? 'corrected' : offense['severity'],
-                    test:     offense['cop_name'],
-                    state:    :failure,
-                  ),
+                    test: offense['cop_name'],
+                    state: :failure
+                  )
                 )
               end
             end

data/lib/pdk/validate/ruby/ruby_validator_group.rb

@@ -10,7 +10,7 @@ module PDK
 
         def validators
           [
-            RubyRubocopValidator,
+            RubyRubocopValidator
           ].freeze
         end
       end