puppet 8.5.1 → 8.6.0

data/lib/puppet/util/character_encoding.rb

@@ -20,13 +20,13 @@ module Puppet::Util::CharacterEncoding
       string_copy = string.dup
       begin
         if original_encoding == Encoding::UTF_8
-          if !string_copy.valid_encoding?
+          unless string_copy.valid_encoding?
             Puppet.debug {
               _("%{value} is already labeled as UTF-8 but this encoding is invalid. It cannot be transcoded by Puppet.") % { value: string.dump }
             }
           end
           # String is already valid UTF-8 - noop
-          return string_copy
+          string_copy
         else
           # If the string comes to us as BINARY encoded, we don't know what it
           # started as. However, to encode! we need a starting place, and our
@@ -34,7 +34,7 @@ module Puppet::Util::CharacterEncoding
           # So set external_encoding to default_external before we try to
           # transcode to UTF-8.
           string_copy.force_encoding(Encoding.default_external) if original_encoding == Encoding::BINARY
-          return string_copy.encode(Encoding::UTF_8)
+          string_copy.encode(Encoding::UTF_8)
         end
       rescue EncodingError => detail
         # Set the encoding on our copy back to its original if we modified it
@@ -46,7 +46,7 @@ module Puppet::Util::CharacterEncoding
         Puppet.debug {
           _("%{error}: %{value} cannot be transcoded by Puppet.") % { error: detail.inspect, value: string.dump }
         }
-        return string_copy
+        string_copy
       end
     end
 
@@ -68,14 +68,15 @@ module Puppet::Util::CharacterEncoding
       string_copy = string.dup
       original_encoding = string_copy.encoding
       return string_copy if original_encoding == Encoding::UTF_8
+
       if string_copy.force_encoding(Encoding::UTF_8).valid_encoding?
-        return string_copy
+        string_copy
       else
         Puppet.debug {
           _("%{value} is not valid UTF-8 and result of overriding encoding would be invalid.") % { value: string.dump }
         }
         # Set copy back to its original encoding before returning
-        return string_copy.force_encoding(original_encoding)
+        string_copy.force_encoding(original_encoding)
       end
     end
   end

data/lib/puppet/util/checksums.rb

@@ -45,12 +45,12 @@ module Puppet::Util::Checksums
 
   # Strip the checksum type from an existing checksum
   def sumdata(checksum)
-    checksum =~ /^\{(\w+)\}(.+)/ ? $2 : nil
+    checksum =~ /^\{(\w+)\}(.+)/ ? ::Regexp.last_match(2) : nil
   end
 
   # Strip the checksum type from an existing checksum
   def sumtype(checksum)
-    checksum =~ /^\{(\w+)\}/ ? $1 : nil
+    checksum =~ /^\{(\w+)\}/ ? ::Regexp.last_match(1) : nil
   end
 
   # Calculate a checksum using Digest::SHA256.

data/lib/puppet/util/classgen.rb

@@ -177,11 +177,11 @@ module Puppet::Util::ClassGen
 
     [:include, :extend].each do |method|
       set = options[method]
-      if set
-        set = [set] unless set.is_a?(Array)
-        set.each do |mod|
-          klass.send(method, mod)
-        end
+      next unless set
+
+      set = [set] unless set.is_a?(Array)
+      set.each do |mod|
+        klass.send(method, mod)
       end
     end
 
@@ -210,9 +210,9 @@ module Puppet::Util::ClassGen
     # If we were told to stick it in a hash, then do so
     array = options[:array]
     if array
-      if (klass.respond_to? :name and
-              array.find { |c| c.name == klassname } and
-              !options[:overwrite])
+      if klass.respond_to? :name and
+         array.find { |c| c.name == klassname } and
+         !options[:overwrite]
         raise Puppet::SubclassAlreadyDefined,
               _("Already a generated class named %{klassname}") % { klassname: klassname }
       end

data/lib/puppet/util/colors.rb

@@ -97,6 +97,6 @@ module Puppet::Util::Colors
 
   def html_color(color, str)
     span = '<span style="%s">' % Colormap[color][:html]
