puppet 8.3.1 → 8.4.0

data/lib/puppet/interface/option_builder.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # @api public
 class Puppet::Interface::OptionBuilder
   # The option under construction
@@ -17,12 +18,12 @@ class Puppet::Interface::OptionBuilder
     @face   = face
     @option = Puppet::Interface::Option.new(face, *declaration)
     instance_eval(&block) if block_given?
-    @option
   end
 
   # Metaprogram the simple DSL from the option class.
   Puppet::Interface::Option.instance_methods.grep(/=$/).each do |setter|
     next if setter =~ /^=/
+
     dsl = setter.to_s.chomp('=')
 
     unless private_method_defined? dsl
@@ -42,17 +43,18 @@ class Puppet::Interface::OptionBuilder
   # @dsl Faces
   def before_action(&block)
     unless block
-      #TRANSLATORS 'before_action' is a method name and should not be translated
+      # TRANSLATORS 'before_action' is a method name and should not be translated
       raise ArgumentError, _("%{option} before_action requires a block") % { option: @option }
     end
     if @option.before_action
-      #TRANSLATORS 'before_action' is a method name and should not be translated
+      # TRANSLATORS 'before_action' is a method name and should not be translated
       raise ArgumentError, _("%{option} already has a before_action set") % { option: @option }
     end
     unless block.arity == 3 then
-      #TRANSLATORS 'before_action' is a method name and should not be translated
+      # TRANSLATORS 'before_action' is a method name and should not be translated
       raise ArgumentError, _("before_action takes three arguments, action, args, and options")
     end
+
     @option.before_action = block
   end
 
@@ -62,17 +64,18 @@ class Puppet::Interface::OptionBuilder
   # @dsl Faces
   def after_action(&block)
     unless block
-      #TRANSLATORS 'after_action' is a method name and should not be translated
+      # TRANSLATORS 'after_action' is a method name and should not be translated
       raise ArgumentError, _("%{option} after_action requires a block") % { option: @option }
     end
     if @option.after_action
-      #TRANSLATORS 'after_action' is a method name and should not be translated
+      # TRANSLATORS 'after_action' is a method name and should not be translated
       raise ArgumentError, _("%{option} already has an after_action set") % { option: @option }
     end
     unless block.arity == 3 then
-      #TRANSLATORS 'after_action' is a method name and should not be translated
+      # TRANSLATORS 'after_action' is a method name and should not be translated
       raise ArgumentError, _("after_action takes three arguments, action, args, and options")
     end
+
     @option.after_action = block
   end
 
@@ -91,16 +94,17 @@ class Puppet::Interface::OptionBuilder
   # @dsl Faces
   def default_to(&block)
     unless block
-      #TRANSLATORS 'default_to' is a method name and should not be translated
+      # TRANSLATORS 'default_to' is a method name and should not be translated
       raise ArgumentError, _("%{option} default_to requires a block") % { option: @option }
     end
     if @option.has_default?
       raise ArgumentError, _("%{option} already has a default value") % { option: @option }
     end
     unless block.arity == 0
-      #TRANSLATORS 'default_to' is a method name and should not be translated
+      # TRANSLATORS 'default_to' is a method name and should not be translated
       raise ArgumentError, _("%{option} default_to block should not take any arguments") % { option: @option }
     end
+
     @option.default = block
   end
 end

data/lib/puppet/interface/option_manager.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
+
 # This class is not actually public API, but the method
 # {Puppet::Interface::OptionManager#option option} is public when used
 # as part of the Faces DSL (i.e. from within a
 # {Puppet::Interface.define define} block).
 # @api public
 module Puppet::Interface::OptionManager
-
   # @api private
   def display_global_options(*args)
     @display_global_options ||= []
     [args].flatten.each do |refopt|
       unless Puppet.settings.include?(refopt)
-        #TRANSLATORS 'Puppet.settings' references to the Puppet settings options and should not be translated
+        # TRANSLATORS 'Puppet.settings' references to the Puppet settings options and should not be translated
         raise ArgumentError, _("Global option %{option} does not exist in Puppet.settings") % { option: refopt }
       end
+
       @display_global_options << refopt if refopt
     end
     @display_global_options.uniq!

data/lib/puppet/interface.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet'
 require_relative '../puppet/util/autoload'
 require 'prettyprint'
@@ -16,7 +17,6 @@ class Puppet::Interface
   require_relative 'interface/option_builder'
   require_relative 'interface/option_manager'
 
-
   include FullDocs
 
   include Puppet::Interface::ActionManager
