(PUP-11993) Style/RedundantRegexpEscape

AriaXLi · AriaXLi · commit 9c208c959585 · 2024-03-04T13:59:00.000-08:00
This commit enables the Style/RedundantRegexpEscape cop and fixes
27 autocorrectable offenses.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -668,10 +668,6 @@ Style/RedundantFetchBlock:
 Style/RedundantInterpolation:
   Enabled: false
 
-# This cop supports safe auto-correction (--auto-correct).
-Style/RedundantRegexpEscape:
-  Enabled: false
-
 # This cop supports safe auto-correction (--auto-correct).
 # Configuration parameters: AllowMultipleReturnValues.
 Style/RedundantReturn:
diff --git a/lib/puppet/face/help.rb b/lib/puppet/face/help.rb
@@ -208,7 +208,7 @@ def horribly_extract_summary_from(appname)
     # formatted.  If we can't match the pattern we expect we return the empty
     # string to ensure we don't blow up in the summary. --daniel 2011-04-11
     while line = help.shift do # rubocop:disable Lint/AssignmentInCondition
-      md = /^puppet-#{appname}\([^\)]+\) -- (.*)$/.match(line)
+      md = /^puppet-#{appname}\([^)]+\) -- (.*)$/.match(line)
       if md
         return md[1]
       end
diff --git a/lib/puppet/pops/loader/ruby_data_type_instantiator.rb b/lib/puppet/pops/loader/ruby_data_type_instantiator.rb
@@ -15,7 +15,7 @@ class Puppet::Pops::Loader::RubyDataTypeInstantiator
   # @return [Puppet::Pops::Types::PAnyType] - an instantiated data type associated with the given loader
   #
   def self.create(loader, typed_name, source_ref, ruby_code_string)
-    unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet\:\:DataTypes\.create_type/
+    unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet::DataTypes\.create_type/
       raise ArgumentError, _("The code loaded from %{source_ref} does not seem to be a Puppet 5x API data type - no create_type call.") % { source_ref: source_ref }
     end
 
diff --git a/lib/puppet/pops/loader/ruby_function_instantiator.rb b/lib/puppet/pops/loader/ruby_function_instantiator.rb
@@ -15,7 +15,7 @@ class Puppet::Pops::Loader::RubyFunctionInstantiator
   # @return [Puppet::Pops::Functions.Function] - an instantiated function with global scope closure associated with the given loader
   #
   def self.create(loader, typed_name, source_ref, ruby_code_string)
-    unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet\:\:Functions\.create_function/
+    unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet::Functions\.create_function/
       raise ArgumentError, _("The code loaded from %{source_ref} does not seem to be a Puppet 4x API function - no create_function call.") % { source_ref: source_ref }
     end
 
diff --git a/lib/puppet/pops/lookup/interpolation.rb b/lib/puppet/pops/lookup/interpolation.rb
@@ -48,7 +48,7 @@ def interpolate(value, context, allow_methods)
   def interpolate_string(subject, context, allow_methods)
     lookup_invocation = context.is_a?(Invocation) ? context : context.invocation
     lookup_invocation.with(:interpolate, subject) do
-      subject.gsub(/%\{([^\}]*)\}/) do |match|
+      subject.gsub(/%\{([^}]*)\}/) do |match|
         expr = ::Regexp.last_match(1)
         # Leading and trailing spaces inside an interpolation expression are insignificant
         expr.strip!
diff --git a/lib/puppet/pops/lookup/sub_lookup.rb b/lib/puppet/pops/lookup/sub_lookup.rb
@@ -3,7 +3,7 @@
 module Puppet::Pops
 module Lookup
 module SubLookup
-  SPECIAL = /['"\.]/
+  SPECIAL = /['".]/
 
   # Split key into segments. A segment may be a quoted string (both single and double quotes can
   # be used) and the segment separator is the '.' character. Whitespace will be trimmed off on
diff --git a/lib/puppet/pops/parser/heredoc_support.rb b/lib/puppet/pops/parser/heredoc_support.rb
@@ -8,7 +8,7 @@ module HeredocSupport
   # Pattern for heredoc `@(endtag[:syntax][/escapes])
   # Produces groups for endtag (group 1), syntax (group 2), and escapes (group 3)
   #
-  PATTERN_HEREDOC = %r{@\(([^:/\r\n\)]+)(?::[[:blank:]]*([a-z][a-zA-Z0-9_+]+)[[:blank:]]*)?(?:/((?:\w|[$])*)[[:blank:]]*)?\)}
+  PATTERN_HEREDOC = %r{@\(([^:/\r\n)]+)(?::[[:blank:]]*([a-z][a-zA-Z0-9_+]+)[[:blank:]]*)?(?:/((?:\w|[$])*)[[:blank:]]*)?\)}
 
   def heredoc
     scn = @scanner
