Merge pull request #468 from bastelfreak/vr

rubocop: Fix style cops
puppetlabs · Jul 4, 2024 · 84fd2a7 · 84fd2a7
2 parents 58aa94b + ff7247e
commit 84fd2a7
Show file tree

Hide file tree

Showing 11 changed files with 43 additions and 104 deletions.
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-06-09 12:47:09 UTC using RuboCop version 1.63.5.
+# on 2024-06-28 12:36:37 UTC using RuboCop version 1.64.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
@@ -18,14 +18,6 @@ Lint/MixedRegexpCaptureTypes:
   Exclude:
     - 'Gemfile'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: strict, consistent
-Lint/SymbolConversion:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/puppetlabs_spec/puppet_internals.rb'
-
 # Offense count: 7
 # Configuration parameters: Prefixes, AllowedPatterns.
 # Prefixes: when, with, without
@@ -99,12 +91,6 @@ Security/Eval:
   Exclude:
     - 'lib/puppetlabs_spec_helper/tasks/fixtures.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/CombinableLoops:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/tasks/fixtures.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowedVars.
@@ -125,14 +111,6 @@ Style/GlobalVars:
   Exclude:
     - 'lib/puppetlabs_spec_helper/puppetlabs_spec/files.rb'
 
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: AllowedReceivers.
-# AllowedReceivers: Thread.current
-Style/HashEachMethods:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/tasks/fixtures.rb'
-
 # Offense count: 1
 Style/MixinUsage:
   Exclude:
@@ -152,42 +130,3 @@ Style/RegexpLiteral:
   Exclude:
     - 'Gemfile'
     - 'spec/unit/puppetlabs_spec_helper/tasks/fixtures_spec.rb'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
-# SupportedStyles: single_quotes, double_quotes
-Style/StringLiterals:
-  Exclude:
-    - 'Rakefile'
-
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
-# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
-Style/TernaryParentheses:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/tasks/fixtures.rb'
-    - 'spec/watchr.rb'
-
-# Offense count: 12
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInArrayLiteral:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/module_spec_helper.rb'
-    - 'lib/puppetlabs_spec_helper/tasks/check_symlinks.rb'
-    - 'spec/spec_helper.rb'
-    - 'spec/unit/puppetlabs_spec_helper/tasks/check_symlinks_spec.rb'
-    - 'spec/unit/puppetlabs_spec_helper/tasks/check_test_file_spec.rb'
-
-# Offense count: 26
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/puppetlabs_spec_helper/rake_tasks.rb'
-    - 'spec/unit/puppetlabs_spec_helper/tasks/check_symlinks_spec.rb'
-    - 'spec/unit/puppetlabs_spec_helper/tasks/fixture_helpers_spec.rb'
diff --git a/Rakefile b/Rakefile
@@ -4,7 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |t|
-  t.exclude_pattern = "spec/acceptance/**/*.rb"
+  t.exclude_pattern = 'spec/acceptance/**/*.rb'
 end
 
 namespace :spec do
@@ -16,7 +16,7 @@ namespace :spec do
 end
 
 RSpec::Core::RakeTask.new(:acceptance) do |t|
-  t.pattern = "spec/acceptance/**/*.rb"
+  t.pattern = 'spec/acceptance/**/*.rb'
 end
 
 require 'yard'

diff --git a/lib/puppetlabs_spec_helper/module_spec_helper.rb b/lib/puppetlabs_spec_helper/module_spec_helper.rb
@@ -31,7 +31,7 @@ def verify_contents(subject, title, expected_lines)
 
   SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console
+    SimpleCov::Formatter::Console,
   ]
 
   begin

diff --git a/lib/puppetlabs_spec_helper/rake_tasks.rb b/lib/puppetlabs_spec_helper/rake_tasks.rb
@@ -381,16 +381,16 @@ def changelog_future_release
       config.configure_sections = {
         'Changed' => {
           'prefix' => '### Changed',
-          'labels' => ['backwards-incompatible']
+          'labels' => ['backwards-incompatible'],
         },
         'Added' => {
           'prefix' => '### Added',
-          'labels' => %w[feature enhancement]
+          'labels' => %w[feature enhancement],
         },
         'Fixed' => {
           'prefix' => '### Fixed',
-          'labels' => ['bugfix']
-        }
+          'labels' => ['bugfix'],
+        },
       }
     end
   else

diff --git a/lib/puppetlabs_spec_helper/tasks/check_symlinks.rb b/lib/puppetlabs_spec_helper/tasks/check_symlinks.rb
@@ -9,12 +9,12 @@ class CheckSymlinks
       DEFAULT_IGNORED = [
         '/.git/',
         '/.bundle/',
-        '/vendor/'
+        '/vendor/',
       ].freeze
 
       IGNORE_LIST_FILES = [
         '.pdkignore',
-        '.gitignore'
+        '.gitignore',
       ].freeze
 
       def check(dir = Dir.pwd)

diff --git a/lib/puppetlabs_spec_helper/tasks/fixtures.rb b/lib/puppetlabs_spec_helper/tasks/fixtures.rb
@@ -106,7 +106,7 @@ def fixtures(category)
                            end
 
         fixtures = fixtures['fixtures']
