Merge pull request #903 from Fryguy/update_rubocop

Upgrade manageiq-style and rubocop

Author: jrafanie

Gemfile

@@ -38,7 +38,7 @@ gem 'awesome_spawn',        '~> 1.6'
 gem 'default_value_for',    '~> 4.0'
 gem 'haml_lint',            '~> 0.51', :require => false
 gem 'irb'
-gem 'manageiq-style',       '~> 1.5', '>=1.5.6', :require => false
+gem 'manageiq-style',       '~> 1.6',  :require => false
 gem 'more_core_extensions', '~> 4.4',  :require => 'more_core_extensions/all'
 gem 'rugged',                          :require => false
 

Gemfile.lock

@@ -76,7 +76,7 @@ GEM
       public_suffix (>= 2.0.2, < 8.0)
     ast (2.4.3)
     awesome_spawn (1.6.0)
-    base64 (0.1.2)
+    base64 (0.3.0)
     benchmark (0.5.0)
     bigdecimal (4.0.1)
     builder (3.3.0)
@@ -149,6 +149,7 @@ GEM
       thor (>= 0.14, < 2.0)
     json (2.19.2)
     language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
     listen (3.10.0)
       logger
       rb-fsevent (~> 0.10, >= 0.10.3)
@@ -162,13 +163,11 @@ GEM
       net-imap
       net-pop
       net-smtp
-    manageiq-style (1.5.10)
+    manageiq-style (1.6.0)
       more_core_extensions
       optimist
       rack (>= 2.2.22, < 4)
-      rexml (>= 3.4.4)
-      rubocop (= 1.56.3)
-      rubocop-ast (~> 1.40.0)
+      rubocop (~> 1.85)
       rubocop-performance
       rubocop-rails
     marcel (1.0.4)
@@ -294,28 +293,30 @@ GEM
       rspec-mocks (>= 3.13.0, < 5.0.0)
       rspec-support (>= 3.13.0, < 5.0.0)
     rspec-support (3.13.7)
-    rubocop (1.56.3)
-      base64 (~> 0.1.1)
+    rubocop (1.86.0)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.40.0)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.23.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.29.1)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rails (2.34.3)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 1.52.0, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
     ruby-progressbar (1.13.0)
     rufus-scheduler (3.9.2)
       fugit (~> 1.1, >= 1.11.1)
@@ -372,7 +373,9 @@ GEM
     turbolinks-source (5.2.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
     uri (1.1.1)
     useragent (0.16.11)
     webmock (3.26.2)
@@ -404,7 +407,7 @@ DEPENDENCIES
   irb
   jquery-rails
   listen
-  manageiq-style (~> 1.5, >= 1.5.6)
+  manageiq-style (~> 1.6)
   minigit (~> 0.0.4)
   more_core_extensions (~> 4.4)
   net-ssh (~> 7.3.0)

app/workers/commit_monitor_handlers/commit_range/rubocop_checker/message_builder.rb

@@ -1,5 +1,6 @@
 require 'rubocop'
 require 'rubocop-rails'
+require 'rubocop-performance'
 require 'haml_lint'
 
 class CommitMonitorHandlers::CommitRange::RubocopChecker::MessageBuilder
@@ -29,25 +30,23 @@ def comments
     "refactor"   => :low
   ).freeze
 
-  COP_URIS = RuboCop::Cop::Base.descendants.each_with_object({}) do |cop, h|
-    plugin, version = nil
+  COP_URIS = begin
+    # Load configuration to get plugin DocumentationBaseURL settings
+    config = RuboCop::ConfigLoader.configuration_from_file('.rubocop.yml')
 
-    case cop.department
-    when :Rails
-      plugin  = "rubocop-rails"
-      version = RuboCop::Rails::Version.document_version
-    else
-      plugin  = "rubocop"
-      version = RuboCop::Version.document_version
-    end
+    RuboCop::Cop::Registry.global.cops.each_with_object({}) do |cop, h|
+      url_string = RuboCop::Cop::Documentation.url_for(cop, config)
+      next unless url_string # Skip cops without documentation URLs
 
-    url               = URI(RuboCop::Cop::Documentation.url_for(cop))
-    url_path_parts    = url.path.split("/")
-    url_path_parts[1] = plugin
-    url_path_parts.insert(2, version) unless url_path_parts[2] == version
+      # Insert "latest" version into URL path to avoid redirect that loses fragment
+      # e.g., /rubocop/cops_layout.html -> /rubocop/latest/cops_layout.html
+      url = URI(url_string)
+      url_path_parts = url.path.split("/")
+      url_path_parts.insert(2, "latest") unless url_path_parts[2] == "latest"
+      url.path = url_path_parts.join("/")
 
-    url.path        = url_path_parts.join("/")
-    h[cop.cop_name] = "[#{cop.cop_name}](#{url})"
+      h[cop.cop_name] = "[#{cop.cop_name}](#{url})"
+    end
   end.freeze
 
   def tag

spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/message_builder_spec.rb

@@ -22,18 +22,18 @@
         5 files checked, 5 offenses detected
 
         **spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/coding_convention.rb**
-        - [ ] :exclamation: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/coding_convention.rb#L3), Col 5 - [Layout/HashAlignment](https://docs.rubocop.org/rubocop/#{rubocop_version_short}/cops_layout.html#layouthashalignment) - Align the keys and values of a hash literal if they span more than one line.
-        - [ ] :exclamation: - [Line 4](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/coding_convention.rb#L4), Col 5 - [Layout/HashAlignment](https://docs.rubocop.org/rubocop/#{rubocop_version_short}/cops_layout.html#layouthashalignment) - Align the keys and values of a hash literal if they span more than one line.
+        - [ ] :exclamation: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/coding_convention.rb#L3), Col 5 - [Layout/HashAlignment](https://docs.rubocop.org/rubocop/latest/cops_layout.html#layouthashalignment) - Align the keys and values of a hash literal if they span more than one line.
+        - [ ] :exclamation: - [Line 4](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/coding_convention.rb#L4), Col 5 - [Layout/HashAlignment](https://docs.rubocop.org/rubocop/latest/cops_layout.html#layouthashalignment) - Align the keys and values of a hash literal if they span more than one line.
 
         **spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/with_results_with_offenses/rails.rb**
-        - [ ] :exclamation: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/with_results_with_offenses/rails.rb#L3), Col 5 - [Rails/DynamicFindBy](https://docs.rubocop.org/rubocop-rails/#{rubocop_rails_version_short}/cops_rails.html#railsdynamicfindby) - Use `find_by` instead of dynamic `find_by_name`.
+        - [ ] :exclamation: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/with_results_with_offenses/rails.rb#L3), Col 5 - [Rails/DynamicFindBy](https://docs.rubocop.org/rubocop-rails/latest/cops_rails.html#railsdynamicfindby) - Use `find_by` instead of dynamic `find_by_name`.
 
         **spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_syntax_error.rb**
-        - [ ] :bomb: :boom: :fire: :fire_engine: - [Line 6](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_syntax_error.rb#L6), Col 1 - [Lint/Syntax](https://docs.rubocop.org/rubocop/#{rubocop_version_short}/cops_lint.html#lintsyntax) - unexpected token kEND
+        - [ ] :bomb: :boom: :fire: :fire_engine: - [Line 6](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_syntax_error.rb#L6), Col 1 - [Lint/Syntax](https://docs.rubocop.org/rubocop/latest/cops_lint.html#lintsyntax) - unexpected token kEND
         (Using Ruby 2.6 parser; configure using `TargetRubyVersion` parameter, under `AllCops`)
 
         **spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_warning.rb**
-        - [ ] :warning: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_warning.rb#L3), Col 5 - [Lint/UselessAssignment](https://docs.rubocop.org/rubocop/#{rubocop_version_short}/cops_lint.html#lintuselessassignment) - Useless assignment to variable - `unused_variable`.
+        - [ ] :warning: - [Line 3](https://github.com/some_user/some_repo/blob/8942a195a0bfa69ceb82c020c60565408cb46d3e/spec/workers/commit_monitor_handlers/commit_range/rubocop_checker/data/#{rubocop_check_directory}/ruby_warning.rb#L3), Col 5 - [Lint/UselessAssignment](https://docs.rubocop.org/rubocop/latest/cops_lint.html#lintuselessassignment) - Useless assignment to variable - `unused_variable`.
       EOMSG
     end
 
@@ -68,6 +68,20 @@
     end
   end
 
+  describe "::COP_URIS" do
+    it "generates documentation URLs for builtin cops" do
+      expect(described_class::COP_URIS['Style/StringLiterals']).to match(/\[Style\/StringLiterals\]\(https:\/\/docs\.rubocop\.org\/rubocop\/latest\/cops_style\.html#stylestringliterals\)/)
+    end
+
+    it "generates documentation URLs for Rails cops" do
+      expect(described_class::COP_URIS['Rails/DynamicFindBy']).to match(/\[Rails\/DynamicFindBy\]\(https:\/\/docs\.rubocop\.org\/rubocop-rails\/latest\/cops_rails\.html#railsdynamicfindby\)/)
+    end
+
+    it "generates documentation URLs for Performance cops" do
+      expect(described_class::COP_URIS['Performance/StringInclude']).to match(/\[Performance\/StringInclude\]\(https:\/\/docs\.rubocop\.org\/rubocop-performance\/latest\/cops_performance\.html#performancestringinclude\)/)
+    end
+  end
+
   context "with stubbed yamllint" do
     before do
       described_class.instance_variable_set(:@yamllint_version, nil) # Clear caching