puppet 6.0.5-x64-mingw32 → 8.8.1-x64-mingw32

data/lib/puppet/interface/documentation.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class Puppet::Interface
   # @api private
   module DocGen
-    require 'puppet/util/docs'
+    require_relative '../../puppet/util/docs'
 
     # @api private
     def self.strip_whitespace(text)
@@ -32,14 +34,14 @@ class Puppet::Interface
       # without as methods.  When we are 1.9 only (hah!) you can totally
       # replace this with some up-and-up define_method. --daniel 2011-04-29
       module_eval(<<-EOT, __FILE__, __LINE__ + 1)
-        def #{name}(value = nil)
-          self.#{name} = value unless value.nil?
-          @#{name}
-        end
-
-        def #{name}=(value)
-          @#{name} = Puppet::Interface::DocGen.strip_whitespace(#{get_arg})
-        end
+        def #{name}(value = nil)                 # def attribute(value=nil)
+          self.#{name} = value unless value.nil? #   self.attribute = value unless value.nil?
+          @#{name}                               #   @value
+        end                                      # end
+
+        def #{name}=(value)                                                 # def attribute=(value)
+          @#{name} = Puppet::Interface::DocGen.strip_whitespace(#{get_arg}) #   @value = Puppet::Interface::DocGen.strip_whitespace(#{get_arg})
+        end                                                                 # end
       EOT
     end
   end
@@ -56,7 +58,7 @@ class Puppet::Interface
     # @dsl Faces
     attr_doc :summary do |value|
       value =~ /\n/ and
-        #TRANSLATORS 'Face' refers to a programming API in Puppet, 'summary' and 'description' are specifc attribute names and should not be translated
+        # TRANSLATORS 'Face' refers to a programming API in Puppet, 'summary' and 'description' are specifc attribute names and should not be translated
         raise ArgumentError, _("Face summary should be a single line; put the long text in 'description' instead.")
       value
     end
@@ -77,7 +79,7 @@ class Puppet::Interface
 
         options.each do |option|
           option = get_option(option)
-          wrap = option.required? ? %w{ < > } : %w{ [ ] }
+          wrap = option.required? ? %w[< >] : %w{[ ]}
 
           s.group(0, *wrap) do
             option.optparse.each do |item|
@@ -94,7 +96,7 @@ class Puppet::Interface
         end
 
         display_global_options.sort.each do |option|
-          wrap = %w{ [ ] }
+          wrap = %w{[ ]}
           s.group(0, *wrap) do
             type = Puppet.settings.setting(option).default
             type ||= Puppet.settings.setting(option).type.to_s.upcase
@@ -109,7 +111,6 @@ class Puppet::Interface
         end
       end
     end
-
   end
 
   # This module can be mixed in to provide a full set of documentation
@@ -178,11 +179,12 @@ class Puppet::Interface
       self.short_description = value unless value.nil?
       if @short_description.nil? then
         return nil if @description.nil?
+
         lines = @description.split("\n")
         first_paragraph_break = lines.index('') || 5
-        grab  = [5, first_paragraph_break].min
+        grab = [5, first_paragraph_break].min
         @short_description = lines[0, grab].join("\n")
-        @short_description += ' [...]' if (grab < lines.length and first_paragraph_break >= 5)
+        @short_description += ' [...]' if grab < lines.length and first_paragraph_break >= 5
       end
       @short_description
     end
@@ -201,14 +203,15 @@ class Puppet::Interface
     def author(value = nil)
       unless value.nil? then
         unless value.is_a? String
-          #TRANSLATORS 'author' is an attribute name and should not be translated
+          # TRANSLATORS 'author' is an attribute name and should not be translated
           raise ArgumentError, _('author must be a string; use multiple statements for multiple authors')
         end
 
         if value =~ /\n/ then
-          #TRANSLATORS 'author' is an attribute name and should not be translated
+          # TRANSLATORS 'author' is an attribute name and should not be translated
           raise ArgumentError, _('author should be a single line; use multiple statements for multiple authors')
         end
+
         @authors.push(Puppet::Interface::DocGen.strip_whitespace(value))
       end
       @authors.empty? ? nil : @authors.join("\n")