-        fixtures['symlinks'] = fixtures['symlinks'].nil? || fixtures['symlinks'].empty? ? auto_symlink : auto_symlink.merge!(fixtures['symlinks'])
+        fixtures['symlinks'] = (fixtures['symlinks'].nil? || fixtures['symlinks'].empty?) ? auto_symlink : auto_symlink.merge!(fixtures['symlinks'])
 
         result = {}
         if fixtures.include?(category) && !fixtures[category].nil?

diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
@@ -10,7 +10,7 @@
 
   SimpleCov.formatters = [
     SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console
+    SimpleCov::Formatter::Console,
   ]
 
   SimpleCov.start do

diff --git a/spec/unit/puppetlabs_spec_helper/tasks/check_symlinks_spec.rb b/spec/unit/puppetlabs_spec_helper/tasks/check_symlinks_spec.rb
@@ -31,7 +31,7 @@
     let(:test_files) do
       [
         File.join(Dir.pwd, 'files', 'a_file.pp'),
-        File.join(Dir.pwd, 'files', 'another_file.pp')
+        File.join(Dir.pwd, 'files', 'another_file.pp'),
       ]
     end
 
@@ -43,13 +43,13 @@
   context 'when there is a symlink present' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'files', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -63,13 +63,13 @@
   context 'when there are symlinks under .git/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, '.git', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, '.git', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -81,13 +81,13 @@
   context 'when there are symlinks under .bundle/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, '.bundle', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, '.bundle', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -99,13 +99,13 @@
   context 'when there are symlinks under vendor/' do
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'vendor', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'vendor', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -121,13 +121,13 @@
 
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'a_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'a_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 
@@ -145,13 +145,13 @@
 
     let(:test_files) do
       [
-        File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'files', 'a_file.pp'),
       ]
     end
 
     let(:symlinks) do
       {
-        File.join(Dir.pwd, 'another_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp')
+        File.join(Dir.pwd, 'another_directory', 'a_symlink.pp') => File.join(Dir.pwd, 'files', 'a_file.pp'),
       }
     end
 

diff --git a/spec/unit/puppetlabs_spec_helper/tasks/check_test_file_spec.rb b/spec/unit/puppetlabs_spec_helper/tasks/check_test_file_spec.rb
@@ -14,7 +14,7 @@
     let(:test_files) do
       [
         File.join(Dir.pwd, 'tests', 'an_example.pp'),
-        File.join(Dir.pwd, 'tests', 'deep', 'directory', 'structure', 'another_example.pp')
+        File.join(Dir.pwd, 'tests', 'deep', 'directory', 'structure', 'another_example.pp'),
       ]
     end
 

diff --git a/spec/unit/puppetlabs_spec_helper/tasks/fixture_helpers_spec.rb b/spec/unit/puppetlabs_spec_helper/tasks/fixture_helpers_spec.rb
@@ -141,7 +141,7 @@
             'branch' => nil,
             'scm' => nil,
             'flags' => nil,
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
@@ -159,7 +159,7 @@
             'branch' => nil,
             'scm' => nil,
             'flags' => '--module_repository=https://myforge.example.com/',
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
@@ -170,7 +170,7 @@
         allow(File).to receive(:exist?).with('.fixtures.yml').and_return true
         allow(YAML).to receive(:load_file).with('.fixtures.yml').and_return(
           'fixtures' => {
-            'repositories' => { 'stdlib' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git' }
+            'repositories' => { 'stdlib' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git' },
           },
         )
       end
@@ -183,7 +183,7 @@
             'branch' => nil,
             'scm' => nil,
             'flags' => nil,
-            'subdir' => nil
+            'subdir' => nil,
           },
         )
       end
@@ -198,9 +198,9 @@
               'stdlib' => {
                 'scm' => 'git',
                 'repo' => 'https://github.com/puppetlabs/puppetlabs-stdlib.git',
-                'ref' => 'this/is/a/branch'
-              }
-            }
+                'ref' => 'this/is/a/branch',
+              },
+            },
           },
         )
       end
@@ -222,9 +222,9 @@ def stub_fixtures(data)
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => Puppet::PUPPETVERSION
-              }
-            }
+                'puppet_version' => Puppet::PUPPETVERSION,
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to include('puppetlabs-stdlib')
@@ -236,9 +236,9 @@ def stub_fixtures(data)
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => '>= 999.9.9'
-              }
-            }
+                'puppet_version' => '>= 999.9.9',
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to eq({})
@@ -250,9 +250,9 @@ def stub_fixtures(data)
             'forge_modules' => {
               'stdlib' => {
                 'repo' => 'puppetlabs-stdlib',
-                'puppet_version' => Puppet::PUPPETVERSION
-              }
-            }
+                'puppet_version' => Puppet::PUPPETVERSION,
+              },
+            },
           },
         )
         expect(helper.fixtures('forge_modules')).to include('puppetlabs-stdlib')

diff --git a/spec/watchr.rb b/spec/watchr.rb
@@ -11,7 +11,7 @@ def growl(message)
   title = 'Watchr Test Results'
   image = case message
           when /(\d+)\s+?(failure|error)/i
-            Regexp.last_match(1).to_i == 0 ? '~/.watchr_images/passed.png' : '~/.watchr_images/failed.png'
+            (Regexp.last_match(1).to_i == 0) ? '~/.watchr_images/passed.png' : '~/.watchr_images/failed.png'
           else
             '~/.watchr_images/unknown.png'
           end