(CONT-801) Autocorrect safe group 7

LukasAud · LukasAud · commit e2c3f6a14f2a · 2023-05-23T16:26:07.000+01:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -290,58 +290,6 @@ Style/RedundantArgument:
   Exclude:
     - 'lib/puppet/provider/file_line/ruby.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantFileExtensionInRequire:
-  Exclude:
-    - 'lib/puppet/functions/to_toml.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantHeredocDelimiterQuotes:
-  Exclude:
-    - 'lib/puppet/parser/functions/convert_base.rb'
-    - 'lib/puppet/parser/functions/deep_merge.rb'
-    - 'lib/puppet/parser/functions/getparam.rb'
-    - 'lib/puppet/parser/functions/loadjson.rb'
-    - 'lib/puppet/parser/functions/loadyaml.rb'
-    - 'lib/puppet/parser/functions/merge.rb'
-
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantParentheses:
-  Exclude:
-    - 'lib/puppet/parser/functions/pw_hash.rb'
-
-# Offense count: 41
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantRegexpEscape:
-  Exclude:
-    - 'lib/puppet/parser/functions/loadjson.rb'
-    - 'lib/puppet/parser/functions/loadyaml.rb'
-    - 'lib/puppet/parser/functions/range.rb'
-    - 'lib/puppet/parser/functions/values_at.rb'
-    - 'spec/functions/load_module_metadata_spec.rb'
-    - 'spec/functions/loadjson_spec.rb'
-    - 'spec/functions/validate_cmd_spec.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantStringEscape:
-  Exclude:
-    - 'lib/puppet/type/file_line.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: implicit, explicit
-Style/RescueStandardError:
-  Exclude:
-    - 'lib/puppet/functions/stdlib/crc32.rb'
-    - 'lib/puppet/functions/stdlib/sha256.rb'
-    - 'lib/puppet/parser/functions/any2bool.rb'
-    - 'spec/spec_helper.rb'
-
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/SelectByRegexp:
diff --git a/lib/puppet/functions/stdlib/crc32.rb b/lib/puppet/functions/stdlib/crc32.rb
@@ -25,7 +25,7 @@
 
   def crc32(my_data)
     Zlib.crc32(my_data.unwrap.to_s).to_s(16).downcase
-  rescue
+  rescue StandardError
     Zlib.crc32(my_data.to_s).to_s(16).downcase
   end
 end
diff --git a/lib/puppet/functions/stdlib/sha256.rb b/lib/puppet/functions/stdlib/sha256.rb
@@ -20,7 +20,7 @@
 
   def sha256(my_data)
     Digest::SHA256.hexdigest(my_data.unwrap.to_s)
-  rescue
+  rescue StandardError
     Digest::SHA256.hexdigest(my_data.to_s)
   end
 end
diff --git a/lib/puppet/functions/to_toml.rb b/lib/puppet/functions/to_toml.rb
@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative '../../puppet_x/stdlib/toml_dumper.rb'
+require_relative '../../puppet_x/stdlib/toml_dumper'
 
 # @summary Convert a data structure and output to TOML.
 Puppet::Functions.create_function(:to_toml) do
diff --git a/lib/puppet/parser/functions/any2bool.rb b/lib/puppet/parser/functions/any2bool.rb
@@ -35,7 +35,7 @@ module Puppet::Parser::Functions
 
     valid_float = begin
       !!Float(arg) # rubocop:disable Style/DoubleNegation : Could not find a better way to check if a boolean
-    rescue
+    rescue StandardError
       false
     end
 
diff --git a/lib/puppet/parser/functions/convert_base.rb b/lib/puppet/parser/functions/convert_base.rb
@@ -4,7 +4,7 @@
 # convert_base.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'DOC') do |args|
+  newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-DOC) do |args|
     @summary
       Converts a given integer or base 10 string representing an integer to a
       specified base, as a string.
diff --git a/lib/puppet/parser/functions/deep_merge.rb b/lib/puppet/parser/functions/deep_merge.rb
@@ -4,7 +4,7 @@
 # deep_merge.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:deep_merge, type: :rvalue, doc: <<-'DOC') do |args|
+  newfunction(:deep_merge, type: :rvalue, doc: <<-DOC) do |args|
     @summary
       Recursively merges two or more hashes together and returns the resulting hash.
 
diff --git a/lib/puppet/parser/functions/getparam.rb b/lib/puppet/parser/functions/getparam.rb
@@ -3,7 +3,7 @@
 # Test whether a given class or definition is defined
 require 'puppet/parser/functions'
 
-Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-'DOC'
+Puppet::Parser::Functions.newfunction(:getparam, type: :rvalue, doc: <<-DOC
     @summary
       Returns the value of a resource's parameter.
 
diff --git a/lib/puppet/parser/functions/loadjson.rb b/lib/puppet/parser/functions/loadjson.rb
@@ -5,7 +5,7 @@
 #
 
 module Puppet::Parser::Functions
-  newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-'DOC') do |args|
+  newfunction(:loadjson, type: :rvalue, arity: -2, doc: <<-DOC) do |args|
     @summary
       Load a JSON file containing an array, string, or hash, and return the data
       in the corresponding native data type.