@@ -121,7 +121,6 @@ class Puppet::Interface
   # splits out this should merge into a module that both the action and face
   # include. --daniel 2011-04-17
 
-
   # Returns the synopsis for the face. This shows basic usage and global
   # options.
   # @return [String] usage synopsis
@@ -130,7 +129,6 @@ class Puppet::Interface
     build_synopsis self.name, '<action>'
   end
 
-
   ########################################################################
 
   # The name of the face
@@ -201,7 +199,9 @@ class Puppet::Interface
   # to be unrecognizable in the final outcome.  At which point we will throw
   # all this away, replace it with something nice, and work out if we should
   # be making this visible to the outside world... --daniel 2011-04-14
+
   private
+
   # @return [void]
   # @api private
   def __invoke_decorations(type, action, passed_args = [], passed_options = {})

data/lib/puppet/loaders.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/concurrent/synchronized'
 
 module Puppet
@@ -27,5 +28,4 @@ module Puppet
       require_relative '../puppet/pops/loader/puppet_plan_instantiator'
     end
   end
-
 end

data/lib/puppet/metatype/manager.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet'
 require_relative '../../puppet/util/classgen'
 require_relative '../../puppet/node/environment'
@@ -16,7 +17,7 @@ module Manager
   # @api private
   #
   def allclear
-    @types.each { |name, type|
+    @types.each { |_name, type|
       type.clear
     }
   end
@@ -37,11 +38,11 @@ module Manager
   # @yieldreturn [Object] the last returned object is also returned from this method
   # @return [Object] the last returned value from the block.
   def eachtype
-    @types.each do |name, type|
+    @types.each do |_name, type|
       # Only consider types that have names
-      #if ! type.parameters.empty? or ! type.validproperties.empty?
-        yield type
-      #end
+      # if ! type.parameters.empty? or ! type.validproperties.empty?
+      yield type
+      # end
     end
   end
 
@@ -74,7 +75,7 @@ module Manager
     @manager_lock.synchronize do
       # Handle backward compatibility
       unless options.is_a?(Hash)
-        #TRANSLATORS 'Puppet::Type.newtype' should not be translated
+        # TRANSLATORS 'Puppet::Type.newtype' should not be translated
         Puppet.warning(_("Puppet::Type.newtype(%{name}) now expects a hash as the second argument, not %{argument}") %
                        { name: name, argument: options.inspect})
       end
@@ -107,7 +108,7 @@ module Manager
       # Now define a "new<type>" method for convenience.
       if self.respond_to? newmethod
         # Refuse to overwrite existing methods like 'newparam' or 'newtype'.
-        #TRANSLATORS 'new%{method}' will become a method name, do not translate this string
+        # TRANSLATORS 'new%{method}' will become a method name, do not translate this string
         Puppet.warning(_("'new%{method}' method already exists; skipping") % { method: name.to_s })
       else
         selfobj.send(:define_method, newmethod) do |*args|
@@ -170,7 +171,7 @@ module Manager
       end
       # Try loading the type.
       if typeloader.load(name, Puppet.lookup(:current_environment))
-        #TRANSLATORS 'puppet/type/%{name}' should not be translated
+        # TRANSLATORS 'puppet/type/%{name}' should not be translated
         Puppet.warning(_("Loaded puppet/type/%{name} but no class was created") % { name: name }) unless @types.include? name
       elsif !Puppet[:always_retry_plugins]
         # PUP-5482 - Only look for a type once if plugin retry is disabled

data/lib/puppet/module/plan.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/logging'
 
 class Puppet::Module
   class Plan
     class Error < Puppet::Error
       attr_accessor :kind, :details
+
       def initialize(message, kind, details = nil)
         super(message)
         @details = details || {}
@@ -34,8 +36,10 @@ class Puppet::Module
 
     class InvalidPlan < Error
     end
+
     class InvalidMetadata < Error
     end
+
     class PlanNotFound < Error
       def initialize(plan_name, module_name)
         msg = _("Plan %{plan_name} not found in module %{module_name}.") %
@@ -46,14 +50,15 @@ class Puppet::Module
 
     ALLOWED_EXTENSIONS = %w{.pp .yaml}
     RESERVED_WORDS = %w{and application attr case class consumes default else
-        elsif environment false function if import in inherits node or private
-        produces site true type undef unless}
+                        elsif environment false function if import in inherits node or private
+                        produces site true type undef unless}
     RESERVED_DATA_TYPES = %w{any array boolean catalogentry class collection
-        callable data default enum float hash integer numeric optional pattern
-        resource runtime scalar string struct tuple type undef variant}
+                             callable data default enum float hash integer numeric optional pattern
+                             resource runtime scalar string struct tuple type undef variant}
 
     def self.is_plan_name?(name)
       return true if name =~ /^[a-z][a-z0-9_]*$/