@@ -225,11 +228,12 @@ class Puppet::Interface
     def author=(value)
       # I think it's a bug that this ends up being the exposed
       # version of `author` on ActionBuilder
-      if Array(value).any? {|x| x =~ /\n/ } then
-        #TRANSLATORS 'author' is an attribute name and should not be translated
+      if Array(value).any? { |x| x =~ /\n/ } then
+        # TRANSLATORS 'author' is an attribute name and should not be translated
         raise ArgumentError, _('author should be a single line; use multiple statements')
       end
-      @authors = Array(value).map{|x| Puppet::Interface::DocGen.strip_whitespace(x) }
+
+      @authors = Array(value).map { |x| Puppet::Interface::DocGen.strip_whitespace(x) }
     end
     alias :authors= :author=
 
@@ -246,15 +250,16 @@ class Puppet::Interface
     # @api public
     # @dsl Faces
     def copyright(owner = nil, years = nil)
-      if years.nil? and not owner.nil? then
-        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+      if years.nil? and !owner.nil? then
+        # TRANSLATORS 'copyright' is an attribute name and should not be translated
         raise ArgumentError, _('copyright takes the owners names, then the years covered')
       end
+
       self.copyright_owner = owner unless owner.nil?
       self.copyright_years = years unless years.nil?
 
-      if self.copyright_years or self.copyright_owner then
-        "Copyright #{self.copyright_years} by #{self.copyright_owner}"
+      if copyright_years or copyright_owner then
+        "Copyright #{copyright_years} by #{copyright_owner}"
       else
         "Unknown copyright owner and years."
       end
@@ -265,16 +270,16 @@ class Puppet::Interface
     #   owners.
     # @return [String] Comma-separated list of copyright owners
     # @api private
-    attr_accessor :copyright_owner
+    attr_reader :copyright_owner
+
     def copyright_owner=(value)
       case value
       when String then @copyright_owner = value
       when Array  then @copyright_owner = value.join(", ")
       else
-        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+        # TRANSLATORS 'copyright' is an attribute name and should not be translated
         raise ArgumentError, _("copyright owner must be a string or an array of strings")
       end
-      @copyright_owner
     end
 
     # Sets the copyright year
@@ -282,11 +287,12 @@ class Puppet::Interface
     #   copyright year or years.
     # @return [String]
     # @api private
-    attr_accessor :copyright_years
+    attr_reader :copyright_years
+
     def copyright_years=(value)
       years = munge_copyright_year value
-      years = (years.is_a?(Array) ? years : [years]).
-        sort_by do |x| x.is_a?(Range) ? x.first : x end
+      years = (years.is_a?(Array) ? years : [years])
+              .sort_by do |x| x.is_a?(Range) ? x.first : x end
 
       @copyright_years = years.map do |year|
         if year.is_a? Range then
@@ -308,9 +314,9 @@ class Puppet::Interface
           fault = "after #{future}"
         end
         if fault then
-          #TRANSLATORS 'copyright' is an attribute name and should not be translated
+          # TRANSLATORS 'copyright' is an attribute name and should not be translated
           raise ArgumentError, _("copyright with a year %{value} is very strange; did you accidentally add or subtract two years?") %
-              { value: fault }
+                               { value: fault }
         end
 
         input
@@ -318,17 +324,21 @@ class Puppet::Interface
       when String then
         input.strip.split(/,/).map do |part|
           part = part.strip
-          if part =~ /^\d+$/ then
+          if part =~ /^\d+$/
             part.to_i
-          elsif found = part.split(/-/) then
-            unless found.length == 2 and found.all? {|x| x.strip =~ /^\d+$/ }
-              #TRANSLATORS 'copyright' is an attribute name and should not be translated
+          else
+            found = part.split(/-/)
+            if found
+              unless found.length == 2 and found.all? { |x| x.strip =~ /^\d+$/ }
+                # TRANSLATORS 'copyright' is an attribute name and should not be translated
+                raise ArgumentError, _("%{value} is not a good copyright year or range") % { value: part.inspect }
+              end
+
+              Range.new(found[0].to_i, found[1].to_i)
+            else
+              # TRANSLATORS 'copyright' is an attribute name and should not be translated
               raise ArgumentError, _("%{value} is not a good copyright year or range") % { value: part.inspect }
             end
