puppet 8.5.0 → 8.6.0

data/lib/puppet/type/tidy.rb

@@ -100,7 +100,7 @@ Puppet::Type.newtype(:tidy) do
 
     # Make sure we convert to an array.
     munge do |value|
-      fail _("Tidy can't use matches with recurse 0, false, or undef") if "#{@resource[:recurse]}" =~ /^(0|false|)$/
+      fail _("Tidy can't use matches with recurse 0, false, or undef") if (@resource[:recurse]).to_s =~ /^(0|false|)$/
 
       [value].flatten
     end
@@ -110,7 +110,7 @@ Puppet::Type.newtype(:tidy) do
     def tidy?(path, stat)
       basename = File.basename(path)
       flags = File::FNM_DOTMATCH | File::FNM_PATHNAME
-      return(value.find { |pattern| File.fnmatch(pattern, basename, flags) } ? true : false)
+      (value.find { |pattern| File.fnmatch(pattern, basename, flags) } ? true : false)
     end
   end
 
@@ -139,7 +139,7 @@ Puppet::Type.newtype(:tidy) do
     def convert(unit, multi)
       num = AgeConvertors[unit]
       if num
-        return num * multi
+        num * multi
       else
         self.fail _("Invalid age unit '%{unit}'") % { unit: unit }
       end
@@ -154,10 +154,10 @@ Puppet::Type.newtype(:tidy) do
       unit = multi = nil
       case age
       when /^([0-9]+)(\w)\w*$/
-        multi = Integer($1)
-        unit = $2.downcase.intern
+        multi = Integer(Regexp.last_match(1))
+        unit = Regexp.last_match(2).downcase.intern
       when /^([0-9]+)$/
-        multi = Integer($1)
+        multi = Integer(Regexp.last_match(1))
         unit = :d
       else
         # TRANSLATORS tidy is the name of a program and should not be translated
@@ -181,7 +181,7 @@ Puppet::Type.newtype(:tidy) do
       if num
         result = multi
         num.times do result *= 1024 end
-        return result
+        result
       else
         self.fail _("Invalid size unit '%{unit}'") % { unit: unit }
       end
@@ -194,10 +194,10 @@ Puppet::Type.newtype(:tidy) do
     munge do |size|
       case size
       when /^([0-9]+)(\w)\w*$/
-        multi = Integer($1)
-        unit = $2.downcase.intern
+        multi = Integer(Regexp.last_match(1))
+        unit = Regexp.last_match(2).downcase.intern
       when /^([0-9]+)$/
-        multi = Integer($1)
+        multi = Integer(Regexp.last_match(1))
         unit = :k
       else
         # TRANSLATORS tidy is the name of a program and should not be translated
@@ -260,9 +260,9 @@ Puppet::Type.newtype(:tidy) do
     # Our ensure property knows how to retrieve everything for us.
     obj = @parameters[:ensure]
     if obj
-      return obj.retrieve
+      obj.retrieve
     else
-      return {}
+      {}
     end
   end
 
@@ -329,10 +329,10 @@ Puppet::Type.newtype(:tidy) do
     basename = File.basename(path)
     flags = File::FNM_DOTMATCH | File::FNM_PATHNAME
     if self[:matches].find { |pattern| File.fnmatch(pattern, basename, flags) }
-      return true
+      true
     else
       debug "No specified patterns match #{path}, not tidying"
-      return false
+      false
     end
   end
 
@@ -368,15 +368,13 @@ Puppet::Type.newtype(:tidy) do
   end
 
   def stat(path)
-    begin
-      Puppet::FileSystem.lstat(path)
-    rescue Errno::ENOENT
-      debug _("File does not exist")
-      return nil
-    rescue Errno::EACCES
-      # TRANSLATORS "stat" is a program name and should not be translated
-      warning _("Could not stat; permission denied")
-      return nil
-    end
+    Puppet::FileSystem.lstat(path)
+  rescue Errno::ENOENT
+    debug _("File does not exist")
+    nil
+  rescue Errno::EACCES
+    # TRANSLATORS "stat" is a program name and should not be translated
+    warning _("Could not stat; permission denied")
+    nil
   end
 end

data/lib/puppet/type/user.rb