@@ -30,12 +30,12 @@ module Puppet::Parser::Functions
     begin
       if args[0].start_with?('http://', 'https://')
         http_options = {}
-        if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)}))
+        if (match = args[0].match(%r{(http://|https://)(.*):(.*)@(.*)}))
           # If URL is in the format of https://username:password@example.local/my_hash.yaml
           protocol, username, password, path = match.captures
           url = "#{protocol}#{path}"
           http_options[:http_basic_authentication] = [username, password]
-        elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)}))
+        elsif (match = args[0].match(%r{(http://|https://)(.*)@(.*)}))
           # If URL is in the format of https://username@example.local/my_hash.yaml
           protocol, username, path = match.captures
           url = "#{protocol}#{path}"
diff --git a/lib/puppet/parser/functions/loadyaml.rb b/lib/puppet/parser/functions/loadyaml.rb
@@ -4,7 +4,7 @@
 # loadyaml.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-'DOC') do |args|
+  newfunction(:loadyaml, type: :rvalue, arity: -2, doc: <<-DOC) do |args|
     @summary
       Load a YAML file containing an array, string, or hash, and return the data
       in the corresponding native data type.
@@ -31,11 +31,11 @@ module Puppet::Parser::Functions
       if args[0].start_with?('http://', 'https://')
         username = ''
         password = ''
-        if (match = args[0].match(%r{(http\://|https\://)(.*):(.*)@(.*)}))
+        if (match = args[0].match(%r{(http://|https://)(.*):(.*)@(.*)}))
           # If URL is in the format of https://username:password@example.local/my_hash.yaml
           protocol, username, password, path = match.captures
           url = "#{protocol}#{path}"
-        elsif (match = args[0].match(%r{(http\:\/\/|https\:\/\/)(.*)@(.*)}))
+        elsif (match = args[0].match(%r{(http://|https://)(.*)@(.*)}))
           # If URL is in the format of https://username@example.local/my_hash.yaml
           protocol, username, path = match.captures
           url = "#{protocol}#{path}"
diff --git a/lib/puppet/parser/functions/merge.rb b/lib/puppet/parser/functions/merge.rb
@@ -4,7 +4,7 @@
 # merge.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:merge, type: :rvalue, doc: <<-'DOC') do |args|
+  newfunction(:merge, type: :rvalue, doc: <<-DOC) do |args|
     @summary
       Merges two or more hashes together and returns the resulting hash.
 
diff --git a/lib/puppet/parser/functions/pw_hash.rb b/lib/puppet/parser/functions/pw_hash.rb
@@ -76,7 +76,7 @@
 
   # handle weak implementations of String#crypt
   # dup the string to get rid of frozen status for testing
-  if ('test'.dup).crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.'
+  if 'test'.dup.crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.'
     password.crypt(salt)
   else
     # JRuby < 1.7.17
diff --git a/lib/puppet/parser/functions/range.rb b/lib/puppet/parser/functions/range.rb
@@ -59,7 +59,7 @@ module Puppet::Parser::Functions
     else # arguments.size == 1
       value = arguments[0]
 
-      m = value.match(%r{^(\w+)(\.\.\.?|\-)(\w+)$})
+      m = value.match(%r{^(\w+)(\.\.\.?|-)(\w+)$})
       if m
         start = m[1]
         stop  = m[3]
diff --git a/lib/puppet/parser/functions/values_at.rb b/lib/puppet/parser/functions/values_at.rb
@@ -53,7 +53,7 @@ module Puppet::Parser::Functions
 
     indices.each do |i|
       i = i.to_s
-      m = i.match(%r{^(\d+)(\.\.\.?|\-)(\d+)$})
+      m = i.match(%r{^(\d+)(\.\.\.?|-)(\d+)$})
       if m
         start = m[1].to_i
         stop  = m[3].to_i
@@ -64,8 +64,8 @@ module Puppet::Parser::Functions
         raise(Puppet::ParseError, 'values_at(): Stop index in given indices range exceeds array size') if stop > array.size - 1 # First element is at index 0 is it not?
 
         range = case type
-                when %r{^(\.\.|\-)$} then (start..stop)
-                when %r{^(\.\.\.)$}  then (start...stop) # Exclusive of last element ...
+                when %r{^(\.\.|-)$} then (start..stop)
+                when %r{^(\.\.\.)$} then (start...stop) # Exclusive of last element ...
                 end
 
         range.each { |i| indices_list << i.to_i } # rubocop:disable Lint/ShadowingOuterLocalVariable : Value is meant to be shadowed
diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb
@@ -32,7 +32,7 @@
       ensure => present,
       path   => '/etc/bashrc',
       line   => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
-      match  => '^export\ HTTP_PROXY\=',
+      match  => '^export HTTP_PROXY=',
     }
     ```
 
@@ -50,7 +50,7 @@
     file_line { 'bashrc_proxy':
       ensure            => absent,
       path              => '/etc/bashrc',
-      match             => '^export\ HTTP_PROXY\=',
+      match             => '^export HTTP_PROXY=',
       match_for_absence => true,
     }
     ```
diff --git a/spec/functions/load_module_metadata_spec.rb b/spec/functions/load_module_metadata_spec.rb
@@ -11,17 +11,17 @@
     before :each do
       # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock
       allow(File).to receive(:read).with(anything, anything).and_call_original
-      allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}')
-      allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}')
+      allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}')
+      allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}')
       # Additional modules used by litmus which are identified while running these dues to being in fixtures
-      allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8')
+      allow(File).to receive(:read).with(%r{/(provision|puppet_agent|facts)/metadata.json}, encoding: 'utf-8')
     end
 
     context 'when calling with valid utf8 and double byte character arguments' do
       before :each do
-        allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèŉţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš -
+        allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"ĭďèŉţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš -
 この文字"}')
-        allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"ĭďèŉţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš -
+        allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"ĭďèŉţĩƒіểя": "ċơņťęאּť ỡƒ ţħíš -
 この文字"}')
       end
 
diff --git a/spec/functions/loadjson_spec.rb b/spec/functions/loadjson_spec.rb
@@ -10,10 +10,10 @@
     before :each do
       # In Puppet 7, there are two prior calls to File.read prior to the responses we want to mock
       allow(File).to receive(:read).with(anything, anything).and_call_original
-      allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}')
-      allow(File).to receive(:read).with(%r{\/(stdlib|test)\/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}')
+      allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}, encoding: 'utf-8').and_return('{"name": "puppetlabs-stdlib"}')
+      allow(File).to receive(:read).with(%r{/(stdlib|test)/metadata.json}).and_return('{"name": "puppetlabs-stdlib"}')
       # Additional modules used by litmus which are identified while running these dues to being in fixtures
-      allow(File).to receive(:read).with(%r{\/(provision|puppet_agent|facts)\/metadata.json}, encoding: 'utf-8')
+      allow(File).to receive(:read).with(%r{/(provision|puppet_agent|facts)/metadata.json}, encoding: 'utf-8')
     end
 
     context 'when a non-existing file is specified' do
diff --git a/spec/functions/validate_cmd_spec.rb b/spec/functions/validate_cmd_spec.rb
@@ -31,7 +31,7 @@
     context 'with % placeholder' do
       it {
         expect(subject).to run
-          .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ \/no\/such\/file' returned 1:.*(cannot touch|o such file or)})
+          .with_params('', "#{touch} % /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \S+ /no/such/file' returned 1:.*(cannot touch|o such file or)})
       }
 
       it { is_expected.to run.with_params('', "#{touch} % /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) }
@@ -40,7 +40,7 @@
     context 'without % placeholder' do
       it {
         expect(subject).to run
-          .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} \/no\/such\/file \S+' returned 1:.*(cannot touch|o such file or)})
+          .with_params('', "#{touch} /no/such/file").and_raise_error(Puppet::ParseError, %r{Execution of '#{touch} /no/such/file \S+' returned 1:.*(cannot touch|o such file or)})
       }
 
       it { is_expected.to run.with_params('', "#{touch} /no/such/file", 'custom error').and_raise_error(Puppet::ParseError, %r{custom error}) }
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -26,7 +26,7 @@
 
   begin
     default_facts.merge!(YAML.safe_load(File.read(f), permitted_classes: [], permitted_symbols: [], aliases: true))
-  rescue => e
+  rescue StandardError => e
     RSpec.configuration.reporter.message "WARNING: Unable to load #{f}: #{e}"
   end
 end

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`# convert_base.rb`
`5`	`5`	`#`
`6`	`6`	`module Puppet::Parser::Functions`
`7`		`- newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-'DOC') do \|args\|`
	`7`	`+ newfunction(:convert_base, type: :rvalue, arity: 2, doc: <<-DOC) do \|args\|`
`8`	`8`	`@summary`
`9`	`9`	`Converts a given integer or base 10 string representing an integer to a`
`10`	`10`	`specified base, as a string.`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`	`# deep_merge.rb`
`5`	`5`	`#`
`6`	`6`	`module Puppet::Parser::Functions`
`7`		`- newfunction(:deep_merge, type: :rvalue, doc: <<-'DOC') do \|args\|`
	`7`	`+ newfunction(:deep_merge, type: :rvalue, doc: <<-DOC) do \|args\|`
`8`	`8`	`@summary`
`9`	`9`	`Recursively merges two or more hashes together and returns the resulting hash.`
`10`	`10`