Merge pull request #9183 from mhashizume/PUP-11771/main/rubocop-naming

(PUP-11771) Rubocop Naming Cops

Author: joshcooper

.rubocop.yml

@@ -54,3 +54,86 @@ Metrics/ParameterLists:
 
 Metrics/PerceivedComplexity:
   Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+Naming/BlockParameterName:
+  Exclude:
+    - 'lib/puppet/util/windows/daemon.rb'
+    - 'lib/puppet/util/windows/user.rb'
+
+Naming/ClassAndModuleCamelCase:
+  Exclude:
+    - 'lib/puppet/ffi/windows/structs.rb'
+    - 'lib/puppet/pops/validation/checker4_0.rb'
+    - 'lib/puppet/pops/validation/validator_factory_4_0.rb'
+    - 'lib/puppet/util/windows/root_certs.rb'
+    - 'lib/puppet/util/windows/security.rb'
+    - 'lib/puppet/util/windows/user.rb'
+
+Naming/ConstantName:
+  Exclude:
+    - 'lib/puppet/graph/relationship_graph.rb'
+    - 'lib/puppet/indirector/hiera.rb'
+    - 'lib/puppet/provider/package/sun.rb'
+    - 'lib/puppet/resource/type.rb'
+    - 'lib/puppet/type/schedule.rb'
+    - 'lib/puppet/type/tidy.rb'
+    - 'lib/puppet/util.rb'
+    - 'lib/puppet/util/colors.rb'
+    - 'lib/puppet/util/execution.rb'
+    - 'lib/puppet/util/symbolic_file_mode.rb'
+    - 'lib/puppet/util/tagging.rb'
+    - 'lib/puppet/util/windows/adsi.rb'
+    - 'lib/puppet/util/windows/sid.rb'
+    - 'lib/puppet/util/yaml.rb'
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+# Exclude existing violations to avoid breaking changes
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/puppet/module_tool/applications/installer.rb'
+    - 'lib/puppet/pops/types/type_factory.rb'
+    - 'lib/puppet/provider/package/portage.rb'
+    - 'lib/puppet/resource.rb'
+
+Naming/MethodName:
+  Exclude:
+    - 'lib/puppet/functions/**/*'
+    - 'lib/puppet/parser/ast/pops_bridge.rb'
+    - 'lib/puppet/pops/**/*'
+    - 'lib/puppet/util/windows/**/*'
+
+Naming/MethodParameterName:
+  Enabled: false
+
+Naming/PredicateName:
+  ForbiddenPrefixes: []
+
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
+
+Naming/VariableName:
+  Exclude:
+    - 'ext/windows/service/daemon.rb'
+    - 'lib/puppet/agent.rb'
+    - 'lib/puppet/application/describe.rb'
+    - 'lib/puppet/pops/lookup/hiera_config.rb'
+    - 'lib/puppet/pops/validation/checker4_0.rb'
+    - 'lib/puppet/provider/package/pip.rb'
+    - 'lib/puppet/provider/package/windows/exe_package.rb'
+    - 'lib/puppet/provider/package/windows/msi_package.rb'
+    - 'lib/puppet/ssl/ssl_provider.rb'
+    - 'lib/puppet/util/windows/adsi.rb'
+    - 'lib/puppet/util/windows/daemon.rb'
+    - 'lib/puppet/util/windows/error.rb'
+    - 'lib/puppet/util/windows/user.rb'
+
+Naming/VariableNumber:
+  Enabled: false

.rubocop_todo.yml

@@ -643,104 +643,6 @@ Lint/ToJSON:
 Lint/UnusedMethodArgument:
   Enabled: false
 
-Naming/AccessorMethodName:
-  Enabled: false
-
-# This cop supports safe auto-correction (--auto-correct).
-Naming/BinaryOperatorParameterName:
-  Enabled: false
-
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-Naming/BlockParameterName:
-  Exclude:
-    - 'lib/puppet/util/windows/daemon.rb'
-    - 'lib/puppet/util/windows/user.rb'
-
-# Configuration parameters: AllowedNames.
-# AllowedNames: module_parent
-Naming/ClassAndModuleCamelCase:
-  Exclude:
-    - 'lib/puppet/ffi/windows/structs.rb'
-    - 'lib/puppet/pops/validation/checker4_0.rb'
-    - 'lib/puppet/pops/validation/validator_factory_4_0.rb'
-    - 'lib/puppet/util/windows/root_certs.rb'
-    - 'lib/puppet/util/windows/security.rb'
-    - 'lib/puppet/util/windows/user.rb'
-
-Naming/ConstantName:
-  Exclude:
-    - 'lib/puppet/graph/relationship_graph.rb'
-    - 'lib/puppet/indirector/hiera.rb'
-    - 'lib/puppet/provider/package/sun.rb'
-    - 'lib/puppet/resource/type.rb'
-    - 'lib/puppet/type/schedule.rb'
-    - 'lib/puppet/type/tidy.rb'
-    - 'lib/puppet/util.rb'
-    - 'lib/puppet/util/colors.rb'
-    - 'lib/puppet/util/execution.rb'
-    - 'lib/puppet/util/symbolic_file_mode.rb'
-    - 'lib/puppet/util/tagging.rb'
-    - 'lib/puppet/util/windows/adsi.rb'
-    - 'lib/puppet/util/windows/sid.rb'
-    - 'lib/puppet/util/yaml.rb'
-
-# Configuration parameters: ForbiddenDelimiters.
-# ForbiddenDelimiters: (?-mix:(^|\s)(EO[A-Z]{1}|END)(\s|$))
-Naming/HeredocDelimiterNaming:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, AllowedPatterns, IgnoredPatterns.
-# SupportedStyles: snake_case, camelCase
-Naming/MethodName:
-  Enabled: false
-
-# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
-# AllowedNames: at, by, db, id, in, io, ip, of, on, os, pp, to
-Naming/MethodParameterName:
-  Enabled: false
-
-# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
-# NamePrefix: is_, has_, have_
-# ForbiddenPrefixes: is_, has_, have_
-# AllowedMethods: is_a?
-# MethodDefinitionMacros: define_method, define_singleton_method
-Naming/PredicateName:
-  Enabled: false
-
-# This cop supports safe auto-correction (--auto-correct).
-# Configuration parameters: PreferredName.
-Naming/RescuedExceptionsVariableName:
-  Enabled: false
-
-# Configuration parameters: EnforcedStyle, AllowedIdentifiers.
-# SupportedStyles: snake_case, camelCase
-Naming/VariableName:
-  Exclude:
-    - 'ext/windows/service/daemon.rb'
-    - 'lib/puppet/agent.rb'
-    - 'lib/puppet/application/describe.rb'
-    - 'lib/puppet/pops/lookup/hiera_config.rb'
-    - 'lib/puppet/pops/validation/checker4_0.rb'
-    - 'lib/puppet/provider/package/pip.rb'
-    - 'lib/puppet/provider/package/windows/exe_package.rb'
-    - 'lib/puppet/provider/package/windows/msi_package.rb'
-    - 'lib/puppet/ssl/ssl_provider.rb'
-    - 'lib/puppet/util/windows/adsi.rb'
-    - 'lib/puppet/util/windows/daemon.rb'
-    - 'lib/puppet/util/windows/error.rb'
-    - 'lib/puppet/util/windows/user.rb'
-
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
-Naming/VariableNumber:
-  Enabled: false
-
 # Configuration parameters: EnforcedStyle, AllowModifiersOnSymbols.
 # SupportedStyles: inline, group
 Style/AccessModifierDeclarations:

lib/puppet/etc.rb

@@ -132,6 +132,7 @@ def group
     # these fields as well. API compatible with Etc::Passwd. Because Struct.new
     # defines a new Class object, we memoize to avoid superfluous extra Class
     # instantiations.
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def puppet_etc_passwd_class
       @password_class ||= Struct.new(*Etc::Passwd.members, *Etc::Passwd.members.map { |member| "canonical_#{member}".to_sym })
     end
@@ -145,6 +146,7 @@ def puppet_etc_passwd_class
     def puppet_etc_group_class
       @group_class ||= Struct.new(*Etc::Group.members, *Etc::Group.members.map { |member| "canonical_#{member}".to_sym })
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # Utility method for overriding the String values of a struct returned by
     # the Etc module to UTF-8. Structs returned by the ruby Etc module contain

lib/puppet/feature/base.rb

@@ -57,7 +57,7 @@ module WindowsSymlink
       require 'ffi'
       extend FFI::Library
 
-      def self.is_implemented
+      def self.is_implemented # rubocop:disable Naming/PredicateName
         begin
           ffi_lib :kernel32
           attach_function :CreateSymbolicLinkW, [:lpwstr, :lpwstr, :dword], :boolean

lib/puppet/forge.rb

@@ -195,6 +195,7 @@ def prepare
     # Obtain a suitable temporary path for unpacking tarballs
     #
     # @return [Pathname] path to temporary unpacking location
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def tmpdir
       @dir ||= Dir.mktmpdir(name, Puppet::Forge::Cache.base_path)
     end
@@ -204,6 +205,7 @@ def tmpfile
         f.binmode
       end
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     def download(uri, destination)
       response = @source.make_http_request(uri, destination)

lib/puppet/functions/defined.rb

@@ -107,7 +107,7 @@
     required_repeated_param 'Variant[String, Type[CatalogEntry], Type[Type[CatalogEntry]]]', :vals
   end
 
-  def is_defined(scope, *vals)
+  def is_defined(scope, *vals) # rubocop:disable Naming/PredicateName
     vals.any? do |val|
       case val
       when String

lib/puppet/module_tool/applications/installer.rb

@@ -395,18 +395,6 @@ def resolve_install_conflicts(graph, is_dependency = false)
           end
         end
       end
-
-      #
-      # Check if a file is a vaild module package.
-      # ---
-      # FIXME: Checking for a valid module package should be more robust and
-      # use the actual metadata contained in the package. 03132012 - Hightower
-      # +++
-      #
-      def is_module_package?(name)
-        filename = File.expand_path(name)
-        filename =~ /.tar.gz$/
-      end
     end
   end
 end

lib/puppet/module_tool/applications/unpacker.rb

@@ -93,9 +93,11 @@ def move_into(dir)
       #
       # @api private
       # @return [String] path to temporary unpacking location
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def tmpdir
         @dir ||= Dir.mktmpdir('tmp', Puppet::Forge::Cache.base_path)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
     end
   end
 end

lib/puppet/module_tool/applications/upgrader.rb

@@ -220,13 +220,15 @@ def installed_release.priority
       end
 
       private
+      # rubocop:disable Naming/MemoizedInstanceVariableName
       def module_repository
         @repo ||= Puppet::Forge.new(Puppet[:module_repository])
       end
 
       def installed_modules_source
         @installed ||= Puppet::ModuleTool::InstalledModules.new(@environment)
       end
+      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       def installed_modules
         installed_modules_source.modules

lib/puppet/module_tool/local_tarball.rb

@@ -76,9 +76,11 @@ def prepare
     # Obtain a suitable temporary path for unpacking tarballs
     #
     # @return [String] path to temporary unpacking location
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def tmpdir
       @dir ||= Dir.mktmpdir('local-tarball', Puppet::Forge::Cache.base_path)
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     def unpack(file, destination)
       begin