@@ -81,7 +81,7 @@ def heredoc
     # that terminates the heredoc is found.
 
     # (Endline in EBNF form): WS* ('|' WS*)? ('-' WS*)? endtag WS* \r? (\n|$)
-    endline_pattern = /([[:blank:]]*)(?:([|])[[:blank:]]*)?(?:(\-)[[:blank:]]*)?#{Regexp.escape(endtag)}[[:blank:]]*\r?(?:\n|\z)/
+    endline_pattern = /([[:blank:]]*)(?:([|])[[:blank:]]*)?(?:(-)[[:blank:]]*)?#{Regexp.escape(endtag)}[[:blank:]]*\r?(?:\n|\z)/
     lines = []
     until scn.eos? do
       one_line = scn.scan_until(/(?:\n|\z)/)
diff --git a/lib/puppet/provider/package/appdmg.rb b/lib/puppet/provider/package/appdmg.rb
@@ -57,7 +57,7 @@ def self.installpkgdmg(source, name)
     cached_source = source
     tmpdir = Dir.mktmpdir
     begin
-      if %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ cached_source
+      if %r{\A[A-Za-z][A-Za-z0-9+\-.]*://} =~ cached_source
         cached_source = File.join(tmpdir, name)
         begin
           curl "-o", cached_source, "-C", "-", "-L", "-s", "--url", source
diff --git a/lib/puppet/provider/package/aptrpm.rb b/lib/puppet/provider/package/aptrpm.rb
@@ -53,7 +53,7 @@ def latest
     if output =~ /Versions:\s*\n((\n|.)+)^$/
       versions = Regexp.last_match(1)
       available_versions = versions.split(/\n/).filter_map { |version|
-        if version =~ /^([^\(]+)\(/
+        if version =~ /^([^(]+)\(/
           Regexp.last_match(1)
         else
           self.warning _("Could not match version '%{version}'") % { version: version }
diff --git a/lib/puppet/provider/package/pkgdmg.rb b/lib/puppet/provider/package/pkgdmg.rb
@@ -85,7 +85,7 @@ def self.installpkgdmg(source, name)
     tmpdir = Dir.mktmpdir
     ext = /(\.dmg|\.pkg)$/i.match(source)[0]
     begin
-      if %r{\A[A-Za-z][A-Za-z0-9+\-\.]*://} =~ cached_source
+      if %r{\A[A-Za-z][A-Za-z0-9+\-.]*://} =~ cached_source
         cached_source = File.join(tmpdir, "#{name}#{ext}")
         args = ["-o", cached_source, "-C", "-", "-L", "-s", "--fail", "--url", source]
         if http_proxy_host and http_proxy_port
diff --git a/lib/puppet/provider/package/portage.rb b/lib/puppet/provider/package/portage.rb
@@ -147,7 +147,7 @@ def qatom_output_format
   end
 
   def qatom_result_format
-    /^\"\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\](.*)\"$/
+    /^"\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\]\s+\[(\S*)\](.*)"$/
   end
 
   def qatom_result_fields
diff --git a/lib/puppet/provider/package/puppetserver_gem.rb b/lib/puppet/provider/package/puppetserver_gem.rb
@@ -167,7 +167,7 @@ def self.execute_rubygems_list_command(command_options)
     # There is no method exclude default gems from the local gem list,
     # for example: psych (default: 2.2.2)
     # but default gems should not be managed by this (or any) provider.
-    gem_list = gem_out.lines.reject { |gem| gem =~ / \(default\: / }
+    gem_list = gem_out.lines.reject { |gem| gem =~ / \(default: / }
     gem_list.join("\n")
   end
 end
diff --git a/lib/puppet/provider/package/rug.rb b/lib/puppet/provider/package/rug.rb
@@ -35,7 +35,7 @@ def latest
     # rug can only get a list of *all* available packages?
     output = rug "list-updates"
 
-    if output =~ /#{Regexp.escape @resource[:name]}\s*\|\s*([^\s\|]+)/
+    if output =~ /#{Regexp.escape @resource[:name]}\s*\|\s*([^\s|]+)/
       return Regexp.last_match(1)
     else
       # rug didn't find updates, pretend the current
diff --git a/lib/puppet/provider/service/freebsd.rb b/lib/puppet/provider/service/freebsd.rb
@@ -75,7 +75,7 @@ def rc_replace(service, rcvar, yesno)
       next unless Puppet::FileSystem.exist?(filename)
 
       s = File.read(filename)
-      next unless s.gsub!(/^(#{rcvar}(_enable)?)=\"?(YES|NO)\"?/, "\\1=\"#{yesno}\"")
+      next unless s.gsub!(/^(#{rcvar}(_enable)?)="?(YES|NO)"?/, "\\1=\"#{yesno}\"")
 
       Puppet::FileSystem.replace_file(filename) { |f| f << s }
       self.debug("Replaced in #{filename}")
diff --git a/lib/puppet/provider/service/upstart.rb b/lib/puppet/provider/service/upstart.rb
@@ -77,11 +77,11 @@ def self.get_services(exclude = [])
         # network-interface (lo) start/running
         # network-interface (eth0) start/running
         # network-interface-security start/running
-        matcher = line.match(/^(network-interface)\s\(([^\)]+)\)/)
+        matcher = line.match(/^(network-interface)\s\(([^)]+)\)/)
         name = if matcher
                  "#{matcher[1]} INTERFACE=#{matcher[2]}"
                else
-                 matcher = line.match(/^(network-interface-security)\s\(([^\)]+)\)/)
+                 matcher = line.match(/^(network-interface-security)\s\(([^)]+)\)/)
                  if matcher
                    "#{matcher[1]} JOB=#{matcher[2]}"
                  else
@@ -99,7 +99,7 @@ def self.defpath
   end
 
   def upstart_version
-    @upstart_version ||= initctl("--version").match(/initctl \(upstart ([^\)]*)\)/)[1]
+    @upstart_version ||= initctl("--version").match(/initctl \(upstart ([^)]*)\)/)[1]
   end
 
   # Where is our override script?
diff --git a/lib/puppet/settings/environment_conf.rb b/lib/puppet/settings/environment_conf.rb
@@ -174,7 +174,7 @@ def get_setting(setting_name, default = nil)
   def expand_glob(path)
     return nil if path.nil?
 
-    if path =~ /[*?\[\{]/
+    if path =~ /[*?\[{]/
       Dir.glob(path)
     else
       path
diff --git a/lib/puppet/util/command_line/trollop.rb b/lib/puppet/util/command_line/trollop.rb
@@ -36,7 +36,7 @@ class VersionNeeded < StandardError; end
   FLOAT_RE = /^-?((\d+(\.\d+)?)|(\.\d+))([eE][-+]?\d+)?$/
 
   ## Regex for parameters
-  PARAM_RE = /^-(-|\.$|[^\d\.])/
+  PARAM_RE = /^-(-|\.$|[^\d.])/
 
   ## The commandline parser. In typical usage, the methods in this class
   ## will be handled internally by Trollop::options. In this case, only the
diff --git a/lib/puppet/util/inifile.rb b/lib/puppet/util/inifile.rb
@@ -150,7 +150,7 @@ def read
     )
     INI_CONTINUATION = /^[ \t\r\n\f]/
     INI_SECTION_NAME = /^\[([^\]]+)\]/
-    INI_PROPERTY     = /^\s*([^\s=]+)\s*\=\s*(.*)$/
+    INI_PROPERTY     = /^\s*([^\s=]+)\s*=\s*(.*)$/
 
     # @api private
     def parse(text)
diff --git a/lib/puppet/util/package.rb b/lib/puppet/util/package.rb
@@ -35,7 +35,7 @@ def versioncmp(version_a, version_b, ignore_trailing_zeroes = false)
 
   def self.normalize(version)
     version = version.split('-')
-    version.first.sub!(/([\.0]+)$/, '')
+    version.first.sub!(/([.0]+)$/, '')
 
     version.join('-')
   end
diff --git a/lib/puppet/util/package/version/debian.rb b/lib/puppet/util/package/version/debian.rb
@@ -163,7 +163,7 @@ def match_digits(a)
     end
 
     def match_non_letters(a)
-      a.match(/^([\.\+-]+)/)
+      a.match(/^([.+-]+)/)
     end
 
     def match_tildes(a)

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ class Puppet::Pops::Loader::RubyDataTypeInstantiator`
`15`	`15`	`# @return [Puppet::Pops::Types::PAnyType] - an instantiated data type associated with the given loader`
`16`	`16`	`#`
`17`	`17`	`def self.create(loader, typed_name, source_ref, ruby_code_string)`
`18`		`- unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet\:\:DataTypes\.create_type/`
	`18`	`+ unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet::DataTypes\.create_type/`
`19`	`19`	`raise ArgumentError, _("The code loaded from %{source_ref} does not seem to be a Puppet 5x API data type - no create_type call.") % { source_ref: source_ref }`
`20`	`20`	`end`
`21`	`21`