-            Range.new(found[0].to_i, found[1].to_i)
-          else
-            #TRANSLATORS 'copyright' is an attribute name and should not be translated
-            raise ArgumentError, _("%{value} is not a good copyright year or range") % { value: part.inspect }
           end
         end
 
@@ -345,7 +355,7 @@ class Puppet::Interface
         result
 
       else
-        #TRANSLATORS 'copyright' is an attribute name and should not be translated
+        # TRANSLATORS 'copyright' is an attribute name and should not be translated
         raise ArgumentError, _("%{value} is not a good copyright year, set, or range") % { value: input.inspect }
       end
     end

data/lib/puppet/interface/face_collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Puppet::Interface::FaceCollection
   @faces = Hash.new { |hash, key| hash[key] = {} }
 
@@ -9,9 +11,9 @@ module Puppet::Interface::FaceCollection
       names = @loader.files_to_load(Puppet.lookup(:current_environment)).map do |fn|
         ::File.basename(fn, '.rb')
       end.uniq
-      names.each {|name| self[name, :current]}
+      names.each { |name| self[name, :current] }
     end
-    @faces.keys.select {|name| @faces[name].length > 0 }
+    @faces.keys.select { |name| @faces[name].length > 0 }
   end
 
   def self.[](name, version)
@@ -24,17 +26,21 @@ module Puppet::Interface::FaceCollection
 
     # If the version they request specifically doesn't exist, don't search
     # elsewhere.  Usually this will start from :current and all...
-    return nil unless face = self[name, version]
-    unless action = face.get_action(action_name)
+    face = self[name, version]
+    return nil unless face
+
+    action = face.get_action(action_name)
+    unless action
       # ...we need to search for it bound to an o{lder,ther} version.  Since
       # we load all actions when the face is first references, this will be in
       # memory in the known set of versions of the face.
-      (@faces[name].keys - [ :current ]).sort.reverse_each do |vers|
-        break if action = @faces[name][vers].get_action(action_name)
+      (@faces[name].keys - [:current]).sort.reverse_each do |vers|
+        action = @faces[name][vers].get_action(action_name)
+        break if action
       end
     end
 
-    return action
+    action
   end
 
   # get face from memory, without loading.
@@ -42,14 +48,14 @@ module Puppet::Interface::FaceCollection
     return nil unless @faces.has_key? name
     return @faces[name][:current] if pattern == :current
 
-    versions = @faces[name].keys - [ :current ]
+    versions = @faces[name].keys - [:current]
     range = pattern.is_a?(SemanticPuppet::Version) ? SemanticPuppet::VersionRange.new(pattern, pattern) : SemanticPuppet::VersionRange.parse(pattern)
     found = find_matching(range, versions)
-    return @faces[name][found]
+    @faces[name][found]
   end
 
   def self.find_matching(range, versions)
-    versions.select { |v| range === v }.sort.last
+    versions.select { |v| range === v }.max
   end
 
   # try to load the face, and return it.
@@ -89,7 +95,7 @@ module Puppet::Interface::FaceCollection
         # versions here and return the last item in that set.
         #
         # --daniel 2011-04-06
-        latest_ver = @faces[name].keys.sort.last
+        latest_ver = @faces[name].keys.max
         @faces[name][:current] = @faces[name][latest_ver]
       end
     end
@@ -99,20 +105,21 @@ module Puppet::Interface::FaceCollection
       safely_require name, version
     end
 
-    return get_face(name, version)
+    get_face(name, version)
   end
 
   def self.safely_require(name, version = nil)
     path = @loader.expand(version ? ::File.join(version.to_s, name.to_s) : name)
     require path
     true
-
   rescue LoadError => e
