Merge pull request #40 from bastelfreak/rubocop

pin rubocop to < 1.79

Author: bastelfreak

.github/workflows/checks.yaml

@@ -26,5 +26,5 @@ jobs:
         with:
           ruby-version: '2.7'
           bundler-cache: true
-      - run: bundle exec rubocop --parallel
+      - run: bundle exec rake rubocop
       - run: gem build --strict --verbose *.gemspec

.rubocop_todo.yml

@@ -1,11 +1,21 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2024-01-08 20:12:30 UTC using RuboCop version 1.59.0.
+# `rubocop --auto-gen-config --no-auto-gen-timestamp`
+# using RuboCop version 1.78.0.
 # 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: 2
+# Configuration parameters: EnforcedStyle, AllowedPatterns, ForbiddenIdentifiers, ForbiddenPatterns.
+# SupportedStyles: snake_case, camelCase
+# ForbiddenIdentifiers: __id__, __send__
+Naming/MethodName:
+  Exclude:
+    - 'spec/mocks/win32ole.rb'
+    - 'spec/mocks/ffi.rb'
+    - 'spec/facter/util/windows/network_utils_spec.rb'
+
 # Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 Performance/RegexpMatch:
@@ -18,35 +28,21 @@ Performance/RegexpMatch:
 RSpec/FilePath:
   Enabled: false
 
-# Need to remove logger class variables
+# Offense count: 14
 Style/ClassVars:
   Exclude:
     - 'lib/facter/framework/logging/logger.rb'
     - 'spec/custom_facts/puppetlabs_spec/files.rb'
-    - 'spec/facter/util/file_helper_spec.rb'
-    - 'spec/framework/core/fact/internal/internal_fact_manager_spec.rb'
     - 'spec/framework/logging/logger_spec.rb'
 
+# Offense count: 981
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
-  Exclude:
-    - 'lib/facter.rb' # should be documented
-    - 'lib/facter/config.rb' # should be documented
-    - 'lib/facter/custom_facts/**/*' # should be documented
-    - 'lib/facter/facts/**/*' # don't care
-    - 'lib/facter/framework/**/*' # should be documented
-    - 'lib/facter/models/**/*' # should be documented
-    - 'lib/facter/resolvers/**/*' # don't care
-    - 'lib/facter/util/**/*'
-    - 'lib/facter/version.rb' # auto updated
-    - 'spec/**/*'
-    - 'spec_integration/**/*'
-    - 'scripts/*'
-    - 'install.rb'
+  Enabled: false
 
-# While it would be preferable to use a keyword argument for the proxy setting in #get_request and #put_request, if we
-# add keyword arguments to those methods Ruby < 3 misinterprets earlier positional arguments as a keyword arguments.
-# This is because those positional arguments are hashes that use symbols as keys.
-# TODO: revisit this after we drop Ruby < 3 support.
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: respond_to_missing?
 Style/OptionalBooleanParameter:
   Exclude:
-    - 'lib/facter/util/resolvers/http.rb'
+    - 'lib/facter/util/resolvers/http.rb'

Rakefile

@@ -77,3 +77,16 @@ end
 
 desc 'Prepare for a release'
 task 'release:prepare' => [:changelog]
+
+begin
+  require 'rubocop/rake_task'
+rescue LoadError
+  # Do nothing if no required gem installed
+else
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    # These make the rubocop experience maybe slightly less terrible
+    task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+    # Use Rubocop's Github Actions formatter if possible
+    task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
+  end
+end

openfact.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'ffi', '>= 1.15.5', '< 1.17.0', '!= 1.16.0', '!= 1.16.1', '!= 1.16.2'
   spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.6'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '~> 1.28' # last version to support 2.5
+  spec.add_development_dependency 'rubocop', '~> 1.28', '< 1.79'
   spec.add_development_dependency 'rubocop-performance', '~> 1.5.2'
   spec.add_development_dependency 'rubocop-rspec', '~> 2.10' # last version to support 2.5
   spec.add_development_dependency 'simplecov', '~> 0.17.1'

spec/facter/util/windows/network_utils_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Ps = Struct.new(:PhysicalAddress, :PhysicalAddressLength)
+Ps = Struct.new(:PhysicalAddress, :PhysicalAddressLength) # rubocop:disable Naming/MethodName
 
 describe NetworkUtils do
   describe '#address_to_string' do