openvox 7.37.1 → 8.19.0

data/lib/puppet/application/doc.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 
 class Puppet::Application::Doc < Puppet::Application
@@ -6,17 +8,17 @@ class Puppet::Application::Doc < Puppet::Application
   attr_accessor :unknown_args, :manifest
 
   def preinit
-    {:references => [], :mode => :text, :format => :to_markdown }.each do |name,value|
+    { :references => [], :mode => :text, :format => :to_markdown }.each do |name, value|
       options[name] = value
     end
     @unknown_args = []
     @manifest = false
   end
 
-  option("--all","-a")
-  option("--outputdir OUTPUTDIR","-o")
-  option("--verbose","-v")
-  option("--debug","-d")
+  option("--all", "-a")
+  option("--outputdir OUTPUTDIR", "-o")
+  option("--verbose", "-v")
+  option("--debug", "-d")
   option("--charset CHARSET")
 
   option("--format FORMAT", "-f") do |arg|
@@ -31,14 +33,14 @@ class Puppet::Application::Doc < Puppet::Application
 
   option("--mode MODE", "-m") do |arg|
     require_relative '../../puppet/util/reference'
-    if Puppet::Util::Reference.modes.include?(arg) or arg.intern==:rdoc
+    if Puppet::Util::Reference.modes.include?(arg) or arg.intern == :rdoc
       options[:mode] = arg.intern
     else
       raise _("Invalid output mode %{arg}") % { arg: arg }
     end
   end
 
-  option("--list", "-l") do |arg|
+  option("--list", "-l") do |_arg|
     require_relative '../../puppet/util/reference'
     refs = Puppet::Util::Reference.references(Puppet.lookup(:current_environment))
     puts refs.collect { |r| Puppet::Util::Reference.reference(r).doc }.join("\n")
@@ -50,77 +52,78 @@ class Puppet::Application::Doc < Puppet::Application
   end
 
   def summary
-    _("Generate Puppet references")
+    _("Generate Puppet references for OpenVox")
   end
 
   def help
-    <<-HELP
+    <<~HELP
 
-puppet-doc(8) -- #{summary}
-========
+      puppet-doc(8) -- #{summary}
+      ========
 
-SYNOPSIS
---------
-Generates a reference for all Puppet types. Largely meant for internal
-Puppet Inc. use. (Deprecated)
+      SYNOPSIS
+      --------
+      Generates a reference for all Puppet types. Largely meant for internal use. (Deprecated)
 
 
-USAGE
------
-puppet doc [-h|--help] [-l|--list]
-  [-r|--reference <reference-name>]
+      USAGE
+      -----
+      puppet doc [-h|--help] [-l|--list]
+        [-r|--reference <reference-name>]
 
 
-DESCRIPTION
------------
-This deprecated command generates a Markdown document to stdout
-describing all installed Puppet types or all allowable arguments to
-puppet executables. It is largely meant for internal use and is used to
-generate the reference document available on the Puppet Inc. web site.
+      DESCRIPTION
+      -----------
+      This deprecated command generates a Markdown document to stdout
+      describing all installed Puppet types or all allowable arguments to
+      puppet executables. It is largely meant for internal use and is used to
+      generate the reference documents which can be posted to a website.
 
-For Puppet module documentation (and all other use cases) this command
-has been superseded by the "puppet-strings"
-module - see https://github.com/puppetlabs/puppetlabs-strings for more information.
+      For Puppet module documentation (and all other use cases) this command
+      has been superseded by the "puppet-strings"
+      module - see https://github.com/puppetlabs/puppetlabs-strings for more information.
 
-This command (puppet-doc) will be removed once the
-puppetlabs internal documentation processing pipeline is completely based
-on puppet-strings.
+      This command (puppet-doc) will be removed once the
+      puppetlabs internal documentation processing pipeline is completely based
+      on puppet-strings.
 
-OPTIONS
--------
+      OPTIONS
+      -------
 
-* --help:
-  Print this help message
+      * --help:
+        Print this help message
 
-* --reference:
-  Build a particular reference. Get a list of references by running
-  'puppet doc --list'.
+      * --reference:
+        Build a particular reference. Get a list of references by running
+        'puppet doc --list'.
 
 
-EXAMPLE
--------
-    $ puppet doc -r type > /tmp/type_reference.markdown
+      EXAMPLE
+      -------
+          $ puppet doc -r type > /tmp/type_reference.markdown
 
 
-AUTHOR
-------
-Luke Kanies
+      AUTHOR
+      ------
+      Luke Kanies
 
 
-COPYRIGHT
----------
-Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License
+      COPYRIGHT
+      ---------
+      Copyright (c) 2011 Puppet Inc.
+      Copyright (c) 2024 Vox Pupuli
+      Licensed under the Apache 2.0 License
 
-HELP
+    HELP
   end
 
-  def handle_unknown( opt, arg )
-    @unknown_args << {:opt => opt, :arg => arg }
+  def handle_unknown(opt, arg)
+    @unknown_args << { :opt => opt, :arg => arg }
     true
   end
 
   def run_command
-    return [:rdoc].include?(options[:mode]) ? send(options[:mode]) : other
+    [:rdoc].include?(options[:mode]) ? send(options[:mode]) : other
   end
 
   def rdoc
@@ -151,7 +154,7 @@ HELP
   end
 
   def other
-    text = ""
+    text = ''.dup
     with_contents = options[:references].length <= 1
     exit_code = 0
     require_relative '../../puppet/util/reference'
@@ -171,11 +174,7 @@ HELP
 
     text += Puppet::Util::Reference.footer unless with_contents # We've only got one reference
 
-    if options[:mode] == :pdf
-      Puppet::Util::Reference.pdf(text)
-    else
-      puts text
-    end
+    puts text
 
     exit exit_code
   end
