Merge pull request #335 from puppetlabs/CAT-1644-rubocop_upgrade

(CAT-1644) - Rubocop upgrade to 1.48.1

Author: gavindidrichsen

.rubocop.yml

@@ -14,65 +14,7 @@ AllCops:
   - pkg/**/*
   - spec/fixtures/**/*
   - vendor/**/*
-Layout/LineLength:
-  Description: People have wide screens, use them.
-  Max: 200
-RSpec/BeforeAfterAll:
-  Description: Beware of using after(:all) as it may cause state to leak between tests.
-    A necessary evil in acceptance testing.
-  Exclude:
-  - spec/acceptance/**/*.rb
-RSpec/HookArgument:
-  Description: Prefer explicit :each argument, matching existing module's style
-  EnforcedStyle: each
-RSpec/SubjectStub:
-  Exclude:
-    - 'spec/puppet/resource_api/base_context_spec.rb'
-Style/BlockDelimiters:
-  Description: Prefer braces for chaining. Mostly an aesthetical choice. Better to
-    be consistent then.
-  EnforcedStyle: braces_for_chaining
-Style/ClassAndModuleChildren:
-  Description: Compact style reduces the required amount of indentation.
-  EnforcedStyle: compact
-# this needs to be easily usable in the gemspec
-  Enabled: false
-Style/EmptyElse:
-  Description: Enforce against empty else clauses, but allow `nil` for clarity.
-  EnforcedStyle: empty
-Style/FormatString:
-  Description: Following the main puppet project's style, prefer the % format format.
-  EnforcedStyle: percent
-Style/FormatStringToken:
-  Description: Following the main puppet project's style, prefer the simpler template
-    tokens over annotated ones.
-  EnforcedStyle: template
-Style/Lambda:
-  Description: Prefer the keyword for easier discoverability.
-  EnforcedStyle: literal
-Style/RegexpLiteral:
-  Description: Community preference. See https://github.com/voxpupuli/modulesync_config/issues/168
-  EnforcedStyle: percent_r
-Style/TernaryParentheses:
-  Description: Checks for use of parentheses around ternary conditions. Enforce parentheses
-    on complex expressions for better readability, but seriously consider breaking
-    it up.
-  EnforcedStyle: require_parentheses_when_complex
-Style/TrailingCommaInArguments:
-  Description: Prefer always trailing comma on multiline argument lists. This makes
-    diffs, and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-Style/SymbolArray:
-  Description: Using percent style obscures symbolic intent of array's contents.
-  EnforcedStyle: brackets
-Layout/EndOfLine:
-  Enabled: false
-Style/CollectionMethods:
-  Enabled: true
-Style/MethodCalledOnDoEndBlock:
-  Enabled: true
-Style/StringMethods:
-  Enabled: true
+
 Metrics/AbcSize:
   Enabled: false
 Metrics/BlockLength:
@@ -85,71 +27,17 @@ Metrics/MethodLength:
   Enabled: false
 Metrics/ModuleLength:
   Enabled: false
-Metrics/ParameterLists:
-  Enabled: false
 Metrics/PerceivedComplexity:
   Enabled: false
-RSpec/DescribeClass:
-  Enabled: false
-RSpec/ExampleLength:
-  Enabled: false
-RSpec/MessageExpectation:
-  Enabled: false
-RSpec/MultipleExpectations:
-  Enabled: false
-RSpec/NestedGroups:
-  Enabled: false
-Style/AsciiComments:
-  Enabled: false
-Style/IfUnlessModifier:
-  Enabled: false
-Style/SymbolProc:
+Style/ClassAndModuleChildren:
   Enabled: false
-
-# local overrides
-
-# overridden for local conventions
-Naming/FileName:
-  Exclude:
-    - 'puppet-resource_api.gemspec'
-
-# metaprogramming makes everything "fun"
+Naming/MethodParameterName:
+  AllowedNames:
+    - is
 Lint/NestedMethodDefinition:
   Exclude:
     - 'lib/puppet/resource_api.rb'
-
-# Interacting with external API makes message spies pretty useless
+Layout/LineLength:
+  Max: 200
 RSpec/MessageSpies:
   Enabled: false
-
-# requires 2.3's squiggly HEREDOC support, which we can't use, yet
-# see http://www.virtuouscode.com/2016/01/06/about-the-ruby-squiggly-heredoc-syntax/
-Layout/HeredocIndentation:
-  Enabled: false
-
-# Updated in 0.53 (or thereabouts)
-Style/TrailingCommaInArrayLiteral:
-  Description: Prefer always trailing comma on multiline literals. This makes diffs,
-    and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-Style/TrailingCommaInHashLiteral:
-  Description: Prefer always trailing comma on multiline literals. This makes diffs,
-    and re-ordering nicer.
-  EnforcedStyleForMultiline: comma
-
-# Add allowing "is", as it is a technical term in puppet
-Naming/MethodParameterName:
-  Description: Checks for method parameter names that contain capital letters, end in
-    numbers, or do not meet a minimal length.
-  Enabled: true
-  MinNameLength: 3
-  AllowNamesEndingInNumbers: true
-  AllowedNames:
-  - io
-  - id
-  - is
-  ForbiddenNames: []
-
-# This cop breaks syntax highlighting in VSCode
-Layout/ClosingHeredocIndentation:
-  Enabled: false

