(CONT-801) Safe correct Layout/ClosingHeredocIndentation

LukasAud · LukasAud · commit ec677d832d6b · 2023-05-23T16:26:07.000+01:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
diff --git a/lib/puppet/parser/functions/assert_private.rb b/lib/puppet/parser/functions/assert_private.rb
@@ -12,7 +12,7 @@ module Puppet::Parser::Functions
       set the current class or definition as private.
 
     Calling the class or definition from outside the current module will fail.
-    DOC
+  DOC
   ) do |args|
     raise(Puppet::ParseError, "assert_private(): Wrong number of arguments given (#{args.size}}) for 0 or 1)") if args.size > 1
 
diff --git a/lib/puppet/parser/functions/base64.rb b/lib/puppet/parser/functions/base64.rb
@@ -33,7 +33,7 @@ module Puppet::Parser::Functions
         function for reading a file with binary (non UTF-8) content.
 
     @return [String] The encoded/decoded value
-    DOC
+  DOC
 
     require 'base64'
 
diff --git a/lib/puppet/parser/functions/basename.rb b/lib/puppet/parser/functions/basename.rb
@@ -9,7 +9,7 @@ module Puppet::Parser::Functions
       Strips directory (and optional suffix) from a filename
 
     @return [String] The stripped filename
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, 'basename(): No arguments given') if arguments.empty?
     raise(Puppet::ParseError, "basename(): Too many arguments given (#{arguments.size})") if arguments.size > 2
diff --git a/lib/puppet/parser/functions/bool2num.rb b/lib/puppet/parser/functions/bool2num.rb
@@ -28,7 +28,7 @@ module Puppet::Parser::Functions
       ```
 
     @return [Integer] The converted value as a number
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/bool2str.rb b/lib/puppet/parser/functions/bool2str.rb
@@ -37,7 +37,7 @@ module Puppet::Parser::Functions
         notice(String(false, '%y'))   # Notices 'yes'
         notice(String(true, '%y'))    # Notices 'no'
       ```
-    DOC
+  DOC
   ) do |arguments|
     unless arguments.size == 1 || arguments.size == 3
       raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)")
diff --git a/lib/puppet/parser/functions/clamp.rb b/lib/puppet/parser/functions/clamp.rb
@@ -23,7 +23,7 @@ module Puppet::Parser::Functions
       `[$minval, $maxval, $value_to_clamp].sort[1]`
 
     @return [Array[Integer]] The sorted Array
-    DOC
+  DOC
   ) do |args|
     args.flatten!
 
diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb
@@ -27,7 +27,7 @@ module Puppet::Parser::Functions
       `$hex_repr = String(254, "%#x")` return `"0xfe"`
 
       @return [String] The converted value as a String
-    DOC
+  DOC
 
     raise Puppet::ParseError, 'convert_base(): First argument must be either a string or an integer' unless args[0].is_a?(Integer) || args[0].is_a?(String)
     raise Puppet::ParseError, 'convert_base(): Second argument must be either a string or an integer' unless args[1].is_a?(Integer) || args[1].is_a?(String)
diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb
@@ -22,7 +22,7 @@ module Puppet::Parser::Functions
       When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
 
     @return [Hash] The merged hash
-    DOC
+  DOC
 
     if args.length < 2
       raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)"
diff --git a/lib/puppet/parser/functions/delete_undef_values.rb b/lib/puppet/parser/functions/delete_undef_values.rb
@@ -24,7 +24,7 @@ module Puppet::Parser::Functions
     $hash.filter |$key, $val| { $val =~ NotUndef }
 
     @return [Array] The given array now issing of undefined values.
-    DOC
+  DOC
   ) do |args|
     raise(Puppet::ParseError, "delete_undef_values(): Wrong number of arguments given (#{args.size})") if args.empty?
 
diff --git a/lib/puppet/parser/functions/delete_values.rb b/lib/puppet/parser/functions/delete_values.rb
@@ -20,7 +20,7 @@ module Puppet::Parser::Functions
     $hash.filter |$key, $val| { $val != 'B' }
 
     @return [Hash] The given hash now missing all instances of the targeted value
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "delete_values(): Wrong number of arguments given (#{arguments.size} of 2)") if arguments.size != 2
 
diff --git a/lib/puppet/parser/functions/deprecation.rb b/lib/puppet/parser/functions/deprecation.rb
@@ -13,7 +13,7 @@ module Puppet::Parser::Functions
 
   @return [String]
     return deprecation warnings
-DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "deprecation: Wrong number of arguments given (#{arguments.size} for 2)") unless arguments.size == 2
 