-    "#{span}%s</span>" % str.gsub(/<span .*?<\/span>/, "</span>\\0#{span}")
+    "#{span}%s</span>" % str.gsub(%r{<span .*?</span>}, "</span>\\0#{span}")
   end
 end

data/lib/puppet/util/command_line/puppet_option_parser.rb

@@ -63,7 +63,7 @@ module Puppet
           when :NONE
             options[:type] = :flag
           else
-            raise PuppetOptionError.new(_("Unsupported type: '%{type}'") % { type: type })
+            raise PuppetOptionError, _("Unsupported type: '%{type}'") % { type: type }
           end
 
           @parser.opt long.sub("^--", "").intern, desc, options

data/lib/puppet/util/command_line/trollop.rb

@@ -33,10 +33,10 @@ class CommandLine
   class VersionNeeded < StandardError; end
 
   ## Regex for floating point numbers
-  FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))([eE][-+]?[\d]+)?$/
+  FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))([eE][-+]?\d+)?$/
 
   ## Regex for parameters
-  PARAM_RE = /^-(-|\.$|[^\d\.])/
+  PARAM_RE = /^-(-|\.$|[^\d.])/
 
   ## The commandline parser. In typical usage, the methods in this class
   ## will be handled internally by Trollop::options. In this case, only the
@@ -221,7 +221,7 @@ class CommandLine
       opts[:long] =
         case opts[:long]
         when /^--([^-].*)$/
-          $1
+          ::Regexp.last_match(1)
         when /^[^-]/
           opts[:long]
         else
@@ -234,7 +234,7 @@ class CommandLine
         opts[:short] = opts[:short].to_s if opts[:short]
       end
       opts[:short] = case opts[:short]
-                     when /^-(.)$/; $1
+                     when /^-(.)$/; ::Regexp.last_match(1)
                      when nil, :none, /^.$/; opts[:short]
                      else raise ArgumentError, _("invalid short option name '%{name}'") % { name: opts[:short].inspect }
                      end
@@ -333,11 +333,11 @@ class CommandLine
       @leftovers = each_arg cmdline do |arg, params|
         sym = case arg
               when /^-([^-])$/
-                @short[$1]
+                @short[::Regexp.last_match(1)]
               when /^--no-([^-]\S*)$/
-                @long["[no-]#{$1}"]
+                @long["[no-]#{::Regexp.last_match(1)}"]
               when /^--([^-]\S*)$/
-                @long[$1] ? @long[$1] : @long["[no-]#{$1}"]
+                @long[::Regexp.last_match(1)] || @long["[no-]#{::Regexp.last_match(1)}"]
               else
                 raise CommandlineError, _("invalid argument syntax: '%{arg}'") % { arg: arg }
               end
@@ -417,7 +417,7 @@ class CommandLine
         when :float, :floats
           vals[sym] = params.map { |pg| pg.map { |p| parse_float_parameter p, arg } }
         when :string, :strings
-          vals[sym] = params.map { |pg| pg.map { |p| p.to_s } }
+          vals[sym] = params.map { |pg| pg.map(&:to_s) }
         when :io, :ios
           vals[sym] = params.map { |pg| pg.map { |p| parse_io_parameter p, arg } }
         when :date, :dates
@@ -425,13 +425,13 @@ class CommandLine
         end
 
         if SINGLE_ARG_TYPES.include?(opts[:type])
-          unless opts[:multi]       # single parameter
-            vals[sym] = vals[sym][0][0]
-          else                      # multiple options, each with a single parameter
+          if opts[:multi] # multiple options, each with a single parameter
             vals[sym] = vals[sym].map { |p| p[0] }
+          else # single parameter
+            vals[sym] = vals[sym][0][0]
           end
         elsif MULTI_ARG_TYPES.include?(opts[:type]) && !opts[:multi]
-          vals[sym] = vals[sym][0]  # single option, with multiple parameters
+          vals[sym] = vals[sym][0] # single option, with multiple parameters
         end
         # else: multiple options, with multiple parameters
 
@@ -454,15 +454,13 @@ class CommandLine
 
     def parse_date_parameter param, arg # :nodoc:
       begin
