puppet 8.4.0 → 8.5.0

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

@@ -102,7 +102,7 @@ class CommandLine
       @stop_on_unknown = false
 
       # instance_eval(&b) if b # can't take arguments
-      cloaker(&b).bind(self).call(*a) if b
+      cloaker(&b).bind_call(self, *a) if b
     end
 
     ## Define an option. +name+ is the option name, a unique identifier
@@ -145,7 +145,7 @@ class CommandLine
     ## If you want a multi-value, multi-occurrence argument with a default
     ## value, you must specify +:type+ as well.
 
-    def opt name, desc="", opts={}
+    def opt name, desc = "", opts = {}
       raise ArgumentError, _("you already have an argument named '%{name}'") % { name: name } if @specs.member? name
 
       ## fill in :type
@@ -230,7 +230,9 @@ class CommandLine
       raise ArgumentError, _("long option name %{value0} is already taken; please specify a (different) :long") % { value0: opts[:long].inspect } if @long[opts[:long]]
 
       ## fill in :short
-      opts[:short] = opts[:short].to_s if opts[:short] unless opts[:short] == :none
+      unless opts[:short] == :none
+        opts[:short] = opts[:short].to_s if opts[:short]
+      end
       opts[:short] = case opts[:short]
                      when /^-(.)$/; $1
                      when nil, :none, /^.$/; opts[:short]
@@ -261,7 +263,7 @@ class CommandLine
     ## Sets the version string. If set, the user can request the version
     ## on the commandline. Should probably be of the form "<program name>
     ## <version number>".
-    def version s=nil; @version = s if s; @version end
+    def version s = nil; @version = s if s; @version end
 
     ## Adds text to the help display. Can be interspersed with calls to
     ## #opt to build a multi-section help page.
@@ -307,12 +309,14 @@ class CommandLine
     ## but you can call it directly if you need more control.
     ##
     ## throws CommandlineError, HelpNeeded, and VersionNeeded exceptions.
-    def parse cmdline=ARGV
+    def parse cmdline = ARGV
       vals = {}
       required = {}
 
       if handle_help_and_version
-        opt :version, _("Print version and exit") if @version unless @specs[:version] || @long["version"]
+        unless @specs[:version] || @long["version"]
+          opt :version, _("Print version and exit") if @version
+        end
         opt :help, _("Show this message") unless @specs[:help] || @long["help"]
       end
 
@@ -462,27 +466,27 @@ class CommandLine
     end
 
     ## Print the help message to +stream+.
-    def educate stream=$stdout
+    def educate stream = $stdout
       width # just calculate it now; otherwise we have to be careful not to
       # call this unless the cursor's at the beginning of a line.
 
       left = {}
       @specs.each do |name, spec|
         left[name] = "--#{spec[:long]}" +
