openvox 7.37.1 → 8.19.0

data/lib/puppet/interface/action.rb

@@ -1,4 +1,6 @@
 # coding: utf-8
+# frozen_string_literal: true
+
 require 'prettyprint'
 
 # This represents an action that is attached to a face. Actions should
@@ -13,6 +15,7 @@ class Puppet::Interface::Action
   # @api private
   def initialize(face, name)
     raise "#{name.inspect} is an invalid action name" unless name.to_s =~ /^[a-z]\w*$/
+
     @face    = face
     @name    = name.to_sym
 
@@ -20,11 +23,11 @@ class Puppet::Interface::Action
     # is a favour to our end users; if you happen to get that in a core face
     # report it as a bug, please. --daniel 2011-04-26
     @authors = []
-    @license  = 'All Rights Reserved'
+    @license = 'All Rights Reserved'
 
     # @options collects the added options in the order they're declared.
     # @options_hash collects the options keyed by alias for quick lookups.
-    @options        = []
+    @options = []
     @display_global_options = []
     @options_hash   = {}
     @when_rendering = {}
@@ -37,9 +40,9 @@ class Puppet::Interface::Action
   # @return [void]
   # @api private
   def __dup_and_rebind_to(to)
-    bound_version = self.dup
+    bound_version = dup
     bound_version.instance_variable_set(:@face, to)
-    return bound_version
+    bound_version
   end
 
   def to_s() "#{@face}##{@name}" end
@@ -56,6 +59,7 @@ class Puppet::Interface::Action
   # @return [Boolean]
   # @api private
   attr_accessor :default
+
   def default?
     !!@default
   end
@@ -71,7 +75,6 @@ class Puppet::Interface::Action
   ########################################################################
   # Support for rendering formats and all.
 
-
   # @api private
   def when_rendering(type)
     unless type.is_a? Symbol
@@ -85,36 +88,36 @@ class Puppet::Interface::Action
     return @when_rendering[alt].bind(@face) if @when_rendering.has_key? alt
 
     # Guess not, nothing to run.
-    return nil
+    nil
   end
 
   # @api private
   def set_rendering_method_for(type, proc)
     unless proc.is_a? Proc
       msg = if proc.nil?
-              #TRANSLATORS 'set_rendering_method_for' and 'Proc' should not be translated
+              # TRANSLATORS 'set_rendering_method_for' and 'Proc' should not be translated
               _("The second argument to set_rendering_method_for must be a Proc")
             else
-              #TRANSLATORS 'set_rendering_method_for' and 'Proc' should not be translated
+              # TRANSLATORS 'set_rendering_method_for' and 'Proc' should not be translated
               _("The second argument to set_rendering_method_for must be a Proc, not %{class_name}") %
-                  { class_name: proc.class.name }
+                { class_name: proc.class.name }
             end
       raise ArgumentError, msg
     end
 
     if proc.arity != 1 and proc.arity != (@positional_arg_count + 1)
       msg = if proc.arity < 0 then
-              #TRANSLATORS 'when_rendering', 'when_invoked' are method names and should not be translated
+              # TRANSLATORS 'when_rendering', 'when_invoked' are method names and should not be translated
               _("The when_rendering method for the %{face} face %{name} action takes either just one argument,"\
-                  " the result of when_invoked, or the result plus the %{arg_count} arguments passed to the"\
-                  " when_invoked block, not a variable number") %
-                  { face: @face.name, name: name, arg_count: @positional_arg_count }
+                " the result of when_invoked, or the result plus the %{arg_count} arguments passed to the"\
+                " when_invoked block, not a variable number") %
+                { face: @face.name, name: name, arg_count: @positional_arg_count }
             else
-              #TRANSLATORS 'when_rendering', 'when_invoked' are method names and should not be translated
+              # TRANSLATORS 'when_rendering', 'when_invoked' are method names and should not be translated
               _("The when_rendering method for the %{face} face %{name} action takes either just one argument,"\
-                  " the result of when_invoked, or the result plus the %{arg_count} arguments passed to the"\
-                  " when_invoked block, not %{string}") %
-                  { face: @face.name, name: name, arg_count: @positional_arg_count, string: proc.arity.to_s }
+                " the result of when_invoked, or the result plus the %{arg_count} arguments passed to the"\
+                " when_invoked block, not %{string}") %
+                { face: @face.name, name: name, arg_count: @positional_arg_count, string: proc.arity.to_s }
             end
       raise ArgumentError, msg
     end