@@ -93,12 +93,12 @@ module Puppet
       def retrieve
         if provider.exists?
           if provider.respond_to?(:is_role?) and provider.is_role?
-            return :role
+            :role
           else
-            return :present
+            :present
           end
         else
-          return :absent
+          :absent
         end
       end
 
@@ -173,11 +173,11 @@ module Puppet
         found = false
         @should.each do |value|
           number = Puppet::Util.gid(value)
-          if number
-            provider.gid = number
-            found = true
-            break
-          end
+          next unless number
+
+          provider.gid = number
+          found = true
+          break
         end
 
         fail _("Could not find group(s) %{groups}") % { groups: @should.join(",") } unless found
@@ -440,7 +440,7 @@ module Puppet
 
       validate do |val|
         if munge(val)
-          raise ArgumentError, _("User provider %{name} can not manage home directories") % { name: provider.class.name } if provider and not provider.class.manages_homedir?
+          raise ArgumentError, _("User provider %{name} can not manage home directories") % { name: provider.class.name } if provider and !provider.class.manages_homedir?
         end
       end
     end
@@ -700,7 +700,7 @@ module Puppet
     end
 
     def generate
-      if !self[:purge_ssh_keys].empty?
+      unless self[:purge_ssh_keys].empty?
         if Puppet::Type.type(:ssh_authorized_key).nil?
           warning _("Ssh_authorized_key type is not available. Cannot purge SSH keys.")
         else
@@ -840,16 +840,16 @@ module Puppet
         next unless line =~ Puppet::Type.type(:ssh_authorized_key).keyline_regex
 
         # the name is stored in the 4th capture of the regex
-        name = $4
+        name = ::Regexp.last_match(4)
         if name.empty?
-          $3.delete("\n")
+          ::Regexp.last_match(3).delete("\n")
           # If no comment is specified for this key, generate a unique internal
           # name. This uses the same rules as
           # provider/ssh_authorized_key/parsed (PUP-3357)
           name = "#{keyfile}:unnamed-#{name_index += 1}"
         end
         names << name