diff --git a/lib/puppet/parser/functions/difference.rb b/lib/puppet/parser/functions/difference.rb
@@ -24,7 +24,7 @@ module Puppet::Parser::Functions
     @return [Array]
       The difference between the two given arrays
 
-    DOC
+  DOC
   ) do |arguments|
     # Two arguments are required
     raise(Puppet::ParseError, "difference(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2
diff --git a/lib/puppet/parser/functions/dirname.rb b/lib/puppet/parser/functions/dirname.rb
@@ -9,7 +9,7 @@ module Puppet::Parser::Functions
       Returns the dirname of a path.
 
     @return [String] the given path's dirname
-    DOC
+  DOC
   ) do |arguments|
     if arguments.empty?
       raise(Puppet::ParseError, 'dirname(): No arguments given')
diff --git a/lib/puppet/parser/functions/dos2unix.rb b/lib/puppet/parser/functions/dos2unix.rb
@@ -9,7 +9,7 @@ module Puppet::Parser::Functions
     Takes a single string argument.
 
     @return The retrieved version
-    DOC
+  DOC
   ) do |arguments|
     unless arguments[0].is_a?(String)
       raise(Puppet::ParseError, 'dos2unix(): Requires string as argument')
diff --git a/lib/puppet/parser/functions/fqdn_rotate.rb b/lib/puppet/parser/functions/fqdn_rotate.rb
@@ -15,7 +15,7 @@
     fqdn_rotate(['a', 'b', 'c', 'd'])
     fqdn_rotate('abcd')
     fqdn_rotate([1, 2, 3], 'custom seed')
-  DOC
+DOC
 ) do |args|
   raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty?
 
diff --git a/lib/puppet/parser/functions/fqdn_uuid.rb b/lib/puppet/parser/functions/fqdn_uuid.rb
@@ -16,7 +16,7 @@ module Puppet::Parser::Functions
     @example Example Usage:
       fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c'
       fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09c8'
-    DOC
+  DOC
 
     raise(ArgumentError, 'fqdn_uuid: No arguments given') if args.empty?
     raise(ArgumentError, "fqdn_uuid: Too many arguments given (#{args.length})") unless args.length == 1
diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb
@@ -42,7 +42,7 @@
     and the [ ] operator. The example below is equivalent to a call to getparam():
       ```Example_resource['example_resource_instance']['param']``
 
-  DOC
+DOC
 ) do |vals|
   reference, param = vals
   raise(ArgumentError, 'Must specify a reference') unless reference
diff --git a/lib/puppet/parser/functions/glob.rb b/lib/puppet/parser/functions/glob.rb
@@ -13,7 +13,7 @@ module Puppet::Parser::Functions
 
     @example Example Usage:
       $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])
-    DOC
+  DOC
   ) do |arguments|
     unless arguments.size == 1
       raise(Puppet::ParseError, 'glob(): Wrong number of arguments given ' \
diff --git a/lib/puppet/parser/functions/grep.rb b/lib/puppet/parser/functions/grep.rb
@@ -18,7 +18,7 @@ module Puppet::Parser::Functions
     [`filter`](https://puppet.com/docs/puppet/latest/function.html#filter) function does
     the "same" - as any logic can be used to filter, as opposed to just regular expressions:
     ```['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }```
-    DOC
+  DOC
   ) do |arguments|
     if arguments.size != 2
       raise(Puppet::ParseError, "grep(): Wrong number of arguments given #{arguments.size} for 2")
diff --git a/lib/puppet/parser/functions/has_interface_with.rb b/lib/puppet/parser/functions/has_interface_with.rb
@@ -19,7 +19,7 @@ module Puppet::Parser::Functions
 
     @example If no "kind" is given, then the presence of the interface is checked:
       has_interface_with("lo") # Returns `true`
-    DOC
+  DOC
   ) do |args|
     raise(Puppet::ParseError, "has_interface_with(): Wrong number of arguments given (#{args.size} for 1 or 2)") if args.empty? || args.size > 2
 
diff --git a/lib/puppet/parser/functions/has_ip_address.rb b/lib/puppet/parser/functions/has_ip_address.rb
@@ -13,7 +13,7 @@ module Puppet::Parser::Functions
 
     This function iterates through the 'interfaces' fact and checks the
     'ipaddress_IFACE' facts, performing a simple string comparison.