+
       return false
     end
 
@@ -71,6 +76,7 @@ class Puppet::Module
       if RESERVED_DATA_TYPES.include?(name)
         return [false, _("Plan name cannot be a Puppet data type, but was '%{name}'") % { name: name }]
       end
+
       return [true]
     end
 

data/lib/puppet/module/task.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
+
 require_relative '../../puppet/util/logging'
 
 class Puppet::Module
   class Task
     class Error < Puppet::Error
       attr_accessor :kind, :details
+
       def initialize(message, kind, details = nil)
         super(message)
         @details = details || {}
@@ -35,8 +37,10 @@ class Puppet::Module
 
     class InvalidTask < Error
     end
+
     class InvalidMetadata < Error
     end
+
     class TaskNotFound < Error
       def initialize(task_name, module_name)
         msg = _("Task %{task_name} not found in module %{module_name}.") %
@@ -50,6 +54,7 @@ class Puppet::Module
 
     def self.is_task_name?(name)
       return true if name =~ /^[a-z][a-z0-9_]*$/
+
       return false
     end
 
@@ -61,6 +66,7 @@ class Puppet::Module
     def self.is_tasks_filename?(path)
       name_less_extension = File.basename(path, '.*')
       return false if not is_task_name?(name_less_extension)
+
       FORBIDDEN_EXTENSIONS.each do |ext|
         return false if path.end_with?(ext)
       end
@@ -74,7 +80,7 @@ class Puppet::Module
       # Partition matches on the first instance it finds of the parameter
       name = "#{mod.name}#{path.partition(mod.path).last}"
 
-      { "name" => name, "path" =>  path }
+      { "name" => name, "path" => path }
     end
     private_class_method :get_file_details
 
@@ -219,7 +225,7 @@ class Puppet::Module
     attr_reader :name, :module, :metadata_file
 
     # file paths must be relative to the modules task directory
-    def initialize(pup_module, task_name,  module_executables, metadata_file = nil)
+    def initialize(pup_module, task_name, module_executables, metadata_file = nil)
       if !Puppet::Module::Task.is_task_name?(task_name)
         raise InvalidName, _("Task names must start with a lowercase letter and be composed of only lowercase letters, numbers, and underscores")
       end

data/lib/puppet/module.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require_relative '../puppet/util/logging'
 require_relative 'module/task'
 require_relative 'module/plan'
@@ -34,6 +35,7 @@ class Puppet::Module
   # of +path+, return +nil+
   def self.find(modname, environment = nil)
     return nil unless modname
+
     # Unless a specific environment is given, use the current environment
     env = environment ? Puppet.lookup(:environments).get!(environment) : Puppet.lookup(:current_environment)
     env.module(modname)
@@ -43,18 +45,21 @@ class Puppet::Module
     # it must be a directory
     fullpath = File.join(path, name)
     return false unless Puppet::FileSystem.directory?(fullpath)
+
     return is_module_directory_name?(name)
   end
 
   def self.is_module_directory_name?(name)
     # it must match an installed module name according to forge validator
     return true if name =~ /^[a-z][a-z0-9_]*$/
+
     return false
   end
 
   def self.is_module_namespaced_name?(name)
     # it must match the full module name according to forge validator
     return true if name =~ /^[a-zA-Z0-9]+[-][a-z][a-z0-9_]*$/
+
     return false
   end
 
@@ -131,6 +136,7 @@ class Puppet::Module
       end
 
       return nil unless Puppet::FileSystem.exist?(full_path)
+
       return full_path
     end
 
@@ -210,18 +216,20 @@ class Puppet::Module
     return @license_file if defined?(@license_file)
 
     return @license_file = nil unless path
+
     @license_file = File.join(path, "License")
   end
 
   def read_metadata
     md_file = metadata_file
     return {} if md_file.nil?
+
     content = File.read(md_file, :encoding => 'utf-8')
     content.empty? ? {} : Puppet::Util::Json.load(content)
   rescue Errno::ENOENT
     {}
   rescue Puppet::Util::Json::ParseError => e
-    #TRANSLATORS 'metadata.json' is a specific file name and should not be translated.
+    # TRANSLATORS 'metadata.json' is a specific file name and should not be translated.
     msg = _("%{name} has an invalid and unparsable metadata.json file. The parse error: %{error}") % { name: name, error: e.message }
     case Puppet[:strict]
     when :off