@@ -124,11 +127,12 @@ class Puppet::Interface::Action
     if @when_rendering.has_key? type then
       raise ArgumentError, _("You can't define a rendering method for %{type} twice") % { type: type }
     end
+
     # Now, the ugly bit.  We add the method to our interface object, and
     # retrieve it, to rotate through the dance of getting a suitable method
     # object out of the whole process. --daniel 2011-04-18
     @when_rendering[type] =
-      @face.__send__( :__add_method, __render_method_name_for(type), proc)
+      @face.__send__(:__add_method, __render_method_name_for(type), proc)
   end
 
   # @return [void]
@@ -138,10 +142,10 @@ class Puppet::Interface::Action
   end
   private :__render_method_name_for
 
-
   # @api private
   # @return [Symbol]
   attr_reader :render_as
+
   def render_as=(value)
     @render_as = value.to_sym
   end
@@ -193,7 +197,6 @@ class Puppet::Interface::Action
   #   @face.send(name, *args, &block)
   # end
 
-
   # We need to build an instance method as a wrapper, using normal code, to be
   # able to expose argument defaulting between the caller and definer in the
   # Ruby API.  An extra method is, sadly, required for Ruby 1.8 to work since
@@ -213,7 +216,6 @@ class Puppet::Interface::Action
   # idea how motivated we were to make this cleaner.  Sorry.
   # --daniel 2011-03-31
 
-
   # The arity of the action
   # @return [Integer]
   attr_reader :positional_arg_count
@@ -221,8 +223,8 @@ class Puppet::Interface::Action
   # The block that is executed when the action is invoked
   # @return [block]
   attr_reader :when_invoked
-  def when_invoked=(block)
 
+  def when_invoked=(block)
     internal_name = "#{@name} implementation, required on Ruby 1.8".to_sym
 
     arity = @positional_arg_count = block.arity
@@ -231,7 +233,7 @@ class Puppet::Interface::Action
       # but will on 1.9.2, which treats it as "no arguments".  Which bites,
       # because this just begs for us to wind up in the horrible situation
       # where a 1.8 vs 1.9 error bites our end users. --daniel 2011-04-19
-      #TRANSLATORS 'when_invoked' should not be translated
+      # TRANSLATORS 'when_invoked' should not be translated
       raise ArgumentError, _("when_invoked requires at least one argument (options) for action %{name}") % { name: @name }
     elsif arity > 0 then
       range = Range.new(1, arity - 1)
@@ -251,18 +253,18 @@ class Puppet::Interface::Action
 
     file    = __FILE__ + "+eval[wrapper]"
     line    = __LINE__ + 2 # <== points to the same line as 'def' in the wrapper.