-    raise unless e.message =~ %r{-- #{path}$}
+    raise unless e.message =~ /-- #{path}$/
+
     # ...guess we didn't find the file; return a much better problem.
     nil
   rescue SyntaxError => e
-    raise unless e.message =~ %r{#{path}\.rb:\d+: }
+    raise unless e.message =~ /#{path}\.rb:\d+: /
+
     Puppet.err _("Failed to load face %{name}:\n%{detail}") % { name: name, detail: e }
     # ...but we just carry on after complaining.
     nil
@@ -124,9 +131,9 @@ module Puppet::Interface::FaceCollection
 
   def self.underscorize(name)
     unless name.to_s =~ /^[-_a-z][-_a-z0-9]*$/i then
-      #TRANSLATORS 'face' refers to a programming API in Puppet
+      # TRANSLATORS 'face' refers to a programming API in Puppet
       raise ArgumentError, _("%{name} (%{class_name}) is not a valid face name") %
-          { name: name.inspect, class_name: name.class }
+                           { name: name.inspect, class_name: name.class }
     end
 
     name.to_s.downcase.split(/[-_]/).join('_').to_sym

data/lib/puppet/interface/option.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This represents an option on an action or face (to be globally applied
 # to its actions). Options should be constructed by calling
 # {Puppet::Interface::OptionManager#option}, which is available on
@@ -20,6 +22,7 @@ class Puppet::Interface::Option
         unless item =~ /^-[a-z]\b/ or item =~ /^--[^-]/ then
           raise ArgumentError, _("%{option}: long options need two dashes (--)") % { option: item.inspect }
         end
+
         @optparse << item
 
         # Duplicate checking...
@@ -35,9 +38,11 @@ class Puppet::Interface::Option
         if Puppet.settings.include? name then
           raise ArgumentError, _("%{option}: already defined in puppet") % { option: item.inspect }
         end
-        if dup = dups[name] then
+
+        dup = dups[name]
+        if dup
           raise ArgumentError, _("%{option}: duplicates existing alias %{duplicate} in %{parent}") %
-              { option: item.inspect, duplicate: dup.inspect, parent: @parent }
+                               { option: item.inspect, duplicate: dup.inspect, parent: @parent }
         else
           dups[name] = item
         end
@@ -59,17 +64,17 @@ class Puppet::Interface::Option
     # incoherence here makes our life super-difficult, and we can more easily
     # relax this rule later if we find a valid use case for it. --daniel 2011-03-30
     @argument = @optparse.any? { |o| o =~ /[ =]/ }
-    if @argument and not @optparse.all? { |o| o =~ /[ =]/ } then
+    if @argument and !@optparse.all? { |o| o =~ /[ =]/ } then
       raise ArgumentError, _("Option %{name} is inconsistent about taking an argument") % { name: @name }
     end
 
     # Is our argument optional?  The rules about consistency apply here, also,
     # just like they do to taking arguments at all. --daniel 2011-03-30
-    @optional_argument = @optparse.any? { |o| o=~/[ =]\[/ }
+    @optional_argument = @optparse.any? { |o| o =~ /[ =]\[/ }
     if @optional_argument
       raise ArgumentError, _("Options with optional arguments are not supported")
     end
-    if @optional_argument and not @optparse.all? { |o| o=~/[ =]\[/ } then
+    if @optional_argument and !@optparse.all? { |o| o =~ /[ =]\[/ } then
       raise ArgumentError, _("Option %{name} is inconsistent about the argument being optional") % { name: @name }
     end
   end
@@ -84,9 +89,11 @@ class Puppet::Interface::Option
 
   # @api private
   def optparse_to_optionname(declaration)
-    unless found = declaration.match(/^-+(?:\[no-\])?([^ =]+)/) then
+    found = declaration.match(/^-+(?:\[no-\])?([^ =]+)/)
+    unless found
       raise ArgumentError, _("Can't find a name in the declaration %{declaration}") % { declaration: declaration.inspect }
     end
+
     found.captures.first
   end
 
@@ -96,16 +103,18 @@ class Puppet::Interface::Option
     unless name.to_s =~ /^[a-z]\w*$/
       raise _("%{name} is an invalid option name") % { name: name.inspect }
     end
+
     name.to_sym
   end
 
-
   def takes_argument?
     !!@argument
   end
+
   def optional_argument?
     !!@optional_argument
   end
+
   def required?
     !!@required
   end
@@ -118,10 +127,11 @@ class Puppet::Interface::Option
     if required
       raise ArgumentError, _("%{name} can't be optional and have a default value") % { name: self }
     end
+
     unless proc.is_a? Proc
-      #TRANSLATORS 'proc' is a Ruby block of code
+      # TRANSLATORS 'proc' is a Ruby block of code
       raise ArgumentError, _("default value for %{name} is a %{class_name}, not a proc") %
-          { name: self, class_name: proc.class.name.inspect }
+                           { name: self, class_name: proc.class.name.inspect }
     end
     @default = proc
   end
@@ -130,32 +140,35 @@ class Puppet::Interface::Option
     @default and @default.call
   end
 
-  attr_reader   :parent, :name, :aliases, :optparse
-  attr_accessor :required
+  attr_reader :parent, :name, :aliases, :optparse, :required
+
   def required=(value)
     if has_default?
       raise ArgumentError, _("%{name} can't be optional and have a default value") % { name: self }
     end
+
     @required = value
   end
 
-  attr_accessor :before_action
+  attr_reader :before_action
+
   def before_action=(proc)
     unless proc.is_a? Proc
-      #TRANSLATORS 'proc' is a Ruby block of code
+      # TRANSLATORS 'proc' is a Ruby block of code
       raise ArgumentError, _("before action hook for %{name} is a %{class_name}, not a proc") %
-          { name: self, class_name: proc.class.name.inspect }
+                           { name: self, class_name: proc.class.name.inspect }
     end
     @before_action =
       @parent.__send__(:__add_method, __decoration_name(:before), proc)
   end
 
-  attr_accessor :after_action
+  attr_reader :after_action
+
   def after_action=(proc)
     unless proc.is_a? Proc
-      #TRANSLATORS 'proc' is a Ruby block of code
+      # TRANSLATORS 'proc' is a Ruby block of code
       raise ArgumentError, _("after action hook for %{name} is a %{class_name}, not a proc") %
-          { name: self, class_name: proc.class.name.inspect }
+                           { name: self, class_name: proc.class.name.inspect }
     end
     @after_action =
       @parent.__send__(:__add_method, __decoration_name(:after), proc)

data/lib/puppet/interface/option_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # @api public
 class Puppet::Interface::OptionBuilder
   # The option under construction
@@ -16,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
@@ -41,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
 
@@ -61,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
 
@@ -90,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,18 +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!
@@ -26,13 +28,13 @@ module Puppet::Interface::OptionManager
 
   # @api private
   def walk_inheritance_tree(start, sym)
-    result = (start || [])
-    if self.is_a?(Class) and superclass.respond_to?(sym)
+    result = start || []
+    if is_a?(Class) and superclass.respond_to?(sym)
       result = superclass.send(sym) + result
     elsif self.class.respond_to?(sym)
       result = self.class.send(sym) + result
     end
-    return result
+    result
   end
 
   # Declare that this app can take a specific option, and provide the
@@ -53,16 +55,18 @@ module Puppet::Interface::OptionManager
     @options_hash ||= {}
 
     option.aliases.each do |name|
-      if conflict = get_option(name) then
+      conflict = get_option(name)
+      if conflict
         raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict}") %
-            { option: option, conflict: conflict }
+                             { option: option, conflict: conflict }
       end
 
       actions.each do |action|
         action = get_action(action)
-        if conflict = action.get_option(name) then
+        conflict = action.get_option(name)
+        if conflict
           raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict} on %{action}") %
-              { option: option, conflict: conflict, action: action }
+                               { option: option, conflict: conflict, action: action }
         end
       end
     end
@@ -73,7 +77,7 @@ module Puppet::Interface::OptionManager
       @options_hash[name] = option
     end
 
-    return option
+    option
   end
 
   # @api private
@@ -87,14 +91,14 @@ module Puppet::Interface::OptionManager
 
     result = @options_hash[name.to_sym]
     if result.nil? and with_inherited_options then
-      if self.is_a?(Class) and superclass.respond_to?(:get_option)
+      if is_a?(Class) and superclass.respond_to?(:get_option)
         result = superclass.get_option(name)
       elsif self.class.respond_to?(:get_option)
         result = self.class.get_option(name)
       end
     end
 
-    return result
+    result
   end
 
   # @api private