updating linting to use cookstyle and correct linting errors

Signed-off-by: John McCrae <john.mccrae@progress.com>

Author: johnmccrae

components/ruby/.rubocop.yml

@@ -0,0 +1,4 @@
+# Feel free to correct anything in this file
+
+AllCops:
+  TargetRubyVersion: 3.1

components/ruby/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "chefstyle", "~> 2.2", ">= 2.2.2"
+  gem "cookstyle", "~> 8.0"
   gem "rake", "~> 13.0", ">= 13.0.6"
   gem "rspec", "~> 3.11"
 end

components/ruby/Gemfile.lock

@@ -28,10 +28,10 @@ GEM
       tomlrb (~> 1.2)
     chef-utils (18.8.46)
       concurrent-ruby
-    chefstyle (2.2.3)
-      rubocop (= 1.25.1)
     coderay (1.1.3)
     concurrent-ruby (1.3.5)
+    cookstyle (8.5.0)
+      rubocop (= 1.81.0)
     crack (1.0.0)
       bigdecimal
       rexml
@@ -67,20 +67,31 @@ GEM
     ffi (1.17.2-arm-linux-gnu)
     ffi (1.17.2-arm-linux-musl)
     ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
     ffi (1.17.2-x86-linux-gnu)
     ffi (1.17.2-x86-linux-musl)
     ffi (1.17.2-x86_64-darwin)
     ffi (1.17.2-x86_64-linux-gnu)
     ffi (1.17.2-x86_64-linux-musl)
+    ffi-win32-extensions (1.0.4)
+      ffi
     fuzzyurl (0.9.0)
     hashdiff (1.2.1)
+    json (2.15.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     method_source (1.1.0)
     mixlib-config (3.0.27)
       tomlrb
     mixlib-log (3.2.3)
       ffi (>= 1.15.5)
     mixlib-shellout (3.3.9)
       chef-utils
+    mixlib-shellout (3.3.9-x64-mingw-ucrt)
+      chef-utils
+      ffi-win32-extensions (~> 1.0.3)
+      win32-process (~> 0.9)
+      wmi-lite (~> 1.0)
     moneta (1.6.0)
     multipart-post (2.4.1)
     ostruct (0.1.0)
@@ -113,15 +124,17 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.6)
-    rubocop (1.25.1)
+    rubocop (1.81.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.15.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
     rubocop-ast (1.47.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
@@ -145,7 +158,10 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    win32-process (0.10.0)
+      ffi (>= 1.0.0)
     wisper (2.0.1)
+    wmi-lite (1.0.7)
 
 PLATFORMS
   aarch64-linux-gnu
@@ -154,6 +170,7 @@ PLATFORMS
   arm-linux-musl
   arm64-darwin
   ruby
+  x64-mingw-ucrt
   x86-linux-gnu
   x86-linux-musl
   x86_64-darwin
@@ -163,7 +180,7 @@ PLATFORMS
 DEPENDENCIES
   byebug
   chef-licensing!
-  chefstyle (~> 2.2, >= 2.2.2)
+  cookstyle (~> 8.0)
   pry
   rake (~> 13.0, >= 13.0.6)
   rspec (~> 3.11)

components/ruby/Rakefile

@@ -3,15 +3,20 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-begin
-  require "chefstyle"
+desc "Check Linting and code style."
+task :style do
   require "rubocop/rake_task"
-  desc "Run Chefstyle tests"
-  RuboCop::RakeTask.new(:style) do |task|
-    task.options += %w{ --display-cop-names --no-color }
+  require "cookstyle/chefstyle"
+
+  if RbConfig::CONFIG["host_os"] =~ /mswin|mingw|cygwin/
+    # Windows-specific command, rubocop erroneously reports the CRLF in each file which is removed when your PR is uploaeded to GitHub.
+    # This is a workaround to ignore the CRLF from the files before running cookstyle.
+    sh "cookstyle --chefstyle -c .rubocop.yml --except Layout/EndOfLine"
+  else
+    sh "cookstyle --chefstyle -c .rubocop.yml"
   end
 rescue LoadError
-  puts "chefstyle gem is not installed. bundle install first to make sure all dependencies are installed."
+  puts "Rubocop or Cookstyle gems are not installed. bundle install first to make sure all dependencies are installed."
 end
 
 task default: :spec

components/ruby/bin/test-app

@@ -16,4 +16,4 @@ ChefLicensing::LicenseKeyFetcher.fetch_and_persist(logger: logger).each do |lice
   puts "License Key: #{license_key}"
 end
 
-puts "Airgap is " + (ChefLicensing.air_gap_detected? ? true : false)
+puts "Airgap is " + (ChefLicensing.air_gap_detected? || false)

components/ruby/chef-licensing.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   spec.files =
-  Dir.glob("{{lib,etc}/**/*,LICENSE,chef-licensing.gemspec}")
-    .reject { |f| File.directory?(f) }
+    Dir.glob("{{lib,etc}/**/*,LICENSE,chef-licensing.gemspec}")
+      .reject { |f| File.directory?(f) }
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

components/ruby/lib/chef-licensing.rb

@@ -41,7 +41,7 @@ def check_software_entitlement!
       unless ChefLicensing::Config.make_licensing_optional
         if license_keys.empty?
           raise ChefLicensing::LicenseKeyFetcher::LicenseKeyNotFetchedError,
-                "Unable to obtain a License Key."
+            "Unable to obtain a License Key."
         end
 
         client(license_keys: license_keys)

components/ruby/lib/chef-licensing/api/client.rb

@@ -36,4 +36,4 @@ def info
       attr_reader :restful_client
     end
   end
-end
+end

components/ruby/lib/chef-licensing/api/describe.rb

@@ -59,4 +59,4 @@ def get_describe_api_response_data
       end
     end
   end
-end
+end

components/ruby/lib/chef-licensing/api/license_feature_entitlement.rb

@@ -52,4 +52,4 @@ def build_payload
       end
     end
   end
-end
+end