-        begin
-          time = Chronic.parse(param)
-        rescue NameError
-          # chronic is not available
-        end
-        time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
-      rescue ArgumentError
-        raise CommandlineError, _("option '%{arg}' needs a date") % { arg: arg }, $!.backtrace
+        time = Chronic.parse(param)
+      rescue NameError
+        # chronic is not available
       end
+      time ? Date.new(time.year, time.month, time.day) : Date.parse(param)
+    rescue ArgumentError => e
+      raise CommandlineError, _("option '%{arg}' needs a date") % { arg: arg }, e.backtrace
     end
 
     ## Print the help message to +stream+.
@@ -489,11 +487,11 @@ class CommandLine
                      end
       end
 
-      leftcol_width = left.values.map { |s| s.length }.max || 0
+      leftcol_width = left.values.map(&:length).max || 0
       rightcol_start = leftcol_width + 6 # spaces
 
       unless @order.size > 0 && @order.first.first == :text
-        stream.puts "#@version\n" if @version
+        stream.puts "#{@version}\n" if @version
         stream.puts _("Options:")
       end
 
@@ -582,11 +580,14 @@ class CommandLine
           remains += args[(i + 1)..]
           return remains
         when /^--(\S+?)=(.*)$/ # long argument with equals
-          yield "--#{$1}", [$2]
+          yield "--#{::Regexp.last_match(1)}", [::Regexp.last_match(2)]
           i += 1
         when /^--(\S+)$/ # long argument
           params = collect_argument_parameters(args, i + 1)
-          unless params.empty?
+          if params.empty? # long argument no parameter
+            yield args[i], nil
+            i += 1
+          else
             num_params_taken = yield args[i], params
             unless num_params_taken
               if @stop_on_unknown
@@ -597,16 +598,16 @@ class CommandLine
               end
             end
             i += 1 + num_params_taken
-          else # long argument no parameter
-            yield args[i], nil
-            i += 1
           end
         when /^-(\S+)$/ # one or more short arguments