@@ -215,7 +214,7 @@ HELP
     if @unknown_args.size > 0
       @unknown_args.each do |option|
         # force absolute path for modulepath when passed on commandline
-        if option[:opt]=="--modulepath"
+        if option[:opt] == "--modulepath"
           option[:arg] = option[:arg].split(::File::PATH_SEPARATOR).collect { |p| ::File.expand_path(p) }.join(::File::PATH_SEPARATOR)
         end
         Puppet.settings.handlearg(option[:opt], option[:arg])

data/lib/puppet/application/epp.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application/face_base'
 require_relative '../../puppet/face'
 

data/lib/puppet/application/face_base.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application'
 require_relative '../../puppet/face'
 require 'optparse'
-require 'pp'
 
 class Puppet::Application::FaceBase < Puppet::Application
-  option("--debug", "-d") do |arg|
+  option("--debug", "-d") do |_arg|
     set_log_level(:debug => true)
   end
 
@@ -16,7 +17,7 @@ class Puppet::Application::FaceBase < Puppet::Application
     self.render_as = format.to_sym
   end
 
-  option("--help", "-h") do |arg|
+  option("--help", "-h") do |_arg|
     if action && !@is_default_action
       # Only invoke help on the action if it was specified, not if
       # it was the default action.
@@ -73,7 +74,7 @@ class Puppet::Application::FaceBase < Puppet::Application
     # non-option word to use as the action.
     action_name = nil
     index       = -1
-    until action_name or (index += 1) >= command_line.args.length do
+    until action_name or (index += 1) >= command_line.args.length
       item = command_line.args[index]
       if item =~ /^-/
         option = @face.options.find do |name|
@@ -87,7 +88,7 @@ class Puppet::Application::FaceBase < Puppet::Application
           # when we get there. --daniel 2011-04-04
           if option.takes_argument? and !item.index('=')
             index += 1 unless
-              (option.optional_argument? and command_line.args[index + 1] =~ /^-/)
+              option.optional_argument? and command_line.args[index + 1] =~ /^-/
           end
         else
           option = find_global_settings_argument(item)
@@ -99,12 +100,12 @@ class Puppet::Application::FaceBase < Puppet::Application
               # employed in the long form of the option. --jeffmccune 2012-09-18
               index += 1 unless item =~ /^--#{option.name}=/
             end
-          else 
+          else
             option = find_application_argument(item)
             if option
-              index += 1 if (option[:argument] and not option[:optional])
+              index += 1 if option[:argument] and !(option[:optional])
             else
-              raise OptionParser::InvalidOption.new(item.sub(/=.*$/, ''))
+              raise OptionParser::InvalidOption, item.sub(/=.*$/, '')
             end
           end
         end
@@ -154,30 +155,33 @@ class Puppet::Application::FaceBase < Puppet::Application
   end
 
   def find_global_settings_argument(item)
-    Puppet.settings.each do |name, object|
+    Puppet.settings.each do |_name, object|
       object.optparse_args.each do |arg|
         next unless arg =~ /^-/
+
         # sadly, we have to emulate some of optparse here...
         pattern = /^#{arg.sub('[no-]', '').sub(/[ =].*$/, '')}(?:[ =].*)?$/
         pattern.match item and return object
       end
     end
-    return nil                  # nothing found.
+    nil                  # nothing found.
   end
 
   def find_application_argument(item)
-    self.class.option_parser_commands.each do |options, function|
+    self.class.option_parser_commands.each do |options, _function|
       options.each do |option|
         next unless option =~ /^-/
+
         pattern = /^#{option.sub('[no-]', '').sub(/[ =].*$/, '')}(?:[ =].*)?$/
         next unless pattern.match(item)
+
         return {
           :argument => option =~ /[ =]/,
           :optional => option =~ /[ =]\[/
         }
       end
     end
-    return nil                  # not found
+    nil                  # not found
   end
 
   def setup
@@ -201,10 +205,9 @@ class Puppet::Application::FaceBase < Puppet::Application
     @arguments << options
 
     # If we don't have a rendering format, set one early.
-    self.render_as ||= (@action.render_as || :console)
+    self.render_as ||= @action.render_as || :console
   end
 
-
   def main
     status = false
 
@@ -244,7 +247,7 @@ class Puppet::Application::FaceBase < Puppet::Application
     # --daniel 2011-04-27
     if (arity = @action.positional_arg_count) > 0
       unless (count = arguments.length) == arity then
-        raise ArgumentError, n_("puppet %{face} %{action} takes %{arg_count} argument, but you gave %{given_count}", "puppet %{face} %{action} takes %{arg_count} arguments, but you gave %{given_count}", arity - 1) % { face: @face.name, action: @action.name, arg_count: arity-1, given_count: count-1 }
+        raise ArgumentError, n_("puppet %{face} %{action} takes %{arg_count} argument, but you gave %{given_count}", "puppet %{face} %{action} takes %{arg_count} arguments, but you gave %{given_count}", arity - 1) % { face: @face.name, action: @action.name, arg_count: arity - 1, given_count: count - 1 }
       end
     end
 
@@ -265,11 +268,9 @@ class Puppet::Application::FaceBase < Puppet::Application
   # --kelsey 2012-02-14
   rescue SystemExit => detail
     status = detail.status
-
   rescue => detail
     Puppet.log_exception(detail)
     Puppet.err _("Try 'puppet help %{face} %{action}' for usage") % { face: @face.name, action: @action.name }
-
   ensure
     exit status
   end

data/lib/puppet/application/facts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../../puppet/application/indirection_base'
 
 class Puppet::Application::Facts < Puppet::Application::IndirectionBase