puppet 8.3.1 → 8.4.0

data/lib/puppet/util/posix.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
+
 # Utility methods for interacting with POSIX objects; mostly user and group
 module Puppet::Util::POSIX
-
   # This is a list of environment variables that we will set when we want to override the POSIX locale
   LOCALE_ENV_VARS = ['LANG', 'LC_ALL', 'LC_MESSAGES', 'LANGUAGE',
-                           'LC_COLLATE', 'LC_CTYPE', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME']
+                     'LC_COLLATE', 'LC_CTYPE', 'LC_MONETARY', 'LC_NUMERIC', 'LC_TIME']
 
   # This is a list of user-related environment variables that we will unset when we want to provide a pristine
   # environment for "exec" runs
@@ -34,13 +34,14 @@ module Puppet::Util::POSIX
     end
 
     private
+
     def get_groups_list(user)
       raise LoadError, "The 'getgrouplist' method is not available" unless Puppet::FFI::POSIX::Functions.respond_to?(:getgrouplist)
 
       user_gid = Puppet::Etc.getpwnam(user).gid
       ngroups = Puppet::FFI::POSIX::Constants::MAXIMUM_NUMBER_OF_GROUPS
 
-      while true do # rubocop:disable Lint/LiteralInCondition
+      while true do
         FFI::MemoryPointer.new(:int) do |ngroups_ptr|
           FFI::MemoryPointer.new(:uint, ngroups) do |groups_ptr|
             old_ngroups = ngroups
@@ -156,12 +157,12 @@ module Puppet::Util::POSIX
 
   # Get the GID
   def gid(group)
-      get_posix_value(:group, :gid, group)
+    get_posix_value(:group, :gid, group)
   end
 
   # Get the UID
   def uid(user)
-      get_posix_value(:passwd, :uid, user)
+    get_posix_value(:passwd, :uid, user)
   end
 
   private
@@ -177,11 +178,13 @@ module Puppet::Util::POSIX
     if field.is_a?(Integer)
       name = get_posix_field(location, :name, field)
       return nil unless name
+
       id = get_posix_field(location, id_field, name)
       check_value = id
     else
       id = get_posix_field(location, id_field, field)
       return nil unless id
+
       name = get_posix_field(location, :name, id)
       check_value = name
     end

data/lib/puppet/util/profiler/aggregate.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/profiler'
 require_relative '../../../puppet/util/profiler/wall_clock'
 
@@ -16,10 +17,6 @@ class Puppet::Util::Profiler::Aggregate < Puppet::Util::Profiler::WallClock
     @logger.call("----------------------------")
   end
 
-  def do_start(description, metric_id)
-    super(description, metric_id)
-  end
-
   def do_finish(context, description, metric_id)
     result = super(context, description, metric_id)
     update_metric(@metrics_hash, metric_id, result[:time])
@@ -43,7 +40,7 @@ class Puppet::Util::Profiler::Aggregate < Puppet::Util::Profiler::WallClock
   end
 
   def print_metrics(metrics_hash, prefix)
-    metrics_hash.sort_by {|k,v| v.time }.reverse_each do |k,v|
+    metrics_hash.sort_by {|_k,v| v.time }.reverse_each do |k,v|
       @logger.call("#{prefix}#{k}: #{v.time} s (#{v.count} calls)")
       print_metrics(metrics_hash[k], "#{prefix}#{k} -> ")
     end

data/lib/puppet/util/profiler/around_profiler.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 # A Profiler that can be used to wrap around blocks of code. It is configured
 # with other profilers and controls them to start before the block is executed
 # and finish after the block is executed.
 #
 # @api private
 class Puppet::Util::Profiler::AroundProfiler
-
   def initialize
     @profilers = []
   end

data/lib/puppet/util/profiler/logging.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Puppet::Util::Profiler::Logging
   def initialize(logger, identifier)
     @logger = logger

data/lib/puppet/util/profiler/object_counts.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/profiler/logging'
 
 class Puppet::Util::Profiler::ObjectCounts < Puppet::Util::Profiler::Logging

data/lib/puppet/util/profiler/wall_clock.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/profiler/logging'
 
 # A profiler implementation that measures the number of seconds a segment of

data/lib/puppet/util/profiler.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'benchmark'
 
 # A simple profiling callback system.

data/lib/puppet/util/provider_features.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Provides feature definitions.
 require_relative '../../puppet/util/docs'
 require_relative '../../puppet/util'
@@ -62,6 +63,7 @@ module Puppet::Util::ProviderFeatures
   def feature(name, docs, hash = {})
     @features ||= {}
     raise Puppet::DevError, _("Feature %{name} is already defined") % { name: name } if @features.include?(name)
+
     begin
       obj = ProviderFeature.new(name, docs, **hash)
       @features[obj.name] = obj
