code-scanning-rubocop 0.3.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4e32fd700366fde1538d35a360bb632a31ad42a1199653c3f4ec2a00ae94ae6
-  data.tar.gz: 99f87d64f5287e712b0375f4e9d7fa840aeddf8fb619a0600f3aa1b5442f4d66
+  metadata.gz: 627fdcc7b65f53d26dc2b282199ac26fbf02a2b2eab521eca4523f3542e517fa
+  data.tar.gz: 54782e0495c961c25d03f72361cfc1f5ed4083a18b7f7384f5492264400f4dd0
 SHA512:
-  metadata.gz: ee4a2b0bdac90ecd2720874c9f5e55d2cef7763f3613a0ea4653f2533e7b065ea4763d0d6e347d602434ff377d7cbaa90ea9d429830ea0d964b5e23031fb9c59
-  data.tar.gz: e723dea9868724bd0bdcd50a05dce61fe1a9d6fcc9b7912618fd81b2aedf99045164dc25bc2f01b33f0630025ff3325b099cc9ba17ac19ea545bc6586084b3aa
+  metadata.gz: 96e006d3410433323cd6c5dc6397f8d06d418db855edaa0a688a17358d3ec1ec23a853facd2aa6c9267866b61542804dd925fc38728d412195297b0a7aae049a
+  data.tar.gz: 154b7ab2cbafde3032ab35d3b24a376b3abcb1387a0d76cc9459a4d42047a119a52862aa11e2893ebd32b554f35826d17594a4892dc5aff278b38f2d4a5f1011

data/.github/workflows/rubocop-analysis.yml

@@ -1,4 +1,4 @@
-name: "Rubocop"
+name: "RuboCop"
 
 on: [push]
 
@@ -21,7 +21,7 @@ jobs:
     - name: Install dependencies
       run: bundle install
 
-    - name: Rubocop run
+    - name: RuboCop run
       run: |
         bash -c "
           bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif

data/.rubocop.yml

@@ -10,6 +10,8 @@ inherit_from: .rubocop_todo.yml
 # where the inspected file is and continue its way up to the root directory.
 #
 # See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  NewCops: enable
 
 Layout/LineLength:
   Exclude:

data/Gemfile.lock

@@ -1,31 +1,34 @@
 PATH
   remote: .
   specs:
-    code-scanning-rubocop (0.2.0)
-      rubocop (~> 0.82.0)
+    code-scanning-rubocop (0.5.0)
+      rubocop (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.4)
+    ast (2.4.2)
     minitest (5.14.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
-    rainbow (3.0.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
     rake (12.3.3)
-    rexml (3.2.4)
-    rubocop (0.82.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.24.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    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
@@ -36,4 +39,4 @@ DEPENDENCIES
   rake (~> 12.0)
 
 BUNDLED WITH
-   2.1.4
+   2.3.4

data/README.md

@@ -1,7 +1,7 @@
 # CodeScanning::Rubocop
 
-'code-scanning-rubocop' is a gem to integrate Rubocop and the GitHub's code scanning feature.
-The repository is composed by two components. The gem which can be installed in any ruby application and a default GitHub action to ease the usage of it. 
+'code-scanning-rubocop' is a gem to integrate RuboCop and the GitHub's code scanning feature.
+The repository is composed by two components. The gem which can be installed in any ruby application and a default GitHub action to ease the usage of it.
 
 The rubygem adds a SARIF exporter to the rubocop runner. GitHub's code scanning feature accepts a SARIF file with the 'results' (alerts) generated by the tool.
 The action, is what will run rubocop with the exporter. Note: you can only run the gem within your application, and have our own action that calls rubocop. See more in the Installation and Usage sections.
@@ -9,13 +9,13 @@ The action, is what will run rubocop with the exporter. Note: you can only run t
 This is how it would look in your Security tab:
 ![preview](preview.png)
 
-## Action Installation 
+## Action Installation
 
 The easiest way to install the integration, is this action template bellow. It will install the gem in your app and run it for you within the GitHub's action enviroment. To install the action create a file `.github/workflows/rubocop-analysis.yml` like the following:
 
 ```yaml
 # .github/workflows/rubocop-analysis.yml
-name: "Rubocop"
+name: "RuboCop"
 
 on: [push]
 
@@ -41,7 +41,7 @@ jobs:
     - name: Install dependencies
       run: bundle install
 
-    - name: Rubocop run
+    - name: RuboCop run
       run: |
         bash -c "
           bundle exec rubocop --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif

data/code-scanning-rubocop.gemspec

@@ -30,5 +30,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubocop", "~> 0.82.0"
+  spec.add_dependency "rubocop", "~> 1.0"
 end

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,23 @@ 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
+        properties["queryURI"] = help_uri
+
+        h.merge!(
+          "helpUri" => help_uri,
+          "help" => {
+            "text" => help(:text),
+            "markdown" => help(:markdown)
+          }
+        )
+      end
+
       h
     end
   end

data/lib/code_scanning/rubocop/sarif_formatter.rb

@@ -7,19 +7,22 @@ module CodeScanning
   class SarifFormatter < RuboCop::Formatter::BaseFormatter
     def initialize(output, options = {})
       super
-      # rubocop:disable Layout/LineLength
       @sarif = {
         "$schema" => "https://raw.githubusercontent.com/oasis-tcs/sarif-spec/master/Schemata/sarif-schema-2.1.0.json",
         "version" => "2.1.0"
       }
-      # rubocop:enable Layout/LineLength
       @rules_map = {}
       @rules = []
       @results = []
       @sarif["runs"] = [
         {
           "tool" => {
-            "driver" => { "name" => "Rubocop", "rules" => @rules }
+            "driver" => {
+              "name" => "RuboCop",
+              "version" => RuboCop::Version.version,
+              "informationUri" => "https://rubocop.org",
+              "rules" => @rules
+            }
           },
           "results" => @results
         }
@@ -54,19 +57,15 @@ module CodeScanning
                 "artifactLocation" => {
                   "uri" => relative_path,
                   "uriBaseId" => "%SRCROOT%",
-                  "index" => 0
                 },
                 "region" => {
                   "startLine" => o.line,
                   "startColumn" => o.real_column,
-                  "endColumn" => o.last_column
+                  "endColumn" => o.last_column.zero? ? o.real_column : o.last_column
                 }
               }
             }
-          ],
-          "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.3.0"
+    VERSION = "0.6.1"
   end
 end

data/lib/code_scanning.rb

@@ -6,3 +6,4 @@ module CodeScanning
 end
 
 require_relative "code_scanning/rubocop/sarif_formatter"
+require_relative "code_scanning/rubocop/version"

data/rubocop-action/action.yml

@@ -1,5 +1,5 @@
 name: 'Rubocop code-scanning'
-description: 'Rubocop and code-scanning integration'
+description: 'RuboCop and code-scanning integration'
 runs:
   using: 'docker'
   image: '../Dockerfile'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code-scanning-rubocop
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Arthur Neves
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-22 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.0'
 description: This gem adds a SARIF formatter to rubocop, so we can export alerts to
   code-scanning inside GitHub.
 email:
@@ -76,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Extra formater to make rubocop compatible with GitHub's code-scanning feature.