-          (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
-          case spec[:type]
-          when :flag; ""
-          when :int; " <i>"
-          when :ints; " <i+>"
-          when :string; " <s>"
-          when :strings; " <s+>"
-          when :float; " <f>"
-          when :floats; " <f+>"
-          when :io; " <filename/uri>"
-          when :ios; " <filename/uri+>"
-          when :date; " <date>"
-          when :dates; " <date+>"
-          end
+                     (spec[:short] && spec[:short] != :none ? ", -#{spec[:short]}" : "") +
+                     case spec[:type]
+                     when :flag; ""
+                     when :int; " <i>"
+                     when :ints; " <i+>"
+                     when :string; " <s>"
+                     when :strings; " <s+>"
+                     when :float; " <f>"
+                     when :floats; " <f+>"
+                     when :io; " <filename/uri>"
+                     when :ios; " <filename/uri+>"
+                     when :date; " <date>"
+                     when :dates; " <date+>"
+                     end
       end
 
       leftcol_width = left.values.map { |s| s.length }.max || 0
@@ -530,9 +534,9 @@ class CommandLine
       @width ||= if $stdout.tty?
                    begin
                      require 'curses'
-                     Curses::init_screen
-                     x = Curses::cols
-                     Curses::close_screen
+                     Curses.init_screen
+                     x = Curses.cols
+                     Curses.close_screen
                      x
                    rescue Exception
                      80
@@ -542,7 +546,7 @@ class CommandLine
                  end
     end
 
-    def wrap str, opts={} # :nodoc:
+    def wrap str, opts = {} # :nodoc:
       if str == ""
         [""]
       else
@@ -570,12 +574,12 @@ class CommandLine
 
       until i >= args.length
         if @stop_words.member? args[i]
-          remains += args[i .. -1]
+          remains += args[i..]
           return remains
         end
         case args[i]
         when /^--$/ # arg terminator
-          remains += args[(i + 1) .. -1]
+          remains += args[(i + 1)..]
           return remains
         when /^--(\S+?)=(.*)$/ # long argument with equals
           yield "--#{$1}", [$2]
@@ -586,7 +590,7 @@ class CommandLine
             num_params_taken = yield args[i], params
             unless num_params_taken
               if @stop_on_unknown
-                remains += args[i + 1 .. -1]
+                remains += args[i + 1..]
                 return remains
               else
                 remains += params
@@ -606,7 +610,7 @@ class CommandLine
                 num_params_taken = yield "-#{a}", params
                 unless num_params_taken
                   if @stop_on_unknown
-                    remains += args[i + 1 .. -1]
+                    remains += args[i + 1..]
                     return remains
                   else
                     remains += params
@@ -623,7 +627,7 @@ class CommandLine
           end
         else
           if @stop_on_unknown
-            remains += args[i .. -1]
+            remains += args[i..]
             return remains
           else
             remains << args[i]
@@ -685,7 +689,7 @@ class CommandLine
       end
     end
 
-    def wrap_line str, opts={}
+    def wrap_line str, opts = {}
       prefix = opts[:prefix] || 0
       width = opts[:width] || (self.width - 1)
       start = 0
@@ -699,7 +703,7 @@ class CommandLine
             x = str.index(/\s/, start) if x && x < start
             x || str.length
           end
-        ret << (ret.empty? ? "" : " " * prefix) + str[start ... nextt]
+        ret << (ret.empty? ? "" : " " * prefix) + str[start...nextt]
         start = nextt + 1
       end
       ret
@@ -749,7 +753,7 @@ class CommandLine
   ##   p opts # => {:monkey_given=>true, :monkey=>true, :goat=>true, :num_limbs=>4, :help=>false, :num_thumbs=>nil}
   ##
   ## See more examples at http://trollop.rubyforge.org.
-  def options args=ARGV, *a, &b
+  def options args = ARGV, *a, &b
     @last_parser = Parser.new(*a, &b)
     with_standard_exception_handling(@last_parser) { @last_parser.parse args }
   end
@@ -813,7 +817,7 @@ class CommandLine
   ##   end
   ##
   ##   Trollop::die "need at least one filename" if ARGV.empty?
-  def die arg, msg=nil
+  def die arg, msg = nil
     if @last_parser
       @last_parser.die arg, msg
     else

data/lib/puppet/util/command_line.rb

@@ -56,7 +56,7 @@ module Puppet
         if subcommand_name.nil?
           @argv
         else
-          @argv[1..-1]
+          @argv[1..]
         end
       end
 

data/lib/puppet/util/diff.rb

@@ -14,7 +14,7 @@ module Puppet::Util::Diff
     command = [diff_cmd]
     args = Puppet[:diff_args]
     if args && args != ""
-      args.split(' ').each do|arg|
+      args.split(' ').each do |arg|
         command << arg
       end
     end
@@ -27,7 +27,7 @@ module Puppet::Util::Diff
   # return diff string of two input strings
   # format defaults to unified
   # context defaults to 3 lines
-  def lcs_diff(data_old, data_new, format=:unified, context_lines=3)
+  def lcs_diff(data_old, data_new, format = :unified, context_lines = 3)
     unless Puppet.features.diff?
       Puppet.warning _("Cannot provide diff without the diff/lcs Ruby library")
       return ""
@@ -48,7 +48,8 @@ module Puppet::Util::Diff
         hunk = ::Diff::LCS::Hunk.new(
           data_old, data_new, piece,
           context_lines,
-          file_length_difference)
+          file_length_difference
+        )
         file_length_difference = hunk.file_length_difference
         next unless oldhunk
 
