(CONT-801) Autocorrect unsafe group 1

Author: LukasAud

.rubocop_todo.yml

@@ -34,15 +34,6 @@ Lint/MissingCopEnableDirective:
     - 'spec/functions/merge_spec.rb'
     - 'spec/unit/puppet/provider/file_line/ruby_spec_alter.rb'
 
-# Offense count: 2
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: instance_of?, kind_of?, is_a?, eql?, respond_to?, equal?
-Lint/RedundantSafeNavigation:
-  Exclude:
-    - 'lib/puppet/parser/functions/assert_private.rb'
-    - 'lib/puppet/parser/functions/getparam.rb'
-
 # Offense count: 3
 # Configuration parameters: AllowComments, AllowNil.
 Lint/SuppressedException:
@@ -105,19 +96,6 @@ Performance/CollectionLiteralInLoop:
   Exclude:
     - 'lib/puppet/functions/ensure_packages.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowRegexpMatch.
-Performance/RedundantEqualityComparisonBlock:
-  Exclude:
-    - 'lib/puppet/parser/functions/bool2str.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Performance/UnfreezeString:
-  Exclude:
-    - 'lib/puppet/parser/functions/pw_hash.rb'
-
 # Offense count: 95
 # This cop supports unsafe autocorrection (--autocorrect-all).
 RSpec/BeEq:
@@ -202,21 +180,6 @@ RSpec/StubbedMock:
     - 'spec/functions/reverse_spec.rb'
     - 'spec/functions/squeeze_spec.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: MinBranchesCount.
-Style/CaseLikeIf:
-  Exclude:
-    - 'lib/puppet_x/stdlib/toml_dumper.rb'
-
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: nested, compact
-Style/ClassAndModuleChildren:
-  Exclude:
-    - 'lib/puppet_x/stdlib/toml_dumper.rb'
-
 # Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/CollectionCompact:

lib/puppet/parser/functions/assert_private.rb

@@ -19,7 +19,7 @@ module Puppet::Parser::Functions
     scope = self
     if scope.lookupvar('module_name') != scope.lookupvar('caller_module_name')
       message = nil
-      if args[0]&.is_a?(String)
+      if args[0].is_a?(String)
         message = args[0]
       else
         manifest_name = scope.source.name

lib/puppet/parser/functions/bool2str.rb

@@ -49,7 +49,7 @@ module Puppet::Parser::Functions
     # We can have either true or false, and nothing else
     raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with') unless [FalseClass, TrueClass].include?(klass)
 
-    raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') unless [true_string, false_string].all? { |x| x.is_a?(String) }
+    raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to') unless [true_string, false_string].all?(String)
 
     return value ? true_string : false_string
   end

lib/puppet/parser/functions/getparam.rb

@@ -46,7 +46,7 @@
 ) do |vals|
   reference, param = vals
   raise(ArgumentError, 'Must specify a reference') unless reference
-  raise(ArgumentError, 'Must specify name of a parameter') unless param&.instance_of?(String)
+  raise(ArgumentError, 'Must specify name of a parameter') unless param.instance_of?(String)
 
   return '' if param.empty?
 

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').crypt('$1$1') == '$1$1$Bp8CU9Oujr9SSEw53WV6G.'
     password.crypt(salt)
   else
     # JRuby < 1.7.17

lib/puppet_x/stdlib/toml_dumper.rb

@@ -21,116 +21,115 @@
 require_relative '../../puppet_x/stdlib'
 require 'date'
 
-module PuppetX::Stdlib
-  # The Dumper class was blindly copied from https://github.com/emancu/toml-rb/blob/v2.0.1/lib/toml-rb/dumper.rb
-  # This allows us to use the `to_toml` function as a `Deferred` function because the `toml-rb` gem is usually
-  # installed on the agent and the `Deferred` function gets evaluated before the catalog gets applied. This
-  # makes it in most scenarios impossible to install the gem before it is used.
-  class TomlDumper
-    attr_reader :toml_str
-
-    def initialize(hash)
-      @toml_str = ''
-
-      visit(hash, [])
-    end
+# The Dumper class was blindly copied from https://github.com/emancu/toml-rb/blob/v2.0.1/lib/toml-rb/dumper.rb
+# This allows us to use the `to_toml` function as a `Deferred` function because the `toml-rb` gem is usually
+# installed on the agent and the `Deferred` function gets evaluated before the catalog gets applied. This
+# makes it in most scenarios impossible to install the gem before it is used.
+class PuppetX::Stdlib::TomlDumper
+  attr_reader :toml_str
 
-    private
+  def initialize(hash)
+    @toml_str = ''
 
-    def visit(hash, prefix, extra_brackets = false)
-      simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash
+    visit(hash, [])
+  end
 
-      print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?)
+  private
 
-      dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix
-    end
+  def visit(hash, prefix, extra_brackets = false)
+    simple_pairs, nested_pairs, table_array_pairs = sort_pairs hash
 
-    def sort_pairs(hash)
-      nested_pairs = []
-      simple_pairs = []
-      table_array_pairs = []
-
-      hash.keys.sort.each do |key|
-        val = hash[key]
-        element = [key, val]
-
-        if val.is_a? Hash
-          nested_pairs << element
-        elsif val.is_a?(Array) && val.first.is_a?(Hash)
-          table_array_pairs << element
-        else
-          simple_pairs << element
-        end
-      end
+    print_prefix prefix, extra_brackets if prefix.any? && (simple_pairs.any? || hash.empty?)
 