-          shortargs = $1.split(//)
+          shortargs = ::Regexp.last_match(1).split(//)
           shortargs.each_with_index do |a, j|
             if j == (shortargs.length - 1)
               params = collect_argument_parameters(args, i + 1)
-              unless params.empty?
+              if params.empty? # argument no parameter
+                yield "-#{a}", nil
+                i += 1
+              else
                 num_params_taken = yield "-#{a}", params
                 unless num_params_taken
                   if @stop_on_unknown
@@ -617,9 +618,6 @@ class CommandLine
                   end
                 end
                 i += 1 + num_params_taken
-              else # argument no parameter
-                yield "-#{a}", nil
-                i += 1
               end
             else
               yield "-#{a}", nil
@@ -667,7 +665,7 @@ class CommandLine
     def collect_argument_parameters args, start_at
       params = []
       pos = start_at
-      while args[pos] && args[pos] !~ PARAM_RE && !@stop_words.member?(args[pos]) do
+      while args[pos] && args[pos] !~ PARAM_RE && !@stop_words.member?(args[pos])
         params << args[pos]
         pos += 1
       end
@@ -784,19 +782,17 @@ class CommandLine
   ## Requires passing in the parser object.
 
   def with_standard_exception_handling parser
-    begin
-      yield
-    rescue CommandlineError => e
-      $stderr.puts _("Error: %{value0}.") % { value0: e.message }
-      $stderr.puts _("Try --help for help.")
-      exit(-1)
-    rescue HelpNeeded
-      parser.educate
-      exit
-    rescue VersionNeeded
-      puts parser.version
-      exit
-    end
+    yield
+  rescue CommandlineError => e
+    $stderr.puts _("Error: %{value0}.") % { value0: e.message }
+    $stderr.puts _("Try --help for help.")
+    exit(-1)
+  rescue HelpNeeded
+    parser.educate
+    exit
+  rescue VersionNeeded
+    puts parser.version
+    exit
   end
 
   ## Informs the user that their usage of 'arg' was wrong, as detailed by

data/lib/puppet/util/command_line.rb

@@ -4,7 +4,7 @@
 # load gems. If Bundler is loaded, let it determine what can be
 # loaded. If it's not loaded, then use rubygems. But do this before
 # loading any puppet code, so that our gem loading system is sane.
-if not defined? ::Bundler
+unless defined? ::Bundler
   begin
     require 'rubygems'
   rescue LoadError
@@ -31,7 +31,7 @@ module Puppet
       # @param zero [String] the name of the executable
       # @param argv [Array<String>] the arguments passed on the command line
       # @param stdin [IO] (unused)
-      def initialize(zero = $0, argv = ARGV, stdin = STDIN)
+      def initialize(zero = $PROGRAM_NAME, argv = ARGV, stdin = STDIN)
         @command = File.basename(zero, '.rb')
         @argv = argv
       end

data/lib/puppet/util/constant_inflector.rb

@@ -12,12 +12,12 @@ module Puppet
   module Util
     module ConstantInflector
       def file2constant(file)
-        file.split("/").collect { |name| name.capitalize }.join("::").gsub(/_+(.)/) { |_term| $1.capitalize }
+        file.split("/").collect(&:capitalize).join("::").gsub(/_+(.)/) { |_term| ::Regexp.last_match(1).capitalize }
       end
       module_function :file2constant
 
       def constant2file(constant)
-        constant.to_s.gsub(/([a-z])([A-Z])/) { |_term| $1 + "_#{$2}" }.gsub("::", "/").downcase
+        constant.to_s.gsub(/([a-z])([A-Z])/) { |_term| ::Regexp.last_match(1) + "_#{::Regexp.last_match(2)}" }.gsub("::", "/").downcase
       end
       module_function :constant2file
     end

data/lib/puppet/util/diff.rb

@@ -32,8 +32,8 @@ module Puppet::Util::Diff
       Puppet.warning _("Cannot provide diff without the diff/lcs Ruby library")
       return ""
     end
-    data_old = data_old.split(/\n/).map! { |e| e.chomp }
-    data_new = data_new.split(/\n/).map! { |e| e.chomp }
+    data_old = data_old.split(/\n/).map!(&:chomp)
+    data_new = data_new.split(/\n/).map!(&:chomp)
 
     output = ''.dup
 
@@ -44,27 +44,25 @@ module Puppet::Util::Diff
     file_length_difference = 0
 
     diffs.each do |piece|
-      begin
-        hunk = ::Diff::LCS::Hunk.new(
-          data_old, data_new, piece,
-          context_lines,
-          file_length_difference
-        )
-        file_length_difference = hunk.file_length_difference
-        next unless oldhunk
+      hunk = ::Diff::LCS::Hunk.new(
+        data_old, data_new, piece,
+        context_lines,
+        file_length_difference
+      )
+      file_length_difference = hunk.file_length_difference
+      next unless oldhunk
 
-        # Hunks may overlap, which is why we need to be careful when our
-        # diff includes lines of context. Otherwise, we might print
-        # redundant lines.
-        if (context_lines > 0) and hunk.overlaps?(oldhunk)
-          hunk.unshift(oldhunk)
-        else
-          output << oldhunk.diff(format)
-        end
-      ensure
-        oldhunk = hunk
-        output << "\n"
+      # Hunks may overlap, which is why we need to be careful when our
+      # diff includes lines of context. Otherwise, we might print
+      # redundant lines.
+      if (context_lines > 0) and hunk.overlaps?(oldhunk)
+        hunk.unshift(oldhunk)
+      else
+        output << oldhunk.diff(format)
       end
+    ensure
+      oldhunk = hunk
+      output << "\n"
     end
 
     # Handle the last remaining hunk

data/lib/puppet/util/docs.rb

@@ -21,7 +21,7 @@ module Puppet::Util::Docs
   # Generate the full doc string.
   def doc
     extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.sort.filter_map { |m|
-      self.send(m)
+      send(m)
     }.collect { |r| "* #{r}" }.join("\n")
 
     if @doc
@@ -125,7 +125,7 @@ module Puppet::Util::Docs
       text = text.gsub(/^#{indent}/, '')
     end
     # Clean trailing space
-    text.lines.map { |line| line.rstrip }.join("\n").rstrip
+    text.lines.map(&:rstrip).join("\n").rstrip
   end
 
   module_function :scrub

data/lib/puppet/util/errors.rb

@@ -22,8 +22,8 @@ module Puppet::Util::Errors
   # @param other [Exception] original exception, source of backtrace info
   # @return [Exception] error parameter
   def adderrorcontext(error, other = nil)
-    error.line ||= self.line if error.respond_to?(:line=) and self.respond_to?(:line) and self.line
-    error.file ||= self.file if error.respond_to?(:file=) and self.respond_to?(:file) and self.file
+    error.line ||= line if error.respond_to?(:line=) and respond_to?(:line) and line
+    error.file ||= file if error.respond_to?(:file=) and respond_to?(:file) and file
     error.original ||= other if error.respond_to?(:original=)
 
     error.set_backtrace(other.backtrace) if other and other.respond_to?(:backtrace)
@@ -42,9 +42,9 @@ module Puppet::Util::Errors
   # @return [String] description of file, line, and column
   #
   def self.error_location(file, line = nil, column = nil)
-    file = nil if (file.is_a?(String) && file.empty?)
-    line = nil if (line.is_a?(String) && line.empty?)
-    column = nil if (column.is_a?(String) && column.empty?)
+    file = nil if file.is_a?(String) && file.empty?
+    line = nil if line.is_a?(String) && line.empty?
+    column = nil if column.is_a?(String) && column.empty?
     if file and line and column
       _("(file: %{file}, line: %{line}, column: %{column})") % { file: file, line: line, column: column }
     elsif file and line
@@ -85,10 +85,10 @@ module Puppet::Util::Errors
   # @param line [String] the line number for the error (nil or "", for not known)
   # @return [String] description of file, and line
   def self.error_location_with_unknowns(file, line)
-    file = nil if (file.is_a?(String) && file.empty?)
-    line = nil if (line.is_a?(String) && line.empty?)
-    file = _('unknown') unless file
-    line = _('unknown') unless line
+    file = nil if file.is_a?(String) && file.empty?
+    line = nil if line.is_a?(String) && line.empty?
+    file ||= _('unknown')
+    line ||= _('unknown')
     error_location(file, line)
   end
 

data/lib/puppet/util/execution.rb

@@ -212,13 +212,25 @@ module Puppet::Util::Execution
       execution_stub = Puppet::Util::ExecutionStub.current_value
       if execution_stub
         child_pid = execution_stub.call(*exec_args)
-        [stdin, stdout, stderr].each { |io| io.close rescue nil }
+        [stdin, stdout, stderr].each { |io|
+          begin
+            io.close
+          rescue
+            nil
+          end
+        }
         return child_pid
       elsif Puppet.features.posix?
         child_pid = nil
         begin
           child_pid = execute_posix(*exec_args)
-          [stdin, stdout, stderr].each { |io| io.close rescue nil }
+          [stdin, stdout, stderr].each { |io|
+            begin
+              io.close
+            rescue
+              nil
+            end
+          }
           if options[:squelch]
             exit_status = Process.waitpid2(child_pid).last.exitstatus
           else
@@ -276,7 +288,13 @@ module Puppet::Util::Execution
       elsif Puppet::Util::Platform.windows?
         process_info = execute_windows(*exec_args)
         begin
-          [stdin, stderr].each { |io| io.close rescue nil }
+          [stdin, stderr].each { |io|
+            begin
+              io.close
+            rescue
+              nil
+            end
+          }
           exit_status = Puppet::Util::Windows::Process.wait_process(process_info.process_handle)
 
           # read output in if required
@@ -295,8 +313,14 @@ module Puppet::Util::Execution
       end
     ensure
       # Make sure all handles are closed in case an exception was thrown attempting to execute.
-      [stdin, stdout, stderr].each { |io| io.close rescue nil }
-      if !options[:squelch]
+      [stdin, stdout, stderr].each { |io|
+        begin
+          io.close
+        rescue
+          nil
+        end
+      }
+      unless options[:squelch]
         # if we opened a pipe, we need to clean it up.
         reader.close if reader
         stdout.close! if Puppet::Util::Platform.windows?
@@ -327,7 +351,7 @@ module Puppet::Util::Execution
   # @api private
   #
   def self.execute_posix(command, options, stdin, stdout, stderr)
-    child_pid = Puppet::Util.safe_posix_fork(stdin, stdout, stderr) do
+    Puppet::Util.safe_posix_fork(stdin, stdout, stderr) do
       # We can't just call Array(command), and rely on it returning
       # things like ['foo'], when passed ['foo'], because
       # Array(command) will call command.to_a internally, which when
@@ -345,7 +369,7 @@ module Puppet::Util::Execution
         Puppet::Util::SUIDManager.change_privileges(options[:uid], options[:gid], true)
 
         # if the caller has requested that we override locale environment variables,
-        if (options[:override_locale]) then
+        if options[:override_locale] then
           # loop over them and clear them
           Puppet::Util::POSIX::LOCALE_ENV_VARS.each { |name| ENV.delete(name) }
           # set LANG and LC_ALL to 'C' so that the command will have consistent, predictable output
@@ -371,7 +395,6 @@ module Puppet::Util::Execution
         exit!(1)
       end
     end
-    child_pid
   end
   private_class_method :execute_posix
 
@@ -381,7 +404,7 @@ module Puppet::Util::Execution
   #
   def self.execute_windows(command, options, stdin, stdout, stderr)
     command = command.map do |part|
-      part.include?(' ') ? %Q["#{part.gsub(/"/, '\"')}"] : part
+      part.include?(' ') ? %Q("#{part.gsub(/"/, '\"')}") : part
     end.join(" ") if command.is_a?(Array)
 
     options[:custom_environment] ||= {}

data/lib/puppet/util/feature.rb

@@ -77,7 +77,7 @@ class Puppet::Util::Feature
     feature = method.to_s.sub(/\?$/, '')
     @loader.load(feature, Puppet.lookup(:current_environment))
 
-    respond_to?(method) && self.send(method)
+    respond_to?(method) && send(method)
   end
 
   # Actually test whether the feature is present.  We only want to test when

data/lib/puppet/util/fileparsing.rb

@@ -42,7 +42,7 @@ module Puppet::Util::FileParsing
     def fields=(fields)
       @fields = fields.collect do |field|
         r = field.intern
-        raise ArgumentError.new(_("Cannot have fields named %{name}") % { name: r }) if INVALID_FIELDS.include?(r)
+        raise ArgumentError, _("Cannot have fields named %{name}") % { name: r } if INVALID_FIELDS.include?(r)
 
         r
       end
@@ -121,9 +121,7 @@ module Puppet::Util::FileParsing
 
     # Customize this so we can do a bit of validation.
     def optional=(optional)
-      @optional = optional.collect do |field|
-        field.intern
-      end
+      @optional = optional.collect(&:intern)
     end
 
     # Create a hook that modifies the hash resulting from parsing.
@@ -230,9 +228,9 @@ module Puppet::Util::FileParsing
 
     if ret
       ret[:record_type] = record.name
-      return ret
+      ret
     else
-      return nil
+      nil
     end
   end
 
@@ -246,7 +244,7 @@ module Puppet::Util::FileParsing
   def lines(text)
     # NOTE: We do not have to remove trailing separators because split will ignore
     # them by default (unless you pass -1 as a second parameter)
-    text.split(self.line_separator)
+    text.split(line_separator)
   end
 
   # Split a bunch of text into lines and then parse them individually.
@@ -346,7 +344,7 @@ module Puppet::Util::FileParsing
     end
 
     case record.type
-    when :text; return details[:line]
+    when :text; details[:line]
     else
       return record.to_line(details) if record.respond_to?(:to_line)
 
@@ -358,9 +356,9 @@ module Puppet::Util::FileParsing
         if regex == true
           regex = /\s+$/
         end
-        return line.sub(regex, '')
+        line.sub(regex, '')
       else
-        return line
+        line
       end
     end
   end
@@ -368,9 +366,9 @@ module Puppet::Util::FileParsing
   # Whether to add a trailing separator to the file.  Defaults to true
   def trailing_separator
     if defined?(@trailing_separator)
-      return @trailing_separator
+      @trailing_separator
     else
-      return true
+      true
     end
   end
 
@@ -378,11 +376,9 @@ module Puppet::Util::FileParsing
     type = type.intern
     record = record_type(type)
     if record && record.fields.include?(attr.intern)
-      return true
-    elsif attr.intern == :ensure
-      return true
+      true
     else
-      false
+      attr.intern == :ensure
     end
   end