@@ -79,4 +80,3 @@ module Puppet::Util::Diff
     tempfile.delete
   end
 end
-

data/lib/puppet/util/docs.rb

@@ -20,9 +20,9 @@ module Puppet::Util::Docs
 
   # Generate the full doc string.
   def doc
-    extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.sort.collect { |m|
+    extra = methods.find_all { |m| m.to_s =~ /^dochook_.+/ }.sort.filter_map { |m|
       self.send(m)
-    }.delete_if {|r| r.nil? }.collect {|r| "* #{r}"}.join("\n")
+    }.collect { |r| "* #{r}" }.join("\n")
 
     if @doc
       scrub(@doc) + (extra.empty? ? '' : "\n\n#{extra}")
@@ -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 { |line| line.rstrip }.join("\n").rstrip
   end
 
   module_function :scrub

data/lib/puppet/util/errors.rb

@@ -41,7 +41,7 @@ module Puppet::Util::Errors
   # @param column [String] the column number for the error (nil or "",  for not known)
   # @return [String] description of file, line, and column
   #
-  def self.error_location(file, line=nil, column=nil)
+  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?)
@@ -69,7 +69,7 @@ module Puppet::Util::Errors
   # @param column [String] the column number for the error (nil or "",  for not known)
   # @return [String] description of file, line, and column
   #
-  def self.error_location_with_space(file, line=nil, column=nil)
+  def self.error_location_with_space(file, line = nil, column = nil)
     error_location_str = error_location(file, line, column)
     if error_location_str.empty?
       ''

data/lib/puppet/util/execution.rb

@@ -27,7 +27,7 @@ module Puppet::Util::Execution
     attr_reader :exitstatus
 
     # @api private
-    def initialize(value,exitstatus)
+    def initialize(value, exitstatus)
       super(value)
       @exitstatus = exitstatus
     end
@@ -76,7 +76,7 @@ module Puppet::Util::Execution
     # the user/system locale to "C" (via environment variables LANG and LC_*)
     # it enables to have non localized output for some commands and therefore
     # a predictable output
-    english_env = ENV.to_hash.merge( {'LANG' => 'C', 'LC_ALL' => 'C'} )
+    english_env = ENV.to_hash.merge({ 'LANG' => 'C', 'LC_ALL' => 'C' })
     output = Puppet::Util.withenv(english_env) do
       # We are intentionally using 'pipe' with open to launch a process
       open("| #{command_str} 2>&1") do |pipe| # rubocop:disable Security/Open
@@ -153,10 +153,11 @@ module Puppet::Util::Execution
 
     options = default_options.merge(options)
 
-    if command.is_a?(Array)
+    case command
+    when Array
       command = command.flatten.map(&:to_s)
       command_str = command.join(" ")
-    elsif command.is_a?(String)
+    when String
       command_str = command
     end
 
@@ -183,7 +184,7 @@ module Puppet::Util::Execution
     null_file = Puppet::Util::Platform.windows? ? 'NUL' : '/dev/null'
 
     cwd = options[:cwd]
-    if cwd && ! Puppet::FileSystem.directory?(cwd)
+    if cwd && !Puppet::FileSystem.directory?(cwd)
       raise ArgumentError, _("Working directory %{cwd} does not exist!") % { cwd: cwd }
     end
 
@@ -211,13 +212,13 @@ 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| io.close rescue nil }
         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| io.close rescue nil }
           if options[:squelch]
             exit_status = Process.waitpid2(child_pid).last.exitstatus
           else