-      [simple_pairs, nested_pairs, table_array_pairs]
-    end
-
-    def dump_pairs(simple, nested, table_array, prefix = [])
-      # First add simple pairs, under the prefix
-      dump_simple_pairs simple
-      dump_nested_pairs nested, prefix
-      dump_table_array_pairs table_array, prefix
-    end
+    dump_pairs simple_pairs, nested_pairs, table_array_pairs, prefix
+  end
 
-    def dump_simple_pairs(simple_pairs)
-      simple_pairs.each do |key, val|
-        key = quote_key(key) unless bare_key? key
-        @toml_str << "#{key} = #{to_toml(val)}\n"
-      end
-    end
+  def sort_pairs(hash)
+    nested_pairs = []
+    simple_pairs = []
+    table_array_pairs = []
 
-    def dump_nested_pairs(nested_pairs, prefix)
-      nested_pairs.each do |key, val|
-        key = quote_key(key) unless bare_key? key
+    hash.keys.sort.each do |key|
+      val = hash[key]
+      element = [key, val]
 
-        visit val, prefix + [key], false
+      if val.is_a? Hash
+        nested_pairs << element
+      elsif val.is_a?(Array) && val.first.is_a?(Hash)
+        table_array_pairs << element
+      else
+        simple_pairs << element
       end
     end
 
-    def dump_table_array_pairs(table_array_pairs, prefix)
-      table_array_pairs.each do |key, val|
-        key = quote_key(key) unless bare_key? key
-        aux_prefix = prefix + [key]
+    [simple_pairs, nested_pairs, table_array_pairs]
+  end
 
-        val.each do |child|
-          print_prefix aux_prefix, true
-          args = sort_pairs(child) << aux_prefix
+  def dump_pairs(simple, nested, table_array, prefix = [])
+    # First add simple pairs, under the prefix
+    dump_simple_pairs simple
+    dump_nested_pairs nested, prefix
+    dump_table_array_pairs table_array, prefix
+  end
 
-          dump_pairs(*args)
-        end
-      end
+  def dump_simple_pairs(simple_pairs)
+    simple_pairs.each do |key, val|
+      key = quote_key(key) unless bare_key? key
+      @toml_str << "#{key} = #{to_toml(val)}\n"
     end
+  end
 
-    def print_prefix(prefix, extra_brackets = false)
-      new_prefix = prefix.join('.')
-      new_prefix = '[' + new_prefix + ']' if extra_brackets
+  def dump_nested_pairs(nested_pairs, prefix)
+    nested_pairs.each do |key, val|
+      key = quote_key(key) unless bare_key? key
 
-      @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals
+      visit val, prefix + [key], false
     end
+  end
 
-    def to_toml(obj)
-      if obj.is_a?(Time) || obj.is_a?(DateTime)
-        obj.strftime('%Y-%m-%dT%H:%M:%SZ')
-      elsif obj.is_a?(Date)
-        obj.strftime('%Y-%m-%d')
-      elsif obj.is_a? Regexp
-        obj.inspect.inspect
-      elsif obj.is_a? String
-        obj.inspect.gsub(/\\(#[$@{])/, '\1') # rubocop:disable Style/RegexpLiteral
-      else
-        obj.inspect
+  def dump_table_array_pairs(table_array_pairs, prefix)
+    table_array_pairs.each do |key, val|
+      key = quote_key(key) unless bare_key? key
+      aux_prefix = prefix + [key]
+
+      val.each do |child|
+        print_prefix aux_prefix, true
+        args = sort_pairs(child) << aux_prefix
+
+        dump_pairs(*args)
       end
     end
+  end
 
-    def bare_key?(key)
-      # rubocop:disable Style/RegexpLiteral
-      !!key.to_s.match(/^[a-zA-Z0-9_-]*$/)
-      # rubocop:enable Style/RegexpLiteral
-    end
+  def print_prefix(prefix, extra_brackets = false)
+    new_prefix = prefix.join('.')
+    new_prefix = '[' + new_prefix + ']' if extra_brackets
 
-    def quote_key(key)
-      '"' + key.gsub('"', '\\"') + '"'
+    @toml_str += "[" + new_prefix + "]\n" # rubocop:disable Style/StringLiterals
+  end
+
+  def to_toml(obj)
+    case obj
+    when Time, DateTime
+      obj.strftime('%Y-%m-%dT%H:%M:%SZ')
+    when Date
+      obj.strftime('%Y-%m-%d')
+    when Regexp
+      obj.inspect.inspect
+    when String
+      obj.inspect.gsub(/\\(#[$@{])/, '\1') # rubocop:disable Style/RegexpLiteral
+    else
+      obj.inspect
     end
   end
+
+  def bare_key?(key)
+    # rubocop:disable Style/RegexpLiteral
+    !!key.to_s.match(/^[a-zA-Z0-9_-]*$/)
+    # rubocop:enable Style/RegexpLiteral
+  end
+
+  def quote_key(key)
+    '"' + key.gsub('"', '\\"') + '"'
+  end
 end