code-scanning-rubocop 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20b12a5a36ae8bf6f57d41d1386088d0b2701437dfca90d7807c79569b70b54f
-  data.tar.gz: 34cb6723cee9ab3de438578b010f4d112d197c41711ba18b81afd289f77dd934
+  metadata.gz: aede2d4f861c011d78db9d9f6df567bdd94322ed40951f3d15613b844e3e48b5
+  data.tar.gz: d2fdb4fc5b34b560c5a9af454def6730d75c4ed80cbfd6865027175df10b393c
 SHA512:
-  metadata.gz: b62c756e603d4445f61326901c47e470553e30f67d823f71dd2afe742c33cd41fdd46d4ad7b4b81bc30d55e5c7ade2359a1fd31b18e7240cf45c4e0fc424a3d9
-  data.tar.gz: 37ee5b0acd4d306cd23fca13d011c986471ea7b204f6f2d3a606340d413ede966b9f69f9855db68831dc12d59c87fdd946ae67003ad1c7b4fb0e2be915397b80
+  metadata.gz: f44b470a1e45e04a535fb6becc9ee6348da281405ea14cd96f726894327bec3523ecd627ece9b2426ae409ca13f14d9eaca5110d4bd5b8ba9515d1ad60edd7bd
+  data.tar.gz: 5f790f1cdcfb47d202e7b4afb613450ebe108fa3cc3b301140ee14cf98b63f7b15b2ad694a7be6ec29968569905e4029cdbfea5fe3b7c353b3d7651785998286

data/Gemfile.lock

@@ -1,34 +1,34 @@
 PATH
   remote: .
   specs:
-    code-scanning-rubocop (0.3.0)
-      rubocop (> 0.82.0)
+    code-scanning-rubocop (0.5.0)
+      rubocop (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
     minitest (5.14.0)
-    parallel (1.19.2)
-    parser (2.7.1.5)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (12.3.3)
-    regexp_parser (1.8.0)
-    rexml (3.2.4)
-    rubocop (0.92.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.24.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.5.0)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.5.0)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
-    unicode-display_width (1.7.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -39,4 +39,4 @@ DEPENDENCIES
   rake (~> 12.0)
 
 BUNDLED WITH
-   2.1.4
+   2.3.4

data/lib/code_scanning/rubocop/rule.rb

@@ -8,19 +8,19 @@ module CodeScanning
       @cop_name = cop_name
       @severity = severity.to_s
       @cop = RuboCop::Cop::Cop.registry.find_by_cop_name(cop_name)
-      @help = StringIO.new
     end
 
     def id
       @cop_name
     end
 
-    def append_help(line)
-      @help.print(line)
-    end
-
-    def help_empty?
-      @help.size.zero?
+    def help(format)
+      case format
+      when :text
+        "More info: #{help_uri}"
+      when :markdown
+        "[More info](#{help_uri})"
+      end
     end
 
     def ==(other)
@@ -41,12 +41,36 @@ module CodeScanning
       "none"
     end
 
-    # The URL for the docs are in this format:
-    # https://docs.rubocop.org/en/stable/cops_layout/#layoutblockendnewline
-    def query_uri
-      kind = badge.department.to_s.downcase
-      full_name = "#{kind}#{badge.cop_name.downcase}"
-      "https://docs.rubocop.org/en/stable/cops_#{kind}/##{full_name}"
+    def help_uri
+      return @cop.documentation_url if @cop.documentation_url
+      return nil unless department_uri
+
+      anchor = "#{badge.department}#{badge.cop_name}".downcase.tr("/", "")
+      "#{department_uri}##{anchor}"
+    end
+
+    def department_uri
+      case badge.department
+      when :Performance
+        "https://docs.rubocop.org/rubocop-performance/index.html"
+      when :Packaging
+        "https://docs.rubocop.org/rubocop-packaging/cops_packaging.html"
+      when :Rails
+        "https://docs.rubocop.org/rubocop-rails/cops_rails.html"
+      when :Minitest
+        "https://docs.rubocop.org/rubocop-minitest/cops_minitest.html"
+      when :RSpec
+        "https://docs.rubocop.org/rubocop-rspec/cops_rspec.html"
+      when :"RSpec/Rails"
+        "https://docs.rubocop.org/rubocop-rspec/cops_rspec_rails.html"
+      when :"RSpec/Capybara"
+        "https://docs.rubocop.org/rubocop-rspec/cops_rspec_capybara.html"
+      when :"RSpec/FactoryBot"
+        "https://docs.rubocop.org/rubocop-rspec/cops_rspec_factorybot.html"
+      else
+        STDERR.puts "WARNING: Unknown docs URI for department #{badge.department}"
+        nil
+      end
     end
 
     def to_json(opts = {})
@@ -66,7 +90,7 @@ module CodeScanning
 
       h = {
         "id" => @cop_name,
-        "name" => @cop_name,
+        "name" => @cop_name.tr("/", "").gsub("RSpec", "Rspec"),
         "defaultConfiguration" => {
           "level" => sarif_severity
         },
@@ -80,19 +104,22 @@ module CodeScanning
         properties["description"] = desc
       end
 
-      unless help_empty?
-        help = @help.string
-        h["help"] = {
-          "text" => help,
-          "markdown" => help
-        }
-        properties["queryURI"] = query_uri if badge.qualified?
-      end
-
       if badge.qualified?
         kind = badge.department.to_s
         properties["tags"] = [kind.downcase]
       end
+
+      if help_uri
+        h.merge!(
+          "queryURI" => help_uri,
+          "helpUri" => help_uri,
+          "help" => {
+            "text" => help(:text),
+            "markdown" => help(:markdown)
+          }
+        )
+      end
+
       h
     end
   end

data/lib/code_scanning/rubocop/sarif_formatter.rb

@@ -17,7 +17,12 @@ module CodeScanning
       @sarif["runs"] = [
         {
           "tool" => {
-            "driver" => { "name" => "RuboCop", "rules" => @rules }
+            "driver" => {
+              "name" => "RuboCop",
+              "version" => RuboCop::Version.version,
+              "informationUri" => "https://rubocop.org",
+              "rules" => @rules
+            }
           },
           "results" => @results
         }
@@ -52,7 +57,6 @@ module CodeScanning
                 "artifactLocation" => {
                   "uri" => relative_path,
                   "uriBaseId" => "%SRCROOT%",
-                  "index" => 0
                 },
                 "region" => {
                   "startLine" => o.line,
@@ -61,10 +65,7 @@ module CodeScanning
                 }
               }
             }
-          ],
-          "partialFingerprints" => {
-            # This will be computed by the upload action for now
-          }
+          ]
         }
       end
     end

data/lib/code_scanning/rubocop/version.rb

@@ -2,6 +2,6 @@
 
 module CodeScanning
   module Rubocop
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code-scanning-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Arthur Neves
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -76,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Extra formater to make rubocop compatible with GitHub's code-scanning feature.