-    DOC
+  DOC
   ) do |args|
     raise(Puppet::ParseError, "has_ip_address(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1
 
diff --git a/lib/puppet/parser/functions/has_ip_network.rb b/lib/puppet/parser/functions/has_ip_network.rb
@@ -13,7 +13,7 @@ module Puppet::Parser::Functions
 
     This function iterates through the 'interfaces' fact and checks the
     'network_IFACE' facts, performing a simple string comparision.
-    DOC
+  DOC
   ) do |args|
     raise(Puppet::ParseError, "has_ip_network(): Wrong number of arguments given (#{args.size} for 1)") if args.size != 1
 
diff --git a/lib/puppet/parser/functions/intersection.rb b/lib/puppet/parser/functions/intersection.rb
@@ -14,7 +14,7 @@ module Puppet::Parser::Functions
     @example Example Usage:
       intersection(["a","b","c"],["b","c","d"])  # returns ["b","c"]
       intersection(["a","b","c"],[1,2,3,4])      # returns [] (true, when evaluated as a Boolean)
-    DOC
+  DOC
   ) do |arguments|
     # Two arguments are required
     raise(Puppet::ParseError, "intersection(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size != 2
diff --git a/lib/puppet/parser/functions/join_keys_to_values.rb b/lib/puppet/parser/functions/join_keys_to_values.rb
@@ -24,7 +24,7 @@ module Puppet::Parser::Functions
     line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual
     formatting of values in the array) - see the `new` function for `String` and its formatting
     options for `Array` and `Hash`.
-    DOC
+  DOC
   ) do |arguments|
     # Validate the number of arguments.
     if arguments.size != 2
diff --git a/lib/puppet/parser/functions/member.rb b/lib/puppet/parser/functions/member.rb
@@ -35,7 +35,7 @@ module Puppet::Parser::Functions
     > **Note** that since Puppet 5.2.0, the general form to test the content of an array or
     hash is to use the built-in [`any`](https://puppet.com/docs/puppet/latest/function.html#any)
     and [`all`](https://puppet.com/docs/puppet/latest/function.html#all) functions.
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "member(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2
 
diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb
@@ -20,7 +20,7 @@ module Puppet::Parser::Functions
 
     Note that since Puppet 4.0.0 the same merge can be achieved with the + operator.
       `$merged_hash = $hash1 + $hash2`
-    DOC
+  DOC
 
     if args.length < 2
       raise Puppet::ParseError, "merge(): wrong number of arguments (#{args.length}; must be at least 2)"
diff --git a/lib/puppet/parser/functions/num2bool.rb b/lib/puppet/parser/functions/num2bool.rb
@@ -15,7 +15,7 @@ module Puppet::Parser::Functions
     @return [Boolean]
         Boolean(0) # false for any zero or negative number
         Boolean(1) # true for any positive number
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "num2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
diff --git a/lib/puppet/parser/functions/pick_default.rb b/lib/puppet/parser/functions/pick_default.rb
@@ -28,7 +28,7 @@ module Puppet::Parser::Functions
       Contrary to the pick() function, the pick_default does not fail if
       all arguments are empty. This allows pick_default to use an empty value as
       default.
-    DOC
+  DOC
   ) do |args|
     raise 'Must receive at least one argument.' if args.empty?
     default = args.last
diff --git a/lib/puppet/parser/functions/prefix.rb b/lib/puppet/parser/functions/prefix.rb
@@ -18,7 +18,7 @@ module Puppet::Parser::Functions
     ['a', 'b', 'c'].map |$x| { "p${x}" }
 
     @return [Hash] or [Array] The passed values now contains the passed prefix
-    DOC
+  DOC
   ) do |arguments|
     # Technically we support two arguments but only first is mandatory ...
     raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
diff --git a/lib/puppet/parser/functions/pry.rb b/lib/puppet/parser/functions/pry.rb
@@ -16,7 +16,7 @@ module Puppet::Parser::Functions
 
       `pry()`
 
-    DOC
+  DOC
   ) do |arguments|
     begin
       require 'pry'
diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb
@@ -35,7 +35,7 @@
   > *Note:*: this uses the Puppet Server's implementation of crypt(3). If your
     environment contains several different operating systems, ensure that they
     are compatible before using this function.
-  DOC
+DOC
 ) do |args|
   raise ArgumentError, "pw_hash(): wrong number of arguments (#{args.size} for 3)" if args.size != 3
   args.map! do |arg|
diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb
@@ -43,7 +43,7 @@ module Puppet::Parser::Functions
       the step() function in Puppet for skipping values.
 
      Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, 'range(): Wrong number of arguments given (0 for 1)') if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/regexpescape.rb b/lib/puppet/parser/functions/regexpescape.rb