-    wrapper = <<WRAPPER
-def #{@name}(#{decl.join(", ")})
-  #{optn}
-  args    = #{args}
-  action  = get_action(#{name.inspect})
-  args   << action.validate_and_clean(args.pop)
-  __invoke_decorations(:before, action, args, args.last)
-  rval = self.__send__(#{internal_name.inspect}, *args)
-  __invoke_decorations(:after, action, args, args.last)
-  return rval
-end
-WRAPPER
+    wrapper = <<~WRAPPER
+      def #{@name}(#{decl.join(', ')})
+        #{optn}
+        args    = #{args}
+        action  = get_action(#{name.inspect})
+        args   << action.validate_and_clean(args.pop)
+        __invoke_decorations(:before, action, args, args.last)
+        rval = self.__send__(#{internal_name.inspect}, *args)
+        __invoke_decorations(:after, action, args, args.last)
+        return rval
+      end
+    WRAPPER
 
     # It should be possible to rewrite this code to use `define_method`
     # instead of `class/instance_eval` since Ruby 1.8 is long dead.
@@ -282,12 +284,12 @@ WRAPPER
       conflict = get_option(name)
       if conflict
         raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict}") %
-            { option: option, conflict: conflict }
+                             { option: option, conflict: conflict }
       else
         conflict = @face.get_option(name)
         if conflict
           raise ArgumentError, _("Option %{option} conflicts with existing option %{conflict} on %{face}") %
-              { option: option, conflict: conflict, face: @face }
+                               { option: option, conflict: conflict, face: @face }
         end
       end
     end
@@ -313,9 +315,10 @@ WRAPPER
     @display_global_options ||= []
     [args].flatten.each do |refopt|
       unless Puppet.settings.include? refopt
-        #TRANSLATORS 'Puppet.settings' should not be translated
+        # TRANSLATORS 'Puppet.settings' should not be translated
         raise ArgumentError, _("Global option %{option} does not exist in Puppet.settings") % { option: refopt }
       end
+
       @display_global_options << refopt
     end
     @display_global_options.uniq!
@@ -362,9 +365,9 @@ WRAPPER
     end
 
     unless overlap.empty?
-      overlap_list = overlap.map {|k, v| "(#{k}, #{v.sort.join(', ')})" }.join(", ")
+      overlap_list = overlap.map { |k, v| "(#{k}, #{v.sort.join(', ')})" }.join(", ")
       raise ArgumentError, _("Multiple aliases for the same option passed: %{overlap_list}") %
-          { overlap_list: overlap_list }
+                           { overlap_list: overlap_list }
     end
 
     unless unknown.empty?
@@ -374,7 +377,7 @@ WRAPPER
 
     # Inject default arguments and check for missing mandating options.
     missing = []
-    options.map {|x| get_option(x) }.each do |option|
+    options.map { |x| get_option(x) }.each do |option|
       name = option.name
       next if result.has_key? name
 
@@ -391,13 +394,14 @@ WRAPPER
     end
 
     # All done.
-    return result
+    result
   end
 
   ########################################################################
   # Support code for action decoration; see puppet/interface.rb for the gory
   # details of why this is hidden away behind private. --daniel 2011-04-15
   private
+
   # @return [void]
   # @api private
   def __add_method(name, proc)

data/lib/puppet/interface/action_builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class is used to build {Puppet::Interface::Action actions}.
 # When an action is defined with
 # {Puppet::Interface::ActionManager#action} the block is evaluated
@@ -16,6 +18,7 @@ class Puppet::Interface::ActionBuilder
   # @api private
   def self.build(face, name, &block)
     raise "Action #{name.inspect} must specify a block" unless block
+
     new(face, name, &block).action
   end
 
@@ -58,14 +61,15 @@ class Puppet::Interface::ActionBuilder
   # @todo this needs more
   # @dsl Faces
   def when_rendering(type = nil, &block)
-    if type.nil? then           # the default error message sucks --daniel 2011-04-18
-      #TRANSLATORS 'when_rendering' is a method name and should not be translated
+    if type.nil? then # the default error message sucks --daniel 2011-04-18
+      # TRANSLATORS 'when_rendering' is a method name and should not be translated
       raise ArgumentError, _('You must give a rendering format to when_rendering')
     end
     if block.nil? then
-      #TRANSLATORS 'when_rendering' is a method name and should not be translated
+      # TRANSLATORS 'when_rendering' is a method name and should not be translated
       raise ArgumentError, _('You must give a block to when_rendering')
     end
+
     @action.set_rendering_method_for(type, block)
   end
 
@@ -124,14 +128,14 @@ class Puppet::Interface::ActionBuilder
   # @api private
   def render_as(value = nil)
     if value.nil?
-      #TRANSLATORS 'render_as' is a method name and should not be translated
+      # TRANSLATORS 'render_as' is a method name and should not be translated
       raise ArgumentError, _("You must give a rendering format to render_as")
     end
 
     formats = Puppet::Network::FormatHandler.formats
     unless formats.include? value
       raise ArgumentError, _("%{value} is not a valid rendering format: %{formats_list}") %
-          { value: value.inspect, formats_list: formats.sort.join(", ")}
+                           { value: value.inspect, formats_list: formats.sort.join(", ") }
     end
 
     @action.render_as = value
@@ -140,6 +144,7 @@ class Puppet::Interface::ActionBuilder
   # Metaprogram the simple DSL from the target class.
   Puppet::Interface::Action.instance_methods.grep(/=$/).each do |setter|
     next if setter =~ /^=/
+
     property = setter.to_s.chomp('=')
 
     unless method_defined? property
@@ -149,12 +154,13 @@ class Puppet::Interface::ActionBuilder
   end
 
   private
+
   def initialize(face, name, &block)
     @face   = face
     @action = Puppet::Interface::Action.new(face, name)
     instance_eval(&block)
     unless @action.when_invoked
-      #TRANSLATORS 'when_invoked' is a method name and should not be translated and 'block' is a Ruby code block
+      # TRANSLATORS 'when_invoked' is a method name and should not be translated and 'block' is a Ruby code block
       raise ArgumentError, _("actions need to know what to do when_invoked; please add the block")
     end
   end

data/lib/puppet/interface/action_manager.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This class is not actually public API, but the method
 # {Puppet::Interface::ActionManager#action action} is public when used
 # as part of the Faces DSL (i.e. from within a
@@ -11,7 +13,7 @@ module Puppet::Interface::ActionManager
   # the methods on {Puppet::Interface::ActionBuilder}.
   # @param name [Symbol] The name that will be used to invoke the
   #   action
-  # @overload action(name, {|| block})
+  # @overload action(name, { block })
   # @return [void]
   # @api public
   # @dsl Faces
@@ -37,7 +39,7 @@ module Puppet::Interface::ActionManager
     @actions ||= {}
     result = @actions.keys
 
-    if self.is_a?(Class) and superclass.respond_to?(:actions)
+    if is_a?(Class) and superclass.respond_to?(:actions)
       result += superclass.actions
     elsif self.class.respond_to?(:actions)
       result += self.class.actions
@@ -56,7 +58,7 @@ module Puppet::Interface::ActionManager
     @actions ||= {}
     result = @actions[name.to_sym]
     if result.nil?
-      if self.is_a?(Class) and superclass.respond_to?(:get_action)
+      if is_a?(Class) and superclass.respond_to?(:get_action)
         found = superclass.get_action(name)
       elsif self.class.respond_to?(:get_action)
         found = self.class.get_action(name)
@@ -69,17 +71,18 @@ module Puppet::Interface::ActionManager
         result = @actions[name.to_sym] = found.__dup_and_rebind_to(self)
       end
     end
-    return result
+    result
   end
 
   # Retrieves the default action for the face
   # @return [Puppet::Interface::Action]
   # @api private
   def get_default_action
-    default = actions.map {|x| get_action(x) }.select {|x| x.default }
+    default = actions.map { |x| get_action(x) }.select(&:default)
     if default.length > 1
-      raise "The actions #{default.map(&:name).join(", ")} cannot all be default"
+      raise "The actions #{default.map(&:name).join(', ')} cannot all be default"
     end
+
     default.first
   end
 

data/lib/puppet/interface/documentation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class Puppet::Interface
   # @api private
   module DocGen
@@ -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
@@ -76,9 +78,8 @@ class Puppet::Interface
         s.text(" ")
 
         options.each do |option|
-          next if option == :extra
           option = get_option(option)
-          wrap = option.required? ? %w{ < > } : %w{ [ ] }
+          wrap = option.required? ? %w[< >] : %w{[ ]}
 
           s.group(0, *wrap) do
             option.optparse.each do |item|
@@ -95,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
@@ -110,7 +111,6 @@ class Puppet::Interface
         end
       end
     end
-
   end
 
   # This module can be mixed in to provide a full set of documentation
@@ -179,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
@@ -202,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")
@@ -226,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=
 
@@ -247,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
@@ -267,15 +271,15 @@ class Puppet::Interface
     # @return [String] Comma-separated list of copyright owners
     # @api private
     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
@@ -284,10 +288,11 @@ class Puppet::Interface
     # @return [String]
     # @api private
     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
@@ -309,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
@@ -324,13 +329,14 @@ class Puppet::Interface
           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
+              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
+              # 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
@@ -349,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