.rubocop_todo.yml

@@ -1,42 +1,20 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-12-13 15:50:43 UTC using RuboCop version 1.48.1.
+# on 2023-12-19 10:44:38 UTC using RuboCop version 1.48.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 6
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: enums
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'spec/puppet/resource_api/base_context_spec.rb'
-    - 'spec/puppet/resource_api/transport/wrapper_spec.rb'
-    - 'spec/puppet/resource_api/transport_spec.rb'
-    - 'spec/puppet/resource_api_spec.rb'
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyleForLeadingUnderscores.
-# SupportedStylesForLeadingUnderscores: disallowed, required, optional
-Naming/MemoizedInstanceVariableName:
-  Exclude:
-    - 'lib/puppet/resource_api/type_definition.rb'
-
-# Offense count: 1
-# Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers, AllowedPatterns.
-# SupportedStyles: snake_case, normalcase, non_integer
-# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339, x86_64
-Naming/VariableNumber:
-  Exclude:
-    - 'spec/puppet/resource_api_spec.rb'
+# Offense count: 25
+# Configuration parameters: IgnoredMetadata.
+RSpec/DescribeClass:
+  Enabled: false
 
-# Offense count: 1
-# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
-# Include: **/*_spec*rb*, **/spec/**/*
-RSpec/FilePath:
-  Exclude:
-    - 'spec/acceptance/custom_insync_spec_hidden_property.rb'
+# Offense count: 33
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 16
 
 # Offense count: 18
 # Configuration parameters: AssignmentOnly.
@@ -45,35 +23,29 @@ RSpec/InstanceVariable:
     - 'spec/acceptance/namevar_spec.rb'
     - 'spec/puppet/resource_api/data_type_handling_spec.rb'
 
-# Offense count: 15
+# # Offense count: 15
 RSpec/LeakyConstantDeclaration:
   Exclude:
     - 'spec/puppet/resource_api/base_context_spec.rb'
     - 'spec/puppet/resource_api/transport/wrapper_spec.rb'
     - 'spec/puppet/resource_api/transport_spec.rb'
     - 'spec/puppet/resource_api_spec.rb'
 
+# Offense count: 163
+RSpec/MultipleExpectations:
+  Max: 11
+
 # Offense count: 126
 # Configuration parameters: AllowSubject.
 RSpec/MultipleMemoizedHelpers:
   Max: 14
 
-# Offense count: 2
-RSpec/RepeatedExampleGroupDescription:
-  Exclude:
-    - 'spec/puppet/resource_api_spec.rb'
+# Offense count: 213
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 7
 
-# Offense count: 25
-RSpec/StubbedMock:
+# Offense count: 47
+RSpec/SubjectStub:
   Exclude:
-    - 'spec/puppet/resource_api/property_spec.rb'
-    - 'spec/puppet/resource_api/transport/wrapper_spec.rb'
-    - 'spec/puppet/resource_api/transport_spec.rb'
-    - 'spec/puppet/resource_api_spec.rb'
-
-# Offense count: 2
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: respond_to_missing?
-Style/OptionalBooleanParameter:
-  Exclude:
-    - 'lib/puppet/resource_api/data_type_handling.rb'
+    - 'spec/puppet/resource_api/base_context_spec.rb'

contrib/pre-commit

@@ -4,15 +4,13 @@
 # Code modified from: https://gist.github.com/hanloong/9849098
 require 'English'
 
-changed_files = `git diff --name-only --cached --diff-filter=ACM`.split(%r{\n})
-changed_files = changed_files.select { |file_name|
+changed_files = `git diff --name-only --cached --diff-filter=ACM`.split(/\n/)
+changed_files = changed_files.select do |file_name|
   File.extname(file_name) == '.rb'
-}.join(' ')
+end.join(' ')
 
 system("bundle exec rubocop -a #{changed_files}") unless changed_files.empty?
 
-if $CHILD_STATUS.to_s[-1].to_i.zero? && !changed_files.empty?
-  system("git add #{changed_files}")
-end
+system("git add #{changed_files}") if $CHILD_STATUS.to_s[-1].to_i.zero? && !changed_files.empty?
 
 exit $CHILD_STATUS.to_s[-1].to_i