-        Puppet.debug "#{self.ref} parsed for purging Ssh_authorized_key[#{name}]"
+        Puppet.debug "#{ref} parsed for purging Ssh_authorized_key[#{name}]"
       end
 
       names.map { |keyname|

data/lib/puppet/type.rb

@@ -103,7 +103,7 @@ class Type
     return nil unless other.is_a?(Puppet::CompilableResourceType) || other.class.is_a?(Puppet::CompilableResourceType)
 
     # against other type instances.
-    self.ref <=> other.ref
+    ref <=> other.ref
   end
 
   # Code related to resource type attributes.
@@ -123,7 +123,7 @@ class Type
   # @return [Array<String>] all type attribute names in a defined order.
   #
   def self.allattrs
-    key_attributes | (parameters & [:provider]) | properties.collect { |property| property.name } | parameters | metaparams
+    key_attributes | (parameters & [:provider]) | properties.collect(&:name) | parameters | metaparams
   end
 
   # Returns the class associated with the given attribute name.
@@ -136,7 +136,7 @@ class Type
     # We cache the value, since this method gets called such a huge number
     # of times (as in, hundreds of thousands in a given run).
     unless @attrclasses.include?(name)
-      @attrclasses[name] = case self.attrtype(name)
+      @attrclasses[name] = case attrtype(name)
                            when :property; @validproperties[name]
                            when :meta; @@metaparamhash[name]
                            when :param; @paramhash[name]
@@ -193,10 +193,10 @@ class Type
   #
   def self.ensurable(&block)
     if block_given?
-      self.newproperty(:ensure, :parent => Puppet::Property::Ensure, &block)
+      newproperty(:ensure, :parent => Puppet::Property::Ensure, &block)
     else
-      self.newproperty(:ensure, :parent => Puppet::Property::Ensure) do
-        self.defaultvalues
+      newproperty(:ensure, :parent => Puppet::Property::Ensure) do
+        defaultvalues
       end
     end
   end
@@ -211,7 +211,7 @@ class Type
     # If the class has all three of these methods defined, then it's
     # ensurable.
     [:exists?, :create, :destroy].all? { |method|
-      self.public_method_defined?(method)
+      public_method_defined?(method)
     }
   end
 
@@ -275,7 +275,7 @@ class Type
       define_method(name.to_s + "?") do
         val = self[name]
         if val == :true or val == true
-          return true
+          true
         end
       end
     end
@@ -304,7 +304,7 @@ class Type
   # @return [Array<String>] all meta-parameter names
   #
   def self.metaparams
-    @@metaparams.collect { |param| param.name }
+    @@metaparams.collect(&:name)
   end
 
   # Returns the documentation for a given meta-parameter of this type.
@@ -389,7 +389,7 @@ class Type
   def self.key_attributes
     # This is a cache miss around 0.05 percent of the time. --daniel 2012-07-17
     # rubocop:disable Naming/MemoizedInstanceVariableName
-    @key_attributes_cache ||= key_attribute_parameters.collect { |p| p.name }
+    @key_attributes_cache ||= key_attribute_parameters.collect(&:name)
     # rubocop:enable Naming/MemoizedInstanceVariableName
   end
 
@@ -443,7 +443,7 @@ class Type
   # @return [Object] an object that is a _uniqueness_key_ for this object
   #
   def uniqueness_key
-    self.class.key_attributes.sort_by { |attribute_name| attribute_name.to_s }.map { |attribute_name| self[attribute_name] }
+    self.class.key_attributes.sort_by(&:to_s).map { |attribute_name| self[attribute_name] }
   end
 
   # Creates a new parameter.
@@ -553,7 +553,7 @@ class Type
   def self.parameters
     return [] unless defined?(@parameters)
 
-    @parameters.collect { |klass| klass.name }
+    @parameters.collect(&:name)
   end
 
   # @return [Puppet::Parameter] Returns the parameter class associated with the given parameter name.
@@ -576,7 +576,7 @@ class Type
     @validattrs ||= {}
 
     unless @validattrs.include?(name)
-      @validattrs[name] = !!(self.validproperty?(name) or self.validparameter?(name) or self.metaparam?(name))
+      @validattrs[name] = !!(validproperty?(name) or validparameter?(name) or metaparam?(name))
     end
 
     @validattrs[name]
@@ -622,7 +622,7 @@ class Type
   # @return [Boolean] true if a new parameter was added, false otherwise
   def add_property_parameter(prop_name)
     if self.class.validproperty?(prop_name) && !@parameters[prop_name]
-      self.newattr(prop_name)
+      newattr(prop_name)
       return true
     end
     false
@@ -662,7 +662,7 @@ class Type
       # not the current value.
       obj.value
     else
-      return nil
+      nil
     end
   end
 
@@ -680,9 +680,9 @@ class Type
       nv = name_var
       name = nv if nv
     end
-    raise Puppet::Error.new("Got nil value for #{name}") if value.nil?
+    raise Puppet::Error, "Got nil value for #{name}" if value.nil?
 
-    property = self.newattr(name)
+    property = newattr(name)
 
     if property
       begin
@@ -710,7 +710,7 @@ class Type
     if @parameters.has_key?(attr)
       @parameters.delete(attr)
     else
-      raise Puppet::DevError.new(_("Undefined attribute '%{attribute}' in %{name}") % { attribute: attr, name: self })
+      raise Puppet::DevError, _("Undefined attribute '%{attribute}' in %{name}") % { attribute: attr, name: self }
     end
   end
 
@@ -933,9 +933,9 @@ class Type
   # @return [Boolean] true, if this type's name is isomorphic with the object
   def self.isomorphic?
     if defined?(@isomorphic)
-      return @isomorphic
+      @isomorphic
     else
-      return true
+      true
     end
   end
 
@@ -965,7 +965,7 @@ class Type
         end
       }
     end
-    return @managed
+    @managed
   end
 
   ###############################
@@ -995,7 +995,7 @@ class Type
     @parent = nil
 
     # Remove the reference to the provider.
-    if self.provider
+    if provider
       @provider.clear
       @provider = nil
     end
@@ -1035,7 +1035,7 @@ class Type
   #
   # @return [???, nil] WHAT DOES IT RETURN? GUESS IS VOID
   def flush