@@ -250,6 +258,7 @@ class Puppet::Module
         unless value.is_a?(Array)
           raise MissingMetadata, "The value for the key dependencies in the file metadata.json of the module #{self.name} must be an array, not: '#{value}'"
         end
+
         value.each do |dep|
           name = dep['name']
           dep['name'] = name.tr('-', '/') unless name.nil?
@@ -289,12 +298,13 @@ class Puppet::Module
     return @metadata_file if defined?(@metadata_file)
 
     return @metadata_file = nil unless path
+
     @metadata_file = File.join(path, "metadata.json")
   end
 
   def hiera_conf_file
     unless defined?(@hiera_conf_file)
-       @hiera_conf_file = path.nil? ? nil : File.join(path, Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
+      @hiera_conf_file = path.nil? ? nil : File.join(path, Puppet::Pops::Lookup::HieraConfig::CONFIG_FILE_NAME)
     end
     @hiera_conf_file
   end
@@ -316,7 +326,7 @@ class Puppet::Module
     subpath("facts.d")
   end
 
-  #@return [String]
+  # @return [String]
   def locale_directory
     subpath("locales")
   end

data/lib/puppet/module_tool/applications/application.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'net/http'
 require_relative '../../../puppet/util/json'
 require_relative '../../../puppet/util/colors'
@@ -34,6 +35,7 @@ module Puppet::ModuleTool
 
       def metadata(require_metadata = false)
         return @metadata if @metadata
+
         @metadata = Puppet::ModuleTool::Metadata.new
 
         unless @path
@@ -44,7 +46,7 @@ module Puppet::ModuleTool
           raise ArgumentError, _("Unable to find metadata.json in module root at %{path} See https://puppet.com/docs/puppet/latest/modules_publishing.html for required file format.") % { path: @path }
         end
 
-        metadata_path   = File.join(@path, 'metadata.json')
+        metadata_path = File.join(@path, 'metadata.json')
 
         if File.file?(metadata_path)
           File.open(metadata_path) do |f|
@@ -82,9 +84,9 @@ module Puppet::ModuleTool
 
         return {
           :module_name => module_name,
-          :author      => author,
-          :dir_name    => shortname,
-          :version     => version
+          :author => author,
+          :dir_name => shortname,
+          :version => version
         }
       end
     end

data/lib/puppet/module_tool/applications/checksummer.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
+
 require_relative '../../../puppet/util/json'
 require_relative '../../../puppet/module_tool/checksums'
 
 module Puppet::ModuleTool
   module Applications
     class Checksummer < Application
-
       def initialize(path, options = {})
         @path = Pathname.new(path)
         super(options)
@@ -15,7 +15,6 @@ module Puppet::ModuleTool
         changes = []
         sums = Puppet::ModuleTool::Checksums.new(@path)
         checksums.each do |child_path, canonical_checksum|
-
           # Avoid checksumming the checksums.json file
           next if File.basename(child_path) == "checksums.json"
 

data/lib/puppet/module_tool/applications/installer.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'open-uri'
 require 'pathname'
 require 'fileutils'
@@ -15,7 +16,6 @@ require_relative '../../../puppet/network/uri'
 module Puppet::ModuleTool
   module Applications
     class Installer < Application
-
       include Puppet::ModuleTool::Errors
       include Puppet::Forge::Errors
       include Puppet::Network::Uri
@@ -74,10 +74,10 @@ module Puppet::ModuleTool
               else
                 changes = Checksummer.run(installed_modules[name].mod.path) rescue []
                 raise AlreadyInstalledError,
-                  :module_name       => name,
-                  :installed_version => installed_modules[name].version,
-                  :requested_version => options[:version] || :latest,
-                  :local_changes     => changes
+                      :module_name => name,
+                      :installed_version => installed_modules[name].version,
+                      :requested_version => options[:version] || :latest,
+                      :local_changes => changes
               end
             end
           end
@@ -184,9 +184,9 @@ module Puppet::ModuleTool
             end
 
             raise NoVersionsSatisfyError, results.merge(
-                    :requested_name => name,
-                    :requested_version => options[:version] || graph.dependencies[name].max.version.to_s,
-                    :unsatisfied => unsatisfied
+              :requested_name => name,
+              :requested_version => options[:version] || graph.dependencies[name].max.version.to_s,
+              :unsatisfied => unsatisfied
             )
           end
 
@@ -205,11 +205,11 @@ module Puppet::ModuleTool
                 end
 
                 raise InstallConflictError,
-                  :requested_module  => name,
-                  :requested_version => options[:version] || 'latest',
-                  :dependency        => dependency,
-                  :directory         => installed_module.path,
-                  :metadata          => installed_module.metadata
+                      :requested_module => name,
+                      :requested_version => options[:version] || 'latest',
+                      :dependency => dependency,
+                      :directory => installed_module.path,
+                      :metadata => installed_module.metadata
               end
             end
           end
@@ -230,10 +230,9 @@ module Puppet::ModuleTool
           results[:result] = :success
           results[:installed_modules] = releases
           results[:graph] = [ build_install_graph(releases.first, releases) ]
-
         rescue ModuleToolError, ForgeError => err
           results[:error] = {
-            :oneline   => err.message,
+            :oneline => err.message,
             :multiline => err.multiline,
           }
         ensure
@@ -253,7 +252,7 @@ module Puppet::ModuleTool
         @tarball_source ||= begin
           Puppet::ModuleTool::LocalTarball.new(@name)
         rescue Puppet::Module::Error => e
-          raise InvalidModuleError.new(@name, :action => @action, :error  => e)
+          raise InvalidModuleError.new(@name, :action => @action, :error => e)
         end
       end
 
@@ -289,13 +288,13 @@ module Puppet::ModuleTool
         previous = installed_modules[release.name]
         previous = previous.version if previous
         return {
-          :release          => release,
-          :name             => release.name,
-          :path             => release.install_dir.to_s,
-          :dependencies     => dependencies.compact,
-          :version          => release.version,
+          :release => release,
+          :name => release.name,
+          :path => release.install_dir.to_s,
+          :dependencies => dependencies.compact,
+          :version => release.version,
           :previous_version => previous,
-          :action           => (previous.nil? || previous == release.version || forced? ? :install : :upgrade),
+          :action => (previous.nil? || previous == release.version || forced? ? :install : :upgrade),
         }
       end
 
@@ -308,10 +307,10 @@ module Puppet::ModuleTool
 
         if !forced? && @installed.include?(@module_name)
           raise AlreadyInstalledError,
-            :module_name       => @module_name,
-            :installed_version => @installed[@module_name].first.version,
-            :requested_version => @version || (@conditions[@module_name].empty? ? :latest : :best),
-            :local_changes     => Puppet::ModuleTool::Applications::Checksummer.run(@installed[@module_name].first.path)
+                :module_name => @module_name,
+                :installed_version => @installed[@module_name].first.version,
+                :requested_version => @version || (@conditions[@module_name].empty? ? :latest : :best),
+                :local_changes => Puppet::ModuleTool::Applications::Checksummer.run(@installed[@module_name].first.path)
         end
 
         if @ignore_dependencies && @source == :filesystem
@@ -361,7 +360,7 @@ module Puppet::ModuleTool
           @environment.modules_by_path[options[:target_dir]].each do |mod|
             if mod.has_metadata?
               metadata = {
-                :name    => mod.forge_name.tr('/', '-'),
+                :name => mod.forge_name.tr('/', '-'),
                 :version => mod.version
               }
               next if release[:module] == metadata[:name]
@@ -371,7 +370,7 @@ module Puppet::ModuleTool
 
             if release[:module] =~ /-#{mod.name}$/
               dependency_info = {
-                :name    => release[:module],
+                :name => release[:module],
                 :version => release[:version][:vstring]
               }
               dependency = is_dependency ? dependency_info : nil
@@ -381,11 +380,11 @@ module Puppet::ModuleTool
               latest_version = versions.last[:vstring]
 
               raise InstallConflictError,
-                :requested_module  => @module_name,
-                :requested_version => @version || "latest: v#{latest_version}",
-                :dependency        => dependency,
-                :directory         => mod.path,
-                :metadata          => metadata
+                    :requested_module => @module_name,
+                    :requested_version => @version || "latest: v#{latest_version}",
+                    :dependency => dependency,
+                    :directory => mod.path,
+                    :metadata => metadata
             end
           end
 
@@ -395,18 +394,6 @@ module Puppet::ModuleTool
           end
         end
       end
-
-      #
-      # Check if a file is a vaild module package.
-      # ---
-      # FIXME: Checking for a valid module package should be more robust and
-      # use the actual metadata contained in the package. 03132012 - Hightower
-      # +++
-      #
-      def is_module_package?(name)
-        filename = File.expand_path(name)
-        filename =~ /.tar.gz$/
-      end
     end
   end
 end