@@ -275,7 +276,7 @@ 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| io.close rescue nil }
           exit_status = Puppet::Util::Windows::Process.wait_process(process_info.process_handle)
 
           # read output in if required
@@ -294,7 +295,7 @@ 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}
+      [stdin, stdout, stderr].each { |io| io.close rescue nil }
       if !options[:squelch]
         # if we opened a pipe, we need to clean it up.
         reader.close if reader
@@ -310,10 +311,10 @@ module Puppet::Util::Execution
   # @return [String] the path to the Ruby executable
   # @api private
   #
-  def self.ruby_path()
+  def self.ruby_path
     File.join(RbConfig::CONFIG['bindir'],
               RbConfig::CONFIG['ruby_install_name'] + RbConfig::CONFIG['EXEEXT'])
-      .sub(/.*\s.*/m, '"\&"')
+        .sub(/.*\s.*/m, '"\&"')
   end
 
   # Because some modules provide their own version of this method.

data/lib/puppet/util/feature.rb

@@ -52,13 +52,11 @@ class Puppet::Util::Feature
       #    * the result was true/false
       #    OR
       #    * we're configured to never retry
-      if @results.has_key?(name) &&
-         (!@results[name].nil? || !Puppet[:always_retry_plugins])
-        !!@results[name]
-      else
+      unless @results.has_key?(name) &&
+             (!@results[name].nil? || !Puppet[:always_retry_plugins])
         @results[name] = test(name, options, &block)
-        !!@results[name]
       end
+      !!@results[name]
     end
   end
 
@@ -89,7 +87,7 @@ class Puppet::Util::Feature
     if block_given?
       begin
         result = yield
-      rescue StandardError,ScriptError => detail
+      rescue StandardError, ScriptError => detail
         warn _("Failed to load feature test for %{name}: %{detail}") % { name: name, detail: detail }
         result = nil
       end
@@ -120,11 +118,11 @@ class Puppet::Util::Feature
     rescue LoadError
       # Expected case. Required library insn't installed.
       debug_once(_("Could not find library '%{lib}' required to enable feature '%{name}'") %
-        {lib: lib, name: name})
+        { lib: lib, name: name })
       false
     rescue StandardError, ScriptError => detail
       debug_once(_("Exception occurred while loading library '%{lib}' required to enable feature '%{name}': %{detail}") %
-        {lib: lib, name: name, detail: detail})
+        { lib: lib, name: name, detail: detail })
       false
     end
   end

data/lib/puppet/util/fileparsing.rb

@@ -105,7 +105,7 @@ module Puppet::Util::FileParsing
     def join(details)
       joinchar = self.joiner
 
-      fields.collect { |field|
+      fields.filter_map { |field|
         # If the field is marked absent, use the appropriate replacement
         if details[field] == :absent or details[field] == [:absent] or details[field].nil?
           if self.optional.include?(field)
@@ -116,7 +116,7 @@ module Puppet::Util::FileParsing
         else
           details[field].to_s
         end
-      }.reject { |c| c.nil?}.join(joinchar)
+      }.join(joinchar)
     end
 
     # Customize this so we can do a bit of validation.
@@ -163,7 +163,7 @@ module Puppet::Util::FileParsing
 
   # Try to match a specific text line.
   def handle_text_line(line, record)
-    line =~ record.match ? {:record_type => record.name, :line => line} : nil
+    line =~ record.match ? { :record_type => record.name, :line => line } : nil
   end
 
   # Try to match a record.
@@ -220,7 +220,7 @@ module Puppet::Util::FileParsing
           end
         end
 
-        if record.rollup and ! line_fields.empty?
+        if record.rollup and !line_fields.empty?
           last_field = record.fields[-1]
           val = ([ret[last_field]] + line_fields).join(record.joiner)
           ret[last_field] = val
@@ -311,7 +311,7 @@ module Puppet::Util::FileParsing
 
   # Are there any record types defined?
   def records?
-    defined?(@record_types) and ! @record_types.empty?
+    defined?(@record_types) and !@record_types.empty?
   end
 
   # Define a new type of text record.