-    self.provider.flush if self.provider and self.provider.respond_to?(:flush)
+    provider.flush if provider and provider.respond_to?(:flush)
   end
 
   # Says if the ensure property should be retrieved if the resource is ensurable
@@ -1051,7 +1051,7 @@ class Type
   # @return [Puppet::Resource] array of all property values (mix of types)
   # @raise [fail???] if there is a provider and it is not suitable for the host this is evaluated for.
   def retrieve
-    fail "Provider #{provider.class.name} is not functional on this host" if self.provider.is_a?(Puppet::Provider) and !provider.class.suitable?
+    fail "Provider #{provider.class.name} is not functional on this host" if provider.is_a?(Puppet::Provider) and !provider.class.suitable?
 
     result = Puppet::Resource.new(self.class, title)
 
@@ -1115,7 +1115,7 @@ class Type
     # is the first property, which is important for skipping 'retrieve' on
     # all the properties if the resource is absent.
     ensure_state = false
-    return properties.each_with_object({}) do |property, prophash|
+    properties.each_with_object({}) do |property, prophash|
       if property.name == :ensure
         ensure_state = property.retrieve
         prophash[property] = ensure_state
@@ -1151,7 +1151,7 @@ class Type
   # Either requires providers or must be overridden.
   # @raise [Puppet::DevError] when there are no providers and the implementation has not overridden this method.
   def self.instances
-    raise Puppet::DevError, _("%{name} has no providers and has not overridden 'instances'") % { name: self.name } if provider_hash.empty?
+    raise Puppet::DevError, _("%{name} has no providers and has not overridden 'instances'") % { name: name } if provider_hash.empty?
 
     # Put the default provider first, then the rest of the suitable providers.
     provider_instances = {}
@@ -1163,7 +1163,7 @@ class Type
         other = provider_instances[title]
         if other
           Puppet.debug {
-            "%s %s found in both %s and %s; skipping the %s version" % [self.name.to_s.capitalize, title, other.class.name, instance.class.name, instance.class.name]
+            "%s %s found in both %s and %s; skipping the %s version" % [name.to_s.capitalize, title, other.class.name, instance.class.name, instance.class.name]
           }
           next
         end
@@ -1229,9 +1229,9 @@ class Type
   def pathbuilder
     p = parent
     if p
-      [p.pathbuilder, self.ref].flatten
+      [p.pathbuilder, ref].flatten
     else
-      [self.ref]
+      [ref]
     end
   end
 
@@ -1309,7 +1309,7 @@ class Type
       and the second run will log the edit made by Puppet.)"
 
     validate do |list|
-      list = Array(list).collect { |p| p.to_sym }
+      list = Array(list).collect(&:to_sym)
       unless list == [:all]
         list.each do |param|
           next if @resource.class.validattr?(param)
@@ -1330,16 +1330,14 @@ class Type
     def all_properties
       resource.class.properties.find_all do |property|
         resource.provider.nil? or resource.provider.class.supports_parameter?(property)
-      end.collect do |property|
-        property.name
-      end
+      end.collect(&:name)
     end
 
     def properties_to_audit(list)
       if !list.is_a?(Array) && list.to_sym == :all
         all_properties
       else
-        Array(list).collect { |p| p.to_sym }
+        Array(list).collect(&:to_sym)
       end
     end
   end
@@ -1375,7 +1373,7 @@ class Type
   end
 
   newmetaparam(:alias) do