@@ -10,7 +10,7 @@ module Puppet::Parser::Functions
       Requires either a single string or an array as an input.
     @return [String]
       A string of characters with metacharacters converted to their escaped form.
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/reject.rb b/lib/puppet/parser/functions/reject.rb
@@ -21,7 +21,7 @@ module Puppet::Parser::Functions
     > *Note:*
     Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function:
     ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~ /aaa/ }
-DOC
+  DOC
 
     if args.size != 2
       raise Puppet::ParseError,
diff --git a/lib/puppet/parser/functions/reverse.rb b/lib/puppet/parser/functions/reverse.rb
@@ -12,7 +12,7 @@ module Puppet::Parser::Functions
       reversed string or array
 
     > *Note:* that the same can be done with the reverse_each() function in Puppet.
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "reverse(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/str2saltedsha512.rb b/lib/puppet/parser/functions/str2saltedsha512.rb
@@ -16,7 +16,7 @@ module Puppet::Parser::Functions
     Given any simple string, you will get a hex version
     of a salted-SHA512 password hash that can be inserted into your Puppet
     manifests as a valid password attribute.
-    DOC
+  DOC
   ) do |arguments|
     require 'digest/sha2'
 
diff --git a/lib/puppet/parser/functions/suffix.rb b/lib/puppet/parser/functions/suffix.rb
@@ -22,7 +22,7 @@ module Puppet::Parser::Functions
 
     ```['a', 'b', 'c'].map |$x| { "${x}p" }```
 
-    DOC
+  DOC
   ) do |arguments|
     # Technically we support two arguments but only first is mandatory ...
     raise(Puppet::ParseError, "suffix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
diff --git a/lib/puppet/parser/functions/swapcase.rb b/lib/puppet/parser/functions/swapcase.rb
@@ -16,7 +16,7 @@ module Puppet::Parser::Functions
 
       swapcase("aBcD")
       Would result in: "AbCd"
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/time.rb b/lib/puppet/parser/functions/time.rb
@@ -22,7 +22,7 @@ module Puppet::Parser::Functions
 
     ```Timestamp()```
 
-    DOC
+  DOC
   ) do |arguments|
     # The Time Zone argument is optional ...
     time_zone = arguments[0] if arguments[0]
diff --git a/lib/puppet/parser/functions/to_bytes.rb b/lib/puppet/parser/functions/to_bytes.rb
@@ -14,7 +14,7 @@ module Puppet::Parser::Functions
     Takes a single string value as an argument.
     These conversions reflect a layperson's understanding of
     1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB.
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "to_bytes(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
diff --git a/lib/puppet/parser/functions/union.rb b/lib/puppet/parser/functions/union.rb
@@ -14,7 +14,7 @@ module Puppet::Parser::Functions
 
       union(["a","b","c"],["b","c","d"])
       Would return: ["a","b","c","d"]
-    DOC
+  DOC
   ) do |arguments|
     # Check that 2 or more arguments have been given ...
     raise(Puppet::ParseError, "union(): Wrong number of arguments given (#{arguments.size} for < 2)") if arguments.size < 2
diff --git a/lib/puppet/parser/functions/unix2dos.rb b/lib/puppet/parser/functions/unix2dos.rb
@@ -10,7 +10,7 @@ module Puppet::Parser::Functions
       the DOS version of the given string.
 
     Takes a single string argument.
-    DOC
+  DOC
   ) do |arguments|
     unless arguments[0].is_a?(String)
       raise(Puppet::ParseError, 'unix2dos(): Requires string as argument')
diff --git a/lib/puppet/parser/functions/uriescape.rb b/lib/puppet/parser/functions/uriescape.rb
@@ -15,7 +15,7 @@ module Puppet::Parser::Functions
     @return [String]
       a string that contains the converted value
 
-    DOC
+  DOC
   ) do |arguments|
     raise(Puppet::ParseError, "uriescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
diff --git a/lib/puppet/parser/functions/validate_augeas.rb b/lib/puppet/parser/functions/validate_augeas.rb
@@ -41,7 +41,7 @@ module Puppet::Parser::Functions
 
         validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')
 
-    DOC
+  DOC
   ) do |args|
     unless Puppet.features.augeas?
       raise Puppet::ParseError, 'validate_augeas(): this function requires the augeas feature. See http://docs.puppetlabs.com/guides/augeas.html#pre-requisites for how to activate it.'
diff --git a/lib/puppet/parser/functions/validate_cmd.rb b/lib/puppet/parser/functions/validate_cmd.rb
diff --git a/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb b/lib/puppet/parser/functions/validate_x509_rsa_key_pair.rb
diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb
diff --git a/lib/puppet/parser/functions/zip.rb b/lib/puppet/parser/functions/zip.rb