@@ -358,7 +358,7 @@ module Puppet::Util::FileParsing
         if regex == true
           regex = /\s+$/
         end
-        return line.sub(regex,'')
+        return line.sub(regex, '')
       else
         return line
       end
@@ -379,12 +379,10 @@ module Puppet::Util::FileParsing
     record = record_type(type)
     if record && record.fields.include?(attr.intern)
       return true
+    elsif attr.intern == :ensure
+      return true
     else
-      if attr.intern == :ensure
-        return true
-      else
-        false
-      end
+      false
     end
   end
 
@@ -408,4 +406,3 @@ module Puppet::Util::FileParsing
     @record_types[type.intern]
   end
 end
-

data/lib/puppet/util/filetype.rb

@@ -41,7 +41,7 @@ class Puppet::Util::FileType
           val = real_read
           @loaded = Time.now
           if val
-            return val.gsub(/# HEADER.*\n/,'')
+            return val.gsub(/# HEADER.*\n/, '')
           else
             return ""
           end
@@ -94,9 +94,9 @@ class Puppet::Util::FileType
   def cronargs
     uid = Puppet::Util.uid(@path)
     if uid && uid == Puppet::Util::SUIDManager.uid
-      {:failonfail => true, :combine => true}
+      { :failonfail => true, :combine => true }
     else
-      {:failonfail => true, :combine => true, :uid => @path}
+      { :failonfail => true, :combine => true, :uid => @path }
     end
   end
 

data/lib/puppet/util/inifile.rb

@@ -306,7 +306,7 @@ module Puppet::Util::IniConfig
     alias [] get_section
 
     def include?(name)
-      !! get_section(name)
+      !!get_section(name)
     end
 
     def add_section(name, file)

data/lib/puppet/util/ldap/manager.rb

@@ -57,7 +57,7 @@ class Puppet::Util::Ldap::Manager
       else
         ssl = false
       end
-      options = {:ssl => ssl}
+      options = { :ssl => ssl }
       user = Puppet[:ldapuser]
       if user && user != ""
         options[:user] = user
@@ -98,7 +98,7 @@ class Puppet::Util::Ldap::Manager
     # name.
     name = entry["dn"].dup.pop.split(",").shift.split("=").pop
 
-    result = {:name => name}
+    result = { :name => name }
 
     @ldap2puppet.each do |ldap, puppet|
       result[puppet] = entry[ldap.to_s] || :absent
@@ -145,7 +145,7 @@ class Puppet::Util::Ldap::Manager
         value = values[generator.source]
         unless value
           raise ArgumentError, _("%{source} must be defined to generate %{name}") %
-              { source: generator.source, name: generator.name }
+                               { source: generator.source, name: generator.name }
         end
         result = generator.generate(value)
       else
@@ -178,7 +178,7 @@ class Puppet::Util::Ldap::Manager
     @puppet2ldap = attributes
 
     # and the ldap attributes as the keys.
-    @ldap2puppet = attributes.inject({}) { |map, ary| map[ary[1]] = ary[0]; map }
+    @ldap2puppet = attributes.each_with_object({}) { |ary, map| map[ary[1]] = ary[0]; }
 
     self
   end
@@ -269,7 +269,7 @@ class Puppet::Util::Ldap::Manager
 
   # Is this a complete ldap configuration?
   def valid?
-    location and objectclasses and ! objectclasses.empty? and puppet2ldap
+    location and objectclasses and !objectclasses.empty? and puppet2ldap
   end
 
   private
@@ -277,10 +277,9 @@ class Puppet::Util::Ldap::Manager
   # Convert a hash of attributes to ldap-like forms.  This mostly means
   # getting rid of :ensure and making sure everything's an array of strings.
   def ldap_convert(attributes)
-    attributes.reject { |param, value| value == :absent or param == :ensure }.inject({}) do |result, ary|
+    attributes.reject { |param, value| value == :absent or param == :ensure }.each_with_object({}) do |ary, result|
       value = (ary[1].is_a?(Array) ? ary[1] : [ary[1]]).collect { |v| v.to_s }
       result[ldap_name(ary[0])] = value
-      result
     end
   end
 end

data/lib/puppet/util/libuser.rb

@@ -2,7 +2,7 @@
 
 module Puppet::Util::Libuser
    def self.getconf
-     File.expand_path("../libuser.conf", __FILE__)
+     File.expand_path('libuser.conf', __dir__)
    end
 
    def self.getenv

data/lib/puppet/util/log/destination.rb

@@ -48,4 +48,3 @@ class Puppet::Util::Log::Destination
     define_method(:initialize, &block)
   end
 end
-

data/lib/puppet/util/log/destinations.rb

@@ -37,9 +37,7 @@ Puppet::Util::Log.newdesttype :syslog do
     else
       msg.to_s.split("\n").each do |line|
         @syslog.send(msg.level, "(%s) %s" % [msg.source.to_s.delete("%"),
-                                             line.gsub("%", '%%')
-          ]
-        )
+                                             line.gsub("%", '%%')])
       end
     end
   end