-    desc %q{Creates an alias for the resource.  Puppet uses this internally when you
+    desc "Creates an alias for the resource.  Puppet uses this internally when you
       provide a symbolic title and an explicit namevar value:
 
           file { 'sshdconfig':
@@ -1411,7 +1409,7 @@ class Type
       There's no way here for the Puppet parser to know that these two stanzas
       should be affecting the same file.
 
-      }
+      "
 
     munge do |aliases|
       aliases = [aliases] unless aliases.is_a?(Array)
@@ -1494,11 +1492,11 @@ class Type
     # @return [void]
     def validate_relationship
       @value.each do |ref|
-        unless @resource.catalog.resource(ref.to_s)
-          description = self.class.direction == :in ? "dependency" : "dependent"
-          fail ResourceError, _("Could not find %{description} %{ref} for %{resource}") %
-                              { description: description, ref: ref, resource: resource.ref }
-        end
+        next if @resource.catalog.resource(ref.to_s)
+
+        description = self.class.direction == :in ? "dependency" : "dependent"
+        fail ResourceError, _("Could not find %{description} %{ref} for %{resource}") %
+                            { description: description, ref: ref, resource: resource.ref }
       end
     end
 
@@ -1550,7 +1548,7 @@ class Type
 
         ## Corrected syntax of debug statement to reflect the way this was called.
         # i.e. before, after, subscribe, notify
-        self.debug do
+        debug do
           relation = case self.class.name
                      when "subscribe"
                        "subscribes"
@@ -1711,16 +1709,16 @@ class Type
     suitable = suitableprovider
 
     # Find which providers are a default for this system.
-    defaults = suitable.find_all { |provider| provider.default? }
+    defaults = suitable.find_all(&:default?)
 
     # If we don't have any default we use suitable providers
     defaults = suitable if defaults.empty?
-    max = defaults.collect { |provider| provider.specificity }.max
+    max = defaults.collect(&:specificity).max
     defaults = defaults.find_all { |provider| provider.specificity == max }
 
     if defaults.length > 1
       Puppet.warning(_("Found multiple default providers for %{name}: %{provider_list}; using %{selected_provider}") %
-                         { name: self.name, provider_list: defaults.collect { |i| i.name.to_s }.join(", "), selected_provider: defaults[0].name })
+                         { name: name, provider_list: defaults.collect { |i| i.name.to_s }.join(", "), selected_provider: defaults[0].name })
     end
 
     @defaultprovider = defaults.shift unless defaults.empty?
@@ -1736,7 +1734,7 @@ class Type
   # @return [Hash{ ??? => Puppet::Provider}] Returns a hash of WHAT EXACTLY for this type.
   # @see provider_hash_by_type method to get the same for some other type
   def self.provider_hash
-    Puppet::Type.provider_hash_by_type(self.name)
+    Puppet::Type.provider_hash_by_type(name)
   end
 
   # Returns the provider having the given name.
@@ -1772,7 +1770,7 @@ class Type
   def self.validprovider?(name)
     name = name.intern
 
-    (provider_hash.has_key?(name) && provider_hash[name].suitable?)
+    provider_hash.has_key?(name) && provider_hash[name].suitable?
   end
 
   # Creates a new provider of a type.
@@ -1803,11 +1801,7 @@ class Type
                  pname
                else
                  provider = self.provider(pname)
-                 if provider
-                   provider
-                 else
-                   raise Puppet::DevError, _("Could not find parent provider %{parent} of %{name}") % { parent: pname, name: name }
-                 end
+                 provider || raise(Puppet::DevError, _("Could not find parent provider %{parent} of %{name}") % { parent: pname, name: name })
                end
              else
                Puppet::Provider
@@ -1815,9 +1809,9 @@ class Type
 
     options[:resource_type] ||= self
 
-    self.providify
+    providify
 