@@ -79,6 +81,7 @@ module Puppet::Util::ProviderFeatures
     str = ''.dup
     @features ||= {}
     return nil if @features.empty?
+
     names = @features.keys.sort_by(&:to_s)
     names.each do |name|
       doc = @features[name].docs.gsub(/\n\s+/, " ")
@@ -128,6 +131,7 @@ module Puppet::Util::ProviderFeatures
       # Create a method that will list all functional features.
       @feature_module.send(:define_method, :features) do
         return false unless defined?(features)
+
         features.keys.find_all { |n| feature?(n) }.sort_by(&:to_s)
       end
 

data/lib/puppet/util/psych_support.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # This module should be included when a class can be serialized to yaml and
 # needs to handle the deserialization from Psych with more control. Psych normally
 # pokes values directly into an instance using `instance_variable_set` which completely

data/lib/puppet/util/rdoc/code_objects.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require 'rdoc/code_objects'
 
 module RDoc
-
   # This modules contains various class that are used to hold information
   # about the various Puppet language structures we found while parsing.
   #
@@ -18,7 +18,7 @@ module RDoc
   # @api private
   module AddClassModuleComment
     def add_comment(comment, location = nil)
-        super
+      super
     end
   end
 
@@ -69,6 +69,7 @@ module RDoc
       if cls
         return cls
       end
+
       @node_container ||= add_module(NormalModule, "__nodes__")
       cls = @node_container.add_class(PuppetNode, name, superclass)
       @nodes[name] = cls if !@done_documenting
@@ -176,7 +177,6 @@ module RDoc
       end
       result
     end
-
   end
 
   # PuppetNode holds a puppet node
@@ -185,10 +185,6 @@ module RDoc
   class PuppetNode < PuppetClass
     include AddClassModuleComment
 
-    def initialize(name, superclass)
-      super(name,superclass)
-    end
-
     def is_module?
       false
     end

data/lib/puppet/util/rdoc/generators/puppet_generator.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
+
 require 'rdoc/generators/html_generator'
 require_relative '../../../../puppet/util/rdoc/code_objects'
 require 'digest/md5'
 
 module Generators
-
   # This module holds all the classes needed to generate the HTML documentation
   # of a bunch of puppet manifests.
   #
@@ -52,7 +52,6 @@ module Generators
 
   # This is a specialized HTMLGenerator tailored to Puppet manifests
   class PuppetGenerator < HTMLGenerator
-
     def PuppetGenerator.for(options)
       AllReferences::reset
       HtmlMethod::reset
@@ -64,18 +63,18 @@ module Generators
       end
     end
 
-    def initialize(options) #:not-new:
-      @options    = options
+    def initialize(options) # :not-new:
+      @options = options
       load_html_template
     end
 
     # loads our own html template file
     def load_html_template
-        require_relative '../../../../puppet/util/rdoc/generators/template/puppet/puppet'
-        extend RDoc::Page
+      require_relative '../../../../puppet/util/rdoc/generators/template/puppet/puppet'
+      extend RDoc::Page
     rescue LoadError
-        $stderr.puts "Could not find Puppet template '#{template}'"
-        exit 99
+      $stderr.puts "Could not find Puppet template '#{template}'"
+      exit 99
     end
 
     def gen_method_index
@@ -116,6 +115,7 @@ module Generators
       # build the modules, classes and per modules classes and define list
       @toplevels.each do |toplevel|
         next unless toplevel.document_self
+
         file = HtmlFile.new(toplevel, @options, FILE_DIR)
         classes = []
         methods = []
@@ -144,7 +144,7 @@ module Generators
         # generate nodes and plugins found
         classes.each do |k|
           if k.context.is_module?
-            k.context.each_node do |name,node|
+            k.context.each_node do |_name,node|
               nodes << HTMLPuppetNode.new(node, toplevel, NODE_DIR, @options)
               @nodes << nodes.last
             end
@@ -196,13 +196,13 @@ module Generators
 
     # generate all the subdirectories, modules, classes and files
     def gen_sub_directories
-        super
-        File.makedirs(MODULE_DIR)
-        File.makedirs(NODE_DIR)
-        File.makedirs(PLUGIN_DIR)
+      super
+      File.makedirs(MODULE_DIR)
+      File.makedirs(NODE_DIR)
+      File.makedirs(PLUGIN_DIR)
     rescue
-        $stderr.puts $ERROR_INFO.message
-        exit 1
+      $stderr.puts $ERROR_INFO.message
+      exit 1
     end
 
     # generate the index of modules