@@ -93,7 +91,7 @@ Puppet::Util::Log.newdesttype :file do
       end
     end
 
-    file = File.open(path, File::WRONLY|File::CREAT|File::APPEND)
+    file = File.new(path, File::WRONLY | File::CREAT | File::APPEND)
     file.puts('[') if need_array_start
 
     @file = file

data/lib/puppet/util/log.rb

@@ -15,7 +15,7 @@ class Puppet::Util::Log
   include Puppet::Util::Tagging
   include Puppet::Network::FormatSupport
 
-  @levels = [:debug,:info,:notice,:warning,:err,:alert,:emerg,:crit]
+  @levels = [:debug, :info, :notice, :warning, :err, :alert, :emerg, :crit]
   @loglevel = 2
 
   @desttypes = {}
@@ -139,7 +139,7 @@ class Puppet::Util::Log
       return
     end
 
-    raise Puppet::DevError, _("Unknown destination type %{dest}") % { dest: dest} unless type
+    raise Puppet::DevError, _("Unknown destination type %{dest}") % { dest: dest } unless type
 
     begin
       if type.instance_method(:initialize).arity == 1
@@ -180,7 +180,7 @@ class Puppet::Util::Log
 
     # We only select the last 10 callers in the stack to avoid being spammy
     message = _("Received a Log attribute with invalid encoding:%{log_message}") %
-        { log_message: Puppet::Util::CharacterEncoding.convert_to_utf_8(str.dump)}
+              { log_message: Puppet::Util::CharacterEncoding.convert_to_utf_8(str.dump) }
     message += '\n' + _("Backtrace:\n%{backtrace}") % { backtrace: caller(1, 10).join("\n") }
     message
   end
@@ -223,7 +223,7 @@ class Puppet::Util::Log
   #  the program is about to exit--most likely in a horrific
   #  error scenario.
   # @return nil
-  def Log.force_flushqueue()
+  def Log.force_flushqueue
     if (@destinations.empty? and !(@queued.empty?))
       newdestination(:console)
     end
@@ -258,7 +258,8 @@ class Puppet::Util::Log
   def self.setup_default
     Log.newdestination(
       (Puppet.features.syslog?   ? :syslog   :
-      (Puppet.features.eventlog? ? :eventlog : Puppet[:puppetdlog])))
+      (Puppet.features.eventlog? ? :eventlog : Puppet[:puppetdlog]))
+    )
   end
 
   # Is the passed level a valid log level?
@@ -292,7 +293,7 @@ class Puppet::Util::Log
     #       as this is good enough, but does not reflect the true call-stack, but is a rough estimate
     #       of where the logging call originates from).
     #
-    Puppet::Util::Log.create({:level => level, :source => scope, :message => vals.join(" ")})
+    Puppet::Util::Log.create({ :level => level, :source => scope, :message => vals.join(" ") })
     nil
   end