-    provider = genclass(
+    genclass(
       name,
       :parent => parent,
       :hash => provider_hash,
@@ -1827,8 +1821,6 @@ class Type
       :extend => feature_module,
       :attributes => options
     )
-
-    provider
   end
 
   # Ensures there is a `:provider` parameter defined.
@@ -1843,7 +1835,7 @@ class Type
       # We expect that the class in which this code is executed will be something
       # like Puppet::Type::Ssh_authorized_key::ParameterProvider.
       desc <<-EOT
-        The specific backend to use for this `#{self.to_s.split('::')[2].downcase}`
+        The specific backend to use for this `#{to_s.split('::')[2].downcase}`
         resource. You will seldom need to specify this --- Puppet will usually
         discover the appropriate provider for your platform.
       EOT
@@ -1912,7 +1904,7 @@ class Type
 
   # Returns a list of suitable providers for the given type.
   # A call to this method will load all providers if not already loaded and ask each if it is
-  # suitable - those that are are included in the result.
+  # suitable - those that are included in the result.
   # @note This method also does some special processing which rejects a provider named `:fake` (for testing purposes).
   # @return [Array<Puppet::Provider>] Returns an array of all suitable providers.
   #
@@ -2094,7 +2086,7 @@ class Type
       next unless Puppet::Type.type(type)
 
       # Retrieve the list of names from the block.
-      list = self.instance_eval(&block)
+      list = instance_eval(&block)
       next unless list
 
       list = [list] unless list.is_a?(Array)
@@ -2337,7 +2329,7 @@ class Type
     [:file, :line, :catalog, :exported, :virtual].each do |getter|
       setter = getter.to_s + "="
       val = resource.send(getter)
-      self.send(setter, val) if val
+      send(setter, val) if val
     end
 
     merge_tags_from(resource)
@@ -2363,13 +2355,11 @@ class Type
   #
   # @return [void]
   def validate_resource
-    begin
-      self.validate if self.respond_to?(:validate)
-    rescue Puppet::Error, ArgumentError => detail
-      error = Puppet::ResourceError.new("Validation of #{ref} failed: #{detail}")
-      adderrorcontext(error, detail)
-      raise error
-    end
+    validate if respond_to?(:validate)
+  rescue Puppet::Error, ArgumentError => detail
+    error = Puppet::ResourceError.new("Validation of #{ref} failed: #{detail}")
+    adderrorcontext(error, detail)
+    raise error
   end
 
   protected
@@ -2454,22 +2444,20 @@ class Type
     # on invalid attributes.
     no_values = []
     (self.class.allattrs + hash.keys).uniq.each do |attr|
-      begin
-        # Set any defaults immediately.  This is mostly done so
-        # that the default provider is available for any other
-        # property validation.
-        if hash.has_key?(attr)
-          self[attr] = hash[attr]
-        else
-          no_values << attr
-        end
-      rescue ArgumentError, Puppet::Error, TypeError
-        raise
-      rescue => detail
-        error = Puppet::DevError.new(_("Could not set %{attribute} on %{class_name}: %{detail}") % { attribute: attr, class_name: self.class.name, detail: detail })
-        error.set_backtrace(detail.backtrace)
-        raise error
+      # Set any defaults immediately.  This is mostly done so
+      # that the default provider is available for any other
+      # property validation.
+      if hash.has_key?(attr)
+        self[attr] = hash[attr]
+      else
+        no_values << attr
       end
+    rescue ArgumentError, Puppet::Error, TypeError
+      raise
+    rescue => detail
+      error = Puppet::DevError.new(_("Could not set %{attribute} on %{class_name}: %{detail}") % { attribute: attr, class_name: self.class.name, detail: detail })
+      error.set_backtrace(detail.backtrace)
+      raise error
     end
     no_values.each do |attr|
       set_default(attr)
@@ -2536,7 +2524,7 @@ class Type
   def ref
     # memoizing this is worthwhile ~ 3 percent of calls are the "first time
     # around" in an average run of Puppet. --daniel 2012-07-17
-    @ref ||= "#{self.class.name.to_s.capitalize}[#{self.title}]"
+    @ref ||= "#{self.class.name.to_s.capitalize}[#{title}]"
   end
 
   # (see self_refresh)
@@ -2582,9 +2570,9 @@ class Type
       if self.class.validparameter?(name_var)
         @title = self[:name]
       elsif self.class.validproperty?(name_var)
-        @title = self.should(name_var)
+        @title = should(name_var)
       else
-        self.devfail "Could not find namevar #{name_var} for #{self.class.name}"
+        devfail "Could not find namevar #{name_var} for #{self.class.name}"
       end
     end
 
@@ -2595,19 +2583,19 @@ class Type
   # @see #ref
   #
   def to_s
-    self.ref
+    ref
   end
 
   # Convert this resource type instance to a Puppet::Resource.
   # @return [Puppet::Resource] Returns a serializable representation of this resource
   #
   def to_resource
-    resource = self.retrieve_resource
+    resource = retrieve_resource
     resource.merge_tags_from(self)
 
     @parameters.each do |name, param|
       # Avoid adding each instance name twice
-      next if param.class.isnamevar? and param.value == self.title
+      next if param.class.isnamevar? and param.value == title
 
       # We've already got property values
       next if param.is_a?(Puppet::Property)