@@ -221,11 +221,11 @@ module Generators
       end
 
       values = {
-        "entries"    => res,
+        "entries" => res,
         'list_title' => CGI.escapeHTML(title),
-        'index_url'  => main_url,
-        'charset'    => @options.charset,
-        'style_url'  => style_url('', @options.css),
+        'index_url' => main_url,
+        'charset' => @options.charset,
+        'style_url' => style_url('', @options.css),
       }
 
       Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
@@ -241,9 +241,8 @@ module Generators
 
           gen_composite_index(
             file,
-              RDoc::Page::COMBO_INDEX,
-
-              "#{MODULE_DIR}/fr_#{file["file"].context.module_name}.html")
+            RDoc::Page::COMBO_INDEX,
+            "#{MODULE_DIR}/fr_#{file["file"].context.module_name}.html")
         end
       end
     end
@@ -288,15 +287,15 @@ module Generators
 
       values = {
         "module" => module_name,
-        "classes"    => res1,
+        "classes" => res1,
         'classes_title' => CGI.escapeHTML("Classes"),
         'defines_title' => CGI.escapeHTML("Defines"),
         'facts_title' => CGI.escapeHTML("Custom Facts"),
         'plugins_title' => CGI.escapeHTML("Plugins"),
         'nodes_title' => CGI.escapeHTML("Nodes"),
-        'index_url'  => main_url,
-        'charset'    => @options.charset,
-        'style_url'  => style_url('', @options.css),
+        'index_url' => main_url,
+        'charset' => @options.charset,
+        'style_url' => style_url('', @options.css),
       }
 
       values["defines"] = res2 if res2.size>0
@@ -348,7 +347,6 @@ module Generators
 
       ref
     end
-
   end
 
   # This module is used to generate a referenced full name list of ContextUser
@@ -398,7 +396,7 @@ module Generators
       resources.each do |r|
         row = {}
         if r.section == section and r.document_self
-          row["name"]        = CGI.escapeHTML(r.name)
+          row["name"] = CGI.escapeHTML(r.name)
           desc = r.description.strip
           row["m_desc"]      = desc unless desc.empty?
           row["aref"]        = r.aref
@@ -499,11 +497,10 @@ module Generators
     def write_on(f)
       value_hash
 
-        template = TemplatePage.new(
-          RDoc::Page::BODYINC,
-            RDoc::Page::NODE_PAGE,
-
-            RDoc::Page::METHOD_LIST)
+      template = TemplatePage.new(
+        RDoc::Page::BODYINC,
+        RDoc::Page::NODE_PAGE,
+        RDoc::Page::METHOD_LIST)
       template.write_html_on(f, @values)
     end
 
@@ -536,7 +533,6 @@ module Generators
       @values["childs"] = cl unless cl.empty?
 
       @values["sections"] = @context.sections.map do |section|
-
         secdata = {
           "sectitle" => section.title,
           "secsequence" => section.sequence,
@@ -572,10 +568,11 @@ module Generators
       res = []
       atts.each do |att|
         next unless att.section == section
+
         if att.visibility == :public || att.visibility == :protected || @options.show_all
           entry = {
-            "name"   => CGI.escapeHTML(att.name),
-            "rw"     => att.rw,
+            "name" => CGI.escapeHTML(att.name),
+            "rw" => att.rw,
             "a_desc" => markup(att.comment, true)
           }
           unless att.visibility == :public || att.visibility == :protected
@@ -649,11 +646,6 @@ module Generators
   end
 
   class HTMLPuppetModule < HtmlClass
-
-    def initialize(context, html_file, prefix, options)
-      super(context, html_file, prefix, options)
-    end
-
     def value_hash
       @values = super
 
@@ -700,7 +692,6 @@ module Generators
     def plugins
       @context.plugins
     end
-
   end
 
   class HTMLPuppetPlugin < ContextUser
@@ -747,11 +738,10 @@ module Generators
     def write_on(f)
       value_hash
 
-        template = TemplatePage.new(
-          RDoc::Page::BODYINC,
-            RDoc::Page::PLUGIN_PAGE,
-
-            RDoc::Page::PLUGIN_LIST)
+      template = TemplatePage.new(
+        RDoc::Page::BODYINC,
+        RDoc::Page::PLUGIN_PAGE,
+        RDoc::Page::PLUGIN_LIST)
       template.write_html_on(f, @values)
     end
 
@@ -819,7 +809,6 @@ module Generators
     def <=>(other)
       self.name <=> other.name
     end
-
   end
 
   class HTMLPuppetResource
@@ -901,7 +890,6 @@ module Generators
       res = @context.parent.find_symbol(symbol, method)
       res && res.viewer
     end
-
   end
 
   class PuppetGeneratorInOne < HTMLGeneratorInOne
@@ -909,5 +897,4 @@ module Generators
       gen_an_index(HtmlMethod.all_methods, 'Defines')